From a0edaa039ad2c219da544b3b3c10490ace961de7 Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Thu, 12 Nov 2020 00:18:57 +0000 Subject: [PATCH 1/7] chore: update models as of 11/11 --- .../aws-models/amplify.2017-07-25.json | 1438 ++-- .../aws-models/auto-scaling.2011-01-01.json | 2056 +++--- .../aws-models/databrew.2017-07-25.json | 4811 +++++++++++++ .../aws-models/datasync.2018-11-09.json | 901 +-- .../aws-models/dynamodb.2012-08-10.json | 528 +- .../aws-models/ec2.2016-11-15.json | 84 +- .../aws-models/ecs.2014-11-13.json | 2941 ++++---- .../elastic-load-balancing-v2.2015-12-01.json | 1191 ++-- .../elasticsearch-service.2015-01-01.json | 232 + .../aws-models/forecast.2018-06-26.json | 1015 +-- .../aws-models/fsx.2018-03-01.json | 1299 ++-- .../aws-models/iotanalytics.2017-11-27.json | 1348 ++-- .../aws-models/macie2.2020-01-01.json | 2405 +++---- .../aws-models/mediaconvert.2017-08-29.json | 5849 ++++++++-------- .../aws-models/quicksight.2018-04-01.json | 5274 ++++++++------- .../sdk-codegen/aws-models/s3.2006-03-01.json | 6025 +++++++++-------- .../service-catalog.2015-12-10.json | 2824 ++++---- .../aws-models/ssm.2014-11-06.json | 12 +- .../storage-gateway.2013-06-30.json | 2542 +++---- 19 files changed, 24914 insertions(+), 17861 deletions(-) create mode 100644 codegen/sdk-codegen/aws-models/databrew.2017-07-25.json diff --git a/codegen/sdk-codegen/aws-models/amplify.2017-07-25.json b/codegen/sdk-codegen/aws-models/amplify.2017-07-25.json index 70f4dad095bc..10518e8f5206 100644 --- a/codegen/sdk-codegen/aws-models/amplify.2017-07-25.json +++ b/codegen/sdk-codegen/aws-models/amplify.2017-07-25.json @@ -192,29 +192,59 @@ "smithy.api#required": {} } }, - "autoBranchCreationPatterns": { - "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", + "appArn": { + "target": "com.amazonaws.amplify#AppArn", "traits": { - "smithy.api#documentation": "
Describes the automated branch creation glob patterns for the Amplify app.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amplify app.
", + "smithy.api#required": {} } }, - "customRules": { - "target": "com.amazonaws.amplify#CustomRules", + "name": { + "target": "com.amazonaws.amplify#Name", "traits": { - "smithy.api#documentation": "Describes the custom redirect and rewrite rules for the Amplify app.
" + "smithy.api#documentation": "The name for the Amplify app.
", + "smithy.api#required": {} } }, - "environmentVariables": { - "target": "com.amazonaws.amplify#EnvironmentVariables", + "tags": { + "target": "com.amazonaws.amplify#TagMap", "traits": { - "smithy.api#documentation": "The environment variables 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#required": {} } }, - "autoBranchCreationConfig": { - "target": "com.amazonaws.amplify#AutoBranchCreationConfig", + "repository": { + "target": "com.amazonaws.amplify#Repository", "traits": { - "smithy.api#documentation": "Describes the automated branch creation configuration for the Amplify app.
" + "smithy.api#documentation": "The repository for the Amplify app.
", + "smithy.api#required": {} + } + }, + "platform": { + "target": "com.amazonaws.amplify#Platform", + "traits": { + "smithy.api#documentation": "The platform for the Amplify app.
", + "smithy.api#required": {} + } + }, + "createTime": { + "target": "com.amazonaws.amplify#CreateTime", + "traits": { + "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#required": {} } }, "iamServiceRoleArn": { @@ -223,10 +253,11 @@ "smithy.api#documentation": "The AWS Identity and Access Management (IAM) service role for the Amazon Resource\n Name (ARN) of the Amplify app.
" } }, - "enableAutoBranchCreation": { - "target": "com.amazonaws.amplify#EnableAutoBranchCreation", + "environmentVariables": { + "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { - "smithy.api#documentation": "Enables automated branch creation for the Amplify app.
" + "smithy.api#documentation": "The environment variables for the Amplify app.
", + "smithy.api#required": {} } }, "defaultDomain": { @@ -236,13 +267,6 @@ "smithy.api#required": {} } }, - "enableBasicAuth": { - "target": "com.amazonaws.amplify#EnableBasicAuth", - "traits": { - "smithy.api#documentation": "Enables basic authorization for the Amplify app's branches.
", - "smithy.api#required": {} - } - }, "enableBranchAutoBuild": { "target": "com.amazonaws.amplify#EnableBranchAutoBuild", "traits": { @@ -250,38 +274,29 @@ "smithy.api#required": {} } }, - "repository": { - "target": "com.amazonaws.amplify#Repository", - "traits": { - "smithy.api#documentation": "The repository for the Amplify app.
", - "smithy.api#required": {} - } - }, - "platform": { - "target": "com.amazonaws.amplify#Platform", + "enableBranchAutoDeletion": { + "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", "traits": { - "smithy.api#documentation": "The platform for the Amplify app.
", - "smithy.api#required": {} + "smithy.api#documentation": "Automatically disconnect a branch in the Amplify Console when you delete a branch\n from your Git repository.
" } }, - "description": { - "target": "com.amazonaws.amplify#Description", + "enableBasicAuth": { + "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { - "smithy.api#documentation": "The description for the Amplify app.
", + "smithy.api#documentation": "Enables basic authorization for the Amplify app's branches.
", "smithy.api#required": {} } }, - "updateTime": { - "target": "com.amazonaws.amplify#UpdateTime", + "basicAuthCredentials": { + "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "Updates the date and time for the Amplify app.
", - "smithy.api#required": {} + "smithy.api#documentation": "The basic authorization credentials for branches for the Amplify app.
" } }, - "tags": { - "target": "com.amazonaws.amplify#TagMap", + "customRules": { + "target": "com.amazonaws.amplify#CustomRules", "traits": { - "smithy.api#documentation": "The tag for the Amplify app.
" + "smithy.api#documentation": "Describes the custom redirect and rewrite rules for the Amplify app.
" } }, "productionBranch": { @@ -290,43 +305,34 @@ "smithy.api#documentation": "Describes the information about a production branch of the Amplify app.
" } }, - "appArn": { - "target": "com.amazonaws.amplify#AppArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amplify app.
", - "smithy.api#required": {} - } - }, "buildSpec": { "target": "com.amazonaws.amplify#BuildSpec", "traits": { "smithy.api#documentation": "Describes the content of the build specification (build spec) for the Amplify app.\n
" } }, - "basicAuthCredentials": { - "target": "com.amazonaws.amplify#BasicAuthCredentials", + "customHeaders": { + "target": "com.amazonaws.amplify#CustomHeaders", "traits": { - "smithy.api#documentation": "The basic authorization credentials for branches for the Amplify app.
" + "smithy.api#documentation": "Describes the custom HTTP headers for the Amplify app.
" } }, - "name": { - "target": "com.amazonaws.amplify#Name", + "enableAutoBranchCreation": { + "target": "com.amazonaws.amplify#EnableAutoBranchCreation", "traits": { - "smithy.api#documentation": "The name for the Amplify app.
", - "smithy.api#required": {} + "smithy.api#documentation": "Enables automated branch creation for the Amplify app.
" } }, - "enableBranchAutoDeletion": { - "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", + "autoBranchCreationPatterns": { + "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", "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": "Describes the automated branch creation glob patterns for the Amplify app.
" } }, - "createTime": { - "target": "com.amazonaws.amplify#CreateTime", + "autoBranchCreationConfig": { + "target": "com.amazonaws.amplify#AutoBranchCreationConfig", "traits": { - "smithy.api#documentation": "Creates a date and time for the Amplify app.
", - "smithy.api#required": {} + "smithy.api#documentation": "Describes the automated branch creation configuration for the Amplify app.
" } } }, @@ -348,8 +354,9 @@ "traits": { "smithy.api#length": { "min": 1, - "max": 255 - } + "max": 20 + }, + "smithy.api#pattern": "d[a-z0-9]+" } }, "com.amazonaws.amplify#Apps": { @@ -361,17 +368,17 @@ "com.amazonaws.amplify#Artifact": { "type": "structure", "members": { - "artifactId": { - "target": "com.amazonaws.amplify#ArtifactId", + "artifactFileName": { + "target": "com.amazonaws.amplify#ArtifactFileName", "traits": { - "smithy.api#documentation": "The unique ID for the artifact.
", + "smithy.api#documentation": "The file name for the artifact.
", "smithy.api#required": {} } }, - "artifactFileName": { - "target": "com.amazonaws.amplify#ArtifactFileName", + "artifactId": { + "target": "com.amazonaws.amplify#ArtifactId", "traits": { - "smithy.api#documentation": "The file name for the artifact.
", + "smithy.api#documentation": "The unique ID for the artifact.
", "smithy.api#required": {} } } @@ -440,10 +447,16 @@ "com.amazonaws.amplify#AutoBranchCreationConfig": { "type": "structure", "members": { - "environmentVariables": { - "target": "com.amazonaws.amplify#EnvironmentVariables", + "stage": { + "target": "com.amazonaws.amplify#Stage", "traits": { - "smithy.api#documentation": "The environment variables 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.
" } }, "enableAutoBuild": { @@ -452,10 +465,10 @@ "smithy.api#documentation": "Enables auto building for the autocreated branch.
" } }, - "framework": { - "target": "com.amazonaws.amplify#Framework", + "environmentVariables": { + "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { - "smithy.api#documentation": "The framework for the autocreated branch.
" + "smithy.api#documentation": "The environment variables for the autocreated branch.
" } }, "basicAuthCredentials": { @@ -464,28 +477,28 @@ "smithy.api#documentation": "The basic authorization credentials for the autocreated branch.
" } }, - "stage": { - "target": "com.amazonaws.amplify#Stage", + "enableBasicAuth": { + "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { - "smithy.api#documentation": "Describes the current stage for the autocreated branch.
" + "smithy.api#documentation": "Enables basic authorization for the autocreated branch.
" } }, - "buildSpec": { - "target": "com.amazonaws.amplify#BuildSpec", + "enablePerformanceMode": { + "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { - "smithy.api#documentation": "The build specification (build spec) for the autocreated branch.
" + "smithy.api#documentation": "Enables performance mode for the branch.
\nPerformance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
" } }, - "enablePerformanceMode": { - "target": "com.amazonaws.amplify#EnablePerformanceMode", + "buildSpec": { + "target": "com.amazonaws.amplify#BuildSpec", "traits": { - "smithy.api#documentation": "Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.
" + "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 preview for the autocreated branch.
" + "smithy.api#documentation": "Enables pull request previews for the autocreated branch.
" } }, "pullRequestEnvironmentName": { @@ -493,12 +506,6 @@ "traits": { "smithy.api#documentation": "The Amplify environment name for the pull request.
" } - }, - "enableBasicAuth": { - "target": "com.amazonaws.amplify#EnableBasicAuth", - "traits": { - "smithy.api#documentation": "Enables basic authorization for the autocreated branch.
" - } } }, "traits": { @@ -548,13 +555,6 @@ "com.amazonaws.amplify#BackendEnvironment": { "type": "structure", "members": { - "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#required": {} - } - }, "backendEnvironmentArn": { "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { @@ -562,10 +562,10 @@ "smithy.api#required": {} } }, - "updateTime": { - "target": "com.amazonaws.amplify#UpdateTime", + "environmentName": { + "target": "com.amazonaws.amplify#EnvironmentName", "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 name for a backend environment that is part of an Amplify app.
", "smithy.api#required": {} } }, @@ -575,17 +575,24 @@ "smithy.api#documentation": "The AWS CloudFormation stack name of a backend environment.
" } }, - "environmentName": { - "target": "com.amazonaws.amplify#EnvironmentName", + "deploymentArtifacts": { + "target": "com.amazonaws.amplify#DeploymentArtifacts", "traits": { - "smithy.api#documentation": "The name for a backend environment that is part of an Amplify app.
", + "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#required": {} } }, - "deploymentArtifacts": { - "target": "com.amazonaws.amplify#DeploymentArtifacts", + "updateTime": { + "target": "com.amazonaws.amplify#UpdateTime", "traits": { - "smithy.api#documentation": "The name of deployment artifacts.
" + "smithy.api#documentation": "The last updated date and time for a backend environment that is part of an Amplify\n app.
", + "smithy.api#required": {} } } }, @@ -634,100 +641,107 @@ "com.amazonaws.amplify#Branch": { "type": "structure", "members": { - "enableAutoBuild": { - "target": "com.amazonaws.amplify#EnableAutoBuild", + "branchArn": { + "target": "com.amazonaws.amplify#BranchArn", "traits": { - "smithy.api#documentation": "Enables auto-building on push for a branch of an Amplify app.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
", "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.amplify#TagMap", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "The tag for the branch of an Amplify app.
" + "smithy.api#documentation": "The name for the branch that is part of an Amplify app.
", + "smithy.api#required": {} } }, - "totalNumberOfJobs": { - "target": "com.amazonaws.amplify#TotalNumberOfJobs", + "description": { + "target": "com.amazonaws.amplify#Description", "traits": { - "smithy.api#documentation": "The total number of jobs that are part of an Amplify app.
", + "smithy.api#documentation": "The description for the branch that is part of an Amplify app.
", "smithy.api#required": {} } }, - "sourceBranch": { - "target": "com.amazonaws.amplify#BranchName", + "tags": { + "target": "com.amazonaws.amplify#TagMap", "traits": { - "smithy.api#documentation": "The source branch if the branch is a pull request branch.
" + "smithy.api#documentation": "The tag for the branch of an Amplify app.
" } }, - "thumbnailUrl": { - "target": "com.amazonaws.amplify#ThumbnailUrl", + "stage": { + "target": "com.amazonaws.amplify#Stage", "traits": { - "smithy.api#documentation": "The thumbnail URL for the branch of an Amplify app.
" + "smithy.api#documentation": "The current stage for the branch that is part of an Amplify app.
", + "smithy.api#required": {} } }, - "pullRequestEnvironmentName": { - "target": "com.amazonaws.amplify#PullRequestEnvironmentName", + "displayName": { + "target": "com.amazonaws.amplify#DisplayName", "traits": { - "smithy.api#documentation": "The Amplify environment name for the pull request.
" + "smithy.api#documentation": "The display name for the branch. This is used as the default domain prefix.
", + "smithy.api#required": {} } }, - "destinationBranch": { - "target": "com.amazonaws.amplify#BranchName", + "enableNotification": { + "target": "com.amazonaws.amplify#EnableNotification", "traits": { - "smithy.api#documentation": "The destination branch if the branch is a pull request branch.
" + "smithy.api#documentation": "Enables notifications for a branch that is part of an Amplify app.
", + "smithy.api#required": {} } }, - "activeJobId": { - "target": "com.amazonaws.amplify#ActiveJobId", + "createTime": { + "target": "com.amazonaws.amplify#CreateTime", "traits": { - "smithy.api#documentation": "The ID of the active job for a branch of an Amplify app.
", + "smithy.api#documentation": "The creation date and time for a branch that is part of an Amplify app.
", "smithy.api#required": {} } }, - "stage": { - "target": "com.amazonaws.amplify#Stage", + "updateTime": { + "target": "com.amazonaws.amplify#UpdateTime", "traits": { - "smithy.api#documentation": "The current stage for the branch that is part of an Amplify app.
", + "smithy.api#documentation": "The last updated date and time for a branch that is part of an Amplify app.
", "smithy.api#required": {} } }, - "enablePerformanceMode": { - "target": "com.amazonaws.amplify#EnablePerformanceMode", + "environmentVariables": { + "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { - "smithy.api#documentation": "Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.
" + "smithy.api#documentation": "The environment variables specific to a branch of an Amplify app.
", + "smithy.api#required": {} } }, - "associatedResources": { - "target": "com.amazonaws.amplify#AssociatedResources", + "enableAutoBuild": { + "target": "com.amazonaws.amplify#EnableAutoBuild", "traits": { - "smithy.api#documentation": "A list of custom resources that are linked to this branch.
" + "smithy.api#documentation": "Enables auto-building on push for a branch of an Amplify app.
", + "smithy.api#required": {} } }, - "createTime": { - "target": "com.amazonaws.amplify#CreateTime", + "customDomains": { + "target": "com.amazonaws.amplify#CustomDomains", "traits": { - "smithy.api#documentation": "The creation date and time for a branch that is part of an Amplify app.
", + "smithy.api#documentation": "The custom domains for a branch of an Amplify app.
", "smithy.api#required": {} } }, - "buildSpec": { - "target": "com.amazonaws.amplify#BuildSpec", + "framework": { + "target": "com.amazonaws.amplify#Framework", "traits": { - "smithy.api#documentation": "The build specification (build spec) content for the branch of an Amplify app.\n
" + "smithy.api#documentation": "The framework for a branch of an Amplify app.
", + "smithy.api#required": {} } }, - "updateTime": { - "target": "com.amazonaws.amplify#UpdateTime", + "activeJobId": { + "target": "com.amazonaws.amplify#ActiveJobId", "traits": { - "smithy.api#documentation": "The last updated date and time for a branch that is part of an Amplify app.
", + "smithy.api#documentation": "The ID of the active job for a branch of an Amplify app.
", "smithy.api#required": {} } }, - "framework": { - "target": "com.amazonaws.amplify#Framework", + "totalNumberOfJobs": { + "target": "com.amazonaws.amplify#TotalNumberOfJobs", "traits": { - "smithy.api#documentation": "The framework for a branch of an Amplify app.
", + "smithy.api#documentation": "The total number of jobs that are part of an Amplify app.
", "smithy.api#required": {} } }, @@ -738,18 +752,16 @@ "smithy.api#required": {} } }, - "displayName": { - "target": "com.amazonaws.amplify#DisplayName", + "enablePerformanceMode": { + "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { - "smithy.api#documentation": "The display name for the branch. This is used as the default domain prefix.
", - "smithy.api#required": {} + "smithy.api#documentation": "Enables performance mode for the branch.
\nPerformance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
" } }, - "description": { - "target": "com.amazonaws.amplify#Description", + "thumbnailUrl": { + "target": "com.amazonaws.amplify#ThumbnailUrl", "traits": { - "smithy.api#documentation": "The description for the branch that is part of an Amplify app.
", - "smithy.api#required": {} + "smithy.api#documentation": "The thumbnail URL for the branch of an Amplify app.
" } }, "basicAuthCredentials": { @@ -758,53 +770,48 @@ "smithy.api#documentation": "The basic authorization credentials for a branch of an Amplify app.
" } }, - "customDomains": { - "target": "com.amazonaws.amplify#CustomDomains", + "buildSpec": { + "target": "com.amazonaws.amplify#BuildSpec", "traits": { - "smithy.api#documentation": "The custom domains for a branch of an Amplify app.
", - "smithy.api#required": {} + "smithy.api#documentation": "The build specification (build spec) content for the branch of an Amplify app.\n
" } }, - "environmentVariables": { - "target": "com.amazonaws.amplify#EnvironmentVariables", + "ttl": { + "target": "com.amazonaws.amplify#TTL", "traits": { - "smithy.api#documentation": "The environment variables specific to a branch of an Amplify app.
", + "smithy.api#documentation": "The content Time to Live (TTL) for the website in seconds.
", "smithy.api#required": {} } }, - "enableNotification": { - "target": "com.amazonaws.amplify#EnableNotification", + "associatedResources": { + "target": "com.amazonaws.amplify#AssociatedResources", "traits": { - "smithy.api#documentation": "Enables notifications for a branch that is part of an Amplify app.
", - "smithy.api#required": {} + "smithy.api#documentation": "A list of custom resources that are linked to this branch.
" } }, "enablePullRequestPreview": { "target": "com.amazonaws.amplify#EnablePullRequestPreview", "traits": { - "smithy.api#documentation": "Enables pull request preview for the branch.
", + "smithy.api#documentation": "Enables pull request previews for the branch.
", "smithy.api#required": {} } }, - "branchArn": { - "target": "com.amazonaws.amplify#BranchArn", + "pullRequestEnvironmentName": { + "target": "com.amazonaws.amplify#PullRequestEnvironmentName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amplify environment name for the pull request.
" } }, - "branchName": { + "destinationBranch": { "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "The name for the branch that is part of an Amplify app.
", - "smithy.api#required": {} + "smithy.api#documentation": "The destination branch if the branch is a pull request branch.
" } }, - "ttl": { - "target": "com.amazonaws.amplify#TTL", + "sourceBranch": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "The content Time to Live (TTL) for the website in seconds.
", - "smithy.api#required": {} + "smithy.api#documentation": "The source branch if the branch is a pull request branch.
" } }, "backendEnvironmentArn": { @@ -940,16 +947,11 @@ "com.amazonaws.amplify#CreateAppRequest": { "type": "structure", "members": { - "enableAutoBranchCreation": { - "target": "com.amazonaws.amplify#EnableAutoBranchCreation", - "traits": { - "smithy.api#documentation": "Enables automated branch creation for the Amplify app.
" - } - }, - "enableBasicAuth": { - "target": "com.amazonaws.amplify#EnableBasicAuth", + "name": { + "target": "com.amazonaws.amplify#Name", "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": "The name for an Amplify app.
", + "smithy.api#required": {} } }, "description": { @@ -958,22 +960,40 @@ "smithy.api#documentation": "The description for an Amplify app.
" } }, + "repository": { + "target": "com.amazonaws.amplify#Repository", + "traits": { + "smithy.api#documentation": "The repository for an Amplify app.
" + } + }, "platform": { "target": "com.amazonaws.amplify#Platform", "traits": { "smithy.api#documentation": "The platform or framework for an Amplify app.
" } }, + "iamServiceRoleArn": { + "target": "com.amazonaws.amplify#ServiceRoleArn", + "traits": { + "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. The OAuth token is not\n stored.
" + } + }, "accessToken": { "target": "com.amazonaws.amplify#AccessToken", "traits": { "smithy.api#documentation": "The personal access token for a third-party source control system for an Amplify app.\n The personal access token is used to create a webhook and a read-only deploy key. The\n token is not stored.
" } }, - "repository": { - "target": "com.amazonaws.amplify#Repository", + "environmentVariables": { + "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { - "smithy.api#documentation": "The repository for an Amplify app.
" + "smithy.api#documentation": "The environment variables map for an Amplify app.
" } }, "enableBranchAutoBuild": { @@ -982,22 +1002,22 @@ "smithy.api#documentation": "Enables the auto building of branches for an Amplify app.
" } }, - "tags": { - "target": "com.amazonaws.amplify#TagMap", + "enableBranchAutoDeletion": { + "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", "traits": { - "smithy.api#documentation": "The tag for an Amplify app.
" + "smithy.api#documentation": "Automatically disconnects a branch in the Amplify Console when you delete a branch\n from your Git repository.
" } }, - "oauthToken": { - "target": "com.amazonaws.amplify#OauthToken", + "enableBasicAuth": { + "target": "com.amazonaws.amplify#EnableBasicAuth", "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. The OAuth token is not\n stored.
" + "smithy.api#documentation": "Enables basic authorization for an Amplify app. This will apply to all branches that\n are part of this app.
" } }, - "autoBranchCreationPatterns": { - "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", + "basicAuthCredentials": { + "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "The automated branch creation glob patterns for the Amplify app.
" + "smithy.api#documentation": "The credentials for basic authorization for an Amplify app.
" } }, "customRules": { @@ -1006,16 +1026,10 @@ "smithy.api#documentation": "The custom rewrite and redirect rules for an Amplify app.
" } }, - "environmentVariables": { - "target": "com.amazonaws.amplify#EnvironmentVariables", - "traits": { - "smithy.api#documentation": "The environment variables map for an Amplify app.
" - } - }, - "iamServiceRoleArn": { - "target": "com.amazonaws.amplify#ServiceRoleArn", + "tags": { + "target": "com.amazonaws.amplify#TagMap", "traits": { - "smithy.api#documentation": "The AWS Identity and Access Management (IAM) service role for an Amplify app.
" + "smithy.api#documentation": "The tag for an Amplify app.
" } }, "buildSpec": { @@ -1024,29 +1038,28 @@ "smithy.api#documentation": "The build specification (build spec) for an Amplify app.
" } }, - "autoBranchCreationConfig": { - "target": "com.amazonaws.amplify#AutoBranchCreationConfig", + "customHeaders": { + "target": "com.amazonaws.amplify#CustomHeaders", "traits": { - "smithy.api#documentation": "The automated branch creation configuration for the Amplify app.
" + "smithy.api#documentation": "The custom HTTP headers for an Amplify app.
" } }, - "basicAuthCredentials": { - "target": "com.amazonaws.amplify#BasicAuthCredentials", + "enableAutoBranchCreation": { + "target": "com.amazonaws.amplify#EnableAutoBranchCreation", "traits": { - "smithy.api#documentation": "The credentials for basic authorization for an Amplify app.
" + "smithy.api#documentation": "Enables automated branch creation for an Amplify app.
" } }, - "name": { - "target": "com.amazonaws.amplify#Name", + "autoBranchCreationPatterns": { + "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", "traits": { - "smithy.api#documentation": "The name for the Amplify app.
", - "smithy.api#required": {} + "smithy.api#documentation": "The automated branch creation glob patterns for an Amplify app.
" } }, - "enableBranchAutoDeletion": { - "target": "com.amazonaws.amplify#EnableBranchAutoDeletion", + "autoBranchCreationConfig": { + "target": "com.amazonaws.amplify#AutoBranchCreationConfig", "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": "The automated branch creation configuration for an Amplify app.
" } } }, @@ -1117,17 +1130,17 @@ "smithy.api#required": {} } }, - "deploymentArtifacts": { - "target": "com.amazonaws.amplify#DeploymentArtifacts", - "traits": { - "smithy.api#documentation": "The name of deployment artifacts.
" - } - }, "stackName": { "target": "com.amazonaws.amplify#StackName", "traits": { "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.
" + } } }, "traits": { @@ -1189,22 +1202,25 @@ "com.amazonaws.amplify#CreateBranchRequest": { "type": "structure", "members": { - "enableNotification": { - "target": "com.amazonaws.amplify#EnableNotification", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "Enables notifications for the branch.
" + "smithy.api#documentation": "The unique ID for an Amplify app.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "enableBasicAuth": { - "target": "com.amazonaws.amplify#EnableBasicAuth", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "Enables basic authorization for the branch.
" + "smithy.api#documentation": "The name for the branch.
", + "smithy.api#required": {} } }, - "enablePerformanceMode": { - "target": "com.amazonaws.amplify#EnablePerformanceMode", + "description": { + "target": "com.amazonaws.amplify#Description", "traits": { - "smithy.api#documentation": "Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.
" + "smithy.api#documentation": "The description for the branch.
" } }, "stage": { @@ -1213,67 +1229,52 @@ "smithy.api#documentation": "Describes the current stage for the branch.
" } }, - "enablePullRequestPreview": { - "target": "com.amazonaws.amplify#EnablePullRequestPreview", - "traits": { - "smithy.api#documentation": "Enables pull request preview for this branch.
" - } - }, - "environmentVariables": { - "target": "com.amazonaws.amplify#EnvironmentVariables", - "traits": { - "smithy.api#documentation": "The environment variables for the branch.
" - } - }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "framework": { + "target": "com.amazonaws.amplify#Framework", "traits": { - "smithy.api#documentation": "The unique ID for an Amplify app.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The framework for the branch.
" } }, - "ttl": { - "target": "com.amazonaws.amplify#TTL", + "enableNotification": { + "target": "com.amazonaws.amplify#EnableNotification", "traits": { - "smithy.api#documentation": "The content Time To Live (TTL) for the website in seconds.
" + "smithy.api#documentation": "Enables notifications for the branch.
" } }, - "tags": { - "target": "com.amazonaws.amplify#TagMap", + "enableAutoBuild": { + "target": "com.amazonaws.amplify#EnableAutoBuild", "traits": { - "smithy.api#documentation": "The tag for the branch.
" + "smithy.api#documentation": "Enables auto building for the branch.
" } }, - "framework": { - "target": "com.amazonaws.amplify#Framework", + "environmentVariables": { + "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { - "smithy.api#documentation": "The framework for the branch.
" + "smithy.api#documentation": "The environment variables for the branch.
" } }, - "backendEnvironmentArn": { - "target": "com.amazonaws.amplify#BackendEnvironmentArn", + "basicAuthCredentials": { + "target": "com.amazonaws.amplify#BasicAuthCredentials", "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 basic authorization credentials for the branch.
" } }, - "description": { - "target": "com.amazonaws.amplify#Description", + "enableBasicAuth": { + "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { - "smithy.api#documentation": "The description for the branch.
" + "smithy.api#documentation": "Enables basic authorization for the branch.
" } }, - "basicAuthCredentials": { - "target": "com.amazonaws.amplify#BasicAuthCredentials", + "enablePerformanceMode": { + "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { - "smithy.api#documentation": "The basic authorization credentials for the branch.
" + "smithy.api#documentation": "Enables performance mode for the branch.
\nPerformance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
" } }, - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "tags": { + "target": "com.amazonaws.amplify#TagMap", "traits": { - "smithy.api#documentation": "The name for the branch.
", - "smithy.api#required": {} + "smithy.api#documentation": "The tag for the branch.
" } }, "buildSpec": { @@ -1282,10 +1283,10 @@ "smithy.api#documentation": "The build specification (build spec) for the branch.
" } }, - "enableAutoBuild": { - "target": "com.amazonaws.amplify#EnableAutoBuild", + "ttl": { + "target": "com.amazonaws.amplify#TTL", "traits": { - "smithy.api#documentation": "Enables auto building for the branch.
" + "smithy.api#documentation": "The content Time To Live (TTL) for the website in seconds.
" } }, "displayName": { @@ -1294,11 +1295,23 @@ "smithy.api#documentation": "The display name for a branch. This is used as the default domain prefix.
" } }, + "enablePullRequestPreview": { + "target": "com.amazonaws.amplify#EnablePullRequestPreview", + "traits": { + "smithy.api#documentation": "Enables pull request previews for this branch.
" + } + }, "pullRequestEnvironmentName": { "target": "com.amazonaws.amplify#PullRequestEnvironmentName", "traits": { "smithy.api#documentation": "The Amplify environment name for the pull request.
" } + }, + "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.
" + } } }, "traits": { @@ -1390,17 +1403,17 @@ "smithy.api#documentation": "The job ID for this deployment. will supply to start deployment api.
" } }, - "zipUploadUrl": { - "target": "com.amazonaws.amplify#UploadUrl", + "fileUploadUrls": { + "target": "com.amazonaws.amplify#FileUploadUrls", "traits": { - "smithy.api#documentation": " When the fileMap
argument is not provided in the request, this\n zipUploadUrl
is returned.
When the fileMap
argument is provided in the request,\n fileUploadUrls
will contain a map of file names to upload URLs.
When the fileMap
argument is provided in the request,\n fileUploadUrls
will contain a map of file names to upload URLs.
When the fileMap
argument is not provided in the request, this\n zipUploadUrl
is returned.
The unique ID for an Amplify app.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "domainName": { "target": "com.amazonaws.amplify#DomainName", "traits": { @@ -1456,6 +1477,12 @@ "smithy.api#required": {} } }, + "enableAutoSubDomain": { + "target": "com.amazonaws.amplify#EnableAutoSubDomain", + "traits": { + "smithy.api#documentation": "Enables the automated creation of subdomains for branches.
" + } + }, "subDomainSettings": { "target": "com.amazonaws.amplify#SubDomainSettings", "traits": { @@ -1469,20 +1496,6 @@ "smithy.api#documentation": "Sets the branch patterns for automatic subdomain creation.
" } }, - "appId": { - "target": "com.amazonaws.amplify#AppId", - "traits": { - "smithy.api#documentation": "The unique ID for an Amplify app.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "enableAutoSubDomain": { - "target": "com.amazonaws.amplify#EnableAutoSubDomain", - "traits": { - "smithy.api#documentation": "Enables the automated creation of subdomains for branches.
" - } - }, "autoSubDomainIAMRole": { "target": "com.amazonaws.amplify#AutoSubDomainIAMRole", "traits": { @@ -1560,18 +1573,18 @@ "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.amplify#Description", - "traits": { - "smithy.api#documentation": "The description for a webhook.
" - } - }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "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.
" + } } }, "traits": { @@ -1614,20 +1627,30 @@ } } }, + "com.amazonaws.amplify#CustomHeaders": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 25000 + } + } + }, "com.amazonaws.amplify#CustomRule": { "type": "structure", "members": { - "target": { - "target": "com.amazonaws.amplify#Target", + "source": { + "target": "com.amazonaws.amplify#Source", "traits": { - "smithy.api#documentation": "The target pattern for a URL rewrite or redirect rule.
", + "smithy.api#documentation": "The source pattern for a URL rewrite or redirect rule.
", "smithy.api#required": {} } }, - "condition": { - "target": "com.amazonaws.amplify#Condition", + "target": { + "target": "com.amazonaws.amplify#Target", "traits": { - "smithy.api#documentation": "The condition for a URL rewrite or redirect rule, such as a country code.
" + "smithy.api#documentation": "The target pattern for a URL rewrite or redirect rule.
", + "smithy.api#required": {} } }, "status": { @@ -1636,11 +1659,10 @@ "smithy.api#documentation": "The status code for a URL rewrite or redirect rule.
\n \nRepresents a 200 rewrite rule.
\nRepresents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
\nRepresents a 302 temporary redirect rule.
\nRepresents a 404 redirect rule.
\nRepresents a 404 rewrite rule.
\nThe source pattern for a URL rewrite or redirect rule.
", - "smithy.api#required": {} + "smithy.api#documentation": "The condition for a URL rewrite or redirect rule, such as a country code.
" } } }, @@ -1846,18 +1868,18 @@ "com.amazonaws.amplify#DeleteBranchRequest": { "type": "structure", "members": { - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "The name for the branch.
", + "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "The unique ID for an Amplify app.
", + "smithy.api#documentation": "The name for the branch.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1919,18 +1941,18 @@ "com.amazonaws.amplify#DeleteDomainAssociationRequest": { "type": "structure", "members": { - "domainName": { - "target": "com.amazonaws.amplify#DomainName", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "The name of the domain.
", + "smithy.api#documentation": "The unique id for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "domainName": { + "target": "com.amazonaws.amplify#DomainName", "traits": { - "smithy.api#documentation": "The unique id for an Amplify app.
", + "smithy.api#documentation": "The name of the domain.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1988,18 +2010,18 @@ "com.amazonaws.amplify#DeleteJobRequest": { "type": "structure", "members": { - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "The name for the branch, for the job.
", + "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "The unique ID for an Amplify app.
", + "smithy.api#documentation": "The name for the branch, for the job.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2139,16 +2161,17 @@ "com.amazonaws.amplify#DomainAssociation": { "type": "structure", "members": { - "certificateVerificationDNSRecord": { - "target": "com.amazonaws.amplify#CertificateVerificationDNSRecord", + "domainAssociationArn": { + "target": "com.amazonaws.amplify#DomainAssociationArn", "traits": { - "smithy.api#documentation": "The DNS record for certificate verification.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the domain association.
", + "smithy.api#required": {} } }, - "domainStatus": { - "target": "com.amazonaws.amplify#DomainStatus", + "domainName": { + "target": "com.amazonaws.amplify#DomainName", "traits": { - "smithy.api#documentation": "The current status of the domain association.
", + "smithy.api#documentation": "The name of the domain.
", "smithy.api#required": {} } }, @@ -2159,45 +2182,44 @@ "smithy.api#required": {} } }, + "autoSubDomainCreationPatterns": { + "target": "com.amazonaws.amplify#AutoSubDomainCreationPatterns", + "traits": { + "smithy.api#documentation": "Sets branch patterns for automatic subdomain creation.
" + } + }, "autoSubDomainIAMRole": { "target": "com.amazonaws.amplify#AutoSubDomainIAMRole", "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.
" } }, - "subDomains": { - "target": "com.amazonaws.amplify#SubDomains", + "domainStatus": { + "target": "com.amazonaws.amplify#DomainStatus", "traits": { - "smithy.api#documentation": "The subdomains for the domain association.
", + "smithy.api#documentation": "The current status of the domain association.
", "smithy.api#required": {} } }, - "domainAssociationArn": { - "target": "com.amazonaws.amplify#DomainAssociationArn", + "statusReason": { + "target": "com.amazonaws.amplify#StatusReason", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the domain association.
", + "smithy.api#documentation": "The reason for the current status of the domain association.
", "smithy.api#required": {} } }, - "domainName": { - "target": "com.amazonaws.amplify#DomainName", + "certificateVerificationDNSRecord": { + "target": "com.amazonaws.amplify#CertificateVerificationDNSRecord", "traits": { - "smithy.api#documentation": "The name of the domain.
", - "smithy.api#required": {} + "smithy.api#documentation": "The DNS record for certificate verification.
" } }, - "statusReason": { - "target": "com.amazonaws.amplify#StatusReason", + "subDomains": { + "target": "com.amazonaws.amplify#SubDomains", "traits": { - "smithy.api#documentation": "The reason for the current status of the domain association.
", + "smithy.api#documentation": "The subdomains for the domain association.
", "smithy.api#required": {} } - }, - "autoSubDomainCreationPatterns": { - "target": "com.amazonaws.amplify#AutoSubDomainCreationPatterns", - "traits": { - "smithy.api#documentation": "Sets branch patterns for automatic subdomain creation.
" - } } }, "traits": { @@ -2664,18 +2686,18 @@ "com.amazonaws.amplify#GetBackendEnvironmentRequest": { "type": "structure", "members": { - "environmentName": { - "target": "com.amazonaws.amplify#EnvironmentName", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "The name for the backend environment.
", + "smithy.api#documentation": "The unique id for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "environmentName": { + "target": "com.amazonaws.amplify#EnvironmentName", "traits": { - "smithy.api#documentation": "The unique id for an Amplify app.
", + "smithy.api#documentation": "The name for the backend environment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -3091,23 +3113,17 @@ "smithy.api#required": {} } }, - "endTime": { - "target": "com.amazonaws.amplify#EndTime", - "traits": { - "smithy.api#documentation": "The end date and time for the job.
" - } - }, - "status": { - "target": "com.amazonaws.amplify#JobStatus", + "jobId": { + "target": "com.amazonaws.amplify#JobId", "traits": { - "smithy.api#documentation": "The current status for the job.
", + "smithy.api#documentation": "The unique ID for the job.
", "smithy.api#required": {} } }, - "startTime": { - "target": "com.amazonaws.amplify#StartTime", + "commitId": { + "target": "com.amazonaws.amplify#CommitId", "traits": { - "smithy.api#documentation": "The start date and time for the job.
", + "smithy.api#documentation": "The commit ID from a third-party repository provider for the job.
", "smithy.api#required": {} } }, @@ -3125,24 +3141,30 @@ "smithy.api#required": {} } }, - "jobId": { - "target": "com.amazonaws.amplify#JobId", + "startTime": { + "target": "com.amazonaws.amplify#StartTime", "traits": { - "smithy.api#documentation": "The unique ID for the job.
", + "smithy.api#documentation": "The start date and time for the job.
", "smithy.api#required": {} } }, - "jobType": { - "target": "com.amazonaws.amplify#JobType", + "status": { + "target": "com.amazonaws.amplify#JobStatus", "traits": { - "smithy.api#documentation": " The type for the job. If the value is RELEASE
, the job was manually\n released from its source by using the StartJob
API. If the value is\n RETRY
, the job was manually retried using the StartJob
\n API. If the value is WEB_HOOK
, the job was automatically triggered by\n webhooks.
The current status for the job.
", "smithy.api#required": {} } }, - "commitId": { - "target": "com.amazonaws.amplify#CommitId", + "endTime": { + "target": "com.amazonaws.amplify#EndTime", "traits": { - "smithy.api#documentation": "The commit ID from a third-party repository provider for the job.
", + "smithy.api#documentation": "The end date and time for the job.
" + } + }, + "jobType": { + "target": "com.amazonaws.amplify#JobType", + "traits": { + "smithy.api#documentation": " The type for the job. If the value is RELEASE
, the job was manually\n released from its source by using the StartJob
API. If the value is\n RETRY
, the job was manually retried using the StartJob
\n API. If the value is WEB_HOOK
, the job was automatically triggered by\n webhooks.
The maximum number of records to list in a single response.
", - "smithy.api#httpQuery": "maxResults" - } - }, "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#httpQuery": "nextToken" } + }, + "maxResults": { + "target": "com.amazonaws.amplify#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of records to list in a single response.
", + "smithy.api#httpQuery": "maxResults" + } } }, "traits": { @@ -3299,11 +3321,12 @@ "com.amazonaws.amplify#ListArtifactsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.amplify#NextToken", + "appId": { + "target": "com.amazonaws.amplify#AppId", "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#httpQuery": "nextToken" + "smithy.api#documentation": "The unique ID for an Amplify app.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "branchName": { @@ -3314,13 +3337,6 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.amplify#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of records to list in a single response.
", - "smithy.api#httpQuery": "maxResults" - } - }, "jobId": { "target": "com.amazonaws.amplify#JobId", "traits": { @@ -3329,12 +3345,18 @@ "smithy.api#required": {} } }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "nextToken": { + "target": "com.amazonaws.amplify#NextToken", "traits": { - "smithy.api#documentation": "The unique ID for an Amplify app.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "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" + } + }, + "maxResults": { + "target": "com.amazonaws.amplify#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of records to list in a single response.
", + "smithy.api#httpQuery": "maxResults" } } }, @@ -3394,13 +3416,6 @@ "com.amazonaws.amplify#ListBackendEnvironmentsRequest": { "type": "structure", "members": { - "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#httpQuery": "nextToken" - } - }, "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { @@ -3409,19 +3424,26 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.amplify#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of records to list in a single response.
", - "smithy.api#httpQuery": "maxResults" - } - }, "environmentName": { "target": "com.amazonaws.amplify#EnvironmentName", "traits": { "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#httpQuery": "nextToken" + } + }, + "maxResults": { + "target": "com.amazonaws.amplify#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of records to list in a single response.
", + "smithy.api#httpQuery": "maxResults" + } } }, "traits": { @@ -3431,18 +3453,18 @@ "com.amazonaws.amplify#ListBackendEnvironmentsResult": { "type": "structure", "members": { - "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.
" - } - }, "backendEnvironments": { "target": "com.amazonaws.amplify#BackendEnvironments", "traits": { "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.
" + } } }, "traits": { @@ -3480,6 +3502,14 @@ "com.amazonaws.amplify#ListBranchesRequest": { "type": "structure", "members": { + "appId": { + "target": "com.amazonaws.amplify#AppId", + "traits": { + "smithy.api#documentation": "The unique ID for an Amplify app.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { @@ -3493,14 +3523,6 @@ "smithy.api#documentation": "The maximum number of records to list in a single response.
", "smithy.api#httpQuery": "maxResults" } - }, - "appId": { - "target": "com.amazonaws.amplify#AppId", - "traits": { - "smithy.api#documentation": "The unique ID for an Amplify app.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -3567,19 +3589,19 @@ "smithy.api#required": {} } }, - "maxResults": { - "target": "com.amazonaws.amplify#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of records to list in a single response.
", - "smithy.api#httpQuery": "maxResults" - } - }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { "smithy.api#documentation": "A pagination token. Set to null to start listing apps from the start. If non-null, a\n pagination token is returned in a result. Pass its value in here to list more projects.\n
", "smithy.api#httpQuery": "nextToken" } + }, + "maxResults": { + "target": "com.amazonaws.amplify#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of records to list in a single response.
", + "smithy.api#httpQuery": "maxResults" + } } }, "traits": { @@ -3649,6 +3671,14 @@ "smithy.api#required": {} } }, + "branchName": { + "target": "com.amazonaws.amplify#BranchName", + "traits": { + "smithy.api#documentation": "The name for a branch.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "nextToken": { "target": "com.amazonaws.amplify#NextToken", "traits": { @@ -3662,14 +3692,6 @@ "smithy.api#documentation": "The maximum number of records to list in a single response.
", "smithy.api#httpQuery": "maxResults" } - }, - "branchName": { - "target": "com.amazonaws.amplify#BranchName", - "traits": { - "smithy.api#documentation": "The name for a branch.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -3679,18 +3701,18 @@ "com.amazonaws.amplify#ListJobsResult": { "type": "structure", "members": { - "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.
" - } - }, "jobSummaries": { "target": "com.amazonaws.amplify#JobSummaries", "traits": { "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.
" + } } }, "traits": { @@ -3789,13 +3811,6 @@ "com.amazonaws.amplify#ListWebhooksRequest": { "type": "structure", "members": { - "maxResults": { - "target": "com.amazonaws.amplify#MaxResults", - "traits": { - "smithy.api#documentation": "The maximum number of records to list in a single response.
", - "smithy.api#httpQuery": "maxResults" - } - }, "appId": { "target": "com.amazonaws.amplify#AppId", "traits": { @@ -3810,6 +3825,13 @@ "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" } + }, + "maxResults": { + "target": "com.amazonaws.amplify#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of records to list in a single response.
", + "smithy.api#httpQuery": "maxResults" + } } }, "traits": { @@ -3819,18 +3841,18 @@ "com.amazonaws.amplify#ListWebhooksResult": { "type": "structure", "members": { - "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.
" - } - }, "webhooks": { "target": "com.amazonaws.amplify#Webhooks", "traits": { "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.
" + } } }, "traits": { @@ -3859,7 +3881,7 @@ "type": "integer", "traits": { "smithy.api#range": { - "min": 1, + "min": 0, "max": 100 } } @@ -3919,12 +3941,6 @@ "com.amazonaws.amplify#ProductionBranch": { "type": "structure", "members": { - "branchName": { - "target": "com.amazonaws.amplify#BranchName", - "traits": { - "smithy.api#documentation": "The branch name for the production branch.
" - } - }, "lastDeployTime": { "target": "com.amazonaws.amplify#LastDeployTime", "traits": { @@ -3942,6 +3958,12 @@ "traits": { "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.
" + } } }, "traits": { @@ -3975,14 +3997,14 @@ "com.amazonaws.amplify#ResourceNotFoundException": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.amplify#ErrorMessage", + "code": { + "target": "com.amazonaws.amplify#Code", "traits": { "smithy.api#required": {} } }, - "code": { - "target": "com.amazonaws.amplify#Code", + "message": { + "target": "com.amazonaws.amplify#ErrorMessage", "traits": { "smithy.api#required": {} } @@ -4103,24 +4125,18 @@ "com.amazonaws.amplify#StartDeploymentRequest": { "type": "structure", "members": { - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "The name for the branch, for the job.
", + "smithy.api#documentation": "The unique ID for an Amplify app.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "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.
" - } - }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "The unique ID for an Amplify app.
", + "smithy.api#documentation": "The name for the branch, for the job.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4130,6 +4146,12 @@ "traits": { "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.
" + } } }, "traits": { @@ -4188,57 +4210,57 @@ "com.amazonaws.amplify#StartJobRequest": { "type": "structure", "members": { - "commitMessage": { - "target": "com.amazonaws.amplify#CommitMessage", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "The commit message from a third-party repository provider for the job.
" + "smithy.api#documentation": "The unique ID for an Amplify app.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "jobReason": { - "target": "com.amazonaws.amplify#JobReason", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "A descriptive reason for starting this job.
" + "smithy.api#documentation": "The branch name for the job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "commitId": { - "target": "com.amazonaws.amplify#CommitId", + "jobId": { + "target": "com.amazonaws.amplify#JobId", "traits": { - "smithy.api#documentation": "The commit ID from a third-party repository provider for the job.
" + "smithy.api#documentation": " The unique ID for an existing job. This is required if the value of\n jobType
is RETRY
.
The commit date and time for the job.
" + "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.
The unique ID for an Amplify app.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "A descriptive reason for starting this job.
" } }, - "jobId": { - "target": "com.amazonaws.amplify#JobId", + "commitId": { + "target": "com.amazonaws.amplify#CommitId", "traits": { - "smithy.api#documentation": " The unique ID for an existing job. This is required if the value of\n jobType
is RETRY
.
The commit ID from a third-party repository provider for the job.
" } }, - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "commitMessage": { + "target": "com.amazonaws.amplify#CommitMessage", "traits": { - "smithy.api#documentation": "The branch name for the job.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The commit message from a third-party repository provider for the job.
" } }, - "jobType": { - "target": "com.amazonaws.amplify#JobType", + "commitTime": { + "target": "com.amazonaws.amplify#CommitTime", "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.
The commit date and time for the job.
" } } }, @@ -4285,16 +4307,18 @@ "com.amazonaws.amplify#Step": { "type": "structure", "members": { - "logUrl": { - "target": "com.amazonaws.amplify#LogUrl", + "stepName": { + "target": "com.amazonaws.amplify#StepName", "traits": { - "smithy.api#documentation": "The URL to the logs for the execution step.
" + "smithy.api#documentation": "The name of the execution step.
", + "smithy.api#required": {} } }, - "testConfigUrl": { - "target": "com.amazonaws.amplify#TestConfigUrl", + "startTime": { + "target": "com.amazonaws.amplify#StartTime", "traits": { - "smithy.api#documentation": "The URL to the test configuration for the execution step.
" + "smithy.api#documentation": "The start date and time of the execution step.
", + "smithy.api#required": {} } }, "status": { @@ -4311,10 +4335,16 @@ "smithy.api#required": {} } }, - "screenshots": { - "target": "com.amazonaws.amplify#Screenshots", + "logUrl": { + "target": "com.amazonaws.amplify#LogUrl", "traits": { - "smithy.api#documentation": "The list of screenshot URLs for the execution step, if relevant.
" + "smithy.api#documentation": "The URL to the logs for the execution step.
" + } + }, + "artifactsUrl": { + "target": "com.amazonaws.amplify#ArtifactsUrl", + "traits": { + "smithy.api#documentation": "The URL to the artifact for the execution step.
" } }, "testArtifactsUrl": { @@ -4323,17 +4353,16 @@ "smithy.api#documentation": "The URL to the test artifact for the execution step.
" } }, - "startTime": { - "target": "com.amazonaws.amplify#StartTime", + "testConfigUrl": { + "target": "com.amazonaws.amplify#TestConfigUrl", "traits": { - "smithy.api#documentation": "The start date and time of the execution step.
", - "smithy.api#required": {} + "smithy.api#documentation": "The URL to the test configuration for the execution step.
" } }, - "context": { - "target": "com.amazonaws.amplify#Context", + "screenshots": { + "target": "com.amazonaws.amplify#Screenshots", "traits": { - "smithy.api#documentation": "The context for the current step. Includes a build image if the step is build.\n
" + "smithy.api#documentation": "The list of screenshot URLs for the execution step, if relevant.
" } }, "statusReason": { @@ -4342,17 +4371,10 @@ "smithy.api#documentation": "The reason for the current step status.
" } }, - "artifactsUrl": { - "target": "com.amazonaws.amplify#ArtifactsUrl", - "traits": { - "smithy.api#documentation": "The URL to the artifact for the execution step.
" - } - }, - "stepName": { - "target": "com.amazonaws.amplify#StepName", + "context": { + "target": "com.amazonaws.amplify#Context", "traits": { - "smithy.api#documentation": "The name of the execution step.
", - "smithy.api#required": {} + "smithy.api#documentation": "The context for the current step. Includes a build image if the step is build.\n
" } } }, @@ -4412,6 +4434,14 @@ "com.amazonaws.amplify#StopJobRequest": { "type": "structure", "members": { + "appId": { + "target": "com.amazonaws.amplify#AppId", + "traits": { + "smithy.api#documentation": "The unique ID for an Amplify app.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { @@ -4427,14 +4457,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "appId": { - "target": "com.amazonaws.amplify#AppId", - "traits": { - "smithy.api#documentation": "The unique ID for an Amplify app.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } }, "traits": { @@ -4488,17 +4510,17 @@ "com.amazonaws.amplify#SubDomainSetting": { "type": "structure", "members": { - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "prefix": { + "target": "com.amazonaws.amplify#DomainPrefix", "traits": { - "smithy.api#documentation": "The branch name setting for the subdomain.
", + "smithy.api#documentation": "The prefix setting for the subdomain.
", "smithy.api#required": {} } }, - "prefix": { - "target": "com.amazonaws.amplify#DomainPrefix", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "The prefix setting for the subdomain.
", + "smithy.api#documentation": "The branch name setting for the subdomain.
", "smithy.api#required": {} } } @@ -4601,17 +4623,10 @@ "code": 200 } } - }, - "com.amazonaws.amplify#TagResourceRequest": { - "type": "structure", - "members": { - "tags": { - "target": "com.amazonaws.amplify#TagMap", - "traits": { - "smithy.api#documentation": "The tags used to tag the resource.
", - "smithy.api#required": {} - } - }, + }, + "com.amazonaws.amplify#TagResourceRequest": { + "type": "structure", + "members": { "resourceArn": { "target": "com.amazonaws.amplify#ResourceArn", "traits": { @@ -4619,6 +4634,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.amplify#TagMap", + "traits": { + "smithy.api#documentation": "The tags used to tag the resource.
", + "smithy.api#required": {} + } } }, "traits": { @@ -4801,28 +4823,18 @@ "com.amazonaws.amplify#UpdateAppRequest": { "type": "structure", "members": { - "accessToken": { - "target": "com.amazonaws.amplify#AccessToken", - "traits": { - "smithy.api#documentation": "The personal access token for a third-party source control system for an Amplify app.\n The token is used to create webhook and a read-only deploy key. The token is not stored.\n
" - } - }, - "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.
" - } - }, - "enableBranchAutoBuild": { - "target": "com.amazonaws.amplify#EnableAutoBuild", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "Enables branch auto-building for an Amplify app.
" + "smithy.api#documentation": "The unique ID for an Amplify app.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "repository": { - "target": "com.amazonaws.amplify#Repository", + "name": { + "target": "com.amazonaws.amplify#Name", "traits": { - "smithy.api#documentation": "The name of the repository for an Amplify app
" + "smithy.api#documentation": "The name for an Amplify app.
" } }, "description": { @@ -4831,10 +4843,10 @@ "smithy.api#documentation": "The description for an Amplify app.
" } }, - "name": { - "target": "com.amazonaws.amplify#Name", + "platform": { + "target": "com.amazonaws.amplify#Platform", "traits": { - "smithy.api#documentation": "The name for an Amplify app.
" + "smithy.api#documentation": "The platform for an Amplify app.
" } }, "iamServiceRoleArn": { @@ -4849,10 +4861,28 @@ "smithy.api#documentation": "The environment variables for an Amplify app.
" } }, - "autoBranchCreationConfig": { - "target": "com.amazonaws.amplify#AutoBranchCreationConfig", + "enableBranchAutoBuild": { + "target": "com.amazonaws.amplify#EnableAutoBuild", + "traits": { + "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.
" + } + }, + "enableBasicAuth": { + "target": "com.amazonaws.amplify#EnableBasicAuth", + "traits": { + "smithy.api#documentation": "Enables basic authorization for an Amplify app.
" + } + }, + "basicAuthCredentials": { + "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "The automated branch creation configuration for the Amplify app.
" + "smithy.api#documentation": "The basic authorization credentials for an Amplify app.
" } }, "customRules": { @@ -4861,54 +4891,52 @@ "smithy.api#documentation": "The custom redirect and rewrite rules for an Amplify app.
" } }, - "autoBranchCreationPatterns": { - "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", + "buildSpec": { + "target": "com.amazonaws.amplify#BuildSpec", "traits": { - "smithy.api#documentation": "Describes the automated branch creation glob patterns for the Amplify app.
" + "smithy.api#documentation": "The build specification (build spec) for an Amplify app.
" } }, - "oauthToken": { - "target": "com.amazonaws.amplify#OauthToken", + "customHeaders": { + "target": "com.amazonaws.amplify#CustomHeaders", "traits": { - "smithy.api#documentation": "The OAuth token for a third-party source control system for an Amplify app. The token\n is used to create a webhook and a read-only deploy key. The OAuth token is not stored.\n
" + "smithy.api#documentation": "The custom HTTP headers for an Amplify app.
" } }, - "platform": { - "target": "com.amazonaws.amplify#Platform", + "enableAutoBranchCreation": { + "target": "com.amazonaws.amplify#EnableAutoBranchCreation", "traits": { - "smithy.api#documentation": "The platform for an Amplify app.
" + "smithy.api#documentation": "Enables automated branch creation for an Amplify app.
" } }, - "basicAuthCredentials": { - "target": "com.amazonaws.amplify#BasicAuthCredentials", + "autoBranchCreationPatterns": { + "target": "com.amazonaws.amplify#AutoBranchCreationPatterns", "traits": { - "smithy.api#documentation": "The basic authorization credentials for an Amplify app.
" + "smithy.api#documentation": "Describes the automated branch creation glob patterns for an Amplify app.
" } }, - "enableBasicAuth": { - "target": "com.amazonaws.amplify#EnableBasicAuth", + "autoBranchCreationConfig": { + "target": "com.amazonaws.amplify#AutoBranchCreationConfig", "traits": { - "smithy.api#documentation": "Enables basic authorization for an Amplify app.
" + "smithy.api#documentation": "The automated branch creation configuration for an Amplify app.
" } }, - "enableAutoBranchCreation": { - "target": "com.amazonaws.amplify#EnableAutoBranchCreation", + "repository": { + "target": "com.amazonaws.amplify#Repository", "traits": { - "smithy.api#documentation": "Enables automated branch creation for the Amplify app.
" + "smithy.api#documentation": "The name of the repository for an Amplify app
" } }, - "buildSpec": { - "target": "com.amazonaws.amplify#BuildSpec", + "oauthToken": { + "target": "com.amazonaws.amplify#OauthToken", "traits": { - "smithy.api#documentation": "The build specification (build spec) for an Amplify app.
" + "smithy.api#documentation": "The OAuth token for a third-party source control system for an Amplify app. The token\n is used to create a webhook and a read-only deploy key. The OAuth token is not stored.\n
" } }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "accessToken": { + "target": "com.amazonaws.amplify#AccessToken", "traits": { - "smithy.api#documentation": "The unique ID for an Amplify app.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The personal access token for a third-party source control system for an Amplify app.\n The token is used to create webhook and a read-only deploy key. The token is not stored.\n
" } } }, @@ -4968,110 +4996,110 @@ "com.amazonaws.amplify#UpdateBranchRequest": { "type": "structure", "members": { - "enableNotification": { - "target": "com.amazonaws.amplify#EnableNotification", + "appId": { + "target": "com.amazonaws.amplify#AppId", "traits": { - "smithy.api#documentation": "Enables notifications for the branch.
" + "smithy.api#documentation": "The unique ID for an Amplify app.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "environmentVariables": { - "target": "com.amazonaws.amplify#EnvironmentVariables", + "branchName": { + "target": "com.amazonaws.amplify#BranchName", "traits": { - "smithy.api#documentation": "The environment variables for the branch.
" + "smithy.api#documentation": "The name for the branch.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "enableBasicAuth": { - "target": "com.amazonaws.amplify#EnableBasicAuth", + "description": { + "target": "com.amazonaws.amplify#Description", "traits": { - "smithy.api#documentation": "Enables basic authorization for the branch.
" + "smithy.api#documentation": "The description for the branch.
" } }, - "buildSpec": { - "target": "com.amazonaws.amplify#BuildSpec", + "framework": { + "target": "com.amazonaws.amplify#Framework", "traits": { - "smithy.api#documentation": "The build specification (build spec) for the branch.
" + "smithy.api#documentation": "The framework for the branch.
" } }, - "ttl": { - "target": "com.amazonaws.amplify#TTL", + "stage": { + "target": "com.amazonaws.amplify#Stage", "traits": { - "smithy.api#documentation": "The content Time to Live (TTL) for the website in seconds.
" + "smithy.api#documentation": "Describes the current stage for the branch.
" } }, - "backendEnvironmentArn": { - "target": "com.amazonaws.amplify#BackendEnvironmentArn", + "enableNotification": { + "target": "com.amazonaws.amplify#EnableNotification", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.
" + "smithy.api#documentation": "Enables notifications for the branch.
" } }, - "appId": { - "target": "com.amazonaws.amplify#AppId", + "enableAutoBuild": { + "target": "com.amazonaws.amplify#EnableAutoBuild", "traits": { - "smithy.api#documentation": "The unique ID for an Amplify app.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Enables auto building for the branch.
" } }, - "enablePerformanceMode": { - "target": "com.amazonaws.amplify#EnablePerformanceMode", + "environmentVariables": { + "target": "com.amazonaws.amplify#EnvironmentVariables", "traits": { - "smithy.api#documentation": "Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.
" + "smithy.api#documentation": "The environment variables for the branch.
" } }, - "framework": { - "target": "com.amazonaws.amplify#Framework", + "basicAuthCredentials": { + "target": "com.amazonaws.amplify#BasicAuthCredentials", "traits": { - "smithy.api#documentation": "The framework for the branch.
" + "smithy.api#documentation": "The basic authorization credentials for the branch.
" } }, - "enablePullRequestPreview": { - "target": "com.amazonaws.amplify#EnablePullRequestPreview", + "enableBasicAuth": { + "target": "com.amazonaws.amplify#EnableBasicAuth", "traits": { - "smithy.api#documentation": "Enables pull request preview for this branch.
" + "smithy.api#documentation": "Enables basic authorization for the branch.
" } }, - "stage": { - "target": "com.amazonaws.amplify#Stage", + "enablePerformanceMode": { + "target": "com.amazonaws.amplify#EnablePerformanceMode", "traits": { - "smithy.api#documentation": "Describes the current stage for the branch.
" + "smithy.api#documentation": "Enables performance mode for the branch.
\nPerformance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
" } }, - "basicAuthCredentials": { - "target": "com.amazonaws.amplify#BasicAuthCredentials", + "buildSpec": { + "target": "com.amazonaws.amplify#BuildSpec", "traits": { - "smithy.api#documentation": "The basic authorization credentials for the branch.
" + "smithy.api#documentation": "The build specification (build spec) for the branch.
" } }, - "enableAutoBuild": { - "target": "com.amazonaws.amplify#EnableAutoBuild", + "ttl": { + "target": "com.amazonaws.amplify#TTL", "traits": { - "smithy.api#documentation": "Enables auto building for the branch.
" + "smithy.api#documentation": "The content Time to Live (TTL) for the website in seconds.
" } }, - "branchName": { - "target": "com.amazonaws.amplify#BranchName", + "displayName": { + "target": "com.amazonaws.amplify#DisplayName", "traits": { - "smithy.api#documentation": "The name for the branch.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The display name for a branch. This is used as the default domain prefix.
" } }, - "pullRequestEnvironmentName": { - "target": "com.amazonaws.amplify#PullRequestEnvironmentName", + "enablePullRequestPreview": { + "target": "com.amazonaws.amplify#EnablePullRequestPreview", "traits": { - "smithy.api#documentation": "The Amplify environment name for the pull request.
" + "smithy.api#documentation": "Enables pull request previews for this branch.
" } }, - "description": { - "target": "com.amazonaws.amplify#Description", + "pullRequestEnvironmentName": { + "target": "com.amazonaws.amplify#PullRequestEnvironmentName", "traits": { - "smithy.api#documentation": "The description for the branch.
" + "smithy.api#documentation": "The Amplify environment name for the pull request.
" } }, - "displayName": { - "target": "com.amazonaws.amplify#DisplayName", + "backendEnvironmentArn": { + "target": "com.amazonaws.amplify#BackendEnvironmentArn", "traits": { - "smithy.api#documentation": "The display name for a branch. This is used as the default domain prefix.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify\n app.
" } } }, @@ -5139,10 +5167,12 @@ "smithy.api#required": {} } }, - "autoSubDomainCreationPatterns": { - "target": "com.amazonaws.amplify#AutoSubDomainCreationPatterns", + "domainName": { + "target": "com.amazonaws.amplify#DomainName", "traits": { - "smithy.api#documentation": "Sets the branch patterns for automatic subdomain creation.
" + "smithy.api#documentation": "The name of the domain.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "enableAutoSubDomain": { @@ -5158,12 +5188,10 @@ "smithy.api#required": {} } }, - "domainName": { - "target": "com.amazonaws.amplify#DomainName", + "autoSubDomainCreationPatterns": { + "target": "com.amazonaws.amplify#AutoSubDomainCreationPatterns", "traits": { - "smithy.api#documentation": "The name of the domain.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Sets the branch patterns for automatic subdomain creation.
" } }, "autoSubDomainIAMRole": { @@ -5240,17 +5268,17 @@ "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.amplify#Description", - "traits": { - "smithy.api#documentation": "The description for a webhook.
" - } - }, "branchName": { "target": "com.amazonaws.amplify#BranchName", "traits": { "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.
" + } } }, "traits": { @@ -5325,17 +5353,17 @@ "smithy.api#required": {} } }, - "updateTime": { - "target": "com.amazonaws.amplify#UpdateTime", + "createTime": { + "target": "com.amazonaws.amplify#CreateTime", "traits": { - "smithy.api#documentation": "Updates the date and time for a webhook.
", + "smithy.api#documentation": "The create date and time for a webhook.
", "smithy.api#required": {} } }, - "createTime": { - "target": "com.amazonaws.amplify#CreateTime", + "updateTime": { + "target": "com.amazonaws.amplify#UpdateTime", "traits": { - "smithy.api#documentation": "The create date and time for a webhook.
", + "smithy.api#documentation": "Updates the date and time for a webhook.
", "smithy.api#required": {} } } diff --git a/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json b/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json index 0f611d5416b7..54ee2e816f05 100644 --- a/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json +++ b/codegen/sdk-codegen/aws-models/auto-scaling.2011-01-01.json @@ -69,12 +69,6 @@ "com.amazonaws.autoscaling#Activity": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "A friendly, more verbose description of the activity.
" - } - }, "ActivityId": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { @@ -82,12 +76,6 @@ "smithy.api#required": {} } }, - "EndTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "The end time of the activity.
" - } - }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { @@ -95,10 +83,10 @@ "smithy.api#required": {} } }, - "Progress": { - "target": "com.amazonaws.autoscaling#Progress", + "Description": { + "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "A value between 0 and 100 that indicates the progress of the activity.
" + "smithy.api#documentation": "A friendly, more verbose description of the activity.
" } }, "Cause": { @@ -108,16 +96,17 @@ "smithy.api#required": {} } }, - "StatusMessage": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "StartTime": { + "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "A friendly, more verbose description of the activity status.
" + "smithy.api#documentation": "The start time of the activity.
", + "smithy.api#required": {} } }, - "Details": { - "target": "com.amazonaws.autoscaling#XmlString", + "EndTime": { + "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "The details about the activity.
" + "smithy.api#documentation": "The end time of the activity.
" } }, "StatusCode": { @@ -127,11 +116,22 @@ "smithy.api#required": {} } }, - "StartTime": { - "target": "com.amazonaws.autoscaling#TimestampType", + "StatusMessage": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The start time of the activity.
", - "smithy.api#required": {} + "smithy.api#documentation": "A friendly, more verbose description of the activity status.
" + } + }, + "Progress": { + "target": "com.amazonaws.autoscaling#Progress", + "traits": { + "smithy.api#documentation": "A value between 0 and 100 that indicates the progress of the activity.
" + } + }, + "Details": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "The details about the activity.
" } } }, @@ -179,17 +179,17 @@ "com.amazonaws.autoscaling#Alarm": { "type": "structure", "members": { - "AlarmARN": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alarm.
" - } - }, "AlarmName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The name of the alarm.
" } + }, + "AlarmARN": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the alarm.
" + } } }, "traits": { @@ -248,7 +248,7 @@ } ], "traits": { - "smithy.api#documentation": "Attaches one or more EC2 instances to the specified Auto Scaling group.
\nWhen you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the\n number of instances being attached. If the number of instances being attached plus the\n desired capacity of the group exceeds the maximum size of the group, the operation\n fails.
\nIf there is a Classic Load Balancer attached to your Auto Scaling group, the instances are\n also registered with the load balancer. If there are target groups attached to your Auto Scaling\n group, the instances are also registered with the target groups.
\nFor more information, see Attach EC2 Instances to\n Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Attaches one or more EC2 instances to the specified Auto Scaling group.
\nWhen you attach instances, Amazon EC2 Auto Scaling increases the desired capacity of the group by the\n number of instances being attached. If the number of instances being attached plus the\n desired capacity of the group exceeds the maximum size of the group, the operation\n fails.
\nIf there is a Classic Load Balancer attached to your Auto Scaling group, the instances are\n also registered with the load balancer. If there are target groups attached to your Auto Scaling\n group, the instances are also registered with the target groups.
\nFor more information, see Attach EC2 instances to\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#AttachInstancesQuery": { @@ -286,7 +286,7 @@ } ], "traits": { - "smithy.api#documentation": "Attaches one or more target groups to the specified Auto Scaling group.
\nTo describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
\nWith Application Load Balancers and Network Load Balancers, instances are registered\n as targets with a target group. With Classic Load Balancers, instances are registered\n with the load balancer. For more information, see Attaching a Load\n Balancer to Your Auto Scaling Group in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Attaches one or more target groups to the specified Auto Scaling group.
\nTo describe the target groups for an Auto Scaling group, call the DescribeLoadBalancerTargetGroups API. To detach the target group from\n the Auto Scaling group, call the DetachLoadBalancerTargetGroups API.
\nWith Application Load Balancers and Network Load Balancers, instances are registered\n as targets with a target group. With Classic Load Balancers, instances are registered\n with the load balancer. For more information, see Attaching a load\n balancer to your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsResultType": { @@ -296,17 +296,17 @@ "com.amazonaws.autoscaling#AttachLoadBalancerTargetGroupsType": { "type": "structure", "members": { - "TargetGroupARNs": { - "target": "com.amazonaws.autoscaling#TargetGroupARNs", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target\n groups.
", + "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "TargetGroupARNs": { + "target": "com.amazonaws.autoscaling#TargetGroupARNs", "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
", + "smithy.api#documentation": "The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target\n groups.
", "smithy.api#required": {} } } @@ -329,7 +329,7 @@ } ], "traits": { - "smithy.api#documentation": "To attach an Application Load Balancer or a Network Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead.
\nAttaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling\n registers the running instances with these Classic Load Balancers.
\nTo describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach the load balancer from the Auto Scaling\n group, call the DetachLoadBalancers API.
\nFor more information, see Attaching a Load\n Balancer to Your Auto Scaling Group in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "To attach an Application Load Balancer or a Network Load Balancer, use the AttachLoadBalancerTargetGroups API operation instead.
\nAttaches one or more Classic Load Balancers to the specified Auto Scaling group. Amazon EC2 Auto Scaling\n registers the running instances with these Classic Load Balancers.
\nTo describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach the load balancer from the Auto Scaling\n group, call the DetachLoadBalancers API.
\nFor more information, see Attaching a load\n balancer to your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#AttachLoadBalancersResultType": { @@ -358,16 +358,11 @@ "com.amazonaws.autoscaling#AutoScalingGroup": { "type": "structure", "members": { - "VPCZoneIdentifier": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen2047", - "traits": { - "smithy.api#documentation": "One or more subnet IDs, if applicable, separated by commas.
" - } - }, - "EnabledMetrics": { - "target": "com.amazonaws.autoscaling#EnabledMetrics", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The metrics enabled for the group.
" + "smithy.api#documentation": "The name of the Auto Scaling group.
", + "smithy.api#required": {} } }, "AutoScalingGroupARN": { @@ -376,68 +371,69 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Auto Scaling group.
" } }, - "DefaultCooldown": { - "target": "com.amazonaws.autoscaling#Cooldown", + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The duration of the default cooldown period, in seconds.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the associated launch configuration.
" } }, - "MaxSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "LaunchTemplate": { + "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "The maximum size of the group.
", - "smithy.api#required": {} + "smithy.api#documentation": "The launch template for the group.
" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "MixedInstancesPolicy": { + "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
", - "smithy.api#required": {} + "smithy.api#documentation": "The mixed instances policy for the group.
" } }, - "TargetGroupARNs": { - "target": "com.amazonaws.autoscaling#TargetGroupARNs", + "MinSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARN) of the target groups for your load balancer.
" + "smithy.api#documentation": "The minimum size of the group.
", + "smithy.api#required": {} } }, - "AvailabilityZones": { - "target": "com.amazonaws.autoscaling#AvailabilityZones", + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", "traits": { - "smithy.api#documentation": "One or more Availability Zones for the group.
", + "smithy.api#documentation": "The maximum size of the group.
", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "DesiredCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", "traits": { - "smithy.api#documentation": "The current state of the group when the DeleteAutoScalingGroup\n operation is in progress.
" + "smithy.api#documentation": "The desired size of the group.
", + "smithy.api#required": {} } }, - "CapacityRebalance": { - "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", + "DefaultCooldown": { + "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "Indicates whether capacity rebalance is enabled.
" + "smithy.api#documentation": "The duration of the default cooldown period, in seconds.
", + "smithy.api#required": {} } }, - "TerminationPolicies": { - "target": "com.amazonaws.autoscaling#TerminationPolicies", + "AvailabilityZones": { + "target": "com.amazonaws.autoscaling#AvailabilityZones", "traits": { - "smithy.api#documentation": "The termination policies for the group.
" + "smithy.api#documentation": "One or more Availability Zones for the group.
", + "smithy.api#required": {} } }, - "PlacementGroup": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "LoadBalancerNames": { + "target": "com.amazonaws.autoscaling#LoadBalancerNames", "traits": { - "smithy.api#documentation": "The name of the placement group into which to launch your instances, if any.
" + "smithy.api#documentation": "One or more load balancers associated with the group.
" } }, - "MaxInstanceLifetime": { - "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", + "TargetGroupARNs": { + "target": "com.amazonaws.autoscaling#TargetGroupARNs", "traits": { - "smithy.api#documentation": "The maximum amount of time, in seconds, that an instance can be in service.
\nValid Range: Minimum value of 0.
" + "smithy.api#documentation": "The Amazon Resource Names (ARN) of the target groups for your load balancer.
" } }, "HealthCheckType": { @@ -447,85 +443,89 @@ "smithy.api#required": {} } }, - "NewInstancesProtectedFromScaleIn": { - "target": "com.amazonaws.autoscaling#InstanceProtected", + "HealthCheckGracePeriod": { + "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", "traits": { - "smithy.api#documentation": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in.
" + "smithy.api#documentation": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service.
" } }, - "DesiredCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", + "Instances": { + "target": "com.amazonaws.autoscaling#Instances", "traits": { - "smithy.api#documentation": "The desired size of the group.
", + "smithy.api#documentation": "The EC2 instances associated with the group.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.autoscaling#TimestampType", + "traits": { + "smithy.api#documentation": "The date and time the group was created.
", "smithy.api#required": {} } }, - "ServiceLinkedRoleARN": { - "target": "com.amazonaws.autoscaling#ResourceName", + "SuspendedProcesses": { + "target": "com.amazonaws.autoscaling#SuspendedProcesses", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other AWS services on your behalf.
" + "smithy.api#documentation": "The suspended processes associated with the group.
" } }, - "MinSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", + "PlacementGroup": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The minimum size of the group.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the placement group into which to launch your instances, if any.
" } }, - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "VPCZoneIdentifier": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen2047", "traits": { - "smithy.api#documentation": "The launch template for the group.
" + "smithy.api#documentation": "One or more subnet IDs, if applicable, separated by commas.
" } }, - "Instances": { - "target": "com.amazonaws.autoscaling#Instances", + "EnabledMetrics": { + "target": "com.amazonaws.autoscaling#EnabledMetrics", "traits": { - "smithy.api#documentation": "The EC2 instances associated with the group.
" + "smithy.api#documentation": "The metrics enabled for the group.
" } }, - "CreatedTime": { - "target": "com.amazonaws.autoscaling#TimestampType", + "Status": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The date and time the group was created.
", - "smithy.api#required": {} + "smithy.api#documentation": "The current state of the group when the DeleteAutoScalingGroup\n operation is in progress.
" } }, - "HealthCheckGracePeriod": { - "target": "com.amazonaws.autoscaling#HealthCheckGracePeriod", + "Tags": { + "target": "com.amazonaws.autoscaling#TagDescriptionList", "traits": { - "smithy.api#documentation": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service.
" + "smithy.api#documentation": "The tags for the group.
" } }, - "MixedInstancesPolicy": { - "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", + "TerminationPolicies": { + "target": "com.amazonaws.autoscaling#TerminationPolicies", "traits": { - "smithy.api#documentation": "The mixed instances policy for the group.
" + "smithy.api#documentation": "The termination policies for the group.
" } }, - "LoadBalancerNames": { - "target": "com.amazonaws.autoscaling#LoadBalancerNames", + "NewInstancesProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#InstanceProtected", "traits": { - "smithy.api#documentation": "One or more load balancers associated with the group.
" + "smithy.api#documentation": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in.
" } }, - "Tags": { - "target": "com.amazonaws.autoscaling#TagDescriptionList", + "ServiceLinkedRoleARN": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "The tags for the group.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other AWS services on your behalf.
" } }, - "SuspendedProcesses": { - "target": "com.amazonaws.autoscaling#SuspendedProcesses", + "MaxInstanceLifetime": { + "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", "traits": { - "smithy.api#documentation": "The suspended processes associated with the group.
" + "smithy.api#documentation": "The maximum amount of time, in seconds, that an instance can be in service.
\nValid Range: Minimum value of 0.
" } }, - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "CapacityRebalance": { + "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", "traits": { - "smithy.api#documentation": "The name of the associated launch configuration.
" + "smithy.api#documentation": "Indicates whether Capacity Rebalancing is enabled.
" } } }, @@ -560,16 +560,16 @@ "com.amazonaws.autoscaling#AutoScalingGroupNamesType": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", + "AutoScalingGroupNames": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupNames", "traits": { - "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" + "smithy.api#documentation": "The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can\n optionally increase this limit using the MaxRecords
parameter.
If you omit this parameter, all Auto Scaling groups are described.
" } }, - "AutoScalingGroupNames": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupNames", + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By\n default, you can only specify up to 50 names. You can optionally increase this limit\n using the MaxRecords
parameter.
If you omit this parameter, all Auto Scaling groups are described.
" + "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" } }, "MaxRecords": { @@ -589,41 +589,42 @@ "com.amazonaws.autoscaling#AutoScalingGroupsType": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken
value when requesting the next set of items. This value is\n null when there are no more items to return.
The groups.
", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken
value when requesting the next set of items. This value is\n null when there are no more items to return.
The name of the Auto Scaling group for the instance.
", + "smithy.api#documentation": "The ID of the instance.
", "smithy.api#required": {} } }, - "WeightedCapacity": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "InstanceType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The number of capacity units contributed by the instance based on its instance\n type.
\nValid Range: Minimum value of 1. Maximum value of 999.
" + "smithy.api#documentation": "The instance type of the EC2 instance.
" } }, - "InstanceType": { + "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The instance type of the EC2 instance.
" + "smithy.api#documentation": "The name of the Auto Scaling group for the instance.
", + "smithy.api#required": {} } }, "AvailabilityZone": { @@ -633,10 +634,11 @@ "smithy.api#required": {} } }, - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "LifecycleState": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "The launch template for the instance.
" + "smithy.api#documentation": "The lifecycle state for the instance.
", + "smithy.api#required": {} } }, "HealthStatus": { @@ -646,18 +648,16 @@ "smithy.api#required": {} } }, - "LifecycleState": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The lifecycle state for the instance.
", - "smithy.api#required": {} + "smithy.api#documentation": "The launch configuration used to launch the instance. This value is not available if\n you attached the instance to the Auto Scaling group.
" } }, - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "LaunchTemplate": { + "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", "traits": { - "smithy.api#documentation": "The ID of the instance.
", - "smithy.api#required": {} + "smithy.api#documentation": "The launch template for the instance.
" } }, "ProtectedFromScaleIn": { @@ -667,10 +667,10 @@ "smithy.api#required": {} } }, - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "WeightedCapacity": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "The launch configuration used to launch the instance. This value is not available if\n you attached the instance to the Auto Scaling group.
" + "smithy.api#documentation": "The number of capacity units contributed by the instance based on its instance\n type.
\nValid Range: Minimum value of 1. Maximum value of 999.
" } } }, @@ -996,17 +996,17 @@ "com.amazonaws.autoscaling#BatchPutScheduledUpdateGroupActionType": { "type": "structure", "members": { - "ScheduledUpdateGroupActions": { - "target": "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequests", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "One or more scheduled actions. The maximum number allowed is 50.
", + "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "ScheduledUpdateGroupActions": { + "target": "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequests", "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
", + "smithy.api#documentation": "One or more scheduled actions. The maximum number allowed is 50.
", "smithy.api#required": {} } } @@ -1056,6 +1056,12 @@ "com.amazonaws.autoscaling#BlockDeviceMapping": { "type": "structure", "members": { + "VirtualName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "The name of the virtual device (for example, ephemeral0
).
You can specify either VirtualName
or Ebs
, but not\n both.
Setting this value to true
suppresses the specified device included in\n the block device mapping of the AMI.
If NoDevice
is true
for the root device, instances might\n fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.
If you specify NoDevice
, you cannot specify Ebs
.
The name of the virtual device (for example, ephemeral0
).
You can specify either VirtualName
or Ebs
, but not\n both.
Completes the lifecycle action for the specified token or instance with the specified\n result.
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a Lambda function and a rule that allows CloudWatch Events to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to\n publish lifecycle notifications to the target.
\nCreate the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a pending state.
\n\n If you finish before the timeout period ends, complete\n the lifecycle action.\n
\nFor more information, see Amazon EC2 Auto Scaling Lifecycle\n Hooks in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Completes the lifecycle action for the specified token or instance with the specified\n result.
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a Lambda function and a rule that allows CloudWatch Events to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to\n publish lifecycle notifications to the target.
\nCreate the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a pending state.
\n\n If you finish before the timeout period ends, complete\n the lifecycle action.\n
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#CompleteLifecycleActionAnswer": { @@ -1174,23 +1174,17 @@ "com.amazonaws.autoscaling#CompleteLifecycleActionType": { "type": "structure", "members": { - "LifecycleActionResult": { - "target": "com.amazonaws.autoscaling#LifecycleActionResult", + "LifecycleHookName": { + "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", "traits": { - "smithy.api#documentation": "The action for the group to take. This parameter can be either CONTINUE
\n or ABANDON
.
The name of the lifecycle hook.
", "smithy.api#required": {} } }, - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", - "traits": { - "smithy.api#documentation": "The ID of the instance.
" - } - }, - "LifecycleHookName": { - "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "The name of the lifecycle hook.
", + "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, @@ -1200,12 +1194,18 @@ "smithy.api#documentation": "A universally unique identifier (UUID) that identifies a specific lifecycle action\n associated with an instance. Amazon EC2 Auto Scaling sends this token to the notification target you\n specified when you created the lifecycle hook.
" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "LifecycleActionResult": { + "target": "com.amazonaws.autoscaling#LifecycleActionResult", "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
", + "smithy.api#documentation": "The action for the group to take. This parameter can be either CONTINUE
\n or ABANDON
.
The ID of the instance.
" + } } } }, @@ -1235,151 +1235,151 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Auto Scaling group with the specified name and attributes.
\nIf you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Amazon EC2 Auto Scaling Service\n Quotas in the Amazon EC2 Auto Scaling User Guide.
\nFor introductory exercises for creating an Auto Scaling group, see Getting Started with\n Amazon EC2 Auto Scaling and Tutorial: Set Up a\n Scaled and Load-Balanced Application in the\n Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling\n Groups in the Amazon EC2 Auto Scaling User Guide.
\nEvery Auto Scaling group has three size parameters (DesiredCapacity
,\n MaxSize
, and MinSize
). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.
Creates an Auto Scaling group with the specified name and attributes.
\nIf you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit,\n call the DescribeAccountLimits API. For information about updating\n this limit, see Amazon EC2 Auto Scaling service\n quotas in the Amazon EC2 Auto Scaling User Guide.
\nFor introductory exercises for creating an Auto Scaling group, see Getting started with\n Amazon EC2 Auto Scaling and Tutorial: Set up a\n scaled and load-balanced application in the\n Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling\n groups in the Amazon EC2 Auto Scaling User Guide.
\nEvery Auto Scaling group has three size parameters (DesiredCapacity
,\n MaxSize
, and MinSize
). Usually, you set these sizes based\n on a specific number of instances. However, if you configure a mixed instances policy\n that defines weights for the instance types, you must specify these sizes with the same\n units that you use for weighting instances.
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in.
\nFor more information about preventing instances from terminating on scale in, see\n Instance Protection in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The name of the Auto Scaling group. This name must be unique per Region per account.
", + "smithy.api#required": {} } }, - "DesiredCapacity": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "The desired capacity is the initial capacity of the Auto Scaling group at the time of its\n creation and the capacity it attempts to maintain. It can scale beyond this capacity if\n you configure automatic scaling.
\nThis number must be greater than or equal to the minimum size of the group and less\n than or equal to the maximum size of the group. If you do not specify a desired\n capacity, the default is the minimum size of the group.
" + "smithy.api#documentation": "The name of the launch configuration to use to launch instances.
\nConditional: You must specify either a launch template (LaunchTemplate
or\n MixedInstancesPolicy
) or a launch configuration\n (LaunchConfigurationName
or InstanceId
).
The maximum size of the group.
\nWith a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize
to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize
by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).
Parameters used to specify the launch\n template and version to use to launch instances.
\nConditional: You must specify either a launch template (LaunchTemplate
or\n MixedInstancesPolicy
) or a launch configuration\n (LaunchConfigurationName
or InstanceId
).
The launch template that is specified must be configured for use with an Auto Scaling\n group. For more information, see Creating a launch\n template for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
\nThe amount of time, in seconds, after a scaling activity completes before another\n scaling activity can start. The default value is 300
.
This setting applies when using simple scaling policies, but not when using other\n scaling policies or scheduled scaling. For more information, see Scaling Cooldowns\n for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "An embedded object that specifies a mixed instances policy. The required parameters\n must be specified. If optional parameters are unspecified, their default values are\n used.
\nThe policy includes parameters that not only define the distribution of On-Demand\n Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the\n Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the\n parameters that specify the instance configuration information—the launch template and\n instance types. The policy can also include a weight for each instance type. For more\n information, see Auto Scaling groups with multiple\n instance types and purchase options in the Amazon EC2 Auto Scaling User\n Guide.
\nConditional: You must specify either a launch template (LaunchTemplate
or\n MixedInstancesPolicy
) or a launch configuration\n (LaunchConfigurationName
or InstanceId
).
The service to use for the health checks. The valid values are EC2
and\n ELB
. The default value is EC2
. If you configure an Auto Scaling\n group to use ELB health checks, it considers the instance unhealthy if it fails either\n the EC2 status checks or the load balancer health checks.
For more information, see Health Checks for Auto Scaling\n Instances in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The ID of the instance used to base the launch configuration on. If specified, Amazon\n EC2 Auto Scaling uses the configuration values from the specified instance to create a\n new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Creating an Auto Scaling group using an EC2 instance in the\n Amazon EC2 Auto Scaling User Guide.
" } }, - "Tags": { - "target": "com.amazonaws.autoscaling#Tags", + "MinSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", "traits": { - "smithy.api#documentation": "One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2\n instances it launches.
\nTags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the\n tags in a launch template but use caution. If the launch template specifies an instance\n tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value\n of that instance tag with the value specified by the Auto Scaling group.
\nFor more information, see Tagging Auto Scaling Groups and\n Instances in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The minimum size of the group.
", + "smithy.api#required": {} } }, - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", "traits": { - "smithy.api#documentation": "Parameters used to specify the launch template and version to use when an instance is\n launched.
\nFor more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API\n Reference.
\nYou can alternatively associate a launch template to the Auto Scaling group by using the\n MixedInstancesPolicy
parameter.
You must specify one of the following parameters in your request:\n LaunchConfigurationName
, LaunchTemplate
,\n InstanceId
, or MixedInstancesPolicy
.
The maximum size of the group.
\nWith a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize
to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize
by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).
One or more lifecycle hooks.
" + "smithy.api#documentation": "The desired capacity is the initial capacity of the Auto Scaling group at the time of its\n creation and the capacity it attempts to maintain. It can scale beyond this capacity if\n you configure auto scaling. This number must be greater than or equal to the minimum\n size of the group and less than or equal to the maximum size of the group. If you do not\n specify a desired capacity, the default is the minimum size of the group.
" } }, - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "DefaultCooldown": { + "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "The ID of the instance used to create a launch configuration for the group. To get the\n instance ID, use the Amazon EC2 DescribeInstances API operation.
\nWhen you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and\n associates it with the group. This launch configuration derives its attributes from the\n specified instance, except for the block device mapping.
\nYou must specify one of the following parameters in your request:\n LaunchConfigurationName
, LaunchTemplate
,\n InstanceId
, or MixedInstancesPolicy
.
The amount of time, in seconds, after a scaling activity completes before another\n scaling activity can start. The default value is 300
. This setting applies\n when using simple scaling policies, but not when using other scaling policies or\n scheduled scaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling\n in the Amazon EC2 Auto Scaling User Guide.
The name of the placement group into which to launch your instances, if any. A\n placement group is a logical grouping of instances within a single Availability Zone.\n You cannot specify multiple Availability Zones and a placement group. For more\n information, see Placement Groups in the\n Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "A list of Availability Zones where instances in the Auto Scaling group can be created. This\n parameter is optional if you specify one or more subnets for\n VPCZoneIdentifier
.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required\n to launch instances into EC2-Classic.
" } }, - "VPCZoneIdentifier": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen2047", + "LoadBalancerNames": { + "target": "com.amazonaws.autoscaling#LoadBalancerNames", "traits": { - "smithy.api#documentation": "A comma-separated list of subnet IDs for your virtual private cloud (VPC).
\nIf you specify VPCZoneIdentifier
with AvailabilityZones
, the\n subnets that you specify for this parameter must reside in those Availability\n Zones.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required\n to launch instances into a VPC.
" + "smithy.api#documentation": "A list of Classic Load Balancers associated with this Auto Scaling group. For\n Application Load Balancers and Network Load Balancers, specify\n TargetGroupARNs
instead.
The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group.\n Instances are registered as targets in a target group, and traffic is routed to the\n target group.
\nFor more information, see Using a Load Balancer\n with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
" - } - }, - "MaxInstanceLifetime": { - "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", - "traits": { - "smithy.api#documentation": "The maximum amount of time, in seconds, that an instance can be in service. The\n default is null.
\nThis parameter is optional, but if you specify a value for it, you must specify a\n value of at least 604,800 seconds (7 days). To clear a previously set value, specify a\n new value of 0.
\nFor more information, see Replacing Auto Scaling\n Instances Based on Maximum Instance Lifetime in the\n Amazon EC2 Auto Scaling User Guide.
\nValid Range: Minimum value of 0.
" + "smithy.api#documentation": "The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group.\n Instances are registered as targets in a target group, and traffic is routed to the\n target group. For more information, see Elastic Load\n Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" } }, - "MixedInstancesPolicy": { - "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", + "HealthCheckType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "An embedded object that specifies a mixed instances policy. The required parameters\n must be specified. If optional parameters are unspecified, their default values are\n used.
\nThe policy includes parameters that not only define the distribution of On-Demand\n Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the\n Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity, but also the\n parameters that specify the instance configuration information—the launch template and\n instance types.
\n \nFor more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and\n Auto Scaling Groups with Multiple\n Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User\n Guide.
\nYou must specify one of the following parameters in your request:\n LaunchConfigurationName
, LaunchTemplate
,\n InstanceId
, or MixedInstancesPolicy
.
The service to use for the health checks. The valid values are EC2
\n (default) and ELB
. If you configure an Auto Scaling group to use load balancer\n (ELB) health checks, it considers the instance unhealthy if it fails either the EC2\n status checks or the load balancer health checks. For more information, see Health checks\n for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service. During this time, any health check\n failures for the instance are ignored. The default value is 0
.
For more information, see Health\n Check Grace Period in the Amazon EC2 Auto Scaling User Guide.
\nRequired if you are adding an ELB
health check.
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service. During this time, any health check\n failures for the instance are ignored. The default value is 0
. For more\n information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.
Conditional: Required if you are adding an ELB
health check.
The name of the launch configuration to use when an instance is launched. To get the\n launch configuration name, use the DescribeLaunchConfigurations API\n operation. New launch configurations can be created with the CreateLaunchConfiguration API.
\nYou must specify one of the following parameters in your request:\n LaunchConfigurationName
, LaunchTemplate
,\n InstanceId
, or MixedInstancesPolicy
.
The name of an existing placement group into which to launch your instances, if any. A\n placement group is a logical grouping of instances within a single Availability Zone.\n You cannot specify multiple Availability Zones and a placement group. For more\n information, see Placement Groups in the\n Amazon EC2 User Guide for Linux Instances.
" } }, - "CapacityRebalance": { - "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", + "VPCZoneIdentifier": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen2047", "traits": { - "smithy.api#documentation": "Indicates whether capacity rebalance is enabled. Otherwise, capacity rebalance is\n disabled.
\nYou can enable capacity rebalancing for your Auto Scaling groups when using Spot Instances.\n When you turn on capacity rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance\n whenever Amazon EC2 predicts that a Spot Instance is at an elevated risk of interruption.\n After launching a new instance, it then terminates an old instance. For more\n information, see Amazon EC2 Auto Scaling capacity\n rebalancing in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "A comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances\n in the Auto Scaling group can be created. If you specify VPCZoneIdentifier
with\n AvailabilityZones
, the subnets that you specify for this parameter must\n reside in those Availability Zones.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required\n to launch instances into a VPC.
" } }, "TerminationPolicies": { "target": "com.amazonaws.autoscaling#TerminationPolicies", "traits": { - "smithy.api#documentation": "One or more termination policies used to select the instance to terminate. These\n policies are executed in the order that they are listed.
\nFor more information, see Controlling Which\n Instances Auto Scaling Terminates During Scale In in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "A policy or a list of policies that are used to select the instance to terminate.\n These policies are executed in the order that you list them. For more information, see\n Controlling which Auto Scaling\n instances terminate during scale in in the\n Amazon EC2 Auto Scaling User Guide.
" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "NewInstancesProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#InstanceProtected", "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group. This name must be unique per Region per account.
", - "smithy.api#required": {} + "smithy.api#documentation": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
" } }, - "LoadBalancerNames": { - "target": "com.amazonaws.autoscaling#LoadBalancerNames", + "CapacityRebalance": { + "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", "traits": { - "smithy.api#documentation": "A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load\n Balancers and Network Load Balancers, specify a list of target groups using the\n TargetGroupARNs
property instead.
For more information, see Using a Load Balancer\n with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is\n disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot\n Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of\n interruption. After launching a new instance, it then terminates an old instance. For\n more information, see Amazon EC2 Auto Scaling Capacity\n Rebalancing in the Amazon EC2 Auto Scaling User Guide.
" } }, - "AvailabilityZones": { - "target": "com.amazonaws.autoscaling#AvailabilityZones", + "LifecycleHookSpecificationList": { + "target": "com.amazonaws.autoscaling#LifecycleHookSpecifications", "traits": { - "smithy.api#documentation": "One or more Availability Zones for the group. This parameter is optional if you\n specify one or more subnets for VPCZoneIdentifier
.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required\n to launch instances into EC2-Classic.
" + "smithy.api#documentation": "One or more lifecycle hooks for the group, which specify actions to perform when\n Amazon EC2 Auto Scaling launches or terminates instances.
" } }, - "MinSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", + "Tags": { + "target": "com.amazonaws.autoscaling#Tags", "traits": { - "smithy.api#documentation": "The minimum size of the group.
", - "smithy.api#required": {} + "smithy.api#documentation": "One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2\n instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS\n volumes, specify the tags in a launch template but use caution. If the launch template\n specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling\n overrides the value of that instance tag with the value specified by the Auto Scaling group. For\n more information, see Tagging Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
" } }, "ServiceLinkedRoleARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role\n named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more\n information, see Service-Linked\n Roles in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role\n named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more\n information, see Service-linked\n roles in the Amazon EC2 Auto Scaling User Guide.
" + } + }, + "MaxInstanceLifetime": { + "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", + "traits": { + "smithy.api#documentation": "The maximum amount of time, in seconds, that an instance can be in service. The\n default is null. If specified, the value must be either 0 or a number equal to or\n greater than 86,400 seconds (1 day). For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the\n Amazon EC2 Auto Scaling User Guide.
" } } } @@ -1401,125 +1401,125 @@ } ], "traits": { - "smithy.api#documentation": "Creates a launch configuration.
\nIf you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Amazon EC2 Auto Scaling Service\n Quotas in the Amazon EC2 Auto Scaling User Guide.
\nFor more information, see Launch\n Configurations in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Creates a launch configuration.
\nIf you exceed your maximum limit of launch configurations, the call fails. To query\n this limit, call the DescribeAccountLimits API. For information about\n updating this limit, see Amazon EC2 Auto Scaling service\n quotas in the Amazon EC2 Auto Scaling User Guide.
\nFor more information, see Launch\n configurations in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#CreateLaunchConfigurationType": { "type": "structure", "members": { - "RamdiskId": { + "LaunchConfigurationName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The ID of the RAM disk to select.
" + "smithy.api#documentation": "The name of the launch configuration. This name must be unique per Region per\n account.
", + "smithy.api#required": {} } }, - "KeyName": { + "ImageId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The name of the key pair. For more information, see Amazon EC2 Key Pairs in the\n Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) that was assigned during registration. For\n more information, see Finding an AMI in the\n Amazon EC2 User Guide for Linux Instances.
\nIf you do not specify InstanceId
, you must specify\n ImageId
.
The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Launching Spot\n Instances in Your Auto Scaling Group in the\n Amazon EC2 Auto Scaling User Guide.
\nWhen you change your maximum price by creating a new launch configuration, running\n instances will continue to run as long as the maximum price for those running\n instances is higher than the current Spot price.
\nThe name of the key pair. For more information, see Amazon EC2 Key Pairs in the\n Amazon EC2 User Guide for Linux Instances.
" } }, - "EbsOptimized": { - "target": "com.amazonaws.autoscaling#EbsOptimized", + "SecurityGroups": { + "target": "com.amazonaws.autoscaling#SecurityGroups", "traits": { - "smithy.api#documentation": "Specifies whether the launch configuration is optimized for EBS I/O\n (true
) or not (false
). The optimization provides dedicated\n throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O\n performance. This optimization is not available with all instance types. Additional fees\n are incurred when you enable EBS optimization for an instance type that is not\n EBS-optimized by default. For more information, see Amazon EBS-Optimized\n Instances in the Amazon EC2 User Guide for Linux\n Instances.
The default value is false
.
A list that contains the security groups to assign to the instances in the Auto Scaling\n group.
\n[EC2-VPC] Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud\n User Guide.
\n[EC2-Classic] Specify either the security group names or the security group IDs. For\n more information, see Amazon EC2 Security\n Groups in the Amazon EC2 User Guide for Linux\n Instances.
" } }, - "ImageId": { + "ClassicLinkVPCId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) that was assigned during registration. For\n more information, see Finding an AMI in the\n Amazon EC2 User Guide for Linux Instances.
\nIf you do not specify InstanceId
, you must specify\n ImageId
.
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
\nThis parameter can only be used if you are launching EC2-Classic instances.
" } }, - "InstanceMonitoring": { - "target": "com.amazonaws.autoscaling#InstanceMonitoring", + "ClassicLinkVPCSecurityGroups": { + "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", "traits": { - "smithy.api#documentation": "Controls whether instances in this group are launched with detailed\n (true
) or basic (false
) monitoring.
The default value is true
(enabled).
When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and\n your account is charged a fee. When you disable detailed monitoring, CloudWatch generates\n metrics every 5 minutes. For more information, see Configure\n Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.
\nThe IDs of one or more security groups for the specified ClassicLink-enabled VPC. For\n more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
\nIf you specify the ClassicLinkVPCId
parameter, you must specify this\n parameter.
A block device mapping, which specifies the block devices for the instance. You can\n specify virtual devices and EBS volumes. For more information, see Block Device\n Mapping in the Amazon EC2 User Guide for Linux\n Instances.
" + "smithy.api#documentation": "The Base64-encoded user data to make available to the launched EC2 instances. For more\n information, see Instance metadata and user\n data in the Amazon EC2 User Guide for Linux Instances.
" } }, "InstanceId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { - "smithy.api#documentation": "The ID of the instance to use to create the launch configuration. The new launch\n configuration derives attributes from the instance, except for the block device\n mapping.
\nTo create a launch configuration with a block device mapping or override any other\n instance attributes, specify them as part of the same request.
\nFor more information, see Create a Launch\n Configuration Using an EC2 Instance in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you do not specify InstanceId
, you must specify both\n ImageId
and InstanceType
.
The ID of the instance to use to create the launch configuration. The new launch\n configuration derives attributes from the instance, except for the block device\n mapping.
\nTo create a launch configuration with a block device mapping or override any other\n instance attributes, specify them as part of the same request.
\nFor more information, see Creating a launch\n configuration using an EC2 instance in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you do not specify InstanceId
, you must specify both\n ImageId
and InstanceType
.
The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For\n more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
\nIf you specify the ClassicLinkVPCId
parameter, you must specify this\n parameter.
Specifies the instance type of the EC2 instance.
\nFor information about available instance types, see Available\n Instance Types in the Amazon EC2 User Guide for Linux\n Instances.\n
\nIf you do not specify InstanceId
, you must specify\n InstanceType
.
The Base64-encoded user data to make available to the launched EC2 instances. For more\n information, see Instance Metadata and User\n Data in the Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The ID of the kernel associated with the AMI.
" } }, - "InstanceType": { + "RamdiskId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "Specifies the instance type of the EC2 instance.
\nFor information about available instance types, see Available\n Instance Types in the Amazon EC2 User Guide for Linux\n Instances.\n
\nIf you do not specify InstanceId
, you must specify\n InstanceType
.
The ID of the RAM disk to select.
" } }, - "ClassicLinkVPCId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "BlockDeviceMappings": { + "target": "com.amazonaws.autoscaling#BlockDeviceMappings", "traits": { - "smithy.api#documentation": "The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
\nThis parameter can only be used if you are launching EC2-Classic instances.
" + "smithy.api#documentation": "A block device mapping, which specifies the block devices for the instance. You can\n specify virtual devices and EBS volumes. For more information, see Block Device\n Mapping in the Amazon EC2 User Guide for Linux\n Instances.
" } }, - "PlacementTenancy": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", + "InstanceMonitoring": { + "target": "com.amazonaws.autoscaling#InstanceMonitoring", "traits": { - "smithy.api#documentation": "The tenancy of the instance. An instance with dedicated
tenancy runs on\n isolated, single-tenant hardware and can only be launched into a VPC.
To launch dedicated instances into a shared tenancy VPC (a VPC with the instance\n placement tenancy attribute set to default
), you must set the value of this\n parameter to dedicated
.
If you specify PlacementTenancy
, you must specify at least one subnet for\n VPCZoneIdentifier
when you create your group.
For more information, see Instance Placement\n Tenancy in the Amazon EC2 Auto Scaling User Guide.
\nValid Values: default
| dedicated
\n
Controls whether instances in this group are launched with detailed\n (true
) or basic (false
) monitoring.
The default value is true
(enabled).
When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and\n your account is charged a fee. When you disable detailed monitoring, CloudWatch generates\n metrics every 5 minutes. For more information, see Configure\n Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.
\nThe metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Requesting Spot\n Instances in the Amazon EC2 Auto Scaling User Guide.
\nWhen you change your maximum price by creating a new launch configuration, running\n instances will continue to run as long as the maximum price for those running\n instances is higher than the current Spot price.
\nThe ID of the kernel associated with the AMI.
" + "smithy.api#documentation": "The name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role.
\nFor more information, see IAM role for applications that run\n on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.
" } }, - "SecurityGroups": { - "target": "com.amazonaws.autoscaling#SecurityGroups", + "EbsOptimized": { + "target": "com.amazonaws.autoscaling#EbsOptimized", "traits": { - "smithy.api#documentation": "A list that contains the security groups to assign to the instances in the Auto Scaling\n group.
\n[EC2-VPC] Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud\n User Guide.
\n[EC2-Classic] Specify either the security group names or the security group IDs. For\n more information, see Amazon EC2 Security\n Groups in the Amazon EC2 User Guide for Linux\n Instances.
" + "smithy.api#documentation": "Specifies whether the launch configuration is optimized for EBS I/O\n (true
) or not (false
). The optimization provides dedicated\n throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O\n performance. This optimization is not available with all instance types. Additional fees\n are incurred when you enable EBS optimization for an instance type that is not\n EBS-optimized by default. For more information, see Amazon EBS-Optimized\n Instances in the Amazon EC2 User Guide for Linux\n Instances.
The default value is false
.
The name of the launch configuration. This name must be unique per Region per\n account.
", - "smithy.api#required": {} + "smithy.api#documentation": "For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether\n to assign a public IP address to the group's instances. If you specify\n true
, each instance in the Auto Scaling group receives a unique public IP address.\n For more information, see Launching Auto Scaling instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.
If you specify this parameter, you must specify at least one subnet for\n VPCZoneIdentifier
when you create your group.
If the instance is launched into a default subnet, the default is to assign a\n public IP address, unless you disabled the option to assign a public IP address on\n the subnet. If the instance is launched into a nondefault subnet, the default is not\n to assign a public IP address, unless you enabled the option to assign a public IP\n address on the subnet.
\nThe name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role.
\nFor more information, see IAM Role for Applications That Run\n on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The tenancy of the instance. An instance with dedicated
tenancy runs on\n isolated, single-tenant hardware and can only be launched into a VPC.
To launch dedicated instances into a shared tenancy VPC (a VPC with the instance\n placement tenancy attribute set to default
), you must set the value of this\n parameter to dedicated
.
If you specify PlacementTenancy
, you must specify at least one subnet for\n VPCZoneIdentifier
when you create your group.
For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
\nValid Values: default
| dedicated
\n
For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether\n to assign a public IP address to the group's instances. If you specify\n true
, each instance in the Auto Scaling group receives a unique public IP address.\n For more information, see Launching Auto Scaling Instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.
If you specify this parameter, you must specify at least one subnet for\n VPCZoneIdentifier
when you create your group.
If the instance is launched into a default subnet, the default is to assign a\n public IP address, unless you disabled the option to assign a public IP address on\n the subnet. If the instance is launched into a nondefault subnet, the default is not\n to assign a public IP address, unless you enabled the option to assign a public IP\n address on the subnet.
\nThe metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the\n Amazon EC2 Auto Scaling User Guide.
" } } } @@ -1544,7 +1544,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates tags for the specified Auto Scaling group.
\nWhen you specify a tag with a key that already exists, the operation overwrites the\n previous tag definition, and you do not get an error message.
\nFor more information, see Tagging Auto Scaling Groups and\n Instances in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Creates or updates tags for the specified Auto Scaling group.
\nWhen you specify a tag with a key that already exists, the operation overwrites the\n previous tag definition, and you do not get an error message.
\nFor more information, see Tagging Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#CreateOrUpdateTagsType": { @@ -1553,15 +1553,29 @@ "Tags": { "target": "com.amazonaws.autoscaling#Tags", "traits": { - "smithy.api#documentation": "One or more tags.
", + "smithy.api#documentation": "One or more tags.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.autoscaling#CustomizedMetricSpecification": { + "type": "structure", + "members": { + "MetricName": { + "target": "com.amazonaws.autoscaling#MetricName", + "traits": { + "smithy.api#documentation": "The name of the metric.
", + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.autoscaling#MetricNamespace", + "traits": { + "smithy.api#documentation": "The namespace of the metric.
", "smithy.api#required": {} } - } - } - }, - "com.amazonaws.autoscaling#CustomizedMetricSpecification": { - "type": "structure", - "members": { + }, "Dimensions": { "target": "com.amazonaws.autoscaling#MetricDimensions", "traits": { @@ -1580,20 +1594,6 @@ "traits": { "smithy.api#documentation": "The unit of the metric.
" } - }, - "Namespace": { - "target": "com.amazonaws.autoscaling#MetricNamespace", - "traits": { - "smithy.api#documentation": "The namespace of the metric.
", - "smithy.api#required": {} - } - }, - "MetricName": { - "target": "com.amazonaws.autoscaling#MetricName", - "traits": { - "smithy.api#documentation": "The name of the metric.
", - "smithy.api#required": {} - } } }, "traits": { @@ -1742,7 +1742,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified scaling policy.
\nDeleting either a step scaling policy or a simple scaling policy deletes the\n underlying alarm action, but does not delete the alarm, even if it no longer has an\n associated action.
\nFor more information, see Deleting a Scaling\n Policy in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Deletes the specified scaling policy.
\nDeleting either a step scaling policy or a simple scaling policy deletes the\n underlying alarm action, but does not delete the alarm, even if it no longer has an\n associated action.
\nFor more information, see Deleting a scaling\n policy in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#DeletePolicyType": { @@ -1780,17 +1780,17 @@ "com.amazonaws.autoscaling#DeleteScheduledActionType": { "type": "structure", "members": { - "ScheduledActionName": { + "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "The name of the action to delete.
", + "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, - "AutoScalingGroupName": { + "ScheduledActionName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
", + "smithy.api#documentation": "The name of the action to delete.
", "smithy.api#required": {} } } @@ -1836,7 +1836,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the current Amazon EC2 Auto Scaling resource quotas for your AWS account.
\nFor information about requesting an increase, see Amazon EC2 Auto Scaling Service\n Quotas in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes the current Amazon EC2 Auto Scaling resource quotas for your AWS account.
\nFor information about requesting an increase, see Amazon EC2 Auto Scaling service\n quotas in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#DescribeAccountLimitsAnswer": { @@ -1848,18 +1848,18 @@ "smithy.api#documentation": "The maximum number of groups allowed for your AWS account. The default is 200 groups\n per AWS Region.
" } }, - "NumberOfAutoScalingGroups": { - "target": "com.amazonaws.autoscaling#NumberOfAutoScalingGroups", - "traits": { - "smithy.api#documentation": "The current number of groups for your AWS account.
" - } - }, "MaxNumberOfLaunchConfigurations": { "target": "com.amazonaws.autoscaling#MaxNumberOfLaunchConfigurations", "traits": { "smithy.api#documentation": "The maximum number of launch configurations allowed for your AWS account. The default\n is 200 launch configurations per AWS Region.
" } }, + "NumberOfAutoScalingGroups": { + "target": "com.amazonaws.autoscaling#NumberOfAutoScalingGroups", + "traits": { + "smithy.api#documentation": "The current number of groups for your AWS account.
" + } + }, "NumberOfLaunchConfigurations": { "target": "com.amazonaws.autoscaling#NumberOfLaunchConfigurations", "traits": { @@ -1954,17 +1954,17 @@ "smithy.api#documentation": "The IDs of the instances. You can specify up to MaxRecords
IDs. If you\n omit this parameter, all Auto Scaling instances are described. If you specify an ID that does\n not exist, it is ignored with no error.
The token for the next set of items to return. (You received this token from a\n previous call.)
" - } - }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 50
and the maximum value is 50
.
The token for the next set of items to return. (You received this token from a\n previous call.)
" + } } } }, @@ -2033,6 +2033,13 @@ "com.amazonaws.autoscaling#DescribeInstanceRefreshesType": { "type": "structure", "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "The name of the Auto Scaling group.
", + "smithy.api#required": {} + } + }, "InstanceRefreshIds": { "target": "com.amazonaws.autoscaling#InstanceRefreshIds", "traits": { @@ -2045,13 +2052,6 @@ "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
", - "smithy.api#required": {} - } - }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { @@ -2177,12 +2177,6 @@ "com.amazonaws.autoscaling#DescribeLoadBalancerTargetGroupsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" - } - }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { @@ -2190,6 +2184,12 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" + } + }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { @@ -2235,12 +2235,6 @@ "com.amazonaws.autoscaling#DescribeLoadBalancersRequest": { "type": "structure", "members": { - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 100
and the maximum value is 100
.
The token for the next set of items to return. (You received this token from a\n previous call.)
" } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 100
and the maximum value is 100
.
The granularities for the metrics.
" - } - }, "Metrics": { "target": "com.amazonaws.autoscaling#MetricCollectionTypes", "traits": { "smithy.api#documentation": "One or more metrics.
" } + }, + "Granularities": { + "target": "com.amazonaws.autoscaling#MetricGranularityTypes", + "traits": { + "smithy.api#documentation": "The granularities for the metrics.
" + } } } }, @@ -2333,36 +2333,36 @@ "com.amazonaws.autoscaling#DescribeNotificationConfigurationsAnswer": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken
value when requesting the next set of items. This value is\n null when there are no more items to return.
The notification configurations.
", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken
value when requesting the next set of items. This value is\n null when there are no more items to return.
The token for the next set of items to return. (You received this token from a\n previous call.)
" - } - }, "AutoScalingGroupNames": { "target": "com.amazonaws.autoscaling#AutoScalingGroupNames", "traits": { "smithy.api#documentation": "The name of the Auto Scaling group.
" } }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" + } + }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { @@ -2409,16 +2409,10 @@ "smithy.api#documentation": "The name of the Auto Scaling group.
" } }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", - "traits": { - "smithy.api#documentation": "The maximum number of items to be returned with each call. The default value is\n 50
and the maximum value is 100
.
The token for the next set of items to return. (You received this token from a\n previous call.)
" + "smithy.api#documentation": "The names of one or more policies. If you omit this parameter, all policies are\n described. If a group name is provided, the results are limited to that group. This list\n is limited to 50 items. If you specify an unknown policy name, it is ignored with no\n error.
" } }, "PolicyTypes": { @@ -2427,10 +2421,16 @@ "smithy.api#documentation": "One or more policy types. The valid values are SimpleScaling
,\n StepScaling
, and TargetTrackingScaling
.
The names of one or more policies. If you omit this parameter, all policies are\n described. If a group name is provided, the results are limited to that group. This list\n is limited to 50 items. If you specify an unknown policy name, it is ignored with no\n error.
" + "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "The maximum number of items to be returned with each call. The default value is\n 50
and the maximum value is 100
.
The token for the next set of items to return. (You received this token from a\n previous call.)
" - } - }, "ActivityIds": { "target": "com.amazonaws.autoscaling#ActivityIds", "traits": { @@ -2487,6 +2481,12 @@ "traits": { "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 100
and the maximum value is 100
.
The token for the next set of items to return. (You received this token from a\n previous call.)
" + } } } }, @@ -2533,12 +2533,6 @@ "com.amazonaws.autoscaling#DescribeScheduledActionsType": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" - } - }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { @@ -2551,10 +2545,10 @@ "smithy.api#documentation": "The names of one or more scheduled actions. You can specify up to 50 actions. If you\n omit this parameter, all scheduled actions are described. If you specify an unknown\n scheduled action, it is ignored with no error.
" } }, - "MaxRecords": { - "target": "com.amazonaws.autoscaling#MaxRecords", + "StartTime": { + "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 50
and the maximum value is 100
.
The earliest scheduled start time to return. If scheduled action names are provided,\n this parameter is ignored.
" } }, "EndTime": { @@ -2563,10 +2557,16 @@ "smithy.api#documentation": "The latest scheduled start time to return. If scheduled action names are provided,\n this parameter is ignored.
" } }, - "StartTime": { - "target": "com.amazonaws.autoscaling#TimestampType", + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "The earliest scheduled start time to return. If scheduled action names are provided,\n this parameter is ignored.
" + "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" + } + }, + "MaxRecords": { + "target": "com.amazonaws.autoscaling#MaxRecords", + "traits": { + "smithy.api#documentation": "The maximum number of items to return with this call. The default value is\n 50
and the maximum value is 100
.
Describes the specified tags.
\nYou can use filters to limit the results. For example, you can query for the tags for\n a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at\n least one of the specified values for it to be included in the results.
\nYou can also specify multiple filters. The result includes information for a\n particular tag only if it matches all the filters. If there's no match, no special\n message is returned.
\nFor more information, see Tagging Auto Scaling Groups and\n Instances in the Amazon EC2 Auto Scaling User Guide.
", + "smithy.api#documentation": "Describes the specified tags.
\nYou can use filters to limit the results. For example, you can query for the tags for\n a specific Auto Scaling group. You can specify multiple values for a filter. A tag must match at\n least one of the specified values for it to be included in the results.
\nYou can also specify multiple filters. The result includes information for a\n particular tag only if it matches all the filters. If there's no match, no special\n message is returned.
\nFor more information, see Tagging Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -2600,18 +2600,18 @@ "com.amazonaws.autoscaling#DescribeTagsType": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" - } - }, "Filters": { "target": "com.amazonaws.autoscaling#Filters", "traits": { "smithy.api#documentation": "One or more filters to scope the tags to return. The maximum number of filters per\n filter type (for example, auto-scaling-group
) is 1000.
The token for the next set of items to return. (You received this token from a\n previous call.)
" + } + }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { @@ -2631,7 +2631,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the termination policies supported by Amazon EC2 Auto Scaling.
\nFor more information, see Controlling Which Auto Scaling\n Instances Terminate During Scale In in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes the termination policies supported by Amazon EC2 Auto Scaling.
\nFor more information, see Controlling which Auto Scaling\n instances terminate during scale in in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#DescribeTerminationPolicyTypesAnswer": { @@ -2659,7 +2659,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes one or more instances from the specified Auto Scaling group.
\nAfter the instances are detached, you can manage them independent of the Auto Scaling\n group.
\nIf you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are detached.
\nIf there is a Classic Load Balancer attached to the Auto Scaling group, the instances are\n deregistered from the load balancer. If there are target groups attached to the Auto Scaling\n group, the instances are deregistered from the target groups.
\nFor more information, see Detach EC2 Instances from\n Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Removes one or more instances from the specified Auto Scaling group.
\nAfter the instances are detached, you can manage them independent of the Auto Scaling\n group.
\nIf you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are detached.
\nIf there is a Classic Load Balancer attached to the Auto Scaling group, the instances are\n deregistered from the load balancer. If there are target groups attached to the Auto Scaling\n group, the instances are deregistered from the target groups.
\nFor more information, see Detach EC2 instances from\n your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#DetachInstancesAnswer": { @@ -2676,11 +2676,10 @@ "com.amazonaws.autoscaling#DetachInstancesQuery": { "type": "structure", "members": { - "ShouldDecrementDesiredCapacity": { - "target": "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity", + "InstanceIds": { + "target": "com.amazonaws.autoscaling#InstanceIds", "traits": { - "smithy.api#documentation": "Indicates whether the Auto Scaling group decrements the desired capacity value by the number\n of instances detached.
", - "smithy.api#required": {} + "smithy.api#documentation": "The IDs of the instances. You can specify up to 20 instances.
" } }, "AutoScalingGroupName": { @@ -2690,10 +2689,11 @@ "smithy.api#required": {} } }, - "InstanceIds": { - "target": "com.amazonaws.autoscaling#InstanceIds", + "ShouldDecrementDesiredCapacity": { + "target": "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity", "traits": { - "smithy.api#documentation": "The IDs of the instances. You can specify up to 20 instances.
" + "smithy.api#documentation": "Indicates whether the Auto Scaling group decrements the desired capacity value by the number\n of instances detached.
", + "smithy.api#required": {} } } } @@ -2722,17 +2722,17 @@ "com.amazonaws.autoscaling#DetachLoadBalancerTargetGroupsType": { "type": "structure", "members": { - "TargetGroupARNs": { - "target": "com.amazonaws.autoscaling#TargetGroupARNs", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target\n groups.
", + "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "TargetGroupARNs": { + "target": "com.amazonaws.autoscaling#TargetGroupARNs", "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
", + "smithy.api#documentation": "The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target\n groups.
", "smithy.api#required": {} } } @@ -2795,18 +2795,18 @@ "com.amazonaws.autoscaling#DisableMetricsCollectionQuery": { "type": "structure", "members": { - "Metrics": { - "target": "com.amazonaws.autoscaling#Metrics", - "traits": { - "smithy.api#documentation": "Specifies one or more of the following metrics:
\n\n GroupMinSize
\n
\n GroupMaxSize
\n
\n GroupDesiredCapacity
\n
\n GroupInServiceInstances
\n
\n GroupPendingInstances
\n
\n GroupStandbyInstances
\n
\n GroupTerminatingInstances
\n
\n GroupTotalInstances
\n
\n GroupInServiceCapacity
\n
\n GroupPendingCapacity
\n
\n GroupStandbyCapacity
\n
\n GroupTerminatingCapacity
\n
\n GroupTotalCapacity
\n
If you omit this parameter, all metrics are disabled.
" - } - }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } + }, + "Metrics": { + "target": "com.amazonaws.autoscaling#Metrics", + "traits": { + "smithy.api#documentation": "Specifies one or more of the following metrics:
\n\n GroupMinSize
\n
\n GroupMaxSize
\n
\n GroupDesiredCapacity
\n
\n GroupInServiceInstances
\n
\n GroupPendingInstances
\n
\n GroupStandbyInstances
\n
\n GroupTerminatingInstances
\n
\n GroupTotalInstances
\n
\n GroupInServiceCapacity
\n
\n GroupPendingCapacity
\n
\n GroupStandbyCapacity
\n
\n GroupTerminatingCapacity
\n
\n GroupTotalCapacity
\n
If you omit this parameter, all metrics are disabled.
" + } } } }, @@ -2818,23 +2818,11 @@ }, "com.amazonaws.autoscaling#Ebs": { "type": "structure", - "members": { - "VolumeType": { - "target": "com.amazonaws.autoscaling#BlockDeviceEbsVolumeType", - "traits": { - "smithy.api#documentation": "The volume type, which can be standard
for Magnetic, io1
for\n Provisioned IOPS SSD, gp2
for General Purpose SSD, st1
for\n Throughput Optimized HDD, or sc1
for Cold HDD. For more information, see\n Amazon\n EBS Volume Types in the Amazon EC2 User Guide for Linux\n Instances.
Valid Values: standard
| io1
| gp2
|\n st1
| sc1
\n
Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see\n Supported Instance Types. If your AMI uses encrypted volumes, you can also\n only launch it on supported instance types.
\nIf you are creating a volume from a snapshot, you cannot specify an encryption\n value. Volumes that are created from encrypted snapshots are automatically\n encrypted, and volumes that are created from unencrypted snapshots are automatically\n unencrypted. By default, encrypted snapshots use the AWS managed CMK that is used\n for EBS encryption, but you can specify a custom CMK when you create the snapshot.\n The ability to encrypt a snapshot during copying also allows you to apply a new CMK\n to an already-encrypted snapshot. Volumes restored from the\n resulting copy are only accessible using the new CMK.
\nEnabling encryption by default results in all EBS volumes being encrypted with\n the AWS managed CMK or a customer managed CMK, whether or not the snapshot was\n encrypted.
\nFor more information, see Using Encryption with EBS-Backed\n AMIs in the Amazon EC2 User Guide for Linux Instances\n and Required\n CMK Key Policy for Use with Encrypted Volumes in the\n Amazon EC2 Auto Scaling User Guide.
" - } - }, - "DeleteOnTermination": { - "target": "com.amazonaws.autoscaling#BlockDeviceEbsDeleteOnTermination", + "members": { + "SnapshotId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the\n default value is true
.
The snapshot ID of the volume to use.
\nYou must specify either a VolumeSize
or a SnapshotId
.
The volume size, in Gibibytes (GiB).
\nThis can be a number from 1-1,024 for standard
, 4-16,384 for\n io1
, 1-16,384 for gp2
, and 500-16,384 for st1
\n and sc1
. If you specify a snapshot, the volume size must be equal to or\n larger than the snapshot size.
Default: If you create a volume from a snapshot and you don't specify a volume size,\n the default is the snapshot size.
\nYou must specify either a VolumeSize
or a SnapshotId
. If you\n specify both SnapshotId
and VolumeSize
, the volume size must\n be equal or greater than the size of the snapshot.
The snapshot ID of the volume to use.
\nYou must specify either a VolumeSize
or a SnapshotId
.
The volume type, which can be standard
for Magnetic, io1
for\n Provisioned IOPS SSD, gp2
for General Purpose SSD, st1
for\n Throughput Optimized HDD, or sc1
for Cold HDD. For more information, see\n Amazon\n EBS Volume Types in the Amazon EC2 User Guide for Linux\n Instances.
Valid Values: standard
| io1
| gp2
|\n st1
| sc1
\n
Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the\n default value is true
.
The number of I/O operations per second (IOPS) to provision for the volume. The\n maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, see Amazon EBS\n Volume Types in the Amazon EC2 User Guide for Linux Instances.
\nRequired when the volume type is io1
. (Not used with\n standard
, gp2
, st1
, or sc1
\n volumes.)
Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be\n attached to instances that support Amazon EBS encryption. For more information, see\n Supported Instance Types. If your AMI uses encrypted volumes, you can also\n only launch it on supported instance types.
\nIf you are creating a volume from a snapshot, you cannot specify an encryption\n value. Volumes that are created from encrypted snapshots are automatically\n encrypted, and volumes that are created from unencrypted snapshots are automatically\n unencrypted. By default, encrypted snapshots use the AWS managed CMK that is used\n for EBS encryption, but you can specify a custom CMK when you create the snapshot.\n The ability to encrypt a snapshot during copying also allows you to apply a new CMK\n to an already-encrypted snapshot. Volumes restored from the\n resulting copy are only accessible using the new CMK.
\nEnabling encryption by default results in all EBS volumes being encrypted with\n the AWS managed CMK or a customer managed CMK, whether or not the snapshot was\n encrypted.
\nFor more information, see Using Encryption with EBS-Backed\n AMIs in the Amazon EC2 User Guide for Linux Instances\n and Required\n CMK key policy for use with encrypted volumes in the\n Amazon EC2 Auto Scaling User Guide.
" + } } }, "traits": { @@ -2877,18 +2877,12 @@ } ], "traits": { - "smithy.api#documentation": "Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring CloudWatch metrics for your Auto Scaling groups and instances in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#EnableMetricsCollectionQuery": { "type": "structure", "members": { - "Metrics": { - "target": "com.amazonaws.autoscaling#Metrics", - "traits": { - "smithy.api#documentation": "Specifies which group-level metrics to start collecting. You can specify one or more\n of the following metrics:
\n\n GroupMinSize
\n
\n GroupMaxSize
\n
\n GroupDesiredCapacity
\n
\n GroupInServiceInstances
\n
\n GroupPendingInstances
\n
\n GroupStandbyInstances
\n
\n GroupTerminatingInstances
\n
\n GroupTotalInstances
\n
The instance weighting feature supports the following additional metrics:
\n\n GroupInServiceCapacity
\n
\n GroupPendingCapacity
\n
\n GroupStandbyCapacity
\n
\n GroupTerminatingCapacity
\n
\n GroupTotalCapacity
\n
If you omit this parameter, all metrics are enabled.
" - } - }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { @@ -2896,6 +2890,12 @@ "smithy.api#required": {} } }, + "Metrics": { + "target": "com.amazonaws.autoscaling#Metrics", + "traits": { + "smithy.api#documentation": "Specifies which group-level metrics to start collecting. You can specify one or more\n of the following metrics:
\n\n GroupMinSize
\n
\n GroupMaxSize
\n
\n GroupDesiredCapacity
\n
\n GroupInServiceInstances
\n
\n GroupPendingInstances
\n
\n GroupStandbyInstances
\n
\n GroupTerminatingInstances
\n
\n GroupTotalInstances
\n
The instance weighting feature supports the following additional metrics:
\n\n GroupInServiceCapacity
\n
\n GroupPendingCapacity
\n
\n GroupStandbyCapacity
\n
\n GroupTerminatingCapacity
\n
\n GroupTotalCapacity
\n
If you omit this parameter, all metrics are enabled.
" + } + }, "Granularity": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { @@ -2945,7 +2945,7 @@ } ], "traits": { - "smithy.api#documentation": "Moves the specified instances into the standby state.
\nIf you choose to decrement the desired capacity of the Auto Scaling group, the instances can\n enter standby as long as the desired capacity of the Auto Scaling group after the instances are\n placed into standby is equal to or greater than the minimum capacity of the\n group.
\nIf you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group\n launches new instances to replace the instances on standby.
\nFor more information, see Temporarily Removing\n Instances from Your Auto Scaling Group in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Moves the specified instances into the standby state.
\nIf you choose to decrement the desired capacity of the Auto Scaling group, the instances can\n enter standby as long as the desired capacity of the Auto Scaling group after the instances are\n placed into standby is equal to or greater than the minimum capacity of the\n group.
\nIf you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group\n launches new instances to replace the instances on standby.
\nFor more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#EnterStandbyAnswer": { @@ -3010,12 +3010,6 @@ "com.amazonaws.autoscaling#ExecutePolicyType": { "type": "structure", "members": { - "HonorCooldown": { - "target": "com.amazonaws.autoscaling#HonorCooldown", - "traits": { - "smithy.api#documentation": "Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing\n the policy.
\nValid only if the policy type is SimpleScaling
. For more information, see\n Scaling\n Cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing\n the policy.
\nValid only if the policy type is SimpleScaling
. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Moves the specified instances out of the standby state.
\nAfter you put the instances back in service, the desired capacity is\n incremented.
\nFor more information, see Temporarily Removing\n Instances from Your Auto Scaling Group in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Moves the specified instances out of the standby state.
\nAfter you put the instances back in service, the desired capacity is\n incremented.
\nFor more information, see Temporarily removing\n instances from your Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#ExitStandbyAnswer": { @@ -3074,30 +3074,24 @@ "com.amazonaws.autoscaling#ExitStandbyQuery": { "type": "structure", "members": { + "InstanceIds": { + "target": "com.amazonaws.autoscaling#InstanceIds", + "traits": { + "smithy.api#documentation": "The IDs of the instances. You can specify up to 20 instances.
" + } + }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } - }, - "InstanceIds": { - "target": "com.amazonaws.autoscaling#InstanceIds", - "traits": { - "smithy.api#documentation": "The IDs of the instances. You can specify up to 20 instances.
" - } } } }, "com.amazonaws.autoscaling#FailedScheduledUpdateGroupActionRequest": { "type": "structure", "members": { - "ErrorMessage": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "The error message accompanying the error code.
" - } - }, "ScheduledActionName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { @@ -3110,6 +3104,12 @@ "traits": { "smithy.api#documentation": "The error code.
" } + }, + "ErrorMessage": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "The error message accompanying the error code.
" + } } }, "traits": { @@ -3125,21 +3125,21 @@ "com.amazonaws.autoscaling#Filter": { "type": "structure", "members": { - "Values": { - "target": "com.amazonaws.autoscaling#Values", - "traits": { - "smithy.api#documentation": "One or more filter values. Filter values are case-sensitive.
" - } - }, "Name": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { "smithy.api#documentation": "The name of the filter. The valid values are: auto-scaling-group
,\n key
, value
, and propagate-at-launch
.
One or more filter values. Filter values are case-sensitive.
" + } } }, "traits": { - "smithy.api#documentation": "Describes a filter that is used to return a more specific list of results when\n describing tags.
\nFor more information, see Tagging Auto Scaling Groups and\n Instances in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes a filter that is used to return a more specific list of results when\n describing tags.
\nFor more information, see Tagging Auto Scaling groups and\n instances in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#Filters": { @@ -3181,12 +3181,6 @@ "com.amazonaws.autoscaling#Instance": { "type": "structure", "members": { - "InstanceType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "The instance type of the EC2 instance.
" - } - }, "InstanceId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { @@ -3194,10 +3188,10 @@ "smithy.api#required": {} } }, - "WeightedCapacity": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "InstanceType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The number of capacity units contributed by the instance based on its instance\n type.
\nValid Range: Minimum value of 1. Maximum value of 999.
" + "smithy.api#documentation": "The instance type of the EC2 instance.
" } }, "AvailabilityZone": { @@ -3207,6 +3201,13 @@ "smithy.api#required": {} } }, + "LifecycleState": { + "target": "com.amazonaws.autoscaling#LifecycleState", + "traits": { + "smithy.api#documentation": "A description of the current lifecycle state. The Quarantined
state is\n not used.
A description of the current lifecycle state. The Quarantined
state is\n not used.
The launch configuration associated with the instance.
" } }, "LaunchTemplate": { @@ -3234,10 +3234,10 @@ "smithy.api#required": {} } }, - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "WeightedCapacity": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "The launch configuration associated with the instance.
" + "smithy.api#documentation": "The number of capacity units contributed by the instance based on its instance\n type.
\nValid Range: Minimum value of 1. Maximum value of 999.
" } } }, @@ -3294,18 +3294,18 @@ "com.amazonaws.autoscaling#InstanceMetadataOptions": { "type": "structure", "members": { - "HttpPutResponseHopLimit": { - "target": "com.amazonaws.autoscaling#InstanceMetadataHttpPutResponseHopLimit", - "traits": { - "smithy.api#documentation": "The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.
\nDefault: 1
\nPossible values: Integers from 1 to 64
" - } - }, "HttpTokens": { "target": "com.amazonaws.autoscaling#InstanceMetadataHttpTokensState", "traits": { "smithy.api#documentation": "The state of token usage for your instance metadata requests. If the parameter is not\n specified in the request, the default state is optional
.
If the state is optional
, you can choose to retrieve instance metadata\n with or without a signed token header on your request. If you retrieve the IAM role\n credentials without a token, the version 1.0 role credentials are returned. If you\n retrieve the IAM role credentials using a valid signed token, the version 2.0 role\n credentials are returned.
If the state is required
, you must send a signed token header with any\n instance metadata retrieval requests. In this state, retrieving the IAM role credentials\n always returns the version 2.0 credentials; the version 1.0 credentials are not\n available.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the\n number, the further instance metadata requests can travel.
\nDefault: 1
\nPossible values: Integers from 1 to 64
" + } + }, "HttpEndpoint": { "target": "com.amazonaws.autoscaling#InstanceMetadataEndpointState", "traits": { @@ -3340,34 +3340,22 @@ "com.amazonaws.autoscaling#InstanceRefresh": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.autoscaling#InstanceRefreshStatus", - "traits": { - "smithy.api#documentation": "The current status for the instance refresh operation:
\n\n Pending
- The request was created, but the operation has not\n started.
\n InProgress
- The operation is in progress.
\n Successful
- The operation completed successfully.
\n Failed
- The operation failed to complete. You can troubleshoot\n using the status reason and the scaling activities.
\n Cancelling
- An ongoing operation is being cancelled.\n Cancellation does not roll back any replacements that have already been\n completed, but it prevents new replacements from being started.
\n Cancelled
- The operation is cancelled.
The number of instances remaining to update before the instance refresh is\n complete.
" - } - }, "InstanceRefreshId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { "smithy.api#documentation": "The instance refresh ID.
" } }, - "PercentageComplete": { - "target": "com.amazonaws.autoscaling#IntPercent", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The percentage of the instance refresh that is complete. For each instance\n replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the\n instance's health status changes to healthy and the specified warm-up time passes, the\n instance is considered updated and added to the percentage complete.
" + "smithy.api#documentation": "The name of the Auto Scaling group.
" } }, - "EndTime": { - "target": "com.amazonaws.autoscaling#TimestampType", + "Status": { + "target": "com.amazonaws.autoscaling#InstanceRefreshStatus", "traits": { - "smithy.api#documentation": "The date and time at which the instance refresh ended.
" + "smithy.api#documentation": "The current status for the instance refresh operation:
\n\n Pending
- The request was created, but the operation has not\n started.
\n InProgress
- The operation is in progress.
\n Successful
- The operation completed successfully.
\n Failed
- The operation failed to complete. You can troubleshoot\n using the status reason and the scaling activities.
\n Cancelling
- An ongoing operation is being cancelled.\n Cancellation does not roll back any replacements that have already been\n completed, but it prevents new replacements from being started.
\n Cancelled
- The operation is cancelled.
The date and time at which the instance refresh began.
" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "EndTime": { + "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
" + "smithy.api#documentation": "The date and time at which the instance refresh ended.
" + } + }, + "PercentageComplete": { + "target": "com.amazonaws.autoscaling#IntPercent", + "traits": { + "smithy.api#documentation": "The percentage of the instance refresh that is complete. For each instance\n replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the\n instance's health status changes to healthy and the specified warm-up time passes, the\n instance is considered updated and added to the percentage complete.
" + } + }, + "InstancesToUpdate": { + "target": "com.amazonaws.autoscaling#InstancesToUpdate", + "traits": { + "smithy.api#documentation": "The number of instances remaining to update before the instance refresh is\n complete.
" } } }, @@ -3461,42 +3461,42 @@ "OnDemandAllocationStrategy": { "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "Indicates how to allocate instance types to fulfill On-Demand capacity.
\nThe only valid value is prioritized
, which is also the default value.\n This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The\n first instance type in the array is prioritized higher than the last. If all your\n On-Demand capacity cannot be fulfilled using your highest priority instance, then the\n Auto Scaling groups launches the remaining capacity using the second priority instance type, and\n so on.
Indicates how to allocate instance types to fulfill On-Demand capacity. The only valid\n value is prioritized
, which is also the default value. This strategy uses\n the order of instance types in the overrides to define the launch priority of each\n instance type. The first instance type in the array is prioritized higher than the last.\n If all your On-Demand capacity cannot be fulfilled using your highest priority instance,\n then the Auto Scaling groups launches the remaining capacity using the second priority instance\n type, and so on.
The number of Spot Instance pools across which to allocate your Spot Instances. The\n Spot pools are determined from the different instance types in the Overrides array of\n LaunchTemplate. Default if not set is 2.
\nUsed only when the Spot allocation strategy is lowest-price
.
Valid Range: Minimum value of 1. Maximum value of 20.
" + "smithy.api#documentation": "The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand\n Instances. This base portion is provisioned first as your group scales. Defaults to 0 if\n not specified. If you specify weights for the instance types in the overrides, set the\n value of OnDemandBaseCapacity
in terms of the number of capacity units, and\n not the number of instances.
Controls the percentages of On-Demand Instances and Spot Instances for your additional\n capacity beyond OnDemandBaseCapacity
.
Default if not set is 100. If you leave it set to 100, the percentages are 100% for\n On-Demand Instances and 0% for Spot Instances.
\nAn update to this setting means a gradual replacement of instances to maintain the\n percentage of On-Demand Instances for your additional capacity above the base\n capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before\n terminating the old ones.
\nValid Range: Minimum value of 0. Maximum value of 100.
" + "smithy.api#documentation": "Controls the percentages of On-Demand Instances and Spot Instances for your additional\n capacity beyond OnDemandBaseCapacity
. Expressed as a number (for example,\n 20 specifies 20% On-Demand Instances, 80% Spot Instances). Defaults to 100 if not\n specified. If set to 100, only On-Demand Instances are provisioned.
The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand\n Instances. This base portion is provisioned first as your group scales.
\nDefault if not set is 0. If you leave it set to 0, On-Demand Instances are launched as\n a percentage of the Auto Scaling group's desired capacity, per the\n OnDemandPercentageAboveBaseCapacity
setting.
An update to this setting means a gradual replacement of instances to maintain the\n specified number of On-Demand Instances for your base capacity. When replacing\n instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones.
\nIndicates how to allocate instances across Spot Instance pools. If the allocation\n strategy is lowest-price
, the Auto Scaling group launches instances using the Spot\n pools with the lowest price, and evenly allocates your instances across the number of\n Spot pools that you specify. If the allocation strategy is\n capacity-optimized
, the Auto Scaling group launches instances using Spot pools\n that are optimally chosen based on the available Spot capacity. Defaults to\n lowest-price
if not specified.
Indicates how to allocate instances across Spot Instance pools.
\nIf the allocation strategy is lowest-price
, the Auto Scaling group launches\n instances using the Spot pools with the lowest price, and evenly allocates your\n instances across the number of Spot pools that you specify. If the allocation strategy\n is capacity-optimized
, the Auto Scaling group launches instances using Spot pools\n that are optimally chosen based on the available Spot capacity.
The default Spot allocation strategy for calls that you make through the API, the AWS\n CLI, or the AWS SDKs is lowest-price
. The default Spot allocation strategy\n for the AWS Management Console is capacity-optimized
.
Valid values: lowest-price
| capacity-optimized
\n
The number of Spot Instance pools across which to allocate your Spot Instances. The\n Spot pools are determined from the different instance types in the overrides. Defaults\n to 2 if not specified. Valid only when the Spot allocation strategy is\n lowest-price
.
Valid Range: Minimum value of 1. Maximum value of 20.
" } }, "SpotMaxPrice": { "target": "com.amazonaws.autoscaling#MixedInstanceSpotPrice", "traits": { - "smithy.api#documentation": "The maximum price per unit hour that you are willing to pay for a Spot Instance. If\n you leave the value of this parameter blank (which is the default), the maximum Spot\n price is set at the On-Demand price.
\nTo remove a value that you previously set, include the parameter but leave the value\n blank.
" + "smithy.api#documentation": "The maximum price per unit hour that you are willing to pay for a Spot Instance. If\n you leave the value of this parameter blank (which is the default), the maximum Spot\n price is set at the On-Demand price. To remove a value that you previously set, include\n the parameter but leave the value blank.
" } } }, "traits": { - "smithy.api#documentation": "Describes an instances distribution for an Auto Scaling group with a MixedInstancesPolicy.
\nThe instances distribution specifies the distribution of On-Demand Instances and Spot\n Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates\n instance types to fulfill On-Demand and Spot capacity.
\nWhen you update SpotAllocationStrategy
, SpotInstancePools
,\n or SpotMaxPrice
, this update action does not deploy any changes across the\n running Amazon EC2 instances in the group. Your existing Spot Instances continue to run\n as long as the maximum price for those instances is higher than the current Spot price.\n When scale out occurs, Amazon EC2 Auto Scaling launches instances based on the new settings. When scale\n in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination\n policies.
Describes an instances distribution for an Auto Scaling group with a MixedInstancesPolicy.
\nThe instances distribution specifies the distribution of On-Demand Instances and Spot\n Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates\n instance types to fulfill On-Demand and Spot capacities.
\nWhen you update SpotAllocationStrategy
, SpotInstancePools
,\n or SpotMaxPrice
, this update action does not deploy any changes across the\n running Amazon EC2 instances in the group. Your existing Spot Instances continue to run\n as long as the maximum price for those instances is higher than the current Spot price.\n When scale out occurs, Amazon EC2 Auto Scaling launches instances based on the new settings. When scale\n in occurs, Amazon EC2 Auto Scaling terminates instances according to the group's termination\n policies.
The Amazon Resource Name (ARN) of the launch configuration.
" + } + }, + "ImageId": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to.
\nFor more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more\n information, see Finding an AMI in the\n Amazon EC2 User Guide for Linux Instances.
", + "smithy.api#required": {} } }, - "MetadataOptions": { - "target": "com.amazonaws.autoscaling#InstanceMetadataOptions", + "KeyName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The name of the key pair.
\nFor more information, see Amazon EC2 Key Pairs in the\n Amazon EC2 User Guide for Linux Instances.
" } }, "SecurityGroups": { "target": "com.amazonaws.autoscaling#SecurityGroups", "traits": { - "smithy.api#documentation": "A list that contains the security groups to assign to the instances in the Auto Scaling\n group.
\nFor more information, see Security Groups for Your\n VPC in the Amazon Virtual Private Cloud User\n Guide.
" + "smithy.api#documentation": "A list that contains the security groups to assign to the instances in the Auto Scaling group.\n For more information, see Security Groups for Your\n VPC in the Amazon Virtual Private Cloud User\n Guide.
" } }, - "PlacementTenancy": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", + "ClassicLinkVPCId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The tenancy of the instance, either default
or dedicated
. An\n instance with dedicated
tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC.
For more information, see Instance Placement\n Tenancy in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more\n information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic\n instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
" } }, - "ImageId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "ClassicLinkVPCSecurityGroups": { + "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", "traits": { - "smithy.api#documentation": "The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.
\nFor more information, see Finding an AMI in the\n Amazon EC2 User Guide for Linux Instances.
", - "smithy.api#required": {} + "smithy.api#documentation": "The IDs of one or more security groups for the VPC specified in\n ClassicLinkVPCId
.
For more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic instances to a VPC in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "UserData": { "target": "com.amazonaws.autoscaling#XmlStringUserData", "traits": { - "smithy.api#documentation": "The Base64-encoded user data to make available to the launched EC2 instances.
\nFor more information, see Instance Metadata and User\n Data in the Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The Base64-encoded user data to make available to the launched EC2 instances. For more\n information, see Instance metadata and user\n data in the Amazon EC2 User Guide for Linux Instances.
" } }, - "IamInstanceProfile": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen1600", + "InstanceType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role.
\nFor more information, see IAM Role for Applications That Run\n on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The instance type for the instances.
\nFor information about available instance types, see Available\n Instance Types in the Amazon EC2 User Guide for Linux\n Instances.\n
", + "smithy.api#required": {} } }, - "ClassicLinkVPCSecurityGroups": { - "target": "com.amazonaws.autoscaling#ClassicLinkVPCSecurityGroups", + "KernelId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The IDs of one or more security groups for the VPC specified in\n ClassicLinkVPCId
.
For more information, see ClassicLink in the\n Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The ID of the kernel associated with the AMI.
" } }, - "AssociatePublicIpAddress": { - "target": "com.amazonaws.autoscaling#AssociatePublicIpAddress", + "RamdiskId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP\n address to the group's instances.
\nFor more information, see Launching Auto Scaling Instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The ID of the RAM disk associated with the AMI.
" } }, "BlockDeviceMappings": { "target": "com.amazonaws.autoscaling#BlockDeviceMappings", "traits": { - "smithy.api#documentation": "A block device mapping, which specifies the block devices for the instance.
\nFor more information, see Block Device\n Mapping in the Amazon EC2 User Guide for Linux\n Instances.
" - } - }, - "KernelId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "The ID of the kernel associated with the AMI.
" + "smithy.api#documentation": "A block device mapping, which specifies the block devices for the instance. For more\n information, see Block Device\n Mapping in the Amazon EC2 User Guide for Linux\n Instances.
" } }, - "CreatedTime": { - "target": "com.amazonaws.autoscaling#TimestampType", + "InstanceMonitoring": { + "target": "com.amazonaws.autoscaling#InstanceMonitoring", "traits": { - "smithy.api#documentation": "The creation date and time for the launch configuration.
", - "smithy.api#required": {} + "smithy.api#documentation": "Controls whether instances in this group are launched with detailed\n (true
) or basic (false
) monitoring.
For more information, see Configure\n Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.
" } }, - "EbsOptimized": { - "target": "com.amazonaws.autoscaling#EbsOptimized", + "SpotPrice": { + "target": "com.amazonaws.autoscaling#SpotPrice", "traits": { - "smithy.api#documentation": "Specifies whether the launch configuration is optimized for EBS I/O\n (true
) or not (false
).
For more information, see Amazon EBS-Optimized\n Instances in the Amazon EC2 User Guide for Linux\n Instances.
" + "smithy.api#documentation": "The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price. For more information, see Requesting Spot\n Instances in the Amazon EC2 Auto Scaling User Guide.
" } }, - "KeyName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "IamInstanceProfile": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen1600", "traits": { - "smithy.api#documentation": "The name of the key pair.
\nFor more information, see Amazon EC2 Key Pairs in the\n Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The name or the Amazon Resource Name (ARN) of the instance profile associated with the\n IAM role for the instance. The instance profile contains the IAM role. For more\n information, see IAM role for applications that run\n on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide.
" } }, - "InstanceMonitoring": { - "target": "com.amazonaws.autoscaling#InstanceMonitoring", + "CreatedTime": { + "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "Controls whether instances in this group are launched with detailed\n (true
) or basic (false
) monitoring.
For more information, see Configure\n Monitoring for Auto Scaling Instances in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The creation date and time for the launch configuration.
", + "smithy.api#required": {} } }, - "InstanceType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "EbsOptimized": { + "target": "com.amazonaws.autoscaling#EbsOptimized", "traits": { - "smithy.api#documentation": "The instance type for the instances.
\nFor information about available instance types, see Available\n Instance Types in the Amazon EC2 User Guide for Linux\n Instances.\n
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies whether the launch configuration is optimized for EBS I/O\n (true
) or not (false
). For more information, see Amazon\n EBS-Optimized Instances in the Amazon EC2 User Guide for Linux\n Instances.
The Amazon Resource Name (ARN) of the launch configuration.
" + "smithy.api#documentation": "For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP\n address to the group's instances. For more information, see Launching Auto Scaling instances in a\n VPC in the Amazon EC2 Auto Scaling User Guide.
" } }, - "SpotPrice": { - "target": "com.amazonaws.autoscaling#SpotPrice", + "PlacementTenancy": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { - "smithy.api#documentation": "The maximum hourly price to be paid for any Spot Instance launched to fulfill the\n request. Spot Instances are launched when the price you specify exceeds the current Spot\n price.
\nFor more information, see Launching Spot\n Instances in Your Auto Scaling Group in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The tenancy of the instance, either default
or dedicated
. An\n instance with dedicated
tenancy runs on isolated, single-tenant hardware\n and can only be launched into a VPC.
For more information, see Configuring\n instance tenancy with Amazon EC2 Auto Scaling in the\n Amazon EC2 Auto Scaling User Guide.
" } }, - "RamdiskId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "MetadataOptions": { + "target": "com.amazonaws.autoscaling#InstanceMetadataOptions", "traits": { - "smithy.api#documentation": "The ID of the RAM disk associated with the AMI.
" + "smithy.api#documentation": "The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the\n Amazon EC2 Auto Scaling User Guide.
" } } }, @@ -3687,18 +3687,18 @@ "com.amazonaws.autoscaling#LaunchConfigurationNamesType": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" - } - }, "LaunchConfigurationNames": { "target": "com.amazonaws.autoscaling#LaunchConfigurationNames", "traits": { "smithy.api#documentation": "The launch configuration names. If you omit this parameter, all launch configurations\n are described.
" } }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "The token for the next set of items to return. (You received this token from a\n previous call.)
" + } + }, "MaxRecords": { "target": "com.amazonaws.autoscaling#MaxRecords", "traits": { @@ -3716,34 +3716,34 @@ "com.amazonaws.autoscaling#LaunchConfigurationsType": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken
value when requesting the next set of items. This value is\n null when there are no more items to return.
The launch configurations.
", "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken
value when requesting the next set of items. This value is\n null when there are no more items to return.
Any parameters that you specify override the same parameters in the launch template.\n Currently, the only supported override is instance type. You can specify between 1 and\n 20 instance types.
\nIf not provided, Amazon EC2 Auto Scaling will use the instance type specified in the launch template\n to launch instances.
" + "smithy.api#documentation": "The launch template to use.
" } }, - "LaunchTemplateSpecification": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "Overrides": { + "target": "com.amazonaws.autoscaling#Overrides", "traits": { - "smithy.api#documentation": "The launch template to use. You must specify either the launch template ID or launch\n template name in the request.
" + "smithy.api#documentation": "Any parameters that you specify override the same parameters in the launch template.\n Currently, the only supported override is instance type. You can specify between 1 and\n 20 instance types. If not provided, Amazon EC2 Auto Scaling will use the instance type specified in the\n launch template when it launches an instance.
" } } }, @@ -3767,13 +3767,13 @@ "InstanceType": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The instance type. You must use an instance type that is supported in your requested\n Region and Availability Zones.
\nFor information about available instance types, see Available\n Instance Types in the Amazon Elastic Compute Cloud User\n Guide.\n
" + "smithy.api#documentation": "The instance type, such as m3.xlarge
. You must use an instance type that\n is supported in your requested Region and Availability Zones. For information about\n available instance types, see Available\n instance types in the Amazon Elastic Compute Cloud User\n Guide.\n
The number of capacity units, which gives the instance type a proportional weight to\n other instance types. For example, larger instance types are generally weighted more\n than smaller instance types. These are the same units that you chose to set the desired\n capacity in terms of instances, or a performance attribute such as vCPUs, memory, or\n I/O.
\nFor more information, see Instance Weighting for\n Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
\nValid Range: Minimum value of 1. Maximum value of 999.
" + "smithy.api#documentation": "The number of capacity units provided by the specified instance type in terms of\n virtual CPUs, memory, storage, throughput, or other relative performance characteristic.\n When a Spot or On-Demand Instance is provisioned, the capacity units count toward the\n desired capacity. Amazon EC2 Auto Scaling provisions instances until the desired capacity is totally\n fulfilled, even if this results in an overage. For example, if there are 2 units\n remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only provision an instance with a\n WeightedCapacity
of 5 units, the instance is provisioned, and the\n desired capacity is exceeded by 3 units. For more information, see Instance weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Valid Range: Minimum value of 1. Maximum value of 999.
" } } }, @@ -3784,27 +3784,27 @@ "com.amazonaws.autoscaling#LaunchTemplateSpecification": { "type": "structure", "members": { - "LaunchTemplateName": { - "target": "com.amazonaws.autoscaling#LaunchTemplateName", + "LaunchTemplateId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created\n using the Amazon EC2 CreateLaunchTemplate API.
\nYou must specify either a template ID or a template name.
" + "smithy.api#documentation": "The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created\n using the Amazon EC2 CreateLaunchTemplate API. You must specify either a\n LaunchTemplateId
or a LaunchTemplateName
.
The version number, $Latest
, or $Default
. To get the version\n number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions\n can be created using the Amazon EC2 CreateLaunchTemplateVersion API.
If the value is $Latest
, Amazon EC2 Auto Scaling selects the latest version of the\n launch template when launching instances. If the value is $Default
,\n Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances.\n The default value is $Default
.
The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created\n using the Amazon EC2 CreateLaunchTemplate API. You must specify either a\n LaunchTemplateId
or a LaunchTemplateName
.
The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created\n using the Amazon EC2 CreateLaunchTemplate API.
\nYou must specify either a template ID or a template name.
" + "smithy.api#documentation": "The version number, $Latest
, or $Default
. To get the version\n number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions\n can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest
,\n Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If\n the value is $Default
, Amazon EC2 Auto Scaling selects the default version of the launch\n template when launching instances. The default value is $Default
.
Describes the Amazon EC2 launch template and the launch template version that can be used\n by an Auto Scaling group to configure Amazon EC2 instances.
\nThe launch template that is specified must be configured for use with an Auto Scaling group.\n For more information, see Creating a Launch\n Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes the Amazon EC2 launch template and the launch template version that can be used\n by an Auto Scaling group to configure Amazon EC2 instances.
\nThe launch template that is specified must be configured for use with an Auto Scaling group.\n For more information, see Creating a launch\n template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#LifecycleActionResult": { @@ -3822,22 +3822,34 @@ "com.amazonaws.autoscaling#LifecycleHook": { "type": "structure", "members": { + "LifecycleHookName": { + "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", + "traits": { + "smithy.api#documentation": "The name of the lifecycle hook.
" + } + }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the Auto Scaling group for the lifecycle hook.
" + } + }, "LifecycleTransition": { "target": "com.amazonaws.autoscaling#LifecycleTransition", "traits": { "smithy.api#documentation": "The state of the EC2 instance to which to attach the lifecycle hook. The following are\n possible values:
\nautoscaling:EC2_INSTANCE_LAUNCHING
\nautoscaling:EC2_INSTANCE_TERMINATING
\nThe maximum time, in seconds, that can elapse before the lifecycle hook times out. If\n the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the\n DefaultResult
parameter.
The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the\n transition state for the lifecycle hook. The notification target can be either an SQS\n queue or an SNS topic.
" } }, - "NotificationTargetARN": { + "RoleARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the\n transition state for the lifecycle hook. The notification target can be either an SQS\n queue or an SNS topic.
" + "smithy.api#documentation": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target.
" } }, "NotificationMetadata": { @@ -3846,16 +3858,16 @@ "smithy.api#documentation": "Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the\n notification target.
" } }, - "RoleARN": { - "target": "com.amazonaws.autoscaling#ResourceName", + "HeartbeatTimeout": { + "target": "com.amazonaws.autoscaling#HeartbeatTimeout", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target.
" + "smithy.api#documentation": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. If\n the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the\n DefaultResult
parameter.
The name of the Auto Scaling group for the lifecycle hook.
" + "smithy.api#documentation": "The maximum time, in seconds, that an instance can remain in a\n Pending:Wait
or Terminating:Wait
state. The maximum is\n 172800 seconds (48 hours) or 100 times HeartbeatTimeout
, whichever is\n smaller.
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses\n or if an unexpected failure occurs. The possible values are CONTINUE
and\n ABANDON
.
The name of the lifecycle hook.
" - } - }, - "GlobalTimeout": { - "target": "com.amazonaws.autoscaling#GlobalTimeout", - "traits": { - "smithy.api#documentation": "The maximum time, in seconds, that an instance can remain in a\n Pending:Wait
or Terminating:Wait
state. The maximum is\n 172800 seconds (48 hours) or 100 times HeartbeatTimeout
, whichever is\n smaller.
The name of the lifecycle hook.
", + "smithy.api#required": {} + } + }, "LifecycleTransition": { "target": "com.amazonaws.autoscaling#LifecycleTransition", "traits": { @@ -3909,11 +3916,10 @@ "smithy.api#documentation": "Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\n the notification target.
" } }, - "LifecycleHookName": { - "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", + "HeartbeatTimeout": { + "target": "com.amazonaws.autoscaling#HeartbeatTimeout", "traits": { - "smithy.api#documentation": "The name of the lifecycle hook.
", - "smithy.api#required": {} + "smithy.api#documentation": "The maximum time, in seconds, that can elapse before the lifecycle hook times\n out.
\nIf the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in\n the DefaultResult
parameter. You can prevent the lifecycle hook from timing\n out by calling RecordLifecycleActionHeartbeat.
The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
" } - }, - "HeartbeatTimeout": { - "target": "com.amazonaws.autoscaling#HeartbeatTimeout", - "traits": { - "smithy.api#documentation": "The maximum time, in seconds, that can elapse before the lifecycle hook times\n out.
\nIf the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in\n the DefaultResult
parameter. You can prevent the lifecycle hook from timing\n out by calling RecordLifecycleActionHeartbeat.
Describes information used to specify a lifecycle hook for an Auto Scaling\n group.
\nA lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance\n launches (before it is put into service) or as the instance terminates (before it is\n fully terminated).
\nThis step is a part of the procedure for creating a lifecycle hook for an Auto Scaling\n group:
\n(Optional) Create a Lambda function and a rule that allows CloudWatch Events to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to\n publish lifecycle notifications to the target.
\n\n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a pending state.
\nIf you finish before the timeout period ends, complete the lifecycle\n action.
\nFor more information, see Amazon EC2 Auto Scaling Lifecycle\n Hooks in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes information used to specify a lifecycle hook for an Auto Scaling\n group.
\nA lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance\n launches (before it is put into service) or as the instance terminates (before it is\n fully terminated).
\nThis step is a part of the procedure for creating a lifecycle hook for an Auto Scaling\n group:
\n(Optional) Create a Lambda function and a rule that allows CloudWatch Events to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to\n publish lifecycle notifications to the target.
\n\n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a pending state.
\nIf you finish before the timeout period ends, complete the lifecycle\n action.
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#LifecycleHookSpecifications": { @@ -4044,16 +4044,16 @@ "com.amazonaws.autoscaling#LoadBalancerState": { "type": "structure", "members": { - "State": { + "LoadBalancerName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "One of the following load balancer states:
\n\n Adding
- The instances in the group are being registered with the\n load balancer.
\n Added
- All instances in the group are registered with the load\n balancer.
\n InService
- At least one instance in the group passed an ELB\n health check.
\n Removing
- The instances in the group are being deregistered from\n the load balancer. If connection draining is enabled, Elastic Load Balancing\n waits for in-flight requests to complete before deregistering the\n instances.
\n Removed
- All instances in the group are deregistered from the\n load balancer.
The name of the load balancer.
" } }, - "LoadBalancerName": { + "State": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The name of the load balancer.
" + "smithy.api#documentation": "One of the following load balancer states:
\n\n Adding
- The instances in the group are being registered with the\n load balancer.
\n Added
- All instances in the group are registered with the load\n balancer.
\n InService
- At least one instance in the group passed an ELB\n health check.
\n Removing
- The instances in the group are being deregistered from\n the load balancer. If connection draining is enabled, Elastic Load Balancing\n waits for in-flight requests to complete before deregistering the\n instances.
\n Removed
- All instances in the group are deregistered from the\n load balancer.
The instances distribution to use.
\nIf you leave this parameter unspecified, the value for each parameter in\n InstancesDistribution
uses a default value.
Specifies the launch template to use and optionally the instance types (overrides)\n that are used to provision EC2 instances to fulfill On-Demand and Spot capacities.\n Required when creating a mixed instances policy.
" } }, - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplate", + "InstancesDistribution": { + "target": "com.amazonaws.autoscaling#InstancesDistribution", "traits": { - "smithy.api#documentation": "The launch template and instance types (overrides).
\nRequired when creating a mixed instances policy.
" + "smithy.api#documentation": "Specifies the instances distribution. If not provided, the value for each parameter in\n InstancesDistribution
uses a default value.
Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling\n group can provision a combination of On-Demand Instances and Spot Instances across\n multiple instance types. For more information, see Auto Scaling Groups with\n Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User\n Guide.
\nYou can create a mixed instances policy for a new Auto Scaling group, or you can create it for\n an existing group by updating the group to specify MixedInstancesPolicy
as\n the top-level parameter instead of a launch configuration or launch template. For more\n information, see CreateAutoScalingGroup and UpdateAutoScalingGroup.
Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling\n group can provision a combination of On-Demand Instances and Spot Instances across\n multiple instance types. For more information, see Auto Scaling Groups with\n Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User\n Guide.
\nYou can create a mixed instances policy for a new Auto Scaling group, or you can create it for\n an existing group by updating the group to specify MixedInstancesPolicy
as\n the top-level parameter instead of a launch configuration or launch template.
One of the following event notification types:
\n\n autoscaling:EC2_INSTANCE_LAUNCH
\n
\n autoscaling:EC2_INSTANCE_LAUNCH_ERROR
\n
\n autoscaling:EC2_INSTANCE_TERMINATE
\n
\n autoscaling:EC2_INSTANCE_TERMINATE_ERROR
\n
\n autoscaling:TEST_NOTIFICATION
\n
The name of the Auto Scaling group.
" } }, "TopicARN": { @@ -4331,10 +4331,10 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS)\n topic.
" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "NotificationType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
" + "smithy.api#documentation": "One of the following event notification types:
\n\n autoscaling:EC2_INSTANCE_LAUNCH
\n
\n autoscaling:EC2_INSTANCE_LAUNCH_ERROR
\n
\n autoscaling:EC2_INSTANCE_TERMINATE
\n
\n autoscaling:EC2_INSTANCE_TERMINATE_ERROR
\n
\n autoscaling:TEST_NOTIFICATION
\n
Describes a process type.
\nFor more information, see Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes a process type.
\nFor more information, see Scaling processes in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#Processes": { @@ -4534,7 +4534,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a lifecycle hook for the specified Auto Scaling group.
\nA lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance\n launches (before it is put into service) or as the instance terminates (before it is\n fully terminated).
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a Lambda function and a rule that allows CloudWatch Events to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to\n publish lifecycle notifications to the target.
\n\n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a pending state using the RecordLifecycleActionHeartbeat API call.
\nIf you finish before the timeout period ends, complete the lifecycle action\n using the CompleteLifecycleAction API call.
\nFor more information, see Amazon EC2 Auto Scaling Lifecycle\n Hooks in the Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling\n group, the call fails.
\nYou can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle\n hook, you can delete it by calling the DeleteLifecycleHook API.
" + "smithy.api#documentation": "Creates or updates a lifecycle hook for the specified Auto Scaling group.
\nA lifecycle hook tells Amazon EC2 Auto Scaling to perform an action on an instance when the instance\n launches (before it is put into service) or as the instance terminates (before it is\n fully terminated).
\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a Lambda function and a rule that allows CloudWatch Events to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to\n publish lifecycle notifications to the target.
\n\n Create the lifecycle hook. Specify whether the hook is\n used when the instances launch or terminate.\n
\nIf you need more time, record the lifecycle action heartbeat to keep the\n instance in a pending state using the RecordLifecycleActionHeartbeat API call.
\nIf you finish before the timeout period ends, complete the lifecycle action\n using the CompleteLifecycleAction API call.
\nFor more information, see Amazon EC2 Auto Scaling lifecycle\n hooks in the Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling\n group, the call fails.
\nYou can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle\n hook, you can delete it by calling the DeleteLifecycleHook API.
" } }, "com.amazonaws.autoscaling#PutLifecycleHookAnswer": { @@ -4544,22 +4544,11 @@ "com.amazonaws.autoscaling#PutLifecycleHookType": { "type": "structure", "members": { - "LifecycleTransition": { - "target": "com.amazonaws.autoscaling#LifecycleTransition", - "traits": { - "smithy.api#documentation": "The instance state to which you want to attach the lifecycle hook. The valid values\n are:
\nautoscaling:EC2_INSTANCE_LAUNCHING
\nautoscaling:EC2_INSTANCE_TERMINATING
\nRequired for new lifecycle hooks, but optional when updating existing hooks.
" - } - }, - "HeartbeatTimeout": { - "target": "com.amazonaws.autoscaling#HeartbeatTimeout", - "traits": { - "smithy.api#documentation": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The\n range is from 30
to 7200
seconds. The default value is\n 3600
seconds (1 hour).
If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in\n the DefaultResult
parameter. You can prevent the lifecycle hook from timing\n out by calling the RecordLifecycleActionHeartbeat API.
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\n the notification target.
" + "smithy.api#documentation": "The name of the lifecycle hook.
", + "smithy.api#required": {} } }, "AutoScalingGroupName": { @@ -4569,17 +4558,16 @@ "smithy.api#required": {} } }, - "RoleARN": { - "target": "com.amazonaws.autoscaling#ResourceName", + "LifecycleTransition": { + "target": "com.amazonaws.autoscaling#LifecycleTransition", "traits": { - "smithy.api#documentation": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
\nRequired for new lifecycle hooks, but optional when updating existing hooks.
" + "smithy.api#documentation": "The instance state to which you want to attach the lifecycle hook. The valid values\n are:
\nautoscaling:EC2_INSTANCE_LAUNCHING
\nautoscaling:EC2_INSTANCE_TERMINATING
\nRequired for new lifecycle hooks, but optional when updating existing hooks.
" } }, - "LifecycleHookName": { - "target": "com.amazonaws.autoscaling#AsciiStringMaxLen255", + "RoleARN": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "The name of the lifecycle hook.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ARN of the IAM role that allows the Auto Scaling group to publish to the specified\n notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
\nRequired for new lifecycle hooks, but optional when updating existing hooks.
" } }, "NotificationTargetARN": { @@ -4588,6 +4576,18 @@ "smithy.api#documentation": "The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance\n is in the transition state for the lifecycle hook. This target can be either an SQS\n queue or an SNS topic.
\nIf you specify an empty string, this overrides the current ARN.
\nThis operation uses the JSON format when sending notifications to an Amazon SQS queue,\n and an email key-value pair format when sending notifications to an Amazon SNS\n topic.
\nWhen you specify a notification target, Amazon EC2 Auto Scaling sends it a test message. Test\n messages contain the following additional key-value pair: \"Event\":\n \"autoscaling:TEST_NOTIFICATION\"
.
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to\n the notification target.
" + } + }, + "HeartbeatTimeout": { + "target": "com.amazonaws.autoscaling#HeartbeatTimeout", + "traits": { + "smithy.api#documentation": "The maximum time, in seconds, that can elapse before the lifecycle hook times out. The\n range is from 30
to 7200
seconds. The default value is\n 3600
seconds (1 hour).
If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in\n the DefaultResult
parameter. You can prevent the lifecycle hook from timing\n out by calling the RecordLifecycleActionHeartbeat API.
Configures an Auto Scaling group to send notifications when specified events take place.\n Subscribers to the specified topic can have messages delivered to an endpoint such as a\n web server or an email address.
\nThis configuration overwrites any existing configuration.
\nFor more information, see Getting Amazon SNS\n Notifications When Your Auto Scaling Group Scales in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call\n fails.
" + "smithy.api#documentation": "Configures an Auto Scaling group to send notifications when specified events take place.\n Subscribers to the specified topic can have messages delivered to an endpoint such as a\n web server or an email address.
\nThis configuration overwrites any existing configuration.
\nFor more information, see Getting Amazon SNS\n notifications when your Auto Scaling group scales in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call\n fails.
" } }, "com.amazonaws.autoscaling#PutNotificationConfigurationType": { "type": "structure", "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the Auto Scaling group.
", + "smithy.api#required": {} + } + }, "TopicARN": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { @@ -4632,13 +4639,6 @@ "smithy.api#documentation": "The type of event that causes the notification to be sent. To query the notification\n types supported by Amazon EC2 Auto Scaling, call the DescribeAutoScalingNotificationTypes API.
", "smithy.api#required": {} } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
", - "smithy.api#required": {} - } } } }, @@ -4662,40 +4662,36 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a scaling policy for an Auto Scaling group.
\nFor more information about using scaling policies to scale your Auto Scaling group, see Target Tracking Scaling Policies and Step and Simple Scaling\n Policies in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Creates or updates a scaling policy for an Auto Scaling group.
\nFor more information about using scaling policies to scale your Auto Scaling group, see Target tracking scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#PutScalingPolicyType": { "type": "structure", "members": { - "ScalingAdjustment": { - "target": "com.amazonaws.autoscaling#PolicyIncrement", - "traits": { - "smithy.api#documentation": "The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a positive value.
\nRequired if the policy type is SimpleScaling
. (Not used with any other\n policy type.)
A target tracking scaling policy. Includes support for predefined or customized\n metrics.
\nThe following predefined metrics are available:
\n\n ASGAverageCPUUtilization
\n
\n ASGAverageNetworkIn
\n
\n ASGAverageNetworkOut
\n
\n ALBRequestCountPerTarget
\n
If you specify ALBRequestCountPerTarget
for the metric, you must specify\n the ResourceLabel
parameter with the\n PredefinedMetricSpecification
.
For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.
\nRequired if the policy type is TargetTrackingScaling
.
The name of the Auto Scaling group.
", + "smithy.api#required": {} } }, - "AdjustmentType": { + "PolicyName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity
,\n ExactCapacity
, and PercentChangeInCapacity
.
Required if the policy type is StepScaling
or SimpleScaling
.\n For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User Guide.
The name of the policy.
", + "smithy.api#required": {} } }, - "EstimatedInstanceWarmup": { - "target": "com.amazonaws.autoscaling#EstimatedInstanceWarmup", + "PolicyType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { - "smithy.api#documentation": "The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics. If not provided, the default is to use the value from the default cooldown\n period for the Auto Scaling group.
\nValid only if the policy type is TargetTrackingScaling
or\n StepScaling
.
One of the following policy types:
\n\n TargetTrackingScaling
\n
\n StepScaling
\n
\n SimpleScaling
(default)
Indicates whether the scaling policy is enabled or disabled. The default is enabled.\n For more information, see Disabling a\n Scaling Policy for an Auto Scaling Group in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity
,\n ExactCapacity
, and PercentChangeInCapacity
.
Required if the policy type is StepScaling
or SimpleScaling
.\n For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User Guide.
Available for backward compatibility. Use MinAdjustmentMagnitude
\n instead.
The name of the policy.
", - "smithy.api#required": {} + "smithy.api#documentation": "The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity
. For example, suppose that you create a step\n scaling policy to scale out an Auto Scaling group by 25 percent and you specify a\n MinAdjustmentMagnitude
of 2. If the group has 4 instances and the\n scaling policy is performed, 25 percent of 4 is 1. However, because you specified a\n MinAdjustmentMagnitude
of 2, Amazon EC2 Auto Scaling scales out the group by 2\n instances.
Valid only if the policy type is StepScaling
or\n SimpleScaling
. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User\n Guide.
Some Auto Scaling groups use instance weights. In this case, set the\n MinAdjustmentMagnitude
to a value that is at least as large as your\n largest instance weight.
The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity
. For example, suppose that you create a step\n scaling policy to scale out an Auto Scaling group by 25 percent and you specify a\n MinAdjustmentMagnitude
of 2. If the group has 4 instances and the\n scaling policy is performed, 25 percent of 4 is 1. However, because you specified a\n MinAdjustmentMagnitude
of 2, Amazon EC2 Auto Scaling scales out the group by 2\n instances.
Valid only if the policy type is StepScaling
or\n SimpleScaling
. For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User\n Guide.
Some Auto Scaling groups use instance weights. In this case, set the\n MinAdjustmentMagnitude
to a value that is at least as large as your\n largest instance weight.
The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current capacity.\n For exact capacity, you must specify a positive value.
\nRequired if the policy type is SimpleScaling
. (Not used with any other\n policy type.)
The name of the Auto Scaling group.
", - "smithy.api#required": {} + "smithy.api#documentation": "The duration of the policy's cooldown period, in seconds. When a cooldown period is\n specified here, it overrides the default cooldown period defined for the Auto Scaling\n group.
\nValid only if the policy type is SimpleScaling
. For more information, see\n Scaling\n cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
The aggregation type for the CloudWatch metrics. The valid values are Minimum
,\n Maximum
, and Average
. If the aggregation type is null, the\n value is treated as Average
.
Valid only if the policy type is StepScaling
.
A set of adjustments that enable you to scale based on the size of the alarm\n breach.
\nRequired if the policy type is StepScaling
. (Not used with any other\n policy type.)
One of the following policy types:
\n\n TargetTrackingScaling
\n
\n StepScaling
\n
\n SimpleScaling
(default)
The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics. If not provided, the default is to use the value from the default cooldown\n period for the Auto Scaling group.
\nValid only if the policy type is TargetTrackingScaling
or\n StepScaling
.
The duration of the policy's cooldown period, in seconds. When a cooldown period is\n specified here, it overrides the default cooldown period defined for the Auto Scaling\n group.
\nValid only if the policy type is SimpleScaling
. For more information, see\n Scaling\n Cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
A target tracking scaling policy. Includes support for predefined or customized\n metrics.
\nThe following predefined metrics are available:
\n\n ASGAverageCPUUtilization
\n
\n ASGAverageNetworkIn
\n
\n ASGAverageNetworkOut
\n
\n ALBRequestCountPerTarget
\n
If you specify ALBRequestCountPerTarget
for the metric, you must specify\n the ResourceLabel
parameter with the\n PredefinedMetricSpecification
.
For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API\n Reference.
\nRequired if the policy type is TargetTrackingScaling
.
The aggregation type for the CloudWatch metrics. The valid values are Minimum
,\n Maximum
, and Average
. If the aggregation type is null, the\n value is treated as Average
.
Valid only if the policy type is StepScaling
.
Indicates whether the scaling policy is enabled or disabled. The default is enabled.\n For more information, see Disabling a\n scaling policy for an Auto Scaling group in the\n Amazon EC2 Auto Scaling User Guide.
" } } } @@ -4767,35 +4767,36 @@ } ], "traits": { - "smithy.api#documentation": "Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a\n parameter unspecified when updating a scheduled scaling action, the corresponding value\n remains unchanged.
\nFor more information, see Scheduled Scaling in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a\n parameter unspecified when updating a scheduled scaling action, the corresponding value\n remains unchanged.
\nFor more information, see Scheduled scaling in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#PutScheduledUpdateGroupActionType": { "type": "structure", "members": { - "Time": { - "target": "com.amazonaws.autoscaling#TimestampType", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "This parameter is no longer used.
" + "smithy.api#documentation": "The name of the Auto Scaling group.
", + "smithy.api#required": {} } }, - "MinSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", + "ScheduledActionName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The minimum size of the Auto Scaling group.
" + "smithy.api#documentation": "The name of this scaling action.
", + "smithy.api#required": {} } }, - "StartTime": { + "Time": { "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2019-06-01T00:00:00Z\"
).
If you specify Recurrence
and StartTime
, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.
If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.
" + "smithy.api#documentation": "This parameter is no longer used.
" } }, - "ScheduledActionName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "StartTime": { + "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "The name of this scaling action.
", - "smithy.api#required": {} + "smithy.api#documentation": "The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2019-06-01T00:00:00Z\"
).
If you specify Recurrence
and StartTime
, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.
If you try to schedule your action in the past, Amazon EC2 Auto Scaling returns an error\n message.
" } }, "EndTime": { @@ -4804,11 +4805,16 @@ "smithy.api#documentation": "The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the\n action after this time.
" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "Recurrence": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
", - "smithy.api#required": {} + "smithy.api#documentation": "The recurring schedule for this action, in Unix cron syntax format. This format\n consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]\n [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1\n 1,6,12 *\"
). For more information about this format, see Crontab.
When StartTime
and EndTime
are specified with\n Recurrence
, they form the boundaries of when the recurring action\n starts and stops.
The minimum size of the Auto Scaling group.
" } }, "MaxSize": { @@ -4822,12 +4828,6 @@ "traits": { "smithy.api#documentation": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain. It can scale beyond this capacity\n if you add more scaling conditions.
" } - }, - "Recurrence": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "The recurring schedule for this action, in Unix cron syntax format. This format\n consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]\n [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1\n 1,6,12 *\"
). For more information about this format, see Crontab.
When StartTime
and EndTime
are specified with\n Recurrence
, they form the boundaries of when the recurring action\n starts and stops.
Records a heartbeat for the lifecycle action associated with the specified token or\n instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.
\n\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a Lambda function and a rule that allows CloudWatch Events to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to\n publish lifecycle notifications to the target.
\nCreate the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.
\n\n If you need more time, record the lifecycle action\n heartbeat to keep the instance in a pending state.\n
\nIf you finish before the timeout period ends, complete the lifecycle\n action.
\nFor more information, see Auto Scaling\n Lifecycle in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Records a heartbeat for the lifecycle action associated with the specified token or\n instance. This extends the timeout by the length of time defined using the PutLifecycleHook API call.
\n\nThis step is a part of the procedure for adding a lifecycle hook to an Auto Scaling\n group:
\n(Optional) Create a Lambda function and a rule that allows CloudWatch Events to\n invoke your Lambda function when Amazon EC2 Auto Scaling launches or terminates\n instances.
\n(Optional) Create a notification target and an IAM role. The target can be\n either an Amazon SQS queue or an Amazon SNS topic. The role allows Amazon EC2 Auto Scaling to\n publish lifecycle notifications to the target.
\nCreate the lifecycle hook. Specify whether the hook is used when the instances\n launch or terminate.
\n\n If you need more time, record the lifecycle action\n heartbeat to keep the instance in a pending state.\n
\nIf you finish before the timeout period ends, complete the lifecycle\n action.
\nFor more information, see Auto Scaling\n lifecycle in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#RecordLifecycleActionHeartbeatAnswer": { @@ -4862,6 +4862,13 @@ "smithy.api#required": {} } }, + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the Auto Scaling group.
", + "smithy.api#required": {} + } + }, "LifecycleActionToken": { "target": "com.amazonaws.autoscaling#LifecycleActionToken", "traits": { @@ -4873,13 +4880,6 @@ "traits": { "smithy.api#documentation": "The ID of the instance.
" } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
", - "smithy.api#required": {} - } } } }, @@ -4895,17 +4895,17 @@ "com.amazonaws.autoscaling#RefreshPreferences": { "type": "structure", "members": { - "InstanceWarmup": { - "target": "com.amazonaws.autoscaling#RefreshInstanceWarmup", - "traits": { - "smithy.api#documentation": "The number of seconds until a newly launched instance is configured and ready to use.\n During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The\n default is to use the value for the health check grace period defined for the\n group.
" - } - }, "MinHealthyPercentage": { "target": "com.amazonaws.autoscaling#IntPercent", "traits": { "smithy.api#documentation": "The amount of capacity in the Auto Scaling group that must remain healthy during an instance\n refresh to allow the operation to continue, as a percentage of the desired capacity of\n the Auto Scaling group (rounded up to the nearest integer). The default is 90
.\n
The number of seconds until a newly launched instance is configured and ready to use.\n During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The\n default is to use the value for the health check grace period defined for the\n group.
" + } } }, "traits": { @@ -4979,7 +4979,7 @@ } ], "traits": { - "smithy.api#documentation": "Resumes the specified suspended automatic scaling processes, or all suspended process,\n for the specified Auto Scaling group.
\nFor more information, see Suspending and\n Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Resumes the specified suspended auto scaling processes, or all suspended process, for\n the specified Auto Scaling group.
\nFor more information, see Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#ScalingActivityInProgressFault": { @@ -5062,40 +5062,40 @@ "com.amazonaws.autoscaling#ScalingPolicy": { "type": "structure", "members": { - "Alarms": { - "target": "com.amazonaws.autoscaling#Alarms", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The CloudWatch alarms related to the policy.
" + "smithy.api#documentation": "The name of the Auto Scaling group.
" } }, - "EstimatedInstanceWarmup": { - "target": "com.amazonaws.autoscaling#EstimatedInstanceWarmup", + "PolicyName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics.
" + "smithy.api#documentation": "The name of the scaling policy.
" } }, - "AdjustmentType": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "PolicyARN": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity
,\n ExactCapacity
, and PercentChangeInCapacity
.
The Amazon Resource Name (ARN) of the policy.
" } }, - "ScalingAdjustment": { - "target": "com.amazonaws.autoscaling#PolicyIncrement", + "PolicyType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen64", "traits": { - "smithy.api#documentation": "The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity.
" + "smithy.api#documentation": "One of the following policy types:
\n\n TargetTrackingScaling
\n
\n StepScaling
\n
\n SimpleScaling
(default)
For more information, see Target tracking\n scaling policies and Step and simple scaling\n policies in the Amazon EC2 Auto Scaling User Guide.
" } }, - "MinAdjustmentStep": { - "target": "com.amazonaws.autoscaling#MinAdjustmentStep", + "AdjustmentType": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "Available for backward compatibility. Use MinAdjustmentMagnitude
\n instead.
Specifies how the scaling adjustment is interpreted (for example, an absolute number\n or a percentage). The valid values are ChangeInCapacity
,\n ExactCapacity
, and PercentChangeInCapacity
.
Indicates whether the policy is enabled (true
) or disabled\n (false
).
Available for backward compatibility. Use MinAdjustmentMagnitude
\n instead.
The minimum value to scale by when the adjustment type is\n PercentChangeInCapacity
.
The name of the scaling policy.
" - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "ScalingAdjustment": { + "target": "com.amazonaws.autoscaling#PolicyIncrement", "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
" + "smithy.api#documentation": "The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity.
" } }, - "PolicyARN": { - "target": "com.amazonaws.autoscaling#ResourceName", + "Cooldown": { + "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the policy.
" + "smithy.api#documentation": "The duration of the policy's cooldown period, in seconds.
" } }, - "TargetTrackingConfiguration": { - "target": "com.amazonaws.autoscaling#TargetTrackingConfiguration", + "StepAdjustments": { + "target": "com.amazonaws.autoscaling#StepAdjustments", "traits": { - "smithy.api#documentation": "A target tracking scaling policy.
" + "smithy.api#documentation": "A set of adjustments that enable you to scale based on the size of the alarm\n breach.
" } }, "MetricAggregationType": { @@ -5134,22 +5128,28 @@ "smithy.api#documentation": "The aggregation type for the CloudWatch metrics. The valid values are Minimum
,\n Maximum
, and Average
.
One of the following policy types:
\n\n TargetTrackingScaling
\n
\n StepScaling
\n
\n SimpleScaling
(default)
For more information, see Target Tracking\n Scaling Policies and Step and Simple Scaling\n Policies in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The estimated time, in seconds, until a newly launched instance can contribute to the\n CloudWatch metrics.
" } }, - "StepAdjustments": { - "target": "com.amazonaws.autoscaling#StepAdjustments", + "Alarms": { + "target": "com.amazonaws.autoscaling#Alarms", "traits": { - "smithy.api#documentation": "A set of adjustments that enable you to scale based on the size of the alarm\n breach.
" + "smithy.api#documentation": "The CloudWatch alarms related to the policy.
" } }, - "Cooldown": { - "target": "com.amazonaws.autoscaling#Cooldown", + "TargetTrackingConfiguration": { + "target": "com.amazonaws.autoscaling#TargetTrackingConfiguration", "traits": { - "smithy.api#documentation": "The duration of the policy's cooldown period, in seconds.
" + "smithy.api#documentation": "A target tracking scaling policy.
" + } + }, + "Enabled": { + "target": "com.amazonaws.autoscaling#ScalingPolicyEnabled", + "traits": { + "smithy.api#documentation": "Indicates whether the policy is enabled (true
) or disabled\n (false
).
One or more of the following processes:
\n\n Launch
\n
\n Terminate
\n
\n AddToLoadBalancer
\n
\n AlarmNotification
\n
\n AZRebalance
\n
\n HealthCheck
\n
\n InstanceRefresh
\n
\n ReplaceUnhealthy
\n
\n ScheduledActions
\n
If you omit this parameter, all processes are specified.
" - } - }, "AutoScalingGroupName": { "target": "com.amazonaws.autoscaling#ResourceName", "traits": { "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } + }, + "ScalingProcesses": { + "target": "com.amazonaws.autoscaling#ProcessNames", + "traits": { + "smithy.api#documentation": "One or more of the following processes:
\n\n Launch
\n
\n Terminate
\n
\n AddToLoadBalancer
\n
\n AlarmNotification
\n
\n AZRebalance
\n
\n HealthCheck
\n
\n InstanceRefresh
\n
\n ReplaceUnhealthy
\n
\n ScheduledActions
\n
If you omit this parameter, all processes are specified.
" + } } } }, @@ -5190,23 +5190,29 @@ "com.amazonaws.autoscaling#ScheduledActionsType": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken
value when requesting the next set of items. This value is\n null when there are no more items to return.
The scheduled actions.
" } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken
value when requesting the next set of items. This value is\n null when there are no more items to return.
The name of the Auto Scaling group.
" + } + }, "ScheduledActionName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { @@ -5219,28 +5225,10 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the scheduled action.
" } }, - "MaxSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", - "traits": { - "smithy.api#documentation": "The maximum size of the Auto Scaling group.
" - } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
" - } - }, - "Recurrence": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "The recurring schedule for the action, in Unix cron syntax format.
\nWhen StartTime
and EndTime
are specified with\n Recurrence
, they form the boundaries of when the recurring action\n starts and stops.
The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain.
" + "smithy.api#documentation": "This parameter is no longer used.
" } }, "StartTime": { @@ -5255,10 +5243,10 @@ "smithy.api#documentation": "The date and time in UTC for the recurring schedule to end. For example,\n \"2019-06-01T00:00:00Z\"
.\n
This parameter is no longer used.
" + "smithy.api#documentation": "The recurring schedule for the action, in Unix cron syntax format.
\nWhen StartTime
and EndTime
are specified with\n Recurrence
, they form the boundaries of when the recurring action\n starts and stops.
The minimum size of the Auto Scaling group.
" } + }, + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "traits": { + "smithy.api#documentation": "The maximum size of the Auto Scaling group.
" + } + }, + "DesiredCapacity": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", + "traits": { + "smithy.api#documentation": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled\n action runs and the capacity it attempts to maintain.
" + } } }, "traits": { @@ -5273,20 +5273,8 @@ } }, "com.amazonaws.autoscaling#ScheduledUpdateGroupActionRequest": { - "type": "structure", - "members": { - "MinSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", - "traits": { - "smithy.api#documentation": "The minimum size of the Auto Scaling group.
" - } - }, - "StartTime": { - "target": "com.amazonaws.autoscaling#TimestampType", - "traits": { - "smithy.api#documentation": "The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2019-06-01T00:00:00Z\"
).
If you specify Recurrence
and StartTime
, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.
If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error\n message.
" - } - }, + "type": "structure", + "members": { "ScheduledActionName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { @@ -5294,10 +5282,10 @@ "smithy.api#required": {} } }, - "MaxSize": { - "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "StartTime": { + "target": "com.amazonaws.autoscaling#TimestampType", "traits": { - "smithy.api#documentation": "The maximum size of the Auto Scaling group.
" + "smithy.api#documentation": "The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT\n only and in quotes (for example, \"2019-06-01T00:00:00Z\"
).
If you specify Recurrence
and StartTime
, Amazon EC2 Auto Scaling performs\n the action at this time, and then performs the action based on the specified\n recurrence.
If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error\n message.
" } }, "EndTime": { @@ -5312,6 +5300,18 @@ "smithy.api#documentation": "The recurring schedule for the action, in Unix cron syntax format. This format\n consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]\n [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, \"30 0 1\n 1,6,12 *\"
). For more information about this format, see Crontab.
When StartTime
and EndTime
are specified with\n Recurrence
, they form the boundaries of when the recurring action\n starts and stops.
The minimum size of the Auto Scaling group.
" + } + }, + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", + "traits": { + "smithy.api#documentation": "The maximum size of the Auto Scaling group.
" + } + }, "DesiredCapacity": { "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", "traits": { @@ -5368,12 +5368,19 @@ } ], "traits": { - "smithy.api#documentation": "Sets the size of the specified Auto Scaling group.
\nIf a scale-in activity occurs as a result of a new DesiredCapacity
value\n that is lower than the current size of the group, the Auto Scaling group uses its termination\n policy to determine which instances to terminate.
For more information, see Manual Scaling in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Sets the size of the specified Auto Scaling group.
\nIf a scale-in activity occurs as a result of a new DesiredCapacity
value\n that is lower than the current size of the group, the Auto Scaling group uses its termination\n policy to determine which instances to terminate.
For more information, see Manual scaling in the\n Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#SetDesiredCapacityType": { "type": "structure", "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", + "traits": { + "smithy.api#documentation": "The name of the Auto Scaling group.
", + "smithy.api#required": {} + } + }, "DesiredCapacity": { "target": "com.amazonaws.autoscaling#AutoScalingGroupDesiredCapacity", "traits": { @@ -5386,13 +5393,6 @@ "traits": { "smithy.api#documentation": "Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before initiating\n a scaling activity to set your Auto Scaling group to its new capacity. By default, Amazon EC2 Auto Scaling does\n not honor the cooldown period during manual scaling activities.
" } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", - "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
", - "smithy.api#required": {} - } } } }, @@ -5407,23 +5407,23 @@ } ], "traits": { - "smithy.api#documentation": "Sets the health status of the specified instance.
\nFor more information, see Health Checks for Auto Scaling\n Instances in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Sets the health status of the specified instance.
\nFor more information, see Health checks for Auto Scaling\n instances in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#SetInstanceHealthQuery": { "type": "structure", "members": { - "HealthStatus": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", + "InstanceId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { - "smithy.api#documentation": "The health status of the instance. Set to Healthy
to have the instance\n remain in service. Set to Unhealthy
to have the instance be out of service.\n Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.
The ID of the instance.
", "smithy.api#required": {} } }, - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "HealthStatus": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen32", "traits": { - "smithy.api#documentation": "The ID of the instance.
", + "smithy.api#documentation": "The health status of the instance. Set to Healthy
to have the instance\n remain in service. Set to Unhealthy
to have the instance be out of service.\n Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.
Updates the instance protection settings of the specified instances.
\nFor more information about preventing instances that are part of an Auto Scaling group from\n terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call\n fails.
" + "smithy.api#documentation": "Updates the instance protection settings of the specified instances.
\nFor more information about preventing instances that are part of an Auto Scaling group from\n terminating on scale in, see Instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
\nIf you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call\n fails.
" } }, "com.amazonaws.autoscaling#SetInstanceProtectionAnswer": { @@ -5465,21 +5465,21 @@ "InstanceIds": { "target": "com.amazonaws.autoscaling#InstanceIds", "traits": { - "smithy.api#documentation": "One or more instance IDs.
", + "smithy.api#documentation": "One or more instance IDs. You can specify up to 50 instances.
", "smithy.api#required": {} } }, - "ProtectedFromScaleIn": { - "target": "com.amazonaws.autoscaling#ProtectedFromScaleIn", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.
", + "smithy.api#documentation": "The name of the Auto Scaling group.
", "smithy.api#required": {} } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "ProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#ProtectedFromScaleIn", "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
", + "smithy.api#documentation": "Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling\n in.
", "smithy.api#required": {} } } @@ -5549,6 +5549,13 @@ "com.amazonaws.autoscaling#StartInstanceRefreshType": { "type": "structure", "members": { + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "traits": { + "smithy.api#documentation": "The name of the Auto Scaling group.
", + "smithy.api#required": {} + } + }, "Strategy": { "target": "com.amazonaws.autoscaling#RefreshStrategy", "traits": { @@ -5560,13 +5567,6 @@ "traits": { "smithy.api#documentation": "Set of preferences associated with the instance refresh request.
\nIf not provided, the default values are used. For MinHealthyPercentage
,\n the default value is 90
. For InstanceWarmup
, the default is to\n use the value specified for the health check grace period for the Auto Scaling group.
For more information, see RefreshPreferences in the Amazon EC2 Auto Scaling API\n Reference.
" } - }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", - "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
", - "smithy.api#required": {} - } } } }, @@ -5579,22 +5579,22 @@ "smithy.api#documentation": "The lower bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the lower bound is inclusive (the metric\n must be greater than or equal to the threshold plus the lower bound). Otherwise, it is\n exclusive (the metric must be greater than the threshold plus the lower bound). A null\n value indicates negative infinity.
" } }, + "MetricIntervalUpperBound": { + "target": "com.amazonaws.autoscaling#MetricScale", + "traits": { + "smithy.api#documentation": "The upper bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the upper bound is exclusive (the metric\n must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the\n metric must be less than or equal to the threshold plus the upper bound). A null value\n indicates positive infinity.
\nThe upper bound must be greater than the lower bound.
" + } + }, "ScalingAdjustment": { "target": "com.amazonaws.autoscaling#PolicyIncrement", "traits": { "smithy.api#documentation": "The amount by which to scale, based on the specified adjustment type. A positive value\n adds to the current capacity while a negative number removes from the current\n capacity.
", "smithy.api#required": {} } - }, - "MetricIntervalUpperBound": { - "target": "com.amazonaws.autoscaling#MetricScale", - "traits": { - "smithy.api#documentation": "The upper bound for the difference between the alarm threshold and the CloudWatch metric. If\n the metric value is above the breach threshold, the upper bound is exclusive (the metric\n must be less than the threshold plus the upper bound). Otherwise, it is inclusive (the\n metric must be less than or equal to the threshold plus the upper bound). A null value\n indicates positive infinity.
\nThe upper bound must be greater than the lower bound.
" - } } }, "traits": { - "smithy.api#documentation": "Describes information used to create a step adjustment for a step scaling\n policy.
\nFor the following examples, suppose that you have an alarm with a breach threshold of\n 50:
\nTo trigger the adjustment when the metric is greater than or equal to 50 and\n less than 60, specify a lower bound of 0 and an upper bound of 10.
\nTo trigger the adjustment when the metric is greater than 40 and less than or\n equal to 50, specify a lower bound of -10 and an upper bound of 0.
\nThere are a few rules for the step adjustments for your step policy:
\nThe ranges of your step adjustments can't overlap or have a gap.
\nAt most, one step adjustment can have a null lower bound. If one step\n adjustment has a negative lower bound, then there must be a step adjustment with\n a null lower bound.
\nAt most, one step adjustment can have a null upper bound. If one step\n adjustment has a positive upper bound, then there must be a step adjustment with\n a null upper bound.
\nThe upper and lower bound can't be null in the same step adjustment.
\nFor more information, see Step\n Adjustments in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes information used to create a step adjustment for a step scaling\n policy.
\nFor the following examples, suppose that you have an alarm with a breach threshold of\n 50:
\nTo trigger the adjustment when the metric is greater than or equal to 50 and\n less than 60, specify a lower bound of 0 and an upper bound of 10.
\nTo trigger the adjustment when the metric is greater than 40 and less than or\n equal to 50, specify a lower bound of -10 and an upper bound of 0.
\nThere are a few rules for the step adjustments for your step policy:
\nThe ranges of your step adjustments can't overlap or have a gap.
\nAt most, one step adjustment can have a null lower bound. If one step\n adjustment has a negative lower bound, then there must be a step adjustment with\n a null lower bound.
\nAt most, one step adjustment can have a null upper bound. If one step\n adjustment has a positive upper bound, then there must be a step adjustment with\n a null upper bound.
\nThe upper and lower bound can't be null in the same step adjustment.
\nFor more information, see Step\n adjustments in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#StepAdjustments": { @@ -5617,27 +5617,27 @@ } ], "traits": { - "smithy.api#documentation": "Suspends the specified automatic scaling processes, or all processes, for the\n specified Auto Scaling group.
\nIf you suspend either the Launch
or Terminate
process types,\n it can prevent other process types from functioning properly. For more information, see\n Suspending and\n Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
To resume processes that have been suspended, call the ResumeProcesses API.
" + "smithy.api#documentation": "Suspends the specified auto scaling processes, or all processes, for the specified\n Auto Scaling group.
\nIf you suspend either the Launch
or Terminate
process types,\n it can prevent other process types from functioning properly. For more information, see\n Suspending and\n resuming scaling processes in the Amazon EC2 Auto Scaling User Guide.
To resume processes that have been suspended, call the ResumeProcesses API.
" } }, "com.amazonaws.autoscaling#SuspendedProcess": { "type": "structure", "members": { - "SuspensionReason": { + "ProcessName": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The reason that the process was suspended.
" + "smithy.api#documentation": "The name of the suspended process.
" } }, - "ProcessName": { + "SuspensionReason": { "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", "traits": { - "smithy.api#documentation": "The name of the suspended process.
" + "smithy.api#documentation": "The reason that the process was suspended.
" } } }, "traits": { - "smithy.api#documentation": "Describes an automatic scaling process that has been suspended.
\nFor more information, see Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Describes an auto scaling process that has been suspended.
\nFor more information, see Scaling processes in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#SuspendedProcesses": { @@ -5655,6 +5655,12 @@ "smithy.api#documentation": "The name of the group.
" } }, + "ResourceType": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "The type of resource. The only supported value is\n auto-scaling-group
.
Determines whether the tag is added to new instances as they are launched in the\n group.
" - } - }, "Value": { "target": "com.amazonaws.autoscaling#TagValue", "traits": { "smithy.api#documentation": "The tag value.
" } }, - "ResourceType": { - "target": "com.amazonaws.autoscaling#XmlString", + "PropagateAtLaunch": { + "target": "com.amazonaws.autoscaling#PropagateAtLaunch", "traits": { - "smithy.api#documentation": "The type of resource. The only supported value is\n auto-scaling-group
.
Determines whether the tag is added to new instances as they are launched in the\n group.
" } } }, @@ -5688,34 +5688,34 @@ "com.amazonaws.autoscaling#TagDescription": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.autoscaling#TagValue", + "ResourceId": { + "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "The tag value.
" + "smithy.api#documentation": "The name of the group.
" } }, - "Key": { - "target": "com.amazonaws.autoscaling#TagKey", + "ResourceType": { + "target": "com.amazonaws.autoscaling#XmlString", "traits": { - "smithy.api#documentation": "The tag key.
" + "smithy.api#documentation": "The type of resource. The only supported value is\n auto-scaling-group
.
Determines whether the tag is added to new instances as they are launched in the\n group.
" + "smithy.api#documentation": "The tag key.
" } }, - "ResourceId": { - "target": "com.amazonaws.autoscaling#XmlString", + "Value": { + "target": "com.amazonaws.autoscaling#TagValue", "traits": { - "smithy.api#documentation": "The name of the group.
" + "smithy.api#documentation": "The tag value.
" } }, - "ResourceType": { - "target": "com.amazonaws.autoscaling#XmlString", + "PropagateAtLaunch": { + "target": "com.amazonaws.autoscaling#PropagateAtLaunch", "traits": { - "smithy.api#documentation": "The type of resource. The only supported value is\n auto-scaling-group
.
Determines whether the tag is added to new instances as they are launched in the\n group.
" } } }, @@ -5758,17 +5758,17 @@ "com.amazonaws.autoscaling#TagsType": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.autoscaling#XmlString", - "traits": { - "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken
value when requesting the next set of items. This value is\n null when there are no more items to return.
One or more tags.
" } + }, + "NextToken": { + "target": "com.amazonaws.autoscaling#XmlString", + "traits": { + "smithy.api#documentation": "A string that indicates that the response contains more items than can be returned in\n a single response. To receive additional items, specify this string for the\n NextToken
value when requesting the next set of items. This value is\n null when there are no more items to return.
A predefined metric. You must specify either a predefined metric or a customized\n metric.
" } }, - "DisableScaleIn": { - "target": "com.amazonaws.autoscaling#DisableScaleIn", + "CustomizedMetricSpecification": { + "target": "com.amazonaws.autoscaling#CustomizedMetricSpecification", "traits": { - "smithy.api#documentation": "Indicates whether scaling in by the target tracking scaling policy is disabled. If\n scaling in is disabled, the target tracking scaling policy doesn't remove instances from\n the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from\n the Auto Scaling group. The default is false
.
A customized metric. You must specify either a predefined metric or a customized\n metric.
" } }, "TargetValue": { @@ -5800,10 +5800,10 @@ "smithy.api#required": {} } }, - "CustomizedMetricSpecification": { - "target": "com.amazonaws.autoscaling#CustomizedMetricSpecification", + "DisableScaleIn": { + "target": "com.amazonaws.autoscaling#DisableScaleIn", "traits": { - "smithy.api#documentation": "A customized metric. You must specify either a predefined metric or a customized\n metric.
" + "smithy.api#documentation": "Indicates whether scaling in by the target tracking scaling policy is disabled. If\n scaling in is disabled, the target tracking scaling policy doesn't remove instances from\n the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from\n the Auto Scaling group. The default is false
.
Terminates the specified instance and optionally adjusts the desired group size.
\nThis call simply makes a termination request. The instance is not terminated\n immediately. When an instance is terminated, the instance status changes to\n terminated
. You can't connect to or start an instance after you've\n terminated it.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are terminated.
\nBy default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you\n decrement the desired capacity, your Auto Scaling group can become unbalanced between\n Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might\n terminate instances in other zones. For more information, see Rebalancing Activities in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Terminates the specified instance and optionally adjusts the desired group size.
\nThis call simply makes a termination request. The instance is not terminated\n immediately. When an instance is terminated, the instance status changes to\n terminated
. You can't connect to or start an instance after you've\n terminated it.
If you do not specify the option to decrement the desired capacity, Amazon EC2 Auto Scaling launches\n instances to replace the ones that are terminated.
\nBy default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you\n decrement the desired capacity, your Auto Scaling group can become unbalanced between\n Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might\n terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide.
" } }, "com.amazonaws.autoscaling#TerminateInstanceInAutoScalingGroupType": { "type": "structure", "members": { - "ShouldDecrementDesiredCapacity": { - "target": "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity", + "InstanceId": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", "traits": { - "smithy.api#documentation": "Indicates whether terminating the instance also decrements the size of the Auto Scaling\n group.
", + "smithy.api#documentation": "The ID of the instance.
", "smithy.api#required": {} } }, - "InstanceId": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen19", + "ShouldDecrementDesiredCapacity": { + "target": "com.amazonaws.autoscaling#ShouldDecrementDesiredCapacity", "traits": { - "smithy.api#documentation": "The ID of the instance.
", + "smithy.api#documentation": "Indicates whether terminating the instance also decrements the size of the Auto Scaling\n group.
", "smithy.api#required": {} } } @@ -5882,58 +5882,59 @@ "com.amazonaws.autoscaling#UpdateAutoScalingGroupType": { "type": "structure", "members": { - "NewInstancesProtectedFromScaleIn": { - "target": "com.amazonaws.autoscaling#InstanceProtected", + "AutoScalingGroupName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in.
\nFor more information about preventing instances from terminating on scale in, see\n Instance Protection in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The name of the Auto Scaling group.
", + "smithy.api#required": {} } }, - "VPCZoneIdentifier": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen2047", + "LaunchConfigurationName": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "A comma-separated list of subnet IDs for virtual private cloud (VPC).
\nIf you specify VPCZoneIdentifier
with AvailabilityZones
, the\n subnets that you specify for this parameter must reside in those Availability\n Zones.
The name of the launch configuration. If you specify\n LaunchConfigurationName
in your update request, you can't specify\n LaunchTemplate
or MixedInstancesPolicy
.
The maximum size of the Auto Scaling group.
\nWith a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize
to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize
by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).
The launch template and version to use to specify the updates. If you specify\n LaunchTemplate
in your update request, you can't specify\n LaunchConfigurationName
or MixedInstancesPolicy
.
The desired capacity is the initial capacity of the Auto Scaling group after this operation\n completes and the capacity it attempts to maintain.
\nThis number must be greater than or equal to the minimum size of the group and less\n than or equal to the maximum size of the group.
" + "smithy.api#documentation": "An embedded object that specifies a mixed instances policy. When you make changes to\n an existing policy, all optional parameters are left unchanged if not specified. For\n more information, see Auto Scaling Groups with Multiple\n Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User\n Guide.
" } }, - "LaunchTemplate": { - "target": "com.amazonaws.autoscaling#LaunchTemplateSpecification", + "MinSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMinSize", "traits": { - "smithy.api#documentation": "The launch template and version to use to specify the updates. If you specify\n LaunchTemplate
in your update request, you can't specify\n LaunchConfigurationName
or MixedInstancesPolicy
.
For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API\n Reference.
" + "smithy.api#documentation": "The minimum size of the Auto Scaling group.
" } }, - "PlacementGroup": { - "target": "com.amazonaws.autoscaling#XmlStringMaxLen255", + "MaxSize": { + "target": "com.amazonaws.autoscaling#AutoScalingGroupMaxSize", "traits": { - "smithy.api#documentation": "The name of the placement group into which to launch your instances, if any. A\n placement group is a logical grouping of instances within a single Availability Zone.\n You cannot specify multiple Availability Zones and a placement group. For more\n information, see Placement Groups in the\n Amazon EC2 User Guide for Linux Instances.
" + "smithy.api#documentation": "The maximum size of the Auto Scaling group.
\nWith a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to\n go above MaxSize
to meet your capacity requirements. In this event,\n Amazon EC2 Auto Scaling will never go above MaxSize
by more than your largest instance\n weight (weights that define how many units each instance contributes to the desired\n capacity of the group).
The amount of time, in seconds, after a scaling activity completes before another\n scaling activity can start. The default value is 300
.
This setting applies when using simple scaling policies, but not when using other\n scaling policies or scheduled scaling. For more information, see Scaling Cooldowns\n for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The desired capacity is the initial capacity of the Auto Scaling group after this operation\n completes and the capacity it attempts to maintain. This number must be greater than or\n equal to the minimum size of the group and less than or equal to the maximum size of the\n group.
" } }, - "MixedInstancesPolicy": { - "target": "com.amazonaws.autoscaling#MixedInstancesPolicy", + "DefaultCooldown": { + "target": "com.amazonaws.autoscaling#Cooldown", "traits": { - "smithy.api#documentation": "An embedded object that specifies a mixed instances policy.
\nIn your call to UpdateAutoScalingGroup
, you can make changes to the\n policy that is specified. All optional parameters are left unchanged if not\n specified.
For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and\n Auto Scaling Groups with Multiple\n Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User\n Guide.
" + "smithy.api#documentation": "The amount of time, in seconds, after a scaling activity completes before another\n scaling activity can start. The default value is 300
. This setting applies\n when using simple scaling policies, but not when using other scaling policies or\n scheduled scaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling\n in the Amazon EC2 Auto Scaling User Guide.
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service. The default value is\n 0
.
For more information, see Health\n Check Grace Period in the Amazon EC2 Auto Scaling User Guide.
\nRequired if you are adding an ELB
health check.
One or more Availability Zones for the group.
" } }, "HealthCheckType": { @@ -5942,53 +5943,52 @@ "smithy.api#documentation": "The service to use for the health checks. The valid values are EC2
and\n ELB
. If you configure an Auto Scaling group to use ELB health checks, it\n considers the instance unhealthy if it fails either the EC2 status checks or the load\n balancer health checks.
The maximum amount of time, in seconds, that an instance can be in service. The\n default is null.
\nThis parameter is optional, but if you specify a value for it, you must specify a\n value of at least 604,800 seconds (7 days). To clear a previously set value, specify a\n new value of 0.
\nFor more information, see Replacing Auto Scaling\n Instances Based on Maximum Instance Lifetime in the\n Amazon EC2 Auto Scaling User Guide.
\nValid Range: Minimum value of 0.
" + "smithy.api#documentation": "The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status\n of an EC2 instance that has come into service. The default value is 0
. For\n more information, see Health\n check grace period in the Amazon EC2 Auto Scaling User Guide.
Conditional: Required if you are adding an ELB
health check.
One or more Availability Zones for the group.
" + "smithy.api#documentation": "The name of an existing placement group into which to launch your instances, if any. A\n placement group is a logical grouping of instances within a single Availability Zone.\n You cannot specify multiple Availability Zones and a placement group. For more\n information, see Placement Groups in the\n Amazon EC2 User Guide for Linux Instances.
" } }, - "LaunchConfigurationName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "VPCZoneIdentifier": { + "target": "com.amazonaws.autoscaling#XmlStringMaxLen2047", "traits": { - "smithy.api#documentation": "The name of the launch configuration. If you specify\n LaunchConfigurationName
in your update request, you can't specify\n LaunchTemplate
or MixedInstancesPolicy
.
A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify\n VPCZoneIdentifier
with AvailabilityZones
, the subnets that\n you specify for this parameter must reside in those Availability Zones.
The minimum size of the Auto Scaling group.
" + "smithy.api#documentation": "A policy or a list of policies that are used to select the instances to terminate. The\n policies are executed in the order that you list them. For more information, see Controlling which Auto Scaling instances terminate during scale in in the\n Amazon EC2 Auto Scaling User Guide.
" } }, - "CapacityRebalance": { - "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", + "NewInstancesProtectedFromScaleIn": { + "target": "com.amazonaws.autoscaling#InstanceProtected", "traits": { - "smithy.api#documentation": "Enables or disables capacity rebalance.
\nYou can enable capacity rebalancing for your Auto Scaling groups when using Spot Instances.\n When you turn on capacity rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance\n whenever Amazon EC2 predicts that a Spot Instance is at an elevated risk of interruption.\n After launching a new instance, it then terminates an old instance. For more\n information, see Amazon EC2 Auto Scaling capacity\n rebalancing in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling\n when scaling in. For more information about preventing instances from terminating on\n scale in, see Instance scale-in protection in the\n Amazon EC2 Auto Scaling User Guide.
" } }, - "TerminationPolicies": { - "target": "com.amazonaws.autoscaling#TerminationPolicies", + "ServiceLinkedRoleARN": { + "target": "com.amazonaws.autoscaling#ResourceName", "traits": { - "smithy.api#documentation": "A standalone termination policy or a list of termination policies used to select the\n instance to terminate. The policies are executed in the order that they are\n listed.
\nFor more information, see Controlling Which\n Instances Auto Scaling Terminates During Scale In in the\n Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other AWS services on your behalf. For more information, see Service-linked\n roles in the Amazon EC2 Auto Scaling User Guide.
" } }, - "ServiceLinkedRoleARN": { - "target": "com.amazonaws.autoscaling#ResourceName", + "MaxInstanceLifetime": { + "target": "com.amazonaws.autoscaling#MaxInstanceLifetime", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to\n call other AWS services on your behalf. For more information, see Service-Linked\n Roles in the Amazon EC2 Auto Scaling User Guide.
" + "smithy.api#documentation": "The maximum amount of time, in seconds, that an instance can be in service. The\n default is null. If specified, the value must be either 0 or a number equal to or\n greater than 86,400 seconds (1 day). To clear a previously set value, specify a new\n value of 0. For more information, see Replacing Auto Scaling\n instances based on maximum instance lifetime in the\n Amazon EC2 Auto Scaling User Guide.
" } }, - "AutoScalingGroupName": { - "target": "com.amazonaws.autoscaling#ResourceName", + "CapacityRebalance": { + "target": "com.amazonaws.autoscaling#CapacityRebalanceEnabled", "traits": { - "smithy.api#documentation": "The name of the Auto Scaling group.
", - "smithy.api#required": {} + "smithy.api#documentation": "Enables or disables Capacity Rebalancing. For more information, see Amazon EC2 Auto Scaling Capacity Rebalancing in the\n Amazon EC2 Auto Scaling User Guide.
" } } } diff --git a/codegen/sdk-codegen/aws-models/databrew.2017-07-25.json b/codegen/sdk-codegen/aws-models/databrew.2017-07-25.json new file mode 100644 index 000000000000..fb2b90cd52f1 --- /dev/null +++ b/codegen/sdk-codegen/aws-models/databrew.2017-07-25.json @@ -0,0 +1,4811 @@ +{ + "smithy": "1.0", + "metadata": { + "suppressions": [ + { + "id": "HttpMethodSemantics", + "namespace": "*" + }, + { + "id": "HttpResponseCodeSemantics", + "namespace": "*" + }, + { + "id": "PaginatedTrait", + "namespace": "*" + }, + { + "id": "HttpHeaderTrait", + "namespace": "*" + }, + { + "id": "HttpUriConflict", + "namespace": "*" + }, + { + "id": "Service", + "namespace": "*" + } + ] + }, + "shapes": { + "com.amazonaws.databrew#AWSGlueDataBrew": { + "type": "service", + "version": "2017-07-25", + "operations": [ + { + "target": "com.amazonaws.databrew#BatchDeleteRecipeVersion" + }, + { + "target": "com.amazonaws.databrew#CreateDataset" + }, + { + "target": "com.amazonaws.databrew#CreateProfileJob" + }, + { + "target": "com.amazonaws.databrew#CreateProject" + }, + { + "target": "com.amazonaws.databrew#CreateRecipe" + }, + { + "target": "com.amazonaws.databrew#CreateRecipeJob" + }, + { + "target": "com.amazonaws.databrew#CreateSchedule" + }, + { + "target": "com.amazonaws.databrew#DeleteDataset" + }, + { + "target": "com.amazonaws.databrew#DeleteJob" + }, + { + "target": "com.amazonaws.databrew#DeleteProject" + }, + { + "target": "com.amazonaws.databrew#DeleteRecipeVersion" + }, + { + "target": "com.amazonaws.databrew#DeleteSchedule" + }, + { + "target": "com.amazonaws.databrew#DescribeDataset" + }, + { + "target": "com.amazonaws.databrew#DescribeJob" + }, + { + "target": "com.amazonaws.databrew#DescribeProject" + }, + { + "target": "com.amazonaws.databrew#DescribeRecipe" + }, + { + "target": "com.amazonaws.databrew#DescribeSchedule" + }, + { + "target": "com.amazonaws.databrew#ListDatasets" + }, + { + "target": "com.amazonaws.databrew#ListJobRuns" + }, + { + "target": "com.amazonaws.databrew#ListJobs" + }, + { + "target": "com.amazonaws.databrew#ListProjects" + }, + { + "target": "com.amazonaws.databrew#ListRecipes" + }, + { + "target": "com.amazonaws.databrew#ListRecipeVersions" + }, + { + "target": "com.amazonaws.databrew#ListSchedules" + }, + { + "target": "com.amazonaws.databrew#ListTagsForResource" + }, + { + "target": "com.amazonaws.databrew#PublishRecipe" + }, + { + "target": "com.amazonaws.databrew#SendProjectSessionAction" + }, + { + "target": "com.amazonaws.databrew#StartJobRun" + }, + { + "target": "com.amazonaws.databrew#StartProjectSession" + }, + { + "target": "com.amazonaws.databrew#StopJobRun" + }, + { + "target": "com.amazonaws.databrew#TagResource" + }, + { + "target": "com.amazonaws.databrew#UntagResource" + }, + { + "target": "com.amazonaws.databrew#UpdateDataset" + }, + { + "target": "com.amazonaws.databrew#UpdateProfileJob" + }, + { + "target": "com.amazonaws.databrew#UpdateProject" + }, + { + "target": "com.amazonaws.databrew#UpdateRecipe" + }, + { + "target": "com.amazonaws.databrew#UpdateRecipeJob" + }, + { + "target": "com.amazonaws.databrew#UpdateSchedule" + } + ], + "traits": { + "aws.api#service": { + "sdkId": "DataBrew", + "arnNamespace": "databrew", + "cloudFormationName": "DataBrew", + "cloudTrailEventSource": "databrew.amazonaws.com" + }, + "aws.auth#sigv4": { + "name": "databrew" + }, + "aws.protocols#restJson1": {}, + "smithy.api#documentation": "AWS Glue DataBrew is a visual, cloud-scale data-preparation service. DataBrew\n simplifies data preparation tasks, targeting data issues that are hard to spot and\n time-consuming to fix. DataBrew empowers users of all technical levels to visualize the\n data and perform one-click data transformations, with no coding required.
", + "smithy.api#title": "AWS Glue DataBrew" + } + }, + "com.amazonaws.databrew#AccessDeniedException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.databrew#Message" + } + }, + "traits": { + "smithy.api#documentation": "Access to the specified resource was denied.
", + "smithy.api#error": "client", + "smithy.api#httpError": 403 + } + }, + "com.amazonaws.databrew#AccountId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 255 + } + } + }, + "com.amazonaws.databrew#ActionId": { + "type": "integer", + "traits": { + "smithy.api#box": {} + } + }, + "com.amazonaws.databrew#Arn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.databrew#AssumeControl": { + "type": "boolean" + }, + "com.amazonaws.databrew#Attempt": { + "type": "integer" + }, + "com.amazonaws.databrew#BatchDeleteRecipeVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#BatchDeleteRecipeVersionRequest" + }, + "output": { + "target": "com.amazonaws.databrew#BatchDeleteRecipeVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes one or more versions of a recipe at a time.
", + "smithy.api#http": { + "method": "POST", + "uri": "/recipes/{Name}/batchDeleteRecipeVersion", + "code": 200 + } + } + }, + "com.amazonaws.databrew#BatchDeleteRecipeVersionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The name of the recipe to be modified.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RecipeVersions": { + "target": "com.amazonaws.databrew#RecipeVersionList", + "traits": { + "smithy.api#documentation": "An array of version identifiers to be deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#BatchDeleteRecipeVersionResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The name of the recipe that was modified.
", + "smithy.api#required": {} + } + }, + "Errors": { + "target": "com.amazonaws.databrew#RecipeErrorList", + "traits": { + "smithy.api#documentation": "Errors, if any, that were encountered when deleting the recipe versions.
" + } + } + } + }, + "com.amazonaws.databrew#Bucket": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 3, + "max": 63 + } + } + }, + "com.amazonaws.databrew#CatalogId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#ClientSessionId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + }, + "smithy.api#pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]*$" + } + }, + "com.amazonaws.databrew#ColumnName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#ColumnNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#ColumnName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.databrew#ColumnRange": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 20 + } + } + }, + "com.amazonaws.databrew#CompressionFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "GZIP", + "name": "GZIP" + }, + { + "value": "LZ4", + "name": "LZ4" + }, + { + "value": "SNAPPY", + "name": "SNAPPY" + }, + { + "value": "BZIP2", + "name": "BZIP2" + }, + { + "value": "DEFLATE", + "name": "DEFLATE" + }, + { + "value": "LZO", + "name": "LZO" + }, + { + "value": "BROTLI", + "name": "BROTLI" + }, + { + "value": "ZSTD", + "name": "ZSTD" + }, + { + "value": "ZLIB", + "name": "ZLIB" + } + ] + } + }, + "com.amazonaws.databrew#Condition": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Z\\_]+$" + } + }, + "com.amazonaws.databrew#ConditionExpression": { + "type": "structure", + "members": { + "Condition": { + "target": "com.amazonaws.databrew#Condition", + "traits": { + "smithy.api#documentation": "A specific condition to apply to a recipe action. For more information, see Recipe\n structure in the AWS Glue DataBrew Developer\n Guide.
", + "smithy.api#required": {} + } + }, + "Value": { + "target": "com.amazonaws.databrew#ConditionValue", + "traits": { + "smithy.api#documentation": "A value that the condition must evaluate to for the condition to succeed.
" + } + }, + "TargetColumn": { + "target": "com.amazonaws.databrew#TargetColumn", + "traits": { + "smithy.api#documentation": "A column to apply this condition to, within an AWS Glue DataBrew dataset.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents an individual condition that evaluates to true or false.
\nConditions are used with recipe actions: The action is only performed for column\n values where the condition evaluates to true.
\nIf a recipe requires more than one condition, then the recipe must specify multiple\n ConditionExpression
elements. Each condition is applied to the rows in\n a dataset first, before the recipe action is performed.
Updating or deleting a resource can cause an inconsistent state.
", + "smithy.api#error": "client", + "smithy.api#httpError": 409 + } + }, + "com.amazonaws.databrew#CreateDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#CreateDatasetRequest" + }, + "output": { + "target": "com.amazonaws.databrew#CreateDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#AccessDeniedException" + }, + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new AWS Glue DataBrew dataset for this AWS account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/datasets", + "code": 200 + } + } + }, + "com.amazonaws.databrew#CreateDatasetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset to be created.
", + "smithy.api#required": {} + } + }, + "FormatOptions": { + "target": "com.amazonaws.databrew#FormatOptions" + }, + "Input": { + "target": "com.amazonaws.databrew#Input", + "traits": { + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "Metadata tags to apply to this dataset.
" + } + } + } + }, + "com.amazonaws.databrew#CreateDatasetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset that you created.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#CreateProfileJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#CreateProfileJobRequest" + }, + "output": { + "target": "com.amazonaws.databrew#CreateProfileJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new job to profile an AWS Glue DataBrew dataset that exists in the current AWS\n account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/profileJobs", + "code": 200 + } + } + }, + "com.amazonaws.databrew#CreateProfileJobRequest": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset that this job is to act upon.
", + "smithy.api#required": {} + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.databrew#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an encryption key that is used to \n protect the job.
" + } + }, + "EncryptionMode": { + "target": "com.amazonaws.databrew#EncryptionMode", + "traits": { + "smithy.api#documentation": "The encryption mode for the job, which can be one of the following:
\n\n SSE-KMS
- para>SSE-KMS
- server-side encryption with AWS KMS-managed keys.
\n SSE-S3
- Server-side encryption with keys managed by Amazon\n S3.
The name of the job to be created.
", + "smithy.api#required": {} + } + }, + "LogSubscription": { + "target": "com.amazonaws.databrew#LogSubscription", + "traits": { + "smithy.api#documentation": "A value that enables or disables Amazon CloudWatch logging for the current AWS\n account. If logging is enabled, CloudWatch writes one log stream for each job\n run.
" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.databrew#MaxCapacity", + "traits": { + "smithy.api#documentation": "The maximum number of nodes that DataBrew can use when the job processes data.
" + } + }, + "MaxRetries": { + "target": "com.amazonaws.databrew#MaxRetries", + "traits": { + "smithy.api#documentation": "The maximum number of times to retry the job after a job run fails.
" + } + }, + "OutputLocation": { + "target": "com.amazonaws.databrew#S3Location", + "traits": { + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to\n be assumed for this request.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "Metadata tags to apply to this job.
" + } + }, + "Timeout": { + "target": "com.amazonaws.databrew#Timeout", + "traits": { + "smithy.api#documentation": "The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT
.
The name of the job that was created.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#CreateProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#CreateProjectRequest" + }, + "output": { + "target": "com.amazonaws.databrew#CreateProjectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#InternalServerException" + }, + { + "target": "com.amazonaws.databrew#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new AWS Glue DataBrew project in the current AWS account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/projects", + "code": 200 + } + } + }, + "com.amazonaws.databrew#CreateProjectRequest": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset to associate this project with.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "A unique name for the new project.
", + "smithy.api#required": {} + } + }, + "RecipeName": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The name of an existing recipe to associate with the project.
", + "smithy.api#required": {} + } + }, + "Sample": { + "target": "com.amazonaws.databrew#Sample" + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to\n be assumed for this request.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "Metadata tags to apply to this project.
" + } + } + } + }, + "com.amazonaws.databrew#CreateProjectResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project that you created.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#CreateRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#CreateRecipeRequest" + }, + "output": { + "target": "com.amazonaws.databrew#CreateRecipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ServiceQuotaExceededException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new AWS Glue DataBrew recipe for the current AWS account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/recipes", + "code": 200 + } + } + }, + "com.amazonaws.databrew#CreateRecipeJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#CreateRecipeJobRequest" + }, + "output": { + "target": "com.amazonaws.databrew#CreateRecipeJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new job for an existing AWS Glue DataBrew recipe in the current AWS account.\n You can create a standalone job using either a project, or a combination of a recipe and\n a dataset.
", + "smithy.api#http": { + "method": "POST", + "uri": "/recipeJobs", + "code": 200 + } + } + }, + "com.amazonaws.databrew#CreateRecipeJobRequest": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset that this job processes.
" + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.databrew#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
" + } + }, + "EncryptionMode": { + "target": "com.amazonaws.databrew#EncryptionMode", + "traits": { + "smithy.api#documentation": "The encryption mode for the job, which can be one of the following:
\n\n SSE-KMS
- Server-side encryption with AWS KMS-managed keys.
\n SSE-S3
- Server-side encryption with keys managed by Amazon S3.
A unique name for the job.
", + "smithy.api#required": {} + } + }, + "LogSubscription": { + "target": "com.amazonaws.databrew#LogSubscription", + "traits": { + "smithy.api#documentation": "A value that enables or disables Amazon CloudWatch logging for the current AWS\n account. If logging is enabled, CloudWatch writes one log stream for each job\n run.
" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.databrew#MaxCapacity", + "traits": { + "smithy.api#documentation": "The maximum number of nodes that DataBrew can consume when the job processes\n data.
" + } + }, + "MaxRetries": { + "target": "com.amazonaws.databrew#MaxRetries", + "traits": { + "smithy.api#documentation": "The maximum number of times to retry the job after a job run fails.
" + } + }, + "Outputs": { + "target": "com.amazonaws.databrew#OutputList", + "traits": { + "smithy.api#documentation": "One or more artifacts that represent the output from running the job.
", + "smithy.api#required": {} + } + }, + "ProjectName": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "Either the name of an existing project, or a combination of a recipe and a dataset to\n associate with the recipe.
" + } + }, + "RecipeReference": { + "target": "com.amazonaws.databrew#RecipeReference" + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to\n be assumed for this request.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "Metadata tags to apply to this job dataset.
" + } + }, + "Timeout": { + "target": "com.amazonaws.databrew#Timeout", + "traits": { + "smithy.api#documentation": "The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT
.
The name of the job that you created.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#CreateRecipeRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.databrew#RecipeDescription", + "traits": { + "smithy.api#documentation": "A description for the recipe.
" + } + }, + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "A unique name for the recipe.
", + "smithy.api#required": {} + } + }, + "Steps": { + "target": "com.amazonaws.databrew#RecipeStepList", + "traits": { + "smithy.api#documentation": "An array containing the steps to be performed by the recipe. Each recipe step consists of one \n recipe action and (optionally) an array of condition expressions.
", + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "Metadata tags to apply to this recipe.
" + } + } + } + }, + "com.amazonaws.databrew#CreateRecipeResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The name of the recipe that you created.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#CreateSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#CreateScheduleRequest" + }, + "output": { + "target": "com.amazonaws.databrew#CreateScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates a new schedule for one or more AWS Glue DataBrew jobs. Jobs can be run at a\n specific date and time, or at regular intervals.
", + "smithy.api#http": { + "method": "POST", + "uri": "/schedules", + "code": 200 + } + } + }, + "com.amazonaws.databrew#CreateScheduleRequest": { + "type": "structure", + "members": { + "JobNames": { + "target": "com.amazonaws.databrew#JobNameList", + "traits": { + "smithy.api#documentation": "The name or names of one or more jobs to be run.
" + } + }, + "CronExpression": { + "target": "com.amazonaws.databrew#CronExpression", + "traits": { + "smithy.api#documentation": "The date or dates and time or times, in cron
format, when the jobs are to\n be run.
Metadata tags to apply to this schedule.
" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "A unique name for the schedule.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#CreateScheduleResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "The name of the schedule that was created.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#CreatedBy": { + "type": "string" + }, + "com.amazonaws.databrew#CronExpression": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.databrew#DataCatalogInputDefinition": { + "type": "structure", + "members": { + "CatalogId": { + "target": "com.amazonaws.databrew#CatalogId", + "traits": { + "smithy.api#documentation": "The unique identifier of the AWS account that holds the Data Catalog that stores the\n data.
" + } + }, + "DatabaseName": { + "target": "com.amazonaws.databrew#DatabaseName", + "traits": { + "smithy.api#documentation": "The name of a database in the Data Catalog.
", + "smithy.api#required": {} + } + }, + "TableName": { + "target": "com.amazonaws.databrew#TableName", + "traits": { + "smithy.api#documentation": "The name of a database table in the Data Catalog. This table corresponds to a DataBrew\n dataset.
", + "smithy.api#required": {} + } + }, + "TempDirectory": { + "target": "com.amazonaws.databrew#S3Location", + "traits": { + "smithy.api#documentation": "An Amazon location that AWS Glue Data Catalog can use as a temporary directory.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents how metadata stored in the AWS Glue Data Catalog is defined in an AWS Glue\n DataBrew dataset.
" + } + }, + "com.amazonaws.databrew#DatabaseName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#Dataset": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.databrew#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the AWS account that owns the dataset.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "The identifier (the user name) of the user who created the dataset.
" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the dataset was created.
" + } + }, + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The unique name of the dataset.
", + "smithy.api#required": {} + } + }, + "FormatOptions": { + "target": "com.amazonaws.databrew#FormatOptions", + "traits": { + "smithy.api#documentation": "Options that define how DataBrew interprets the data in the dataset.
" + } + }, + "Input": { + "target": "com.amazonaws.databrew#Input", + "traits": { + "smithy.api#documentation": "Information on how DataBrew can find the dataset, in either the AWS Glue Data Catalog\n or Amazon S3.
", + "smithy.api#required": {} + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The last modification date and time of the dataset.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "The identifier (the user name) of the user who last modified the dataset.
" + } + }, + "Source": { + "target": "com.amazonaws.databrew#Source", + "traits": { + "smithy.api#documentation": "The location of the data for the dataset, either Amazon S3 or the AWS Glue Data\n Catalog.
" + } + }, + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "Metadata tags that have been applied to the dataset.
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) for the dataset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a dataset that can be processed by AWS Glue DataBrew.
" + } + }, + "com.amazonaws.databrew#DatasetList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#Dataset" + } + }, + "com.amazonaws.databrew#DatasetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#Date": { + "type": "timestamp" + }, + "com.amazonaws.databrew#DeleteDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DeleteDatasetRequest" + }, + "output": { + "target": "com.amazonaws.databrew#DeleteDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a dataset from AWS Glue DataBrew.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/datasets/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DeleteDatasetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteDatasetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset that you deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DeleteJobRequest" + }, + "output": { + "target": "com.amazonaws.databrew#DeleteJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified AWS Glue DataBrew job from the current AWS account. The job can\n be for a recipe or for a profile.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/jobs/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DeleteJobRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "The name of the job to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteJobResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "The name of the job that you deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DeleteProjectRequest" + }, + "output": { + "target": "com.amazonaws.databrew#DeleteProjectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes an existing AWS Glue DataBrew project from the current AWS account.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/projects/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DeleteProjectRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteProjectResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project that you deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteRecipeVersion": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DeleteRecipeVersionRequest" + }, + "output": { + "target": "com.amazonaws.databrew#DeleteRecipeVersionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes a single version of an AWS Glue DataBrew recipe.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/recipes/{Name}/recipeVersion/{RecipeVersion}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DeleteRecipeVersionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The name of the recipe to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "The version of the recipe to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteRecipeVersionResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The name of the recipe that was deleted.
", + "smithy.api#required": {} + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "The version of the recipe that was deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DeleteScheduleRequest" + }, + "output": { + "target": "com.amazonaws.databrew#DeleteScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Deletes the specified AWS Glue DataBrew schedule from the current AWS account.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/schedules/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DeleteScheduleRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "The name of the schedule to be deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DeleteScheduleResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "The name of the schedule that was deleted.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DescribeDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DescribeDatasetRequest" + }, + "output": { + "target": "com.amazonaws.databrew#DescribeDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the definition of a specific AWS Glue DataBrew dataset that is in the current\n AWS account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/datasets/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DescribeDatasetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset to be described.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DescribeDatasetResponse": { + "type": "structure", + "members": { + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "The identifier (user name) of the user who created the dataset.
" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the dataset was created.
" + } + }, + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset.
", + "smithy.api#required": {} + } + }, + "FormatOptions": { + "target": "com.amazonaws.databrew#FormatOptions" + }, + "Input": { + "target": "com.amazonaws.databrew#Input", + "traits": { + "smithy.api#required": {} + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the dataset was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "The identifier (user name) of the user who last modified the dataset.
" + } + }, + "Source": { + "target": "com.amazonaws.databrew#Source", + "traits": { + "smithy.api#documentation": "The location of the data for this dataset, Amazon S3 or the AWS Glue Data\n Catalog.
" + } + }, + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "Metadata tags associated with this dataset.
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" + } + } + } + }, + "com.amazonaws.databrew#DescribeJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DescribeJobRequest" + }, + "output": { + "target": "com.amazonaws.databrew#DescribeJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the definition of a specific AWS Glue DataBrew job that is in the current AWS\n account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/jobs/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DescribeJobRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "The name of the job to be described.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DescribeJobResponse": { + "type": "structure", + "members": { + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the job was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "The identifier (user name) of the user associated with the creation of the job.
" + } + }, + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The dataset that the job acts upon.
" + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.databrew#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
" + } + }, + "EncryptionMode": { + "target": "com.amazonaws.databrew#EncryptionMode", + "traits": { + "smithy.api#documentation": "The encryption mode for the job, which can be one of the following:
\n\n SSE-KMS
- Server-side encryption with AWS KMS-managed keys.
\n SSE-S3
- Server-side encryption with keys managed by Amazon S3.
The name of the job.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.databrew#JobType", + "traits": { + "smithy.api#documentation": "The job type, which must be one of the following:
\n\n PROFILE
- The job analyzes the dataset to determine its size,\n data types, data distribution, and more.
\n RECIPE
- The job applies one or more transformations to a\n dataset.
The identifier (user name) of the user who last modified the job.
" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the job was last modified.
" + } + }, + "LogSubscription": { + "target": "com.amazonaws.databrew#LogSubscription", + "traits": { + "smithy.api#documentation": "A value that indicates whether Amazon CloudWatch logging is enabled for this job.
" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.databrew#MaxCapacity", + "traits": { + "smithy.api#documentation": "The maximum number of nodes that AWS Glue DataBrew can consume when the job processes\n data.
" + } + }, + "MaxRetries": { + "target": "com.amazonaws.databrew#MaxRetries", + "traits": { + "smithy.api#documentation": "The maximum number of times to retry the job after a job run fails.
" + } + }, + "Outputs": { + "target": "com.amazonaws.databrew#OutputList", + "traits": { + "smithy.api#documentation": "One or more artifacts that represent the output from running the job.
" + } + }, + "ProjectName": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The DataBrew project associated with this job.
" + } + }, + "RecipeReference": { + "target": "com.amazonaws.databrew#RecipeReference" + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the AWS Identity and Access Management (IAM) role that was assumed for this\n request.
" + } + }, + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "Metadata tags associated with this job.
" + } + }, + "Timeout": { + "target": "com.amazonaws.databrew#Timeout", + "traits": { + "smithy.api#documentation": "The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT
.
Returns the definition of a specific AWS Glue DataBrew project that is in the current\n AWS account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/projects/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DescribeProjectRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project to be described.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DescribeProjectResponse": { + "type": "structure", + "members": { + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the project was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "The identifier (user name) of the user who created the project.
" + } + }, + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The dataset associated with the project.
" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the project was last modified.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "The identifier (user name) of the user who last modified the project.
" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project.
", + "smithy.api#required": {} + } + }, + "RecipeName": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The recipe associated with this job.
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the project.
" + } + }, + "Sample": { + "target": "com.amazonaws.databrew#Sample" + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the AWS Identity and Access Management (IAM) role that was assumed for this\n request.
" + } + }, + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "Metadata tags associated with this project.
" + } + }, + "SessionStatus": { + "target": "com.amazonaws.databrew#SessionStatus", + "traits": { + "smithy.api#documentation": "Describes the current state of the session:
\n\n PROVISIONING
- allocating resources for the session.
\n INITIALIZING
- getting the session ready for first use.
\n ASSIGNED
- the session is ready for use.
The identifier (user name) of the user that opened the project for use.
" + } + }, + "OpenDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time when the project was opened.
" + } + } + } + }, + "com.amazonaws.databrew#DescribeRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DescribeRecipeRequest" + }, + "output": { + "target": "com.amazonaws.databrew#DescribeRecipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the definition of a specific AWS Glue DataBrew recipe that is in the current\n AWS account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/recipes/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DescribeRecipeRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The name of the recipe to be described.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "The recipe version identifier. If this parameter isn't specified, then the latest\n published version is returned.
", + "smithy.api#httpQuery": "recipeVersion" + } + } + } + }, + "com.amazonaws.databrew#DescribeRecipeResponse": { + "type": "structure", + "members": { + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "The identifier (user name) of the user who created the recipe.
" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the recipe was created.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "The identifier (user name) of the user who last modified the recipe.
" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the recipe was last modified.
" + } + }, + "ProjectName": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project associated with this recipe.
" + } + }, + "PublishedBy": { + "target": "com.amazonaws.databrew#PublishedBy", + "traits": { + "smithy.api#documentation": "The identifier (user name) of the user who last published the recipe.
" + } + }, + "PublishedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time when the recipe was last published.
" + } + }, + "Description": { + "target": "com.amazonaws.databrew#RecipeDescription", + "traits": { + "smithy.api#documentation": "The description of the recipe.
" + } + }, + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The name of the recipe.
", + "smithy.api#required": {} + } + }, + "Steps": { + "target": "com.amazonaws.databrew#RecipeStepList", + "traits": { + "smithy.api#documentation": "One or more steps to be performed by the recipe. Each step consists of an action, and\n the conditions under which the action should succeed.
" + } + }, + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "Metadata tags associated with this project.
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the recipe.
" + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "The recipe version identifier.
" + } + } + } + }, + "com.amazonaws.databrew#DescribeSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#DescribeScheduleRequest" + }, + "output": { + "target": "com.amazonaws.databrew#DescribeScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Returns the definition of a specific AWS Glue DataBrew schedule that is in the current\n AWS account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/schedules/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#DescribeScheduleRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "The name of the schedule to be described.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#DescribeScheduleResponse": { + "type": "structure", + "members": { + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the schedule was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "The identifier (user name) of the user who created the schedule.
" + } + }, + "JobNames": { + "target": "com.amazonaws.databrew#JobNameList", + "traits": { + "smithy.api#documentation": "The name or names of one or more jobs to be run by using the schedule.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "The identifier (user name) of the user who last modified the schedule.
" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the schedule was last modified.
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the schedule.
" + } + }, + "CronExpression": { + "target": "com.amazonaws.databrew#CronExpression", + "traits": { + "smithy.api#documentation": "The date or dates and time or times, in cron
format, when the jobs are to\n be run for the schedule.
Metadata tags associated with this schedule.
" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "The name of the schedule.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#EncryptionKeyArn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 20, + "max": 2048 + } + } + }, + "com.amazonaws.databrew#EncryptionMode": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "SSE-KMS", + "name": "SSEKMS" + }, + { + "value": "SSE-S3", + "name": "SSES3" + } + ] + } + }, + "com.amazonaws.databrew#ErrorCode": { + "type": "string", + "traits": { + "smithy.api#pattern": "^[1-5][0-9][0-9]$" + } + }, + "com.amazonaws.databrew#ExcelOptions": { + "type": "structure", + "members": { + "SheetNames": { + "target": "com.amazonaws.databrew#SheetNameList", + "traits": { + "smithy.api#documentation": "Specifies one or more named sheets in the Excel file, which will be included in the dataset.
" + } + }, + "SheetIndexes": { + "target": "com.amazonaws.databrew#SheetIndexList", + "traits": { + "smithy.api#documentation": "Specifies one or more sheet numbers in the Excel file, which will be included in the dataset.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Options that define how DataBrew will interpret a Microsoft Excel file, when creating a\n dataset from that file.
" + } + }, + "com.amazonaws.databrew#ExecutionTime": { + "type": "integer" + }, + "com.amazonaws.databrew#FormatOptions": { + "type": "structure", + "members": { + "Json": { + "target": "com.amazonaws.databrew#JsonOptions", + "traits": { + "smithy.api#documentation": "Options that define how JSON input is to be interpreted by DataBrew.
" + } + }, + "Excel": { + "target": "com.amazonaws.databrew#ExcelOptions", + "traits": { + "smithy.api#documentation": "Options that define how Excel input is to be interpreted by DataBrew.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Options that define how Microsoft Excel input is to be interpreted by DataBrew.
" + } + }, + "com.amazonaws.databrew#HiddenColumnList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#ColumnName" + } + }, + "com.amazonaws.databrew#Input": { + "type": "structure", + "members": { + "S3InputDefinition": { + "target": "com.amazonaws.databrew#S3Location", + "traits": { + "smithy.api#documentation": "The Amazon S3 location where the data is stored.
" + } + }, + "DataCatalogInputDefinition": { + "target": "com.amazonaws.databrew#DataCatalogInputDefinition", + "traits": { + "smithy.api#documentation": "The AWS Glue Data Catalog parameters for the data.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Information on how AWS Glue DataBrew can find data, in either the AWS Glue Data\n Catalog or Amazon S3.
" + } + }, + "com.amazonaws.databrew#InternalServerException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.databrew#Message" + } + }, + "traits": { + "smithy.api#documentation": "An internal service failure occurred.
", + "smithy.api#error": "server", + "smithy.api#httpError": 500 + } + }, + "com.amazonaws.databrew#Job": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.databrew#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the AWS account that owns the job.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "The identifier (the user name) of the user who created the job.
" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the job was created.
" + } + }, + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "A dataset that the job is to process.
" + } + }, + "EncryptionKeyArn": { + "target": "com.amazonaws.databrew#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an encryption key that is used to protect a job.
" + } + }, + "EncryptionMode": { + "target": "com.amazonaws.databrew#EncryptionMode", + "traits": { + "smithy.api#documentation": "The encryption mode for the job, which can be one of the following:
\n\n SSE-KMS
- Server-side encryption with AWS KMS-managed keys.
\n SSE-S3
- Server-side encryption with keys managed by Amazon\n S3.
The unique name of the job.
", + "smithy.api#required": {} + } + }, + "Type": { + "target": "com.amazonaws.databrew#JobType", + "traits": { + "smithy.api#documentation": "The job type of the job, which must be one of the following:
\n\n PROFILE
- A job to analyze a dataset, to determine its size, data\n types, data distribution, and more.
\n RECIPE
- A job to apply one or more transformations to a\n dataset.
The identifier (the user name) of the user who last modified the job.
" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The modification date and time of the job.
" + } + }, + "LogSubscription": { + "target": "com.amazonaws.databrew#LogSubscription", + "traits": { + "smithy.api#documentation": "The current status of Amazon CloudWatch logging for the job.
" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.databrew#MaxCapacity", + "traits": { + "smithy.api#documentation": "The maximum number of nodes that can be consumed when the job processes data.
" + } + }, + "MaxRetries": { + "target": "com.amazonaws.databrew#MaxRetries", + "traits": { + "smithy.api#documentation": "The maximum number of times to retry the job after a job run fails.
" + } + }, + "Outputs": { + "target": "com.amazonaws.databrew#OutputList", + "traits": { + "smithy.api#documentation": "One or more artifacts that represent output from running the job.
" + } + }, + "ProjectName": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project that the job is associated with.
" + } + }, + "RecipeReference": { + "target": "com.amazonaws.databrew#RecipeReference", + "traits": { + "smithy.api#documentation": "A set of steps that the job runs.
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The unique Amazon Resource Name (ARN) for the job.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that will be assumed for this job.
" + } + }, + "Timeout": { + "target": "com.amazonaws.databrew#Timeout", + "traits": { + "smithy.api#documentation": "The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT
.
Metadata tags that have been applied to the job.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents all of the attributes of an AWS Glue DataBrew job.
" + } + }, + "com.amazonaws.databrew#JobList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#Job" + } + }, + "com.amazonaws.databrew#JobName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 240 + } + } + }, + "com.amazonaws.databrew#JobNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#JobName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.databrew#JobRun": { + "type": "structure", + "members": { + "Attempt": { + "target": "com.amazonaws.databrew#Attempt", + "traits": { + "smithy.api#documentation": "The number of times that DataBrew has attempted to run the job.
" + } + }, + "CompletedOn": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time when the job completed processing.
" + } + }, + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset for the job to process.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.databrew#JobRunErrorMessage", + "traits": { + "smithy.api#documentation": "A message indicating an error (if any) that was encountered when the job ran.
" + } + }, + "ExecutionTime": { + "target": "com.amazonaws.databrew#ExecutionTime", + "traits": { + "smithy.api#documentation": "The amount of time, in seconds, during which a job run consumed resources.
" + } + }, + "JobName": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "The name of the job being processed during this run.
" + } + }, + "RunId": { + "target": "com.amazonaws.databrew#JobRunId", + "traits": { + "smithy.api#documentation": "The unique identifier of the job run.
" + } + }, + "State": { + "target": "com.amazonaws.databrew#JobRunState", + "traits": { + "smithy.api#documentation": "The current state of the job run entity itself.
" + } + }, + "LogSubscription": { + "target": "com.amazonaws.databrew#LogSubscription", + "traits": { + "smithy.api#documentation": "The current status of Amazon CloudWatch logging for the job run.
" + } + }, + "LogGroupName": { + "target": "com.amazonaws.databrew#LogGroupName", + "traits": { + "smithy.api#documentation": "The name of an Amazon CloudWatch log group, where the job writes diagnostic messages\n when it runs.
" + } + }, + "Outputs": { + "target": "com.amazonaws.databrew#OutputList", + "traits": { + "smithy.api#documentation": "One or more output artifacts from a job run.
" + } + }, + "RecipeReference": { + "target": "com.amazonaws.databrew#RecipeReference", + "traits": { + "smithy.api#documentation": "The set of steps processed by the job.
" + } + }, + "StartedBy": { + "target": "com.amazonaws.databrew#StartedBy", + "traits": { + "smithy.api#documentation": "The identifier (the user name) of the user who initiated the job run.
" + } + }, + "StartedOn": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time when the job run began.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents one run of an AWS Glue DataBrew job.
" + } + }, + "com.amazonaws.databrew#JobRunErrorMessage": { + "type": "string" + }, + "com.amazonaws.databrew#JobRunId": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#JobRunList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#JobRun" + } + }, + "com.amazonaws.databrew#JobRunState": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STARTING", + "name": "STARTING" + }, + { + "value": "RUNNING", + "name": "RUNNING" + }, + { + "value": "STOPPING", + "name": "STOPPING" + }, + { + "value": "STOPPED", + "name": "STOPPED" + }, + { + "value": "SUCCEEDED", + "name": "SUCCEEDED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "TIMEOUT", + "name": "TIMEOUT" + } + ] + } + }, + "com.amazonaws.databrew#JobType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "PROFILE", + "name": "PROFILE" + }, + { + "value": "RECIPE", + "name": "RECIPE" + } + ] + } + }, + "com.amazonaws.databrew#JsonOptions": { + "type": "structure", + "members": { + "MultiLine": { + "target": "com.amazonaws.databrew#MultiLine", + "traits": { + "smithy.api#documentation": "A value that specifies whether JSON input contains embedded new line\n characters.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the JSON-specific options that define how input is to be interpreted by AWS\n Glue DataBrew.
" + } + }, + "com.amazonaws.databrew#Key": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1280 + } + } + }, + "com.amazonaws.databrew#LastModifiedBy": { + "type": "string" + }, + "com.amazonaws.databrew#ListDatasets": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListDatasetsRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListDatasetsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all of the AWS Glue DataBrew datasets for the current AWS account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/datasets", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Datasets", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListDatasetsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "A token generated by DataBrew that specifies where to continue pagination if a\n previous request was truncated. To get the next set of pages, pass in the NextToken\n value from the response object of the previous page call.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.databrew#ListDatasetsResponse": { + "type": "structure", + "members": { + "Datasets": { + "target": "com.amazonaws.databrew#DatasetList", + "traits": { + "smithy.api#documentation": "A list of datasets that are defined in the current AWS account.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "A token generated by DataBrew that specifies where to continue pagination if a previous\n request was truncated. To obtain the next set of pages, pass in the NextToken from the\n response object of the previous page call.
" + } + } + } + }, + "com.amazonaws.databrew#ListJobRuns": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListJobRunsRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListJobRunsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all of the previous runs of a particular AWS Glue DataBrew job in the current\n AWS account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/jobs/{Name}/jobRuns", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "JobRuns", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListJobRunsRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "The name of the job.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "A token generated by AWS Glue DataBrew that specifies where to continue pagination if\n a previous request was truncated. To get the next set of pages, pass in the NextToken\n value from the response object of the previous page call.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.databrew#ListJobRunsResponse": { + "type": "structure", + "members": { + "JobRuns": { + "target": "com.amazonaws.databrew#JobRunList", + "traits": { + "smithy.api#documentation": "A list of job runs that have occurred for the specified job.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "A token generated by DataBrew that specifies where to continue pagination if a previous\n request was truncated. To obtain the next set of pages, pass in the NextToken from the\n response object of the previous page call.
" + } + } + } + }, + "com.amazonaws.databrew#ListJobs": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListJobsRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListJobsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the AWS Glue DataBrew jobs in the current AWS account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/jobs", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Jobs", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListJobsRequest": { + "type": "structure", + "members": { + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The name of a dataset. Using this parameter indicates to return only those jobs that\n act on the specified dataset.
", + "smithy.api#httpQuery": "datasetName" + } + }, + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "A token generated by DataBrew that specifies where to continue pagination if a\n previous request was truncated. To get the next set of pages, pass in the NextToken\n value from the response object of the previous page call.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "ProjectName": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The name of a project. Using this parameter indicates to return\n only those jobs that are associated with the specified project.
", + "smithy.api#httpQuery": "projectName" + } + } + } + }, + "com.amazonaws.databrew#ListJobsResponse": { + "type": "structure", + "members": { + "Jobs": { + "target": "com.amazonaws.databrew#JobList", + "traits": { + "smithy.api#documentation": "A list of jobs that are defined in the current AWS account.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "A token generated by DataBrew that specifies where to continue pagination if a previous\n request was truncated. To obtain the next set of pages, pass in the NextToken from the\n response object of the previous page call.
" + } + } + } + }, + "com.amazonaws.databrew#ListProjects": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListProjectsRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListProjectsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all of the DataBrew projects in the current AWS account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/projects", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Projects", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListProjectsRequest": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + } + } + }, + "com.amazonaws.databrew#ListProjectsResponse": { + "type": "structure", + "members": { + "Projects": { + "target": "com.amazonaws.databrew#ProjectList", + "traits": { + "smithy.api#documentation": "A list of projects that are defined in the current AWS account.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "A token generated by DataBrew that specifies where to continue pagination if a\n previous request was truncated. To get the next set of pages, pass in the NextToken\n value from the response object of the previous page call.
" + } + } + } + }, + "com.amazonaws.databrew#ListRecipeVersions": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListRecipeVersionsRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListRecipeVersionsResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all of the versions of a particular AWS Glue DataBrew recipe in the current AWS\n account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/recipeVersions", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Recipes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListRecipeVersionsRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The name of the recipe for which to return version information.
", + "smithy.api#httpQuery": "name", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#ListRecipeVersionsResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "A token generated by DataBrew that specifies where to continue pagination if a\n previous request was truncated. To get the next set of pages, pass in the NextToken\n value from the response object of the previous page call.
" + } + }, + "Recipes": { + "target": "com.amazonaws.databrew#RecipeList", + "traits": { + "smithy.api#documentation": "A list of versions for the specified recipe.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#ListRecipes": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListRecipesRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListRecipesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all of the AWS Glue DataBrew recipes in the current AWS account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/recipes", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Recipes", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListRecipesRequest": { + "type": "structure", + "members": { + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
", + "smithy.api#httpQuery": "nextToken" + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "A version identifier. Using this parameter indicates to return only those \n recipes that have this version identifier.
", + "smithy.api#httpQuery": "recipeVersion" + } + } + } + }, + "com.amazonaws.databrew#ListRecipesResponse": { + "type": "structure", + "members": { + "Recipes": { + "target": "com.amazonaws.databrew#RecipeList", + "traits": { + "smithy.api#documentation": "A list of recipes that are defined in the current AWS account.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "A token generated by DataBrew that specifies where to continue pagination if a\n previous request was truncated. To get the next set of pages, pass in the NextToken\n value from the response object of the previous page call.
" + } + } + } + }, + "com.amazonaws.databrew#ListSchedules": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListSchedulesRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListSchedulesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists the AWS Glue DataBrew schedules in the current AWS account.
", + "smithy.api#http": { + "method": "GET", + "uri": "/schedules", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Schedules", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.databrew#ListSchedulesRequest": { + "type": "structure", + "members": { + "JobName": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "The name of the job that these schedules apply to.
", + "smithy.api#httpQuery": "jobName" + } + }, + "MaxResults": { + "target": "com.amazonaws.databrew#MaxResults100", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
", + "smithy.api#httpQuery": "nextToken" + } + } + } + }, + "com.amazonaws.databrew#ListSchedulesResponse": { + "type": "structure", + "members": { + "Schedules": { + "target": "com.amazonaws.databrew#ScheduleList", + "traits": { + "smithy.api#documentation": "A list of schedules in the current AWS account.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.databrew#NextToken", + "traits": { + "smithy.api#documentation": "A token generated by DataBrew that specifies where to continue pagination if a\n previous request was truncated. To get the next set of pages, pass in the NextToken\n value from the response object of the previous page call.
" + } + } + } + }, + "com.amazonaws.databrew#ListTagsForResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#ListTagsForResourceRequest" + }, + "output": { + "target": "com.amazonaws.databrew#ListTagsForResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#InternalServerException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Lists all the tags for an AWS Glue DataBrew resource.
", + "smithy.api#http": { + "method": "GET", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#ListTagsForResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) string that uniquely identifies the DataBrew resource.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#ListTagsForResourceResponse": { + "type": "structure", + "members": { + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "A list of tags associated with the DataBrew resource.
" + } + } + } + }, + "com.amazonaws.databrew#LogGroupName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 512 + } + } + }, + "com.amazonaws.databrew#LogSubscription": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ENABLE", + "name": "ENABLE" + }, + { + "value": "DISABLE", + "name": "DISABLE" + } + ] + } + }, + "com.amazonaws.databrew#MaxCapacity": { + "type": "integer" + }, + "com.amazonaws.databrew#MaxResults100": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 100 + } + } + }, + "com.amazonaws.databrew#MaxRetries": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.databrew#Message": { + "type": "string" + }, + "com.amazonaws.databrew#MultiLine": { + "type": "boolean" + }, + "com.amazonaws.databrew#NextToken": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 2000 + } + } + }, + "com.amazonaws.databrew#OpenedBy": { + "type": "string" + }, + "com.amazonaws.databrew#Operation": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Z\\_]+$" + } + }, + "com.amazonaws.databrew#Output": { + "type": "structure", + "members": { + "CompressionFormat": { + "target": "com.amazonaws.databrew#CompressionFormat", + "traits": { + "smithy.api#documentation": "The compression algorithm used to compress the output text of the job.
" + } + }, + "Format": { + "target": "com.amazonaws.databrew#OutputFormat", + "traits": { + "smithy.api#documentation": "The data format of the output of the job.
" + } + }, + "PartitionColumns": { + "target": "com.amazonaws.databrew#ColumnNameList", + "traits": { + "smithy.api#documentation": "The names of one or more partition columns for the output of the job.
" + } + }, + "Location": { + "target": "com.amazonaws.databrew#S3Location", + "traits": { + "smithy.api#documentation": "The location in Amazon S3 where the job writes its output.
", + "smithy.api#required": {} + } + }, + "Overwrite": { + "target": "com.amazonaws.databrew#OverwriteOutput", + "traits": { + "smithy.api#documentation": "A value that, if true, means that any data in the location specified for output is\n overwritten with new output.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents individual output from a particular job run.
" + } + }, + "com.amazonaws.databrew#OutputFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "CSV", + "name": "CSV" + }, + { + "value": "JSON", + "name": "JSON" + }, + { + "value": "PARQUET", + "name": "PARQUET" + }, + { + "value": "GLUEPARQUET", + "name": "GLUEPARQUET" + }, + { + "value": "AVRO", + "name": "AVRO" + }, + { + "value": "ORC", + "name": "ORC" + }, + { + "value": "XML", + "name": "XML" + } + ] + } + }, + "com.amazonaws.databrew#OutputList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#Output" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, + "com.amazonaws.databrew#OverwriteOutput": { + "type": "boolean" + }, + "com.amazonaws.databrew#ParameterMap": { + "type": "map", + "key": { + "target": "com.amazonaws.databrew#ParameterName" + }, + "value": { + "target": "com.amazonaws.databrew#ParameterValue" + } + }, + "com.amazonaws.databrew#ParameterName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[A-Za-z0-9]+$" + } + }, + "com.amazonaws.databrew#ParameterValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 8192 + } + } + }, + "com.amazonaws.databrew#Preview": { + "type": "boolean" + }, + "com.amazonaws.databrew#Project": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.databrew#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the AWS account that owns the project.
" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the project was created.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "The identifier (the user name) of the user who crated the\n project.
" + } + }, + "DatasetName": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The dataset that the project is to act upon.
" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The last modification date and time for the project.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "The identifier (user name) of the user who last modified the project.
" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The unique name of a project.
", + "smithy.api#required": {} + } + }, + "RecipeName": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The name of a recipe that will be developed during a project session.
", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the project.
" + } + }, + "Sample": { + "target": "com.amazonaws.databrew#Sample", + "traits": { + "smithy.api#documentation": "The sample size and sampling type to apply to the data. If this parameter isn't specified, then the sample will consiste of the first 500 rows from the dataset.
" + } + }, + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "Metadata tags that have been applied to the project.
" + } + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the role that will be assumed for this project.
" + } + }, + "OpenedBy": { + "target": "com.amazonaws.databrew#OpenedBy", + "traits": { + "smithy.api#documentation": "The identifier (the user name) of the user that opened the project for use.
" + } + }, + "OpenDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time when the project was opened.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents all of the attributes of an AWS Glue DataBrew project.
" + } + }, + "com.amazonaws.databrew#ProjectList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#Project" + } + }, + "com.amazonaws.databrew#ProjectName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#PublishRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#PublishRecipeRequest" + }, + "output": { + "target": "com.amazonaws.databrew#PublishRecipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Publishes a new major version of an AWS Glue DataBrew recipe that exists in the\n current AWS account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/recipes/{Name}/publishRecipe", + "code": 200 + } + } + }, + "com.amazonaws.databrew#PublishRecipeRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.databrew#RecipeDescription", + "traits": { + "smithy.api#documentation": "A description of the recipe to be published, for this version of the recipe.
" + } + }, + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The name of the recipe to be published.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#PublishRecipeResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The name of the recipe that you published.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#PublishedBy": { + "type": "string" + }, + "com.amazonaws.databrew#Recipe": { + "type": "structure", + "members": { + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "The identifier (the user name) of the user who created the recipe.
" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the recipe was created.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "The identifier (user name) of the user who last modified the recipe.
" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The last modification date and time of the recipe.
" + } + }, + "ProjectName": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project that the recipe is associated with.
" + } + }, + "PublishedBy": { + "target": "com.amazonaws.databrew#PublishedBy", + "traits": { + "smithy.api#documentation": "The identifier (the user name) of the user who published the recipe.
" + } + }, + "PublishedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time when the recipe was published.
" + } + }, + "Description": { + "target": "com.amazonaws.databrew#RecipeDescription", + "traits": { + "smithy.api#documentation": "The description of the recipe.
" + } + }, + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The unique name for the recipe.
", + "smithy.api#required": {} + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the recipe.
" + } + }, + "Steps": { + "target": "com.amazonaws.databrew#RecipeStepList", + "traits": { + "smithy.api#documentation": "A list of steps that are defined by the recipe.
" + } + }, + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "Metadata tags that have been applied to the recipe.
" + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "The identifier for the version for the recipe.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents one or more actions to be performed on an AWS Glue DataBrew dataset.
" + } + }, + "com.amazonaws.databrew#RecipeAction": { + "type": "structure", + "members": { + "Operation": { + "target": "com.amazonaws.databrew#Operation", + "traits": { + "smithy.api#documentation": "The name of a valid DataBrew transformation to be performed on the data.
", + "smithy.api#required": {} + } + }, + "Parameters": { + "target": "com.amazonaws.databrew#ParameterMap", + "traits": { + "smithy.api#documentation": "Contextual parameters for the transformation.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents a transformation and associated parameters that are used to apply a change\n to an AWS Glue DataBrew dataset. For more information, see Recipe structure and ecipe\n actions reference .
" + } + }, + "com.amazonaws.databrew#RecipeDescription": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 1024 + } + } + }, + "com.amazonaws.databrew#RecipeErrorList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#RecipeVersionErrorDetail" + } + }, + "com.amazonaws.databrew#RecipeErrorMessage": { + "type": "string" + }, + "com.amazonaws.databrew#RecipeList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#Recipe" + } + }, + "com.amazonaws.databrew#RecipeName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#RecipeReference": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The name of the recipe.
", + "smithy.api#required": {} + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "The identifier for the version for the recipe.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents all of the attributes of an AWS Glue DataBrew recipe.
" + } + }, + "com.amazonaws.databrew#RecipeStep": { + "type": "structure", + "members": { + "Action": { + "target": "com.amazonaws.databrew#RecipeAction", + "traits": { + "smithy.api#documentation": "The particular action to be performed in the recipe step.
", + "smithy.api#required": {} + } + }, + "ConditionExpressions": { + "target": "com.amazonaws.databrew#ConditionExpressionList", + "traits": { + "smithy.api#documentation": "One or more conditions that must be met, in order for the recipe step to succeed.
\nAll of the conditions in the array must be met. In other words, all of the\n conditions must be combined using a logical AND operation.
\nRepresents a single step to be performed in an AWS Glue DataBrew recipe.
" + } + }, + "com.amazonaws.databrew#RecipeStepList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#RecipeStep" + } + }, + "com.amazonaws.databrew#RecipeVersion": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 16 + } + } + }, + "com.amazonaws.databrew#RecipeVersionErrorDetail": { + "type": "structure", + "members": { + "ErrorCode": { + "target": "com.amazonaws.databrew#ErrorCode", + "traits": { + "smithy.api#documentation": "The HTTP status code for the error.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.databrew#RecipeErrorMessage", + "traits": { + "smithy.api#documentation": "The text of the error message.
" + } + }, + "RecipeVersion": { + "target": "com.amazonaws.databrew#RecipeVersion", + "traits": { + "smithy.api#documentation": "The identifier for the recipe version associated with this error.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents any errors encountered when attempting to delete multiple recipe versions.
" + } + }, + "com.amazonaws.databrew#RecipeVersionList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#RecipeVersion" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 50 + } + } + }, + "com.amazonaws.databrew#ResourceNotFoundException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.databrew#Message" + } + }, + "traits": { + "smithy.api#documentation": "One or more resources can't be found.
", + "smithy.api#error": "client", + "smithy.api#httpError": 404 + } + }, + "com.amazonaws.databrew#Result": { + "type": "string" + }, + "com.amazonaws.databrew#S3Location": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.databrew#Bucket", + "traits": { + "smithy.api#documentation": "The S3 bucket name.
", + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.databrew#Key", + "traits": { + "smithy.api#documentation": "The unique name of the object in the bucket.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An Amazon S3 location (bucket name an object key) where DataBrew can read input data, or write output from a job.
" + } + }, + "com.amazonaws.databrew#Sample": { + "type": "structure", + "members": { + "Size": { + "target": "com.amazonaws.databrew#SampleSize", + "traits": { + "smithy.api#documentation": "The number of rows in the sample.
" + } + }, + "Type": { + "target": "com.amazonaws.databrew#SampleType", + "traits": { + "smithy.api#documentation": "The way in which DataBrew obtains rows from a dataset.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the sample size and sampling type for AWS Glue DataBrew to use for\n interactive data analysis.
" + } + }, + "com.amazonaws.databrew#SampleSize": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 5000 + } + } + }, + "com.amazonaws.databrew#SampleType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "FIRST_N", + "name": "FIRST_N" + }, + { + "value": "LAST_N", + "name": "LAST_N" + }, + { + "value": "RANDOM", + "name": "RANDOM" + } + ] + } + }, + "com.amazonaws.databrew#Schedule": { + "type": "structure", + "members": { + "AccountId": { + "target": "com.amazonaws.databrew#AccountId", + "traits": { + "smithy.api#documentation": "The ID of the AWS account that owns the schedule.
" + } + }, + "CreatedBy": { + "target": "com.amazonaws.databrew#CreatedBy", + "traits": { + "smithy.api#documentation": "The identifier (the user name) of the user who created the schedule.
" + } + }, + "CreateDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the schedule was created.
" + } + }, + "JobNames": { + "target": "com.amazonaws.databrew#JobNameList", + "traits": { + "smithy.api#documentation": "A list of jobs to be run, according to the schedule.
" + } + }, + "LastModifiedBy": { + "target": "com.amazonaws.databrew#LastModifiedBy", + "traits": { + "smithy.api#documentation": "The identifier (the user name) of the user who last modified the schedule.
" + } + }, + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time when the schedule was last modified.
" + } + }, + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the schedule.
" + } + }, + "CronExpression": { + "target": "com.amazonaws.databrew#CronExpression", + "traits": { + "smithy.api#documentation": "The date(s) and time(s), in cron
format, when the job will run.
Metadata tags that have been applied to the schedule.
" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "The name of the schedule.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Represents one or more dates and times when a job is to run.
" + } + }, + "com.amazonaws.databrew#ScheduleList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#Schedule" + } + }, + "com.amazonaws.databrew#ScheduleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#SendProjectSessionAction": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#SendProjectSessionActionRequest" + }, + "output": { + "target": "com.amazonaws.databrew#SendProjectSessionActionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ConflictException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Performs a recipe step within an interactive AWS Glue DataBrew session that's\n currently open.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/projects/{Name}/sendProjectSessionAction", + "code": 200 + } + } + }, + "com.amazonaws.databrew#SendProjectSessionActionRequest": { + "type": "structure", + "members": { + "Preview": { + "target": "com.amazonaws.databrew#Preview", + "traits": { + "smithy.api#documentation": "Returns the result of the recipe step, without applying it. The result isn't\n added to the view frame stack.
" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project to apply the action to.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RecipeStep": { + "target": "com.amazonaws.databrew#RecipeStep" + }, + "StepIndex": { + "target": "com.amazonaws.databrew#StepIndex", + "traits": { + "smithy.api#documentation": "The index from which to preview a step. This index is used to preview the result of\n steps that have already been applied, so that the resulting view frame is from earlier\n in the view frame stack.
" + } + }, + "ClientSessionId": { + "target": "com.amazonaws.databrew#ClientSessionId", + "traits": { + "smithy.api#documentation": "A unique identifier for an interactive session that's currently open and ready for\n work. The action will be performed on this session.
" + } + }, + "ViewFrame": { + "target": "com.amazonaws.databrew#ViewFrame" + } + } + }, + "com.amazonaws.databrew#SendProjectSessionActionResponse": { + "type": "structure", + "members": { + "Result": { + "target": "com.amazonaws.databrew#Result", + "traits": { + "smithy.api#documentation": "A message indicating the result of performing the action.
" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project that was affected by the action.
", + "smithy.api#required": {} + } + }, + "ActionId": { + "target": "com.amazonaws.databrew#ActionId", + "traits": { + "smithy.api#documentation": "A unique identifier for the action that was performed.
" + } + } + } + }, + "com.amazonaws.databrew#ServiceQuotaExceededException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.databrew#Message" + } + }, + "traits": { + "smithy.api#documentation": "A service quota is exceeded.
", + "smithy.api#error": "client", + "smithy.api#httpError": 402 + } + }, + "com.amazonaws.databrew#SessionStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ASSIGNED", + "name": "ASSIGNED" + }, + { + "value": "FAILED", + "name": "FAILED" + }, + { + "value": "INITIALIZING", + "name": "INITIALIZING" + }, + { + "value": "PROVISIONING", + "name": "PROVISIONING" + }, + { + "value": "READY", + "name": "READY" + }, + { + "value": "RECYCLING", + "name": "RECYCLING" + }, + { + "value": "ROTATING", + "name": "ROTATING" + }, + { + "value": "TERMINATED", + "name": "TERMINATED" + }, + { + "value": "TERMINATING", + "name": "TERMINATING" + }, + { + "value": "UPDATING", + "name": "UPDATING" + } + ] + } + }, + "com.amazonaws.databrew#SheetIndex": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0, + "max": 200 + } + } + }, + "com.amazonaws.databrew#SheetIndexList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#SheetIndex" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.databrew#SheetName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 31 + } + } + }, + "com.amazonaws.databrew#SheetNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#SheetName" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, + "com.amazonaws.databrew#Source": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "S3", + "name": "S3" + }, + { + "value": "DATA-CATALOG", + "name": "DATACATALOG" + } + ] + } + }, + "com.amazonaws.databrew#StartColumnIndex": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.databrew#StartJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#StartJobRunRequest" + }, + "output": { + "target": "com.amazonaws.databrew#StartJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Runs an AWS Glue DataBrew job that exists in the current AWS account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/jobs/{Name}/startJobRun", + "code": 200 + } + } + }, + "com.amazonaws.databrew#StartJobRunRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "The name of the job to be run.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#StartJobRunResponse": { + "type": "structure", + "members": { + "RunId": { + "target": "com.amazonaws.databrew#JobRunId", + "traits": { + "smithy.api#documentation": "A system-generated identifier for this particular job run.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#StartProjectSession": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#StartProjectSessionRequest" + }, + "output": { + "target": "com.amazonaws.databrew#StartProjectSessionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Creates an interactive session, enabling you to manipulate an AWS Glue DataBrew\n project.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/projects/{Name}/startProjectSession", + "code": 200 + } + } + }, + "com.amazonaws.databrew#StartProjectSessionRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project to act upon.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssumeControl": { + "target": "com.amazonaws.databrew#AssumeControl", + "traits": { + "smithy.api#documentation": "A value that, if true, enables you to take control of a session, even if a different client is\n currently accessing the project.
" + } + } + } + }, + "com.amazonaws.databrew#StartProjectSessionResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project to be acted upon.
", + "smithy.api#required": {} + } + }, + "ClientSessionId": { + "target": "com.amazonaws.databrew#ClientSessionId", + "traits": { + "smithy.api#documentation": "A system-generated identifier for the session.
" + } + } + } + }, + "com.amazonaws.databrew#StartedBy": { + "type": "string" + }, + "com.amazonaws.databrew#StepIndex": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.databrew#StopJobRun": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#StopJobRunRequest" + }, + "output": { + "target": "com.amazonaws.databrew#StopJobRunResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Stops the specified job from running in the current AWS account.
", + "smithy.api#http": { + "method": "POST", + "uri": "/jobs/{Name}/jobRun/{RunId}/stopJobRun", + "code": 200 + } + } + }, + "com.amazonaws.databrew#StopJobRunRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#JobName", + "traits": { + "smithy.api#documentation": "The name of the job to be stopped.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "RunId": { + "target": "com.amazonaws.databrew#JobRunId", + "traits": { + "smithy.api#documentation": "The ID of the job run to be stopped.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#StopJobRunResponse": { + "type": "structure", + "members": { + "RunId": { + "target": "com.amazonaws.databrew#JobRunId", + "traits": { + "smithy.api#documentation": "The ID of the job run that you stopped.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#TableName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 255 + } + } + }, + "com.amazonaws.databrew#TagKey": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + } + } + }, + "com.amazonaws.databrew#TagKeyList": { + "type": "list", + "member": { + "target": "com.amazonaws.databrew#TagKey" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.databrew#TagMap": { + "type": "map", + "key": { + "target": "com.amazonaws.databrew#TagKey" + }, + "value": { + "target": "com.amazonaws.databrew#TagValue" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 200 + } + } + }, + "com.amazonaws.databrew#TagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#TagResourceRequest" + }, + "output": { + "target": "com.amazonaws.databrew#TagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#InternalServerException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Adds metadata tags to an AWS Glue DataBrew resource, such as a dataset, job, project,\n or recipe.
", + "smithy.api#http": { + "method": "POST", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#TagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The DataBrew resource to which tags should be added. The value for this parameter is\n an Amazon Resource Name (ARN). For DataBrew, you can tag a dataset, a job, a project, or a\n recipe.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Tags": { + "target": "com.amazonaws.databrew#TagMap", + "traits": { + "smithy.api#documentation": "One or more tags to be assigned to the resource.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#TagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.databrew#TagValue": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 256 + } + } + }, + "com.amazonaws.databrew#TargetColumn": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1024 + } + } + }, + "com.amazonaws.databrew#Timeout": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 0 + } + } + }, + "com.amazonaws.databrew#UntagResource": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UntagResourceRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UntagResourceResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#InternalServerException" + }, + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Removes metadata tags from an AWS Glue DataBrew resource.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/tags/{ResourceArn}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#UntagResourceRequest": { + "type": "structure", + "members": { + "ResourceArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "An DataBrew resource from which you want to remove a tag or tags. The value for this\n parameter is an Amazon Resource Name (ARN).
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "TagKeys": { + "target": "com.amazonaws.databrew#TagKeyList", + "traits": { + "smithy.api#documentation": "The tag keys (names) of one or more tags to be removed.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "com.amazonaws.databrew#UpdateDataset": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UpdateDatasetRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UpdateDatasetResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the definition of an existing AWS Glue DataBrew dataset in the current AWS\n account.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/datasets/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#UpdateDatasetRequest": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "FormatOptions": { + "target": "com.amazonaws.databrew#FormatOptions" + }, + "Input": { + "target": "com.amazonaws.databrew#Input", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateDatasetResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the dataset that you updated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateProfileJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UpdateProfileJobRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UpdateProfileJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the definition of an existing AWS Glue DataBrew job in the current AWS\n account.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/profileJobs/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#UpdateProfileJobRequest": { + "type": "structure", + "members": { + "EncryptionKeyArn": { + "target": "com.amazonaws.databrew#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
" + } + }, + "EncryptionMode": { + "target": "com.amazonaws.databrew#EncryptionMode", + "traits": { + "smithy.api#documentation": "The encryption mode for the job, which can be one of the following:
\n\n SSE-KMS
- Server-side encryption with AWS KMS-managed keys.
\n SSE-S3
- Server-side encryption with keys managed by Amazon S3.
The name of the job to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LogSubscription": { + "target": "com.amazonaws.databrew#LogSubscription", + "traits": { + "smithy.api#documentation": "A value that enables or disables Amazon CloudWatch logging for the current AWS\n account. If logging is enabled, CloudWatch writes one log stream for each job\n run.
" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.databrew#MaxCapacity", + "traits": { + "smithy.api#documentation": "The maximum number of nodes that DataBrew can use when the job processes data.
" + } + }, + "MaxRetries": { + "target": "com.amazonaws.databrew#MaxRetries", + "traits": { + "smithy.api#documentation": "The maximum number of times to retry the job after a job run fails.
" + } + }, + "OutputLocation": { + "target": "com.amazonaws.databrew#S3Location", + "traits": { + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to\n be assumed for this request.
", + "smithy.api#required": {} + } + }, + "Timeout": { + "target": "com.amazonaws.databrew#Timeout", + "traits": { + "smithy.api#documentation": "The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT
.
The name of the job that was updated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateProject": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UpdateProjectRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UpdateProjectResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the definition of an existing AWS Glue DataBrew project in the current AWS\n account.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/projects/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#UpdateProjectRequest": { + "type": "structure", + "members": { + "Sample": { + "target": "com.amazonaws.databrew#Sample" + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role to be assumed for this request.
", + "smithy.api#required": {} + } + }, + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateProjectResponse": { + "type": "structure", + "members": { + "LastModifiedDate": { + "target": "com.amazonaws.databrew#Date", + "traits": { + "smithy.api#documentation": "The date and time that the project was last modified.
" + } + }, + "Name": { + "target": "com.amazonaws.databrew#ProjectName", + "traits": { + "smithy.api#documentation": "The name of the project that you updated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateRecipe": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UpdateRecipeRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UpdateRecipeResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the definition of the latest working version of an AWS Glue DataBrew recipe\n in the current AWS account.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/recipes/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#UpdateRecipeJob": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UpdateRecipeJobRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UpdateRecipeJobResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the definition of an existing AWS Glue DataBrew recipe job in the current AWS\n account.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/recipeJobs/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#UpdateRecipeJobRequest": { + "type": "structure", + "members": { + "EncryptionKeyArn": { + "target": "com.amazonaws.databrew#EncryptionKeyArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an encryption key that is used to protect the job.
" + } + }, + "EncryptionMode": { + "target": "com.amazonaws.databrew#EncryptionMode", + "traits": { + "smithy.api#documentation": "The encryption mode for the job, which can be one of the following:
\n\n SSE-KMS
- Server-side encryption with AWS KMS-managed keys.
\n SSE-S3
- Server-side encryption with keys managed by Amazon S3.
The name of the job to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "LogSubscription": { + "target": "com.amazonaws.databrew#LogSubscription", + "traits": { + "smithy.api#documentation": "A value that enables or disables Amazon CloudWatch logging for the current AWS\n account. If logging is enabled, CloudWatch writes one log stream for each job\n run.
" + } + }, + "MaxCapacity": { + "target": "com.amazonaws.databrew#MaxCapacity", + "traits": { + "smithy.api#documentation": "The maximum number of nodes that DataBrew\n can consume when the job processes data.
" + } + }, + "MaxRetries": { + "target": "com.amazonaws.databrew#MaxRetries", + "traits": { + "smithy.api#documentation": "The maximum number of times to retry the job after a job run fails.
" + } + }, + "Outputs": { + "target": "com.amazonaws.databrew#OutputList", + "traits": { + "smithy.api#documentation": "One or more artifacts that represent the output from running the job.
", + "smithy.api#required": {} + } + }, + "RoleArn": { + "target": "com.amazonaws.databrew#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role to\n be assumed for this request.
", + "smithy.api#required": {} + } + }, + "Timeout": { + "target": "com.amazonaws.databrew#Timeout", + "traits": { + "smithy.api#documentation": "The job's timeout in minutes. A job that attempts to run longer than this timeout\n period ends with a status of TIMEOUT
.
The name of the job that you updated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateRecipeRequest": { + "type": "structure", + "members": { + "Description": { + "target": "com.amazonaws.databrew#RecipeDescription", + "traits": { + "smithy.api#documentation": "A description of the recipe.
" + } + }, + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The name of the recipe to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Steps": { + "target": "com.amazonaws.databrew#RecipeStepList", + "traits": { + "smithy.api#documentation": "One or more steps to be performed by the recipe. Each step consists of an action, and\n the conditions under which the action should succeed.
" + } + } + } + }, + "com.amazonaws.databrew#UpdateRecipeResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#RecipeName", + "traits": { + "smithy.api#documentation": "The name of the recipe that was updated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.databrew#UpdateScheduleRequest" + }, + "output": { + "target": "com.amazonaws.databrew#UpdateScheduleResponse" + }, + "errors": [ + { + "target": "com.amazonaws.databrew#ValidationException" + } + ], + "traits": { + "smithy.api#documentation": "Modifies the definition of an existing AWS Glue DataBrew schedule in the current AWS\n account.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/schedules/{Name}", + "code": 200 + } + } + }, + "com.amazonaws.databrew#UpdateScheduleRequest": { + "type": "structure", + "members": { + "JobNames": { + "target": "com.amazonaws.databrew#JobNameList", + "traits": { + "smithy.api#documentation": "The name or names of one or more jobs to be run for this schedule.
" + } + }, + "CronExpression": { + "target": "com.amazonaws.databrew#CronExpression", + "traits": { + "smithy.api#documentation": "The date or dates and time or times, in cron
format, when the jobs are to\n be run.
The name of the schedule to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#UpdateScheduleResponse": { + "type": "structure", + "members": { + "Name": { + "target": "com.amazonaws.databrew#ScheduleName", + "traits": { + "smithy.api#documentation": "The name of the schedule that was updated.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.databrew#ValidationException": { + "type": "structure", + "members": { + "Message": { + "target": "com.amazonaws.databrew#Message" + } + }, + "traits": { + "smithy.api#documentation": "The input parameters for this request failed validation.
", + "smithy.api#error": "client", + "smithy.api#httpError": 400 + } + }, + "com.amazonaws.databrew#ViewFrame": { + "type": "structure", + "members": { + "StartColumnIndex": { + "target": "com.amazonaws.databrew#StartColumnIndex", + "traits": { + "smithy.api#documentation": "The starting index for the range of columns to return in the view\n frame.
", + "smithy.api#required": {} + } + }, + "ColumnRange": { + "target": "com.amazonaws.databrew#ColumnRange", + "traits": { + "smithy.api#documentation": "The number of columns to include in the view frame, beginning with the\n StartColumnIndex
value and ignoring any columns in the\n HiddenColumns
list.
A list of columns to hide in the view frame.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the data being being transformed during an AWS Glue DataBrew project session.
" + } + } + } +} diff --git a/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json b/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json index 5bd532923eba..18116475d6f3 100644 --- a/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json +++ b/codegen/sdk-codegen/aws-models/datasync.2018-11-09.json @@ -70,6 +70,12 @@ "com.amazonaws.datasync#AgentListEntry": { "type": "structure", "members": { + "AgentArn": { + "target": "com.amazonaws.datasync#AgentArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent.
" + } + }, "Name": { "target": "com.amazonaws.datasync#TagValue", "traits": { @@ -81,12 +87,6 @@ "traits": { "smithy.api#documentation": "The status of the agent.
" } - }, - "AgentArn": { - "target": "com.amazonaws.datasync#AgentArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent.
" - } } }, "traits": { @@ -201,16 +201,10 @@ "smithy.api#required": {} } }, - "SecurityGroupArns": { - "target": "com.amazonaws.datasync#PLSecurityGroupArnList", - "traits": { - "smithy.api#documentation": "The ARNs of the security groups used to protect your data transfer task subnets. See CreateAgentRequest$SubnetArns.
" - } - }, - "VpcEndpointId": { - "target": "com.amazonaws.datasync#VpcEndpointId", + "AgentName": { + "target": "com.amazonaws.datasync#TagValue", "traits": { - "smithy.api#documentation": "The ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is\n the client-side VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC\n endpoint, see Creating a VPC Endpoint Service Configuration in the Amazon VPC User Guide.
\nVPC endpoint ID looks like this: vpce-01234d5aff67890e1
.
The name you configured for your agent. This value is a text reference that is used to\n identify the agent in the console.
" } }, "Tags": { @@ -219,16 +213,22 @@ "smithy.api#documentation": "The key-value pair that represents the tag that you want to associate with the agent.\n The value can be an empty string. This value helps you manage, filter, and search for your\n agents.
\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @.
\nThe ID of the VPC (virtual private cloud) endpoint that the agent has access to. This is\n the client-side VPC endpoint, also called a PrivateLink. If you don't have a PrivateLink VPC\n endpoint, see Creating a VPC Endpoint Service Configuration in the Amazon VPC User Guide.
\nVPC endpoint ID looks like this: vpce-01234d5aff67890e1
.
The Amazon Resource Names (ARNs) of the subnets in which DataSync will create elastic\n network interfaces for each data transfer task. The agent that runs a task must be private.\n When you start a task that is associated with an agent created in a VPC, or one that has\n access to an IP address in a VPC, then the task is also private. In this case, DataSync\n creates four network interfaces for each task in your subnet. For a data transfer to work, the\n agent must be able to route to all these four network interfaces.
" } }, - "AgentName": { - "target": "com.amazonaws.datasync#TagValue", + "SecurityGroupArns": { + "target": "com.amazonaws.datasync#PLSecurityGroupArnList", "traits": { - "smithy.api#documentation": "The name you configured for your agent. This value is a text reference that is used to\n identify the agent in the console.
" + "smithy.api#documentation": "The ARNs of the security groups used to protect your data transfer task subnets. See CreateAgentRequest$SubnetArns.
" } } }, @@ -273,18 +273,19 @@ "com.amazonaws.datasync#CreateLocationEfsRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.datasync#InputTagList", - "traits": { - "smithy.api#documentation": "The key-value pair that represents a tag that you want to add to the resource. The\n value can be an empty string. This value helps you manage, filter, and search for your\n resources. We recommend that you create a name tag for your location.
" - } - }, "Subdirectory": { "target": "com.amazonaws.datasync#EfsSubdirectory", "traits": { "smithy.api#documentation": "A subdirectory in the location’s path. This subdirectory in the EFS file system is used\n to read data from the EFS source location or write data to the EFS destination. By default,\n AWS DataSync uses the root directory.
\n\n Subdirectory
must be specified with forward slashes. For example,\n /path/to/folder
.
The Amazon Resource Name (ARN) for the Amazon EFS file system.
", + "smithy.api#required": {} + } + }, "Ec2Config": { "target": "com.amazonaws.datasync#Ec2Config", "traits": { @@ -292,11 +293,10 @@ "smithy.api#required": {} } }, - "EfsFilesystemArn": { - "target": "com.amazonaws.datasync#EfsFilesystemArn", + "Tags": { + "target": "com.amazonaws.datasync#InputTagList", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the Amazon EFS file system.
", - "smithy.api#required": {} + "smithy.api#documentation": "The key-value pair that represents a tag that you want to add to the resource. The\n value can be an empty string. This value helps you manage, filter, and search for your\n resources. We recommend that you create a name tag for your location.
" } } }, @@ -341,23 +341,23 @@ "com.amazonaws.datasync#CreateLocationFsxWindowsRequest": { "type": "structure", "members": { - "SecurityGroupArns": { - "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", + "Subdirectory": { + "target": "com.amazonaws.datasync#FsxWindowsSubdirectory", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the security groups that are to use to configure the\n FSx for Windows file system.
", - "smithy.api#required": {} + "smithy.api#documentation": "A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows file system is used\n to read data from the Amazon FSx for Windows source location or write data to the FSx for Windows destination.
" } }, - "Domain": { - "target": "com.amazonaws.datasync#SmbDomain", + "FsxFilesystemArn": { + "target": "com.amazonaws.datasync#FsxFilesystemArn", "traits": { - "smithy.api#documentation": "The name of the Windows domain that the FSx for Windows server belongs to.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the FSx for Windows file system.
", + "smithy.api#required": {} } }, - "Password": { - "target": "com.amazonaws.datasync#SmbPassword", + "SecurityGroupArns": { + "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", "traits": { - "smithy.api#documentation": "The password of the user who has the permissions to access files and folders in the\n FSx for Windows file system.
", + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the security groups that are to use to configure the\n FSx for Windows file system.
", "smithy.api#required": {} } }, @@ -367,23 +367,23 @@ "smithy.api#documentation": "The key-value pair that represents a tag that you want to add to the resource. The\n value can be an empty string. This value helps you manage, filter, and search for your\n resources. We recommend that you create a name tag for your location.
" } }, - "Subdirectory": { - "target": "com.amazonaws.datasync#FsxWindowsSubdirectory", + "User": { + "target": "com.amazonaws.datasync#SmbUser", "traits": { - "smithy.api#documentation": "A subdirectory in the location’s path. This subdirectory in the Amazon FSx for Windows file system is used\n to read data from the Amazon FSx for Windows source location or write data to the FSx for Windows destination.
" + "smithy.api#documentation": "The user who has the permissions to access files and folders in the\n FSx for Windows file system.
", + "smithy.api#required": {} } }, - "FsxFilesystemArn": { - "target": "com.amazonaws.datasync#FsxFilesystemArn", + "Domain": { + "target": "com.amazonaws.datasync#SmbDomain", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the FSx for Windows file system.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the Windows domain that the FSx for Windows server belongs to.
" } }, - "User": { - "target": "com.amazonaws.datasync#SmbUser", + "Password": { + "target": "com.amazonaws.datasync#SmbPassword", "traits": { - "smithy.api#documentation": "The user who has the permissions to access files and folders in the\n FSx for Windows file system.
", + "smithy.api#documentation": "The password of the user who has the permissions to access files and folders in the\n FSx for Windows file system.
", "smithy.api#required": {} } } @@ -423,25 +423,13 @@ "com.amazonaws.datasync#CreateLocationNfsRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.datasync#InputTagList", - "traits": { - "smithy.api#documentation": "The key-value pair that represents the tag that you want to add to the location. The\n value can be an empty string. We recommend using tags to name your resources.
" - } - }, "Subdirectory": { "target": "com.amazonaws.datasync#NfsSubdirectory", "traits": { - "smithy.api#documentation": "The subdirectory in the NFS file system that is used to read data from the NFS source\n location or write data to the NFS destination. The NFS path should be a path that's\n exported by the NFS server, or a subdirectory of that path. The path should be such that it\n can be mounted by other NFS clients in your network.
\nTo see all the paths exported by your NFS server. run \"showmount -e\n nfs-server-name
\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.
To transfer all the data in the folder you specified, DataSync needs to have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash,
or ensure that the permissions for all of the files that you\n want DataSync allow read access for all users. Doing either enables the agent to read the\n files. For the agent to access directories, you must additionally enable all execute\n access.
If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.
\n \nFor information about NFS export configuration, see 18.7. The /etc/exports\n Configuration File in the Red Hat Enterprise Linux documentation.
", + "smithy.api#documentation": "The subdirectory in the NFS file system that is used to read data from the NFS source\n location or write data to the NFS destination. The NFS path should be a path that's\n exported by the NFS server, or a subdirectory of that path. The path should be such that it\n can be mounted by other NFS clients in your network.
\nTo see all the paths exported by your NFS server, run \"showmount -e\n nfs-server-name
\" from an NFS client that has access to your server. You can specify\n any directory that appears in the results, and any subdirectory of that directory. Ensure that\n the NFS export is accessible without Kerberos authentication.
To transfer all the data in the folder you specified, DataSync needs to have\n permissions to read all the data. To ensure this, either configure the NFS export with\n no_root_squash,
or ensure that the permissions for all of the files that you\n want DataSync allow read access for all users. Doing either enables the agent to read the\n files. For the agent to access directories, you must additionally enable all execute\n access.
If you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.
\n \nFor information about NFS export configuration, see 18.7. The /etc/exports\n Configuration File in the Red Hat Enterprise Linux documentation.
", "smithy.api#required": {} } }, - "MountOptions": { - "target": "com.amazonaws.datasync#NfsMountOptions", - "traits": { - "smithy.api#documentation": "The NFS mount options that DataSync can use to mount your NFS share.
" - } - }, "ServerHostname": { "target": "com.amazonaws.datasync#ServerHostname", "traits": { @@ -455,6 +443,18 @@ "smithy.api#documentation": "Contains a list of Amazon Resource Names (ARNs) of agents that are used to connect to\n an NFS server.
\nIf you are copying data to or from your AWS Snowcone device, see NFS Server on AWS Snowcone for more information.
", "smithy.api#required": {} } + }, + "MountOptions": { + "target": "com.amazonaws.datasync#NfsMountOptions", + "traits": { + "smithy.api#documentation": "The NFS mount options that DataSync can use to mount your NFS share.
" + } + }, + "Tags": { + "target": "com.amazonaws.datasync#InputTagList", + "traits": { + "smithy.api#documentation": "The key-value pair that represents the tag that you want to add to the location. The\n value can be an empty string. We recommend using tags to name your resources.
" + } } }, "traits": { @@ -498,18 +498,6 @@ "com.amazonaws.datasync#CreateLocationObjectStorageRequest": { "type": "structure", "members": { - "ServerProtocol": { - "target": "com.amazonaws.datasync#ObjectStorageServerProtocol", - "traits": { - "smithy.api#documentation": "The protocol that the object storage server uses to communicate. \n Valid values are HTTP or HTTPS.
" - } - }, - "SecretKey": { - "target": "com.amazonaws.datasync#ObjectStorageSecretKey", - "traits": { - "smithy.api#documentation": "Optional. The secret key is used if credentials are required to access the self-managed\n object storage server. If your object storage requires a user name and password to\n authenticate, use AccessKey
and SecretKey
to provide the user name\n and password, respectively.
The bucket on the self-managed object storage server that is used\n to read data from.
", - "smithy.api#required": {} + "smithy.api#documentation": "The port that your self-managed object storage server accepts inbound network traffic on.\n The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can \n specify a custom port if your self-managed object storage server requires one.
" + } + }, + "ServerProtocol": { + "target": "com.amazonaws.datasync#ObjectStorageServerProtocol", + "traits": { + "smithy.api#documentation": "The protocol that the object storage server uses to communicate. \n Valid values are HTTP or HTTPS.
" } }, "Subdirectory": { @@ -530,16 +523,23 @@ "smithy.api#documentation": "The subdirectory in the self-managed object storage server that is used\n to read data from.
" } }, + "BucketName": { + "target": "com.amazonaws.datasync#ObjectStorageBucketName", + "traits": { + "smithy.api#documentation": "The bucket on the self-managed object storage server that is used\n to read data from.
", + "smithy.api#required": {} + } + }, "AccessKey": { "target": "com.amazonaws.datasync#ObjectStorageAccessKey", "traits": { "smithy.api#documentation": "Optional. The access key is used if credentials are required to access the self-managed\n object storage server. If your object storage requires a user name and password to\n authenticate, use AccessKey
and SecretKey
to provide the user name\n and password, respectively.
The port that your self-managed object storage server accepts inbound network traffic on.\n The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can \n specify a custom port if your self-managed object storage server requires one.
" + "smithy.api#documentation": "Optional. The secret key is used if credentials are required to access the self-managed\n object storage server. If your object storage requires a user name and password to\n authenticate, use AccessKey
and SecretKey
to provide the user name\n and password, respectively.
Creates an endpoint for an Amazon S3 bucket.
\n\n \nFor more information, see\n https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli\n in the AWS DataSync User Guide.
" + "smithy.api#documentation": "Creates an endpoint for an Amazon S3 bucket.
\n\n \nFor\n more information, see\n https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli\n in the AWS DataSync User Guide.
" } }, "com.amazonaws.datasync#CreateLocationS3Request": { "type": "structure", "members": { - "S3BucketArn": { - "target": "com.amazonaws.datasync#S3BucketArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon S3 bucket. If the bucket is on an \n AWS Outpost, this must be an access point ARN.
", - "smithy.api#required": {} - } - }, - "AgentArns": { - "target": "com.amazonaws.datasync#AgentArnList", + "Subdirectory": { + "target": "com.amazonaws.datasync#S3Subdirectory", "traits": { - "smithy.api#documentation": "If you are using DataSync on an AWS Outpost, specify the Amazon Resource Names (ARNs) of \n the DataSync agents deployed on your AWS Outpost. For more information about launching a \n DataSync agent on an Amazon Outpost, see outposts-agent.
" + "smithy.api#documentation": "A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read\n data from the S3 source location or write data to the S3 destination.
" } }, - "Tags": { - "target": "com.amazonaws.datasync#InputTagList", + "S3BucketArn": { + "target": "com.amazonaws.datasync#S3BucketArn", "traits": { - "smithy.api#documentation": "The key-value pair that represents the tag that you want to add to the location. The\n value can be an empty string. We recommend using tags to name your resources.
" + "smithy.api#documentation": "The ARN of the Amazon S3 bucket. If the bucket is on an AWS Outpost, this must be an\n access point ARN.
", + "smithy.api#required": {} } }, "S3StorageClass": { "target": "com.amazonaws.datasync#S3StorageClass", "traits": { - "smithy.api#documentation": "The Amazon S3 storage class that you want to store your files in when this location is\n used as a task destination. For buckets in AWS Regions, the storage class defaults to Standard.\n For buckets on AWS Outposts, the storage class defaults to AWS S3 Outposts.
\n \nFor more information about S3 storage classes, see Amazon S3 Storage Classes in the\n Amazon Simple Storage Service Developer Guide. Some storage classes\n have behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes.
" + "smithy.api#documentation": "The Amazon S3 storage class that you want to store your files in when this location is\n used as a task destination. For buckets in AWS Regions, the storage class defaults to Standard.\n For buckets on AWS Outposts, the storage class defaults to AWS S3 Outposts.
\n \nFor more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage classes have behaviors that\n can affect your S3 storage cost. For detailed information, see using-storage-classes.
" } }, "S3Config": { @@ -628,10 +622,16 @@ "smithy.api#required": {} } }, - "Subdirectory": { - "target": "com.amazonaws.datasync#S3Subdirectory", + "AgentArns": { + "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used to read\n data from the S3 source location or write data to the S3 destination.
" + "smithy.api#documentation": "If you are using DataSync on an AWS Outpost, specify the Amazon Resource Names (ARNs) of\n the DataSync agents deployed on your Outpost. For more information about launching a DataSync\n agent on an AWS Outpost, see outposts-agent.
" + } + }, + "Tags": { + "target": "com.amazonaws.datasync#InputTagList", + "traits": { + "smithy.api#documentation": "The key-value pair that represents the tag that you want to add to the location. The\n value can be an empty string. We recommend using tags to name your resources.
" } } }, @@ -676,18 +676,6 @@ "com.amazonaws.datasync#CreateLocationSmbRequest": { "type": "structure", "members": { - "Domain": { - "target": "com.amazonaws.datasync#SmbDomain", - "traits": { - "smithy.api#documentation": "The name of the Windows domain that the SMB server belongs to.
" - } - }, - "MountOptions": { - "target": "com.amazonaws.datasync#SmbMountOptions", - "traits": { - "smithy.api#documentation": "The mount options used by DataSync to access the SMB server.
" - } - }, "Subdirectory": { "target": "com.amazonaws.datasync#SmbSubdirectory", "traits": { @@ -695,6 +683,13 @@ "smithy.api#required": {} } }, + "ServerHostname": { + "target": "com.amazonaws.datasync#ServerHostname", + "traits": { + "smithy.api#documentation": "The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name\n of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB\n server in a network.
\nThis name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
\nThe name of the Windows domain that the SMB server belongs to.
" + } + }, "Password": { "target": "com.amazonaws.datasync#SmbPassword", "traits": { @@ -709,24 +710,23 @@ "smithy.api#required": {} } }, - "ServerHostname": { - "target": "com.amazonaws.datasync#ServerHostname", + "AgentArns": { + "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "The name of the SMB server. This value is the IP address or Domain Name Service (DNS) name\n of the SMB server. An agent that is installed on-premises uses this hostname to mount the SMB\n server in a network.
\nThis name must either be DNS-compliant or must be an IP version 4 (IPv4) address.
\nThe Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB)\n location.
", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.datasync#InputTagList", + "MountOptions": { + "target": "com.amazonaws.datasync#SmbMountOptions", "traits": { - "smithy.api#documentation": "The key-value pair that represents the tag that you want to add to the location. The value\n can be an empty string. We recommend using tags to name your resources.
" + "smithy.api#documentation": "The mount options used by DataSync to access the SMB server.
" } }, - "AgentArns": { - "target": "com.amazonaws.datasync#AgentArnList", + "Tags": { + "target": "com.amazonaws.datasync#InputTagList", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block (SMB)\n location.
", - "smithy.api#required": {} + "smithy.api#documentation": "The key-value pair that represents the tag that you want to add to the location. The value\n can be an empty string. We recommend using tags to name your resources.
" } } }, @@ -778,41 +778,35 @@ "smithy.api#required": {} } }, - "Options": { - "target": "com.amazonaws.datasync#Options", - "traits": { - "smithy.api#documentation": "The set of configuration options that control the behavior of a single execution of the\n task that occurs when you call StartTaskExecution
. You can configure these\n options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data\n integrity verification, and so on.
For each individual task execution, you can override these options by specifying the\n OverrideOptions
before starting the task execution. For more information, see\n the operation.
The name of a task. This value is a text reference that is used to identify the task in\n the console.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an AWS storage resource's location.
", + "smithy.api#required": {} } }, - "Excludes": { - "target": "com.amazonaws.datasync#FilterList", + "CloudWatchLogGroupArn": { + "target": "com.amazonaws.datasync#LogGroupArn", "traits": { - "smithy.api#documentation": "A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\"
\n
\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to\n monitor and log events in the task.
" } }, - "Tags": { - "target": "com.amazonaws.datasync#InputTagList", + "Name": { + "target": "com.amazonaws.datasync#TagValue", "traits": { - "smithy.api#documentation": "The key-value pair that represents the tag that you want to add to the resource. The\n value can be an empty string.
" + "smithy.api#documentation": "The name of a task. This value is a text reference that is used to identify the task in\n the console.
" } }, - "DestinationLocationArn": { - "target": "com.amazonaws.datasync#LocationArn", + "Options": { + "target": "com.amazonaws.datasync#Options", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an AWS storage resource's location.
", - "smithy.api#required": {} + "smithy.api#documentation": "The set of configuration options that control the behavior of a single execution of the\n task that occurs when you call StartTaskExecution
. You can configure these\n options to preserve metadata such as user ID (UID) and group ID (GID), file permissions, data\n integrity verification, and so on.
For each individual task execution, you can override these options by specifying the\n OverrideOptions
before starting the task execution. For more information, see\n the operation.
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to\n monitor and log events in the task.
" + "smithy.api#documentation": "A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example, \"/folder1|/folder2\"
.
\n
" } }, "Schedule": { @@ -820,6 +814,12 @@ "traits": { "smithy.api#documentation": "Specifies a schedule used to periodically transfer files from a source to a destination\n location. The schedule should be specified in UTC time. For more information, see task-scheduling.
" } + }, + "Tags": { + "target": "com.amazonaws.datasync#InputTagList", + "traits": { + "smithy.api#documentation": "The key-value pair that represents the tag that you want to add to the resource. The\n value can be an empty string.
" + } } }, "traits": { @@ -995,22 +995,16 @@ "com.amazonaws.datasync#DescribeAgentResponse": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.datasync#Time", - "traits": { - "smithy.api#documentation": "The time that the agent was activated (that is, created in your account).
" - } - }, "AgentArn": { "target": "com.amazonaws.datasync#AgentArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agent.
" } }, - "EndpointType": { - "target": "com.amazonaws.datasync#EndpointType", + "Name": { + "target": "com.amazonaws.datasync#TagValue", "traits": { - "smithy.api#documentation": "The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint,\n the agent is not accessible over the public internet.
" + "smithy.api#documentation": "The name of the agent.
" } }, "Status": { @@ -1019,22 +1013,28 @@ "smithy.api#documentation": "The status of the agent. If the status is ONLINE, then the agent is configured properly\n and is available to use. The Running status is the normal running status for an agent. If the\n status is OFFLINE, the agent's VM is turned off or the agent is in an unhealthy state. When\n the issue that caused the unhealthy state is resolved, the agent returns to ONLINE\n status.
" } }, - "PrivateLinkConfig": { - "target": "com.amazonaws.datasync#PrivateLinkConfig", + "LastConnectionTime": { + "target": "com.amazonaws.datasync#Time", "traits": { - "smithy.api#documentation": "The subnet and the security group that DataSync used to access a VPC endpoint.
" + "smithy.api#documentation": "The time that the agent last connected to DataSyc.
" } }, - "LastConnectionTime": { + "CreationTime": { "target": "com.amazonaws.datasync#Time", "traits": { - "smithy.api#documentation": "The time that the agent last connected to DataSyc.
" + "smithy.api#documentation": "The time that the agent was activated (that is, created in your account).
" } }, - "Name": { - "target": "com.amazonaws.datasync#TagValue", + "EndpointType": { + "target": "com.amazonaws.datasync#EndpointType", "traits": { - "smithy.api#documentation": "The name of the agent.
" + "smithy.api#documentation": "The type of endpoint that your agent is connected to. If the endpoint is a VPC endpoint,\n the agent is not accessible over the public internet.
" + } + }, + "PrivateLinkConfig": { + "target": "com.amazonaws.datasync#PrivateLinkConfig", + "traits": { + "smithy.api#documentation": "The subnet and the security group that DataSync used to access a VPC endpoint.
" } } }, @@ -1080,15 +1080,6 @@ "com.amazonaws.datasync#DescribeLocationEfsResponse": { "type": "structure", "members": { - "CreationTime": { - "target": "com.amazonaws.datasync#Time", - "traits": { - "smithy.api#documentation": "The time that the EFS location was created.
" - } - }, - "Ec2Config": { - "target": "com.amazonaws.datasync#Ec2Config" - }, "LocationArn": { "target": "com.amazonaws.datasync#LocationArn", "traits": { @@ -1100,6 +1091,15 @@ "traits": { "smithy.api#documentation": "The URL of the EFS location that was described.
" } + }, + "Ec2Config": { + "target": "com.amazonaws.datasync#Ec2Config" + }, + "CreationTime": { + "target": "com.amazonaws.datasync#Time", + "traits": { + "smithy.api#documentation": "The time that the EFS location was created.
" + } } }, "traits": { @@ -1153,10 +1153,10 @@ "smithy.api#documentation": "The URL of the FSx for Windows location that was described.
" } }, - "User": { - "target": "com.amazonaws.datasync#SmbUser", + "SecurityGroupArns": { + "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", "traits": { - "smithy.api#documentation": "The user who has the permissions to access files and folders in the\n FSx for Windows file system.
" + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx\n for Windows file system.
" } }, "CreationTime": { @@ -1165,10 +1165,10 @@ "smithy.api#documentation": "The time that the FSx for Windows location was created.
" } }, - "SecurityGroupArns": { - "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", + "User": { + "target": "com.amazonaws.datasync#SmbUser", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the security groups that are configured for the FSx\n for Windows file system.
" + "smithy.api#documentation": "The user who has the permissions to access files and folders in the\n FSx for Windows file system.
" } }, "Domain": { @@ -1217,10 +1217,10 @@ "com.amazonaws.datasync#DescribeLocationNfsResponse": { "type": "structure", "members": { - "MountOptions": { - "target": "com.amazonaws.datasync#NfsMountOptions", + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "The NFS mount options that DataSync used to mount your NFS share.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the NFS location that was described.
" } }, "LocationUri": { @@ -1229,20 +1229,20 @@ "smithy.api#documentation": "The URL of the source NFS location that was described.
" } }, - "LocationArn": { - "target": "com.amazonaws.datasync#LocationArn", + "OnPremConfig": { + "target": "com.amazonaws.datasync#OnPremConfig" + }, + "MountOptions": { + "target": "com.amazonaws.datasync#NfsMountOptions", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the NFS location that was described.
" + "smithy.api#documentation": "The NFS mount options that DataSync used to mount your NFS share.
" } }, "CreationTime": { "target": "com.amazonaws.datasync#Time", "traits": { "smithy.api#documentation": "The time that the NFS location was created.
" - } - }, - "OnPremConfig": { - "target": "com.amazonaws.datasync#OnPremConfig" + } } }, "traits": { @@ -1287,22 +1287,10 @@ "com.amazonaws.datasync#DescribeLocationObjectStorageResponse": { "type": "structure", "members": { - "AgentArns": { - "target": "com.amazonaws.datasync#AgentArnList", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agents associated with the \n self-managed object storage server location.
" - } - }, - "CreationTime": { - "target": "com.amazonaws.datasync#Time", - "traits": { - "smithy.api#documentation": "The time that the self-managed object storage server agent was created.
" - } - }, - "ServerProtocol": { - "target": "com.amazonaws.datasync#ObjectStorageServerProtocol", + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "The protocol that the object storage server uses to communicate. \n Valid values are HTTP or HTTPS.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the self-managed object storage server location to describe.
" } }, "LocationUri": { @@ -1323,10 +1311,22 @@ "smithy.api#documentation": "The port that your self-managed object storage server accepts inbound network traffic on.\n The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS).
" } }, - "LocationArn": { - "target": "com.amazonaws.datasync#LocationArn", + "ServerProtocol": { + "target": "com.amazonaws.datasync#ObjectStorageServerProtocol", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the self-managed object storage server location to describe.
" + "smithy.api#documentation": "The protocol that the object storage server uses to communicate. \n Valid values are HTTP or HTTPS.
" + } + }, + "AgentArns": { + "target": "com.amazonaws.datasync#AgentArnList", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the agents associated with the \n self-managed object storage server location.
" + } + }, + "CreationTime": { + "target": "com.amazonaws.datasync#Time", + "traits": { + "smithy.api#documentation": "The time that the self-managed object storage server agent was created.
" } } }, @@ -1384,10 +1384,19 @@ "smithy.api#documentation": "The URL of the Amazon S3 location that was described.
" } }, + "S3StorageClass": { + "target": "com.amazonaws.datasync#S3StorageClass", + "traits": { + "smithy.api#documentation": "The Amazon S3 storage class that you chose to store your files in when this location is\n used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes. Some storage\n classes have behaviors that can affect your S3 storage cost. For detailed information, see\n using-storage-classes.
" + } + }, + "S3Config": { + "target": "com.amazonaws.datasync#S3Config" + }, "AgentArns": { "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "If you are using DataSync on an Amazon Outpost, the Amazon Resource Name (ARNs) \n of the EC2 agents deployed on your AWS Outpost. For more information about launching \n a DataSync agent on an Amazon Outpost, see outposts-agent.
" + "smithy.api#documentation": "If you are using DataSync on an AWS Outpost, the Amazon Resource Name (ARNs) of the EC2\n agents deployed on your Outpost. For more information about launching a DataSync agent on an\n AWS Outpost, see outposts-agent.
" } }, "CreationTime": { @@ -1395,15 +1404,6 @@ "traits": { "smithy.api#documentation": "The time that the Amazon S3 bucket location was created.
" } - }, - "S3StorageClass": { - "target": "com.amazonaws.datasync#S3StorageClass", - "traits": { - "smithy.api#documentation": "The Amazon S3 storage class that you chose to store your files in when this location is\n used as a task destination. For more information about S3 storage classes, see Amazon S3 Storage Classes in the\n Amazon Simple Storage Service Developer Guide. Some storage classes\n have behaviors that can affect your S3 storage cost. For detailed information, see using-storage-classes.
" - } - }, - "S3Config": { - "target": "com.amazonaws.datasync#S3Config" } }, "traits": { @@ -1448,16 +1448,10 @@ "com.amazonaws.datasync#DescribeLocationSmbResponse": { "type": "structure", "members": { - "AgentArns": { - "target": "com.amazonaws.datasync#AgentArnList", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source SMB file system location that is\n created.
" - } - }, - "User": { - "target": "com.amazonaws.datasync#SmbUser", + "LocationArn": { + "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "The user who can mount the share, has the permissions to access files and folders in the\n SMB share.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SMB location that was described.
" } }, "LocationUri": { @@ -1466,22 +1460,22 @@ "smithy.api#documentation": "The URL of the source SBM location that was described.
" } }, - "CreationTime": { - "target": "com.amazonaws.datasync#Time", + "AgentArns": { + "target": "com.amazonaws.datasync#AgentArnList", "traits": { - "smithy.api#documentation": "The time that the SMB location was created.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source SMB file system location that is\n created.
" } }, - "Domain": { - "target": "com.amazonaws.datasync#SmbDomain", + "User": { + "target": "com.amazonaws.datasync#SmbUser", "traits": { - "smithy.api#documentation": "The name of the Windows domain that the SMB server belongs to.
" + "smithy.api#documentation": "The user who can mount the share, has the permissions to access files and folders in the\n SMB share.
" } }, - "LocationArn": { - "target": "com.amazonaws.datasync#LocationArn", + "Domain": { + "target": "com.amazonaws.datasync#SmbDomain", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the SMB location that was described.
" + "smithy.api#documentation": "The name of the Windows domain that the SMB server belongs to.
" } }, "MountOptions": { @@ -1489,6 +1483,12 @@ "traits": { "smithy.api#documentation": "The mount options that are available for DataSync to use to access an SMB location.
" } + }, + "CreationTime": { + "target": "com.amazonaws.datasync#Time", + "traits": { + "smithy.api#documentation": "The time that the SMB location was created.
" + } } }, "traits": { @@ -1553,8 +1553,11 @@ "com.amazonaws.datasync#DescribeTaskExecutionResponse": { "type": "structure", "members": { - "Options": { - "target": "com.amazonaws.datasync#Options" + "TaskExecutionArn": { + "target": "com.amazonaws.datasync#TaskExecutionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution that was described.\n TaskExecutionArn
is hierarchical and includes TaskArn
for the task\n that was executed.
For example, a TaskExecution
value with the ARN\n arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
\n executed the task with the ARN\n arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2
.
The status of the task execution.
\n\n \nFor detailed information about task execution statuses, see Understanding\n Task Statuses in the AWS DataSync User Guide.\n
" } }, - "BytesTransferred": { - "target": "com.amazonaws.datasync#long", - "traits": { - "smithy.api#documentation": "The physical number of bytes transferred over the network.
" - } - }, - "FilesTransferred": { - "target": "com.amazonaws.datasync#long", - "traits": { - "smithy.api#documentation": "The actual number of files that was transferred over the network. This value is\n calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated\n periodically when each file is read from the source and sent over the network.
\nIf failures occur during a transfer, this value can be less than\n EstimatedFilesToTransfer
. This value can also be greater than\n EstimatedFilesTransferred
in some cases. This element is\n implementation-specific for some location types, so don't use it as an indicator for a correct\n file number or to monitor your task execution.
A list of filter rules that determines which files to include when running a task. The\n list should contain a single filter string that consists of the patterns to include. The\n patterns are delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"
\n
\n
" } }, - "BytesWritten": { - "target": "com.amazonaws.datasync#long", + "StartTime": { + "target": "com.amazonaws.datasync#Time", "traits": { - "smithy.api#documentation": "The number of logical bytes written to the destination AWS storage resource.
" + "smithy.api#documentation": "The time that the task execution was started.
" } }, "EstimatedFilesToTransfer": { @@ -1598,28 +1592,34 @@ "smithy.api#documentation": "The expected number of files that is to be transferred over the network. This value is\n calculated during the PREPARING phase, before the TRANSFERRING phase. This value is the\n expected number of files to be transferred. It's calculated based on comparing the\n content of the source and destination locations and finding the delta that needs to be\n transferred.
" } }, - "Result": { - "target": "com.amazonaws.datasync#TaskExecutionResultDetail", + "EstimatedBytesToTransfer": { + "target": "com.amazonaws.datasync#long", "traits": { - "smithy.api#documentation": "The result of the task execution.
" + "smithy.api#documentation": "The estimated physical number of bytes that is to be transferred over the\n network.
" } }, - "TaskExecutionArn": { - "target": "com.amazonaws.datasync#TaskExecutionArn", + "FilesTransferred": { + "target": "com.amazonaws.datasync#long", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution that was described.\n TaskExecutionArn
is hierarchical and includes TaskArn
for the task\n that was executed.
For example, a TaskExecution
value with the ARN\n arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
\n executed the task with the ARN\n arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2
.
The actual number of files that was transferred over the network. This value is\n calculated and updated on an ongoing basis during the TRANSFERRING phase. It's updated\n periodically when each file is read from the source and sent over the network.
\nIf failures occur during a transfer, this value can be less than\n EstimatedFilesToTransfer
. This value can also be greater than\n EstimatedFilesTransferred
in some cases. This element is\n implementation-specific for some location types, so don't use it as an indicator for a correct\n file number or to monitor your task execution.
The estimated physical number of bytes that is to be transferred over the\n network.
" + "smithy.api#documentation": "The number of logical bytes written to the destination AWS storage resource.
" } }, - "StartTime": { - "target": "com.amazonaws.datasync#Time", + "BytesTransferred": { + "target": "com.amazonaws.datasync#long", "traits": { - "smithy.api#documentation": "The time that the task execution was started.
" + "smithy.api#documentation": "The physical number of bytes transferred over the network.
" + } + }, + "Result": { + "target": "com.amazonaws.datasync#TaskExecutionResultDetail", + "traits": { + "smithy.api#documentation": "The result of the task execution.
" } } }, @@ -1645,16 +1645,16 @@ "com.amazonaws.datasync#DescribeTaskResponse": { "type": "structure", "members": { - "ErrorDetail": { - "target": "com.amazonaws.datasync#string", + "TaskArn": { + "target": "com.amazonaws.datasync#TaskArn", "traits": { - "smithy.api#documentation": "Detailed description of an error that was encountered during the task execution. You\n can use this information to help troubleshoot issues.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task that was described.
" } }, - "DestinationNetworkInterfaceArns": { - "target": "com.amazonaws.datasync#DestinationNetworkInterfaceArns", + "Status": { + "target": "com.amazonaws.datasync#TaskStatus", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that\n was created for your subnet.
" + "smithy.api#documentation": "The status of the task that was described.
\n\n \nFor detailed information about task execution statuses, see Understanding\n Task Statuses in the AWS DataSync User Guide.
" } }, "Name": { @@ -1669,10 +1669,10 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution that is syncing files.
" } }, - "Excludes": { - "target": "com.amazonaws.datasync#FilterList", + "SourceLocationArn": { + "target": "com.amazonaws.datasync#LocationArn", "traits": { - "smithy.api#documentation": "A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"
\n
\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source file system's location.
" } }, "DestinationLocationArn": { @@ -1681,10 +1681,10 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS storage resource's location.
" } }, - "TaskArn": { - "target": "com.amazonaws.datasync#TaskArn", + "CloudWatchLogGroupArn": { + "target": "com.amazonaws.datasync#LogGroupArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task that was described.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to\n monitor and log events in the task.
\n\n \nFor more information on these groups, see Working with Log Groups and Log\n Streams in the Amazon CloudWatch User Guide.
" } }, "SourceNetworkInterfaceArns": { @@ -1693,46 +1693,46 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) that was\n created for your subnet.
" } }, - "Status": { - "target": "com.amazonaws.datasync#TaskStatus", + "DestinationNetworkInterfaceArns": { + "target": "com.amazonaws.datasync#DestinationNetworkInterfaceArns", "traits": { - "smithy.api#documentation": "The status of the task that was described.
\n\n \nFor detailed information about task execution statuses, see Understanding\n Task Statuses in the AWS DataSync User Guide.\n
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) that\n was created for your subnet.
" } }, - "Schedule": { - "target": "com.amazonaws.datasync#TaskSchedule", + "Options": { + "target": "com.amazonaws.datasync#Options", "traits": { - "smithy.api#documentation": "The schedule used to periodically transfer files from a source to a destination location.
" + "smithy.api#documentation": "The set of configuration options that control the behavior of a single execution of the\n task that occurs when you call StartTaskExecution
. You can configure these\n options to preserve metadata such as user ID (UID) and group (GID), file permissions, data\n integrity verification, and so on.
For each individual task execution, you can override these options by specifying the\n overriding OverrideOptions
value to \n operation.
Errors that AWS DataSync encountered during execution of the task. You can use this\n error code to help troubleshoot issues.
" + "smithy.api#documentation": "A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"
\n
\n
" } }, - "CreationTime": { - "target": "com.amazonaws.datasync#Time", + "Schedule": { + "target": "com.amazonaws.datasync#TaskSchedule", "traits": { - "smithy.api#documentation": "The time that the task was created.
" + "smithy.api#documentation": "The schedule used to periodically transfer files from a source to a destination location.
" } }, - "CloudWatchLogGroupArn": { - "target": "com.amazonaws.datasync#LogGroupArn", + "ErrorCode": { + "target": "com.amazonaws.datasync#string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used to\n monitor and log events in the task.
\n\n \nFor more information on these groups, see Working with Log Groups and Log\n Streams in the Amazon CloudWatch User Guide.
" + "smithy.api#documentation": "Errors that AWS DataSync encountered during execution of the task. You can use this\n error code to help troubleshoot issues.
" } }, - "SourceLocationArn": { - "target": "com.amazonaws.datasync#LocationArn", + "ErrorDetail": { + "target": "com.amazonaws.datasync#string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source file system's location.
" + "smithy.api#documentation": "Detailed description of an error that was encountered during the task execution. You\n can use this information to help troubleshoot issues.
" } }, - "Options": { - "target": "com.amazonaws.datasync#Options", + "CreationTime": { + "target": "com.amazonaws.datasync#Time", "traits": { - "smithy.api#documentation": "The set of configuration options that control the behavior of a single execution of the\n task that occurs when you call StartTaskExecution
. You can configure these\n options to preserve metadata such as user ID (UID) and group (GID), file permissions, data\n integrity verification, and so on.
For each individual task execution, you can override these options by specifying the\n overriding OverrideOptions
value to \n operation.
The time that the task was created.
" } } }, @@ -1758,17 +1758,17 @@ "com.amazonaws.datasync#Ec2Config": { "type": "structure", "members": { - "SecurityGroupArns": { - "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", + "SubnetArn": { + "target": "com.amazonaws.datasync#Ec2SubnetArn", "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the security groups that are configured for the\n Amazon EC2 resource.
", + "smithy.api#documentation": "The ARN of the subnet and the security group that DataSync uses to access the target\n EFS file system.
", "smithy.api#required": {} } }, - "SubnetArn": { - "target": "com.amazonaws.datasync#Ec2SubnetArn", + "SecurityGroupArns": { + "target": "com.amazonaws.datasync#Ec2SecurityGroupArnList", "traits": { - "smithy.api#documentation": "The ARN of the subnet and the security group that DataSync uses to access the target\n EFS file system.
", + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the security groups that are configured for the\n Amazon EC2 resource.
", "smithy.api#required": {} } } @@ -2028,6 +2028,9 @@ }, { "target": "com.amazonaws.datasync#UpdateTask" + }, + { + "target": "com.amazonaws.datasync#UpdateTaskExecution" } ], "traits": { @@ -2035,7 +2038,7 @@ "sdkId": "DataSync", "arnNamespace": "datasync", "cloudFormationName": "DataSync", - "cloudTrailEventSource": "fmrs.amazonaws.com" + "cloudTrailEventSource": "datasync.amazonaws.com" }, "aws.auth#sigv4": { "name": "datasync" @@ -2113,10 +2116,10 @@ "com.amazonaws.datasync#InternalException": { "type": "structure", "members": { - "errorCode": { + "message": { "target": "com.amazonaws.datasync#string" }, - "message": { + "errorCode": { "target": "com.amazonaws.datasync#string" } }, @@ -2188,17 +2191,17 @@ "com.amazonaws.datasync#ListAgentsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.datasync#NextToken", - "traits": { - "smithy.api#documentation": "An opaque string that indicates the position at which to begin returning the next list\n of agents.
" - } - }, "Agents": { "target": "com.amazonaws.datasync#AgentList", "traits": { "smithy.api#documentation": "A list of agents in your account.
" } + }, + "NextToken": { + "target": "com.amazonaws.datasync#NextToken", + "traits": { + "smithy.api#documentation": "An opaque string that indicates the position at which to begin returning the next list\n of agents.
" + } } }, "traits": { @@ -2233,10 +2236,10 @@ "com.amazonaws.datasync#ListLocationsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.datasync#LocationFilters", + "MaxResults": { + "target": "com.amazonaws.datasync#MaxResults", "traits": { - "smithy.api#documentation": "You can use API filters to narrow down the list of resources returned by ListLocations
. \n For example, to retrieve all tasks on a specific source location, you can use ListLocations
\n with filter name LocationType S3
and Operator Equals
.
The maximum number of locations to return.
" } }, "NextToken": { @@ -2245,10 +2248,10 @@ "smithy.api#documentation": "An opaque string that indicates the position at which to begin the next list of\n locations.
" } }, - "MaxResults": { - "target": "com.amazonaws.datasync#MaxResults", + "Filters": { + "target": "com.amazonaws.datasync#LocationFilters", "traits": { - "smithy.api#documentation": "The maximum number of locations to return.
" + "smithy.api#documentation": "You can use API filters to narrow down the list of resources returned by ListLocations
. \n For example, to retrieve all tasks on a specific source location, you can use ListLocations
\n with filter name LocationType S3
and Operator Equals
.
An opaque string that indicates the position at which to begin returning the next list\n of resource tags.
" - } - }, + "members": { "Tags": { "target": "com.amazonaws.datasync#OutputTagList", "traits": { "smithy.api#documentation": "Array of resource tags.
" } + }, + "NextToken": { + "target": "com.amazonaws.datasync#NextToken", + "traits": { + "smithy.api#documentation": "An opaque string that indicates the position at which to begin returning the next list\n of resource tags.
" + } } }, "traits": { @@ -2447,10 +2450,10 @@ "com.amazonaws.datasync#ListTasksRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.datasync#TaskFilters", + "MaxResults": { + "target": "com.amazonaws.datasync#MaxResults", "traits": { - "smithy.api#documentation": "You can use API filters to narrow down the list of resources returned by ListTasks
. \n For example, to retrieve all tasks on a specific source location, you can use ListTasks
\n with filter name LocationId
and Operator Equals
with the ARN for the \n location.
The maximum number of tasks to return.
" } }, "NextToken": { @@ -2459,10 +2462,10 @@ "smithy.api#documentation": "An opaque string that indicates the position at which to begin the next list of\n tasks.
" } }, - "MaxResults": { - "target": "com.amazonaws.datasync#MaxResults", + "Filters": { + "target": "com.amazonaws.datasync#TaskFilters", "traits": { - "smithy.api#documentation": "The maximum number of tasks to return.
" + "smithy.api#documentation": "You can use API filters to narrow down the list of resources returned by ListTasks
. \n For example, to retrieve all tasks on a specific source location, you can use ListTasks
\n with filter name LocationId
and Operator Equals
with the ARN for the \n location.
An opaque string that indicates the position at which to begin returning the next list\n of tasks.
" - } - }, "Tasks": { "target": "com.amazonaws.datasync#TaskList", "traits": { "smithy.api#documentation": "A list of all the tasks that are returned.
" } + }, + "NextToken": { + "target": "com.amazonaws.datasync#NextToken", + "traits": { + "smithy.api#documentation": "An opaque string that indicates the position at which to begin returning the next list\n of tasks.
" + } } }, "traits": { @@ -2503,10 +2506,10 @@ "com.amazonaws.datasync#LocationFilter": { "type": "structure", "members": { - "Operator": { - "target": "com.amazonaws.datasync#Operator", + "Name": { + "target": "com.amazonaws.datasync#LocationFilterName", "traits": { - "smithy.api#documentation": "The operator that is used to compare filter values (for example, Equals
or \n Contains
). For more about API filtering operators, see query-resources.
The name of the filter being used. Each API call supports a list of filters that are available \n for it (for example, LocationType
for ListLocations
).
The name of the filter being used. Each API call supports a list of filters that are available \n for it (for example, LocationType
for ListLocations
).
The operator that is used to compare filter values (for example, Equals
or \n Contains
). For more about API filtering operators, see query-resources.
A value that determines whether a data integrity verification should be performed at\n the end of a task execution after all data and metadata have been transferred. \n For more information, see \n create-task\n
\nDefault value: POINT_IN_TIME_CONSISTENT.
\nONLY_FILES_TRANSFERRED (recommended): Perform verification only on files that were transferred.\n
\n \nPOINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination \n at the end of the transfer \n to verify that source and destination are fully \n synchronized. This option isn't supported when transferring to S3 Glacier or S3 Glacier \n Deep Archive storage classes.
\nNONE: No additional verification is done at the end of the \n transfer, but all data transmissions are integrity-checked with \n checksum verification during the transfer.
" } }, - "PreserveDevices": { - "target": "com.amazonaws.datasync#PreserveDevices", - "traits": { - "smithy.api#documentation": "A value that determines whether AWS DataSync should preserve the metadata of block\n and character devices in the source file system, and recreate the files with that device name\n and metadata on the destination.
\nAWS DataSync can't sync the actual contents of such devices, because they are\n nonterminal and don't return an end-of-file (EOF) marker.
\nDefault value: NONE.
\nNONE: Ignore special devices (recommended).
\nPRESERVE: Preserve character and block device metadata. This option isn't currently\n supported for Amazon EFS.
" - } - }, "OverwriteMode": { "target": "com.amazonaws.datasync#OverwriteMode", "traits": { @@ -2856,16 +2853,16 @@ "smithy.api#documentation": "A file metadata value that shows the last time a file was accessed (that is, when the\n file was read or written to). If you set Atime
to BEST_EFFORT, DataSync\n attempts to preserve the original Atime
attribute on all source files (that is,\n the version before the PREPARING phase). However, Atime
's behavior is not\n fully standard across platforms, so AWS DataSync can only do this on a best-effort basis.
Default value: BEST_EFFORT.
\nBEST_EFFORT: Attempt to preserve the per-file Atime
value\n (recommended).
NONE: Ignore Atime
.
If Atime
is set to BEST_EFFORT, Mtime
must be set to PRESERVE.
If Atime
is set to NONE, Mtime
must also be NONE.
A value that determines which users or groups can access a file for a specific purpose\n such as reading, writing, or execution of the file.
\nDefault value: PRESERVE.
\nPRESERVE: Preserve POSIX-style permissions (recommended).
\nNONE: Ignore permissions.
\nAWS DataSync can preserve extant permissions of a source location.
\nA value that indicates the last time that a file was modified (that is, a file was\n written to) before the PREPARING phase.
\nDefault value: PRESERVE.
\nPRESERVE: Preserve original Mtime
(recommended)
NONE: Ignore Mtime
.
If Mtime
is set to PRESERVE, Atime
must be set to\n BEST_EFFORT.
If Mtime
is set to NONE, Atime
must also be set to NONE.\n
A value that specifies whether files in the destination that don't exist in the source\n file system should be preserved. This option can affect your storage cost. \n If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed\n information, see using-storage-classes in the AWS DataSync User\n Guide.
\nDefault value: PRESERVE.
\nPRESERVE: Ignore such destination files (recommended).
\nREMOVE: Delete destination files that aren’t present in the source.
" + "smithy.api#documentation": "The user ID (UID) of the file's owner.
\nDefault value: INT_VALUE. This preserves the integer value of the ID.
\nINT_VALUE: Preserve the integer value of UID and group ID (GID)\n (recommended).
\nNONE: Ignore UID and GID.
" } }, "Gid": { @@ -2874,16 +2871,22 @@ "smithy.api#documentation": "The group ID (GID) of the file's owners.
\nDefault value: INT_VALUE. This preserves the integer value of the ID.
\nINT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
\nNONE: Ignore UID and GID.
" } }, - "Uid": { - "target": "com.amazonaws.datasync#Uid", + "PreserveDeletedFiles": { + "target": "com.amazonaws.datasync#PreserveDeletedFiles", "traits": { - "smithy.api#documentation": "The user ID (UID) of the file's owner.
\nDefault value: INT_VALUE. This preserves the integer value of the ID.
\nINT_VALUE: Preserve the integer value of UID and group ID (GID)\n (recommended).
\nNONE: Ignore UID and GID.
" + "smithy.api#documentation": "A value that specifies whether files in the destination that don't exist in the source\n file system should be preserved. This option can affect your storage cost. \n If your task deletes objects, you might incur minimum storage duration charges for certain storage classes. For detailed\n information, see using-storage-classes in the AWS DataSync User\n Guide.
\nDefault value: PRESERVE.
\nPRESERVE: Ignore such destination files (recommended).
\nREMOVE: Delete destination files that aren’t present in the source.
" } }, - "LogLevel": { - "target": "com.amazonaws.datasync#LogLevel", + "PreserveDevices": { + "target": "com.amazonaws.datasync#PreserveDevices", "traits": { - "smithy.api#documentation": "A value that determines the type of logs that DataSync publishes to a log stream in the\n Amazon CloudWatch log group that you provide. For more information about providing a log group\n for DataSync, see CloudWatchLogGroupArn. If set to OFF
, no logs are published.\n BASIC
publishes logs on errors for individual files transferred, and\n TRANSFER
publishes logs for every file or object that is transferred and\n integrity checked.
A value that determines whether AWS DataSync should preserve the metadata of block\n and character devices in the source file system, and recreate the files with that device name\n and metadata on the destination.
\nAWS DataSync can't sync the actual contents of such devices, because they are\n nonterminal and don't return an end-of-file (EOF) marker.
\nDefault value: NONE.
\nNONE: Ignore special devices (recommended).
\nPRESERVE: Preserve character and block device metadata. This option isn't currently\n supported for Amazon EFS.
" + } + }, + "PosixPermissions": { + "target": "com.amazonaws.datasync#PosixPermissions", + "traits": { + "smithy.api#documentation": "A value that determines which users or groups can access a file for a specific purpose\n such as reading, writing, or execution of the file.
\nDefault value: PRESERVE.
\nPRESERVE: Preserve POSIX-style permissions (recommended).
\nNONE: Ignore permissions.
\nAWS DataSync can preserve extant permissions of a source location.
\nA value that limits the bandwidth used by AWS DataSync. For example, if you want\n AWS DataSync to use a maximum of 1 MB, set this value to 1048576
\n (=1024*1024
).
A value that indicates the last time that a file was modified (that is, a file was\n written to) before the PREPARING phase.
\nDefault value: PRESERVE.
\nPRESERVE: Preserve original Mtime
(recommended)
NONE: Ignore Mtime
.
If Mtime
is set to PRESERVE, Atime
must be set to\n BEST_EFFORT.
If Mtime
is set to NONE, Atime
must also be set to NONE.\n
A value that determines whether tasks should be queued before executing the tasks. If set\n to ENABLED
, the tasks will be queued. The default is ENABLED
.
If you use the same agent to run multiple tasks, you can enable the tasks to run in\n series. For more information, see queue-task-execution.
" } }, - "TransferMode": { - "target": "com.amazonaws.datasync#TransferMode", + "LogLevel": { + "target": "com.amazonaws.datasync#LogLevel", "traits": { - "smithy.api#documentation": "A value that determines whether DataSync transfers only the data and metadata that differ between the source \n and the destination location, or whether DataSync transfers all the content from the source, without comparing to \n the destination location.
\nCHANGED: DataSync copies only data or metadata that is new or different content from the source location to the \n destination location.
\nALL: DataSync copies all source location content to the destination, without comparing to existing content on \n the destination.
" + "smithy.api#documentation": "A value that determines the type of logs that DataSync publishes to a log stream in the\n Amazon CloudWatch log group that you provide. For more information about providing a log group\n for DataSync, see CloudWatchLogGroupArn. If set to OFF
, no logs are published.\n BASIC
publishes logs on errors for individual files transferred, and\n TRANSFER
publishes logs for every file or object that is transferred and\n integrity checked.
A value that determines whether tasks should be queued before executing the tasks. If set\n to ENABLED
, the tasks will be queued. The default is ENABLED
.
If you use the same agent to run multiple tasks, you can enable the tasks to run in\n series. For more information, see queue-task-execution.
" + "smithy.api#documentation": "A value that determines whether DataSync transfers only the data and metadata that differ between the source \n and the destination location, or whether DataSync transfers all the content from the source, without comparing to \n the destination location.
\nCHANGED: DataSync copies only data or metadata that is new or different content from the source location to the \n destination location.
\nALL: DataSync copies all source location content to the destination, without comparing to existing content on \n the destination.
" } } }, @@ -3039,6 +3042,12 @@ "smithy.api#documentation": "The ID of the VPC endpoint that is configured for an agent. An agent that is configured\n with a VPC endpoint will not be accessible over the public internet.
" } }, + "PrivateLinkEndpoint": { + "target": "com.amazonaws.datasync#Endpoint", + "traits": { + "smithy.api#documentation": "The private endpoint that is configured for an agent that has access to IP addresses in a\n PrivateLink. An agent that is configured with this endpoint will not be accessible\n over the public internet.
" + } + }, "SubnetArns": { "target": "com.amazonaws.datasync#PLSubnetArnList", "traits": { @@ -3050,12 +3059,6 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the security groups that are configured for the EC2\n resource that hosts an agent activated in a VPC or an agent that has access to a VPC\n endpoint.
" } - }, - "PrivateLinkEndpoint": { - "target": "com.amazonaws.datasync#Endpoint", - "traits": { - "smithy.api#documentation": "The private endpoint that is configured for an agent that has access to IP addresses in a\n PrivateLink. An agent that is configured with this endpoint will not be accessible\n over the public internet.
" - } } }, "traits": { @@ -3262,14 +3265,14 @@ "smithy.api#required": {} } }, + "OverrideOptions": { + "target": "com.amazonaws.datasync#Options" + }, "Includes": { "target": "com.amazonaws.datasync#FilterList", "traits": { - "smithy.api#documentation": "A list of filter rules that determines which files to include when running a task. The\n pattern should contain a single filter string that consists of the patterns to include. The\n patterns are delimited by \"|\" (that is, a pipe). For example: \"/folder1|/folder2\"
\n
\n
" + "smithy.api#documentation": "A list of filter rules that determines which files to include when running a task. The\n pattern should contain a single filter string that consists of the patterns to include. The\n patterns are delimited by \"|\" (that is, a pipe). For example: \"/folder1|/folder2\"
\n
\n
" } - }, - "OverrideOptions": { - "target": "com.amazonaws.datasync#Options" } }, "traits": { @@ -3315,18 +3318,18 @@ "com.amazonaws.datasync#TagListEntry": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.datasync#TagValue", - "traits": { - "smithy.api#documentation": "The value for an AWS resource tag.
" - } - }, "Key": { "target": "com.amazonaws.datasync#TagKey", "traits": { "smithy.api#documentation": "The key for an AWS resource tag.
", "smithy.api#required": {} } + }, + "Value": { + "target": "com.amazonaws.datasync#TagValue", + "traits": { + "smithy.api#documentation": "The value for an AWS resource tag.
" + } } }, "traits": { @@ -3448,58 +3451,58 @@ "com.amazonaws.datasync#TaskExecutionResultDetail": { "type": "structure", "members": { - "PrepareStatus": { - "target": "com.amazonaws.datasync#PhaseStatus", + "PrepareDuration": { + "target": "com.amazonaws.datasync#Duration", "traits": { - "smithy.api#documentation": "The status of the PREPARING phase.
" + "smithy.api#documentation": "The total time in milliseconds that AWS DataSync spent in the PREPARING phase.\n
" } }, - "VerifyStatus": { + "PrepareStatus": { "target": "com.amazonaws.datasync#PhaseStatus", "traits": { - "smithy.api#documentation": "The status of the VERIFYING Phase.
" + "smithy.api#documentation": "The status of the PREPARING phase.
" } }, - "PrepareDuration": { + "TotalDuration": { "target": "com.amazonaws.datasync#Duration", "traits": { - "smithy.api#documentation": "The total time in milliseconds that AWS DataSync spent in the PREPARING phase.\n
" + "smithy.api#documentation": "The total time in milliseconds that AWS DataSync took to transfer the file from the source to the destination location.
" } }, - "VerifyDuration": { + "TransferDuration": { "target": "com.amazonaws.datasync#Duration", "traits": { - "smithy.api#documentation": "The total time in milliseconds that AWS DataSync spent in the VERIFYING\n phase.
" + "smithy.api#documentation": "The total time in milliseconds that AWS DataSync spent in the TRANSFERRING\n phase.
" } }, - "ErrorCode": { - "target": "com.amazonaws.datasync#string", + "TransferStatus": { + "target": "com.amazonaws.datasync#PhaseStatus", "traits": { - "smithy.api#documentation": "Errors that AWS DataSync encountered during execution of the task. You can use this\n error code to help troubleshoot issues.
" + "smithy.api#documentation": "The status of the TRANSFERRING phase.
" } }, - "ErrorDetail": { - "target": "com.amazonaws.datasync#string", + "VerifyDuration": { + "target": "com.amazonaws.datasync#Duration", "traits": { - "smithy.api#documentation": "Detailed description of an error that was encountered during the task execution. You\n can use this information to help troubleshoot issues.
" + "smithy.api#documentation": "The total time in milliseconds that AWS DataSync spent in the VERIFYING\n phase.
" } }, - "TransferStatus": { + "VerifyStatus": { "target": "com.amazonaws.datasync#PhaseStatus", "traits": { - "smithy.api#documentation": "The status of the TRANSFERRING Phase.
" + "smithy.api#documentation": "The status of the VERIFYING phase.
" } }, - "TotalDuration": { - "target": "com.amazonaws.datasync#Duration", + "ErrorCode": { + "target": "com.amazonaws.datasync#string", "traits": { - "smithy.api#documentation": "The total time in milliseconds that AWS DataSync took to transfer the file from the source to the destination location.
" + "smithy.api#documentation": "Errors that AWS DataSync encountered during execution of the task. You can use this\n error code to help troubleshoot issues.
" } }, - "TransferDuration": { - "target": "com.amazonaws.datasync#Duration", + "ErrorDetail": { + "target": "com.amazonaws.datasync#string", "traits": { - "smithy.api#documentation": "The total time in milliseconds that AWS DataSync spent in the TRANSFERRING\n phase.
" + "smithy.api#documentation": "Detailed description of an error that was encountered during the task execution. You\n can use this information to help troubleshoot issues.
" } } }, @@ -3545,10 +3548,10 @@ "com.amazonaws.datasync#TaskFilter": { "type": "structure", "members": { - "Operator": { - "target": "com.amazonaws.datasync#Operator", + "Name": { + "target": "com.amazonaws.datasync#TaskFilterName", "traits": { - "smithy.api#documentation": "The operator that is used to compare filter values (for example, Equals
or \n Contains
). For more about API filtering operators, see query-resources.
The name of the filter being used. Each API call supports a list of filters that are available\n for it. For example, LocationId
for ListTasks
.
The name of the filter being used. Each API call supports a list of filters that are available\n for it. For example, LocationId
for ListTasks
.
The operator that is used to compare filter values (for example, Equals
or \n Contains
). For more about API filtering operators, see query-resources.
The Amazon Resource Name (ARN) of the task.
" + } + }, "Status": { "target": "com.amazonaws.datasync#TaskStatus", "traits": { @@ -3612,12 +3621,6 @@ "traits": { "smithy.api#documentation": "The name of the task.
" } - }, - "TaskArn": { - "target": "com.amazonaws.datasync#TaskArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task.
" - } } }, "traits": { @@ -3745,17 +3748,17 @@ "com.amazonaws.datasync#UntagResourceRequest": { "type": "structure", "members": { - "Keys": { - "target": "com.amazonaws.datasync#TagKeyList", + "ResourceArn": { + "target": "com.amazonaws.datasync#TaggableResourceArn", "traits": { - "smithy.api#documentation": "The keys in the key-value pair in the tag to remove.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to remove the tag from.
", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.datasync#TaggableResourceArn", + "Keys": { + "target": "com.amazonaws.datasync#TagKeyList", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to remove the tag from.
", + "smithy.api#documentation": "The keys in the key-value pair in the tag to remove.
", "smithy.api#required": {} } } @@ -3833,6 +3836,48 @@ "smithy.api#documentation": "Updates the metadata associated with a task.
" } }, + "com.amazonaws.datasync#UpdateTaskExecution": { + "type": "operation", + "input": { + "target": "com.amazonaws.datasync#UpdateTaskExecutionRequest" + }, + "output": { + "target": "com.amazonaws.datasync#UpdateTaskExecutionResponse" + }, + "errors": [ + { + "target": "com.amazonaws.datasync#InternalException" + }, + { + "target": "com.amazonaws.datasync#InvalidRequestException" + } + ], + "traits": { + "smithy.api#documentation": "Updates execution of a task.
\nYou can modify bandwidth throttling for a task execution that is running or queued.\n For more information, see Adjusting Bandwidth Throttling for a Task Execution.
\n \nThe only Option
that can be modified by UpdateTaskExecution
\n is \n BytesPerSecond\n
.
The Amazon Resource Name (ARN) of the specific task execution that is being updated.
", + "smithy.api#required": {} + } + }, + "Options": { + "target": "com.amazonaws.datasync#Options", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.datasync#UpdateTaskExecutionResponse": { + "type": "structure", + "members": {} + }, "com.amazonaws.datasync#UpdateTaskRequest": { "type": "structure", "members": { @@ -3843,14 +3888,20 @@ "smithy.api#required": {} } }, + "Options": { + "target": "com.amazonaws.datasync#Options" + }, "Excludes": { "target": "com.amazonaws.datasync#FilterList", "traits": { "smithy.api#documentation": "A list of filter rules that determines which files to exclude from a task. The list should\n contain a single filter string that consists of the patterns to exclude. The patterns are\n delimited by \"|\" (that is, a pipe), for example: \"/folder1|/folder2\"
\n
\n
" } }, - "Options": { - "target": "com.amazonaws.datasync#Options" + "Schedule": { + "target": "com.amazonaws.datasync#TaskSchedule", + "traits": { + "smithy.api#documentation": "Specifies a schedule used to periodically transfer files from a source to a destination\n location. You can configure your task to execute hourly, daily, weekly or on specific days of\n the week. You control when in the day or hour you want the task to execute. The time you\n specify is UTC time. For more information, see task-scheduling.
" + } }, "Name": { "target": "com.amazonaws.datasync#TagValue", @@ -3863,12 +3914,6 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource name of the CloudWatch\n LogGroup.
" } - }, - "Schedule": { - "target": "com.amazonaws.datasync#TaskSchedule", - "traits": { - "smithy.api#documentation": "Specifies a schedule used to periodically transfer files from a source to a destination\n location. You can configure your task to execute hourly, daily, weekly or on specific days of\n the week. You control when in the day or hour you want the task to execute. The time you\n specify is UTC time. For more information, see task-scheduling.
" - } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json b/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json index f2fd84493159..830b9ed8cf46 100644 --- a/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json +++ b/codegen/sdk-codegen/aws-models/dynamodb.2012-08-10.json @@ -921,6 +921,15 @@ } } }, + "com.amazonaws.dynamodb#BilledSizeBytes": { + "type": "long", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 0 + } + } + }, "com.amazonaws.dynamodb#BillingMode": { "type": "string", "traits": { @@ -1048,6 +1057,9 @@ } } }, + "com.amazonaws.dynamodb#ClientToken": { + "type": "string" + }, "com.amazonaws.dynamodb#Code": { "type": "string" }, @@ -1386,7 +1398,7 @@ } }, "traits": { - "smithy.api#documentation": "Represents a Contributor Insights summary entry..
" + "smithy.api#documentation": "Represents a Contributor Insights summary entry.
" } }, "com.amazonaws.dynamodb#CreateBackup": { @@ -2256,6 +2268,52 @@ } } }, + "com.amazonaws.dynamodb#DescribeExport": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#DescribeExportInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#DescribeExportOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ExportNotFoundException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + } + ], + "traits": { + "smithy.api#documentation": "Describes an existing table export.
" + } + }, + "com.amazonaws.dynamodb#DescribeExportInput": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.dynamodb#ExportArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the export.
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.dynamodb#DescribeExportOutput": { + "type": "structure", + "members": { + "ExportDescription": { + "target": "com.amazonaws.dynamodb#ExportDescription", + "traits": { + "smithy.api#documentation": "Represents the properties of the export.
" + } + } + } + }, "com.amazonaws.dynamodb#DescribeGlobalTable": { "type": "operation", "input": { @@ -2600,6 +2658,9 @@ { "target": "com.amazonaws.dynamodb#DescribeEndpoints" }, + { + "target": "com.amazonaws.dynamodb#DescribeExport" + }, { "target": "com.amazonaws.dynamodb#DescribeGlobalTable" }, @@ -2618,6 +2679,9 @@ { "target": "com.amazonaws.dynamodb#DescribeTimeToLive" }, + { + "target": "com.amazonaws.dynamodb#ExportTableToPointInTime" + }, { "target": "com.amazonaws.dynamodb#GetItem" }, @@ -2627,6 +2691,9 @@ { "target": "com.amazonaws.dynamodb#ListContributorInsights" }, + { + "target": "com.amazonaws.dynamodb#ListExports" + }, { "target": "com.amazonaws.dynamodb#ListGlobalTables" }, @@ -2788,6 +2855,341 @@ "smithy.api#documentation": "Represents a condition to be compared with an attribute value. This condition can be\n used with DeleteItem
, PutItem
, or UpdateItem
\n operations; if the comparison evaluates to true, the operation succeeds; if not, the\n operation fails. You can use ExpectedAttributeValue
in one of two different\n ways:
Use AttributeValueList
to specify one or more values to compare against an\n attribute. Use ComparisonOperator
to specify how you want to perform the\n comparison. If the comparison evaluates to true, then the conditional operation\n succeeds.
Use Value
to specify a value that DynamoDB will compare against an attribute. If the\n values match, then ExpectedAttributeValue
evaluates to true and the conditional\n operation succeeds. Optionally, you can also set Exists
to false, indicating that\n you do not expect to find the attribute value in the table. In this case, the\n conditional operation succeeds only if the comparison evaluates to false.
\n Value
and Exists
are incompatible with AttributeValueList
and\n ComparisonOperator
. Note that if you use both sets of parameters at once, DynamoDB will\n return a ValidationException
exception.
There was a conflict when writing to the specified S3 bucket.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ExportDescription": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.dynamodb#ExportArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the table export.
" + } + }, + "ExportStatus": { + "target": "com.amazonaws.dynamodb#ExportStatus", + "traits": { + "smithy.api#documentation": "Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
" + } + }, + "StartTime": { + "target": "com.amazonaws.dynamodb#ExportStartTime", + "traits": { + "smithy.api#documentation": "The time at which the export task began.
" + } + }, + "EndTime": { + "target": "com.amazonaws.dynamodb#ExportEndTime", + "traits": { + "smithy.api#documentation": "The time at which the export task completed.
" + } + }, + "ExportManifest": { + "target": "com.amazonaws.dynamodb#ExportManifest", + "traits": { + "smithy.api#documentation": "The name of the manifest file for the export task.
" + } + }, + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the table that was exported.
" + } + }, + "TableId": { + "target": "com.amazonaws.dynamodb#TableId", + "traits": { + "smithy.api#documentation": "Unique ID of the table that was exported.
" + } + }, + "ExportTime": { + "target": "com.amazonaws.dynamodb#ExportTime", + "traits": { + "smithy.api#documentation": "Point in time from which table data was exported.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.dynamodb#ClientToken", + "traits": { + "smithy.api#documentation": "The client token that was provided for the export task. A client token makes calls to\n ExportTableToPointInTimeInput
idempotent, meaning that multiple\n identical calls have the same effect as one single call.
The name of the Amazon S3 bucket containing the export.
" + } + }, + "S3BucketOwner": { + "target": "com.amazonaws.dynamodb#S3BucketOwner", + "traits": { + "smithy.api#documentation": "The ID of the AWS account that owns the bucket containing the export.
" + } + }, + "S3Prefix": { + "target": "com.amazonaws.dynamodb#S3Prefix", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket prefix used as the file name and path of the exported\n snapshot.
" + } + }, + "S3SseAlgorithm": { + "target": "com.amazonaws.dynamodb#S3SseAlgorithm", + "traits": { + "smithy.api#documentation": "Type of encryption used on the bucket where export data is stored. Valid values\n for S3SseAlgorithm
are:
\n AES256
- server-side encryption with Amazon S3 managed keys
\n KMS
- server-side encryption with AWS KMS managed keys
The ID of the AWS KMS managed key used to encrypt the S3 bucket where export data is\n stored (if applicable).
" + } + }, + "FailureCode": { + "target": "com.amazonaws.dynamodb#FailureCode", + "traits": { + "smithy.api#documentation": "Status code for the result of the failed export.
" + } + }, + "FailureMessage": { + "target": "com.amazonaws.dynamodb#FailureMessage", + "traits": { + "smithy.api#documentation": "Export failure reason description.
" + } + }, + "ExportFormat": { + "target": "com.amazonaws.dynamodb#ExportFormat", + "traits": { + "smithy.api#documentation": "The format of the exported data. Valid values for ExportFormat
are\n DYNAMODB_JSON
or ION
.
The billable size of the table export.
" + } + }, + "ItemCount": { + "target": "com.amazonaws.dynamodb#ItemCount", + "traits": { + "smithy.api#documentation": "The number of items exported.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Represents the properties of the exported table.
" + } + }, + "com.amazonaws.dynamodb#ExportEndTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExportFormat": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "DYNAMODB_JSON", + "name": "DYNAMODB_JSON" + }, + { + "value": "ION", + "name": "ION" + } + ] + } + }, + "com.amazonaws.dynamodb#ExportManifest": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExportNextToken": { + "type": "string" + }, + "com.amazonaws.dynamodb#ExportNotFoundException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The specified export was not found.
", + "smithy.api#error": "client" + } + }, + "com.amazonaws.dynamodb#ExportStartTime": { + "type": "timestamp" + }, + "com.amazonaws.dynamodb#ExportStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "IN_PROGRESS", + "name": "IN_PROGRESS" + }, + { + "value": "COMPLETED", + "name": "COMPLETED" + }, + { + "value": "FAILED", + "name": "FAILED" + } + ] + } + }, + "com.amazonaws.dynamodb#ExportSummaries": { + "type": "list", + "member": { + "target": "com.amazonaws.dynamodb#ExportSummary" + } + }, + "com.amazonaws.dynamodb#ExportSummary": { + "type": "structure", + "members": { + "ExportArn": { + "target": "com.amazonaws.dynamodb#ExportArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the export.
" + } + }, + "ExportStatus": { + "target": "com.amazonaws.dynamodb#ExportStatus", + "traits": { + "smithy.api#documentation": "Export can be in one of the following states: IN_PROGRESS, COMPLETED, or FAILED.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about an export task.
" + } + }, + "com.amazonaws.dynamodb#ExportTableToPointInTime": { + "type": "operation", + "input": { + "target": "com.amazonaws.dynamodb#ExportTableToPointInTimeInput" + }, + "output": { + "target": "com.amazonaws.dynamodb#ExportTableToPointInTimeOutput" + }, + "errors": [ + { + "target": "com.amazonaws.dynamodb#ExportConflictException" + }, + { + "target": "com.amazonaws.dynamodb#InternalServerError" + }, + { + "target": "com.amazonaws.dynamodb#InvalidExportTimeException" + }, + { + "target": "com.amazonaws.dynamodb#LimitExceededException" + }, + { + "target": "com.amazonaws.dynamodb#PointInTimeRecoveryUnavailableException" + }, + { + "target": "com.amazonaws.dynamodb#TableNotFoundException" + } + ], + "traits": { + "smithy.api#documentation": "Exports table data to an S3 bucket. The table must have point in time recovery\n enabled, and you can export data from any time within the point in time recovery\n window.
" + } + }, + "com.amazonaws.dynamodb#ExportTableToPointInTimeInput": { + "type": "structure", + "members": { + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the table to export.
", + "smithy.api#required": {} + } + }, + "ExportTime": { + "target": "com.amazonaws.dynamodb#ExportTime", + "traits": { + "smithy.api#documentation": "Time in the past from which to export table data. The table export will be a snapshot\n of the table's state at this point in time.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.dynamodb#ClientToken", + "traits": { + "smithy.api#documentation": "Providing a ClientToken
makes the call to\n ExportTableToPointInTimeInput
idempotent, meaning that multiple\n identical calls have the same effect as one single call.
A client token is valid for 8 hours after the first request that uses it is\n completed. After 8 hours, any request with the same client token is treated as a new\n request. Do not resubmit the same request with the same client token for more than 8\n hours, or the result might not be idempotent.
\nIf you submit a request with the same client token but a change in other parameters\n within the 8-hour idempotency window, DynamoDB returns an\n IdempotentParameterMismatch
exception.
The name of the Amazon S3 bucket to export the snapshot to.
", + "smithy.api#required": {} + } + }, + "S3BucketOwner": { + "target": "com.amazonaws.dynamodb#S3BucketOwner", + "traits": { + "smithy.api#documentation": "The ID of the AWS account that owns the bucket the export will be stored in.
" + } + }, + "S3Prefix": { + "target": "com.amazonaws.dynamodb#S3Prefix", + "traits": { + "smithy.api#documentation": "The Amazon S3 bucket prefix to use as the file name and path of the exported\n snapshot.
" + } + }, + "S3SseAlgorithm": { + "target": "com.amazonaws.dynamodb#S3SseAlgorithm", + "traits": { + "smithy.api#documentation": "Type of encryption used on the bucket where export data will be stored. Valid values\n for S3SseAlgorithm
are:
\n AES256
- server-side encryption with Amazon S3 managed keys
\n KMS
- server-side encryption with AWS KMS managed keys
The ID of the AWS KMS managed key used to encrypt the S3 bucket where export data will\n be stored (if applicable).
" + } + }, + "ExportFormat": { + "target": "com.amazonaws.dynamodb#ExportFormat", + "traits": { + "smithy.api#documentation": "The format for the exported data. Valid values for ExportFormat
are\n DYNAMODB_JSON
or ION
.
Contains a description of the table export.
" + } + } + } + }, + "com.amazonaws.dynamodb#ExportTime": { + "type": "timestamp" + }, "com.amazonaws.dynamodb#ExpressionAttributeNameMap": { "type": "map", "key": { @@ -2812,6 +3214,9 @@ "com.amazonaws.dynamodb#ExpressionAttributeValueVariable": { "type": "string" }, + "com.amazonaws.dynamodb#FailureCode": { + "type": "string" + }, "com.amazonaws.dynamodb#FailureException": { "type": "structure", "members": { @@ -2832,6 +3237,9 @@ "smithy.api#documentation": "Represents a failure a contributor insights operation.
" } }, + "com.amazonaws.dynamodb#FailureMessage": { + "type": "string" + }, "com.amazonaws.dynamodb#FilterConditionMap": { "type": "map", "key": { @@ -3418,6 +3826,18 @@ "smithy.api#httpError": 421 } }, + "com.amazonaws.dynamodb#InvalidExportTimeException": { + "type": "structure", + "members": { + "message": { + "target": "com.amazonaws.dynamodb#ErrorMessage" + } + }, + "traits": { + "smithy.api#documentation": "The specified ExportTime
is outside of the point in time recovery\n window.
Lists completed exports within the past 90 days.
", + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.dynamodb#ListExportsInput": { + "type": "structure", + "members": { + "TableArn": { + "target": "com.amazonaws.dynamodb#TableArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) associated with the exported table.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.dynamodb#ListExportsMaxLimit", + "traits": { + "smithy.api#documentation": "Maximum number of results to return per page.
" + } + }, + "NextToken": { + "target": "com.amazonaws.dynamodb#ExportNextToken", + "traits": { + "smithy.api#documentation": "An optional string that, if supplied, must be copied from the output of a previous\n call to ListExports
. When provided in this manner, the API fetches the next\n page of results.
A list of ExportSummary
objects.
If this value is returned, there are additional results to be displayed. To retrieve\n them, call ListExports
again, with NextToken
set to this\n value.
The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
" + } + }, "EgressOnlyInternetGatewayId": { "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", "traits": { @@ -11280,7 +11286,7 @@ "target": "com.amazonaws.ec2#CreateVpcEndpointResult" }, "traits": { - "smithy.api#documentation": "Creates a VPC endpoint for a specified service. An endpoint enables you to create a\n private connection between your VPC and the service. The service may be provided by AWS,\n an AWS Marketplace Partner, or another AWS account. For more information, see VPC Endpoints in\n the Amazon Virtual Private Cloud User Guide.
\nA gateway
endpoint serves as a target for a route in your route table for\n traffic destined for the AWS service. You can specify an endpoint policy to attach to\n the endpoint, which will control access to the service from your VPC. You can also\n specify the VPC route tables that use the endpoint.
An interface
endpoint is a network interface in your subnet that\n serves as an endpoint for communicating with the specified service. You can specify the\n subnets in which to create an endpoint, and the security groups to associate with the\n endpoint network interface.
Use DescribeVpcEndpointServices to get a list of supported\n services.
" + "smithy.api#documentation": "Creates a VPC endpoint for a specified service. An endpoint enables you to create a\n private connection between your VPC and the service. The service may be provided by AWS,\n an AWS Marketplace Partner, or another AWS account. For more information, see VPC Endpoints in\n the Amazon Virtual Private Cloud User Guide.
\nA gateway
endpoint serves as a target for a route in your route table for\n traffic destined for the AWS service. You can specify an endpoint policy to attach to\n the endpoint, which will control access to the service from your VPC. You can also\n specify the VPC route tables that use the endpoint.
An interface
endpoint is a network interface in your subnet that\n serves as an endpoint for communicating with the specified service. You can specify the\n subnets in which to create an endpoint, and the security groups to associate with the\n endpoint network interface.
A GatewayLoadBalancer
endpoint is a network interface in your subnet that serves an endpoint for communicating with a Gateway Load Balancer that you've configured as a VPC endpoint service.
Use DescribeVpcEndpointServices to get a list of supported\n services.
" } }, "com.amazonaws.ec2#CreateVpcEndpointConnectionNotification": { @@ -11391,7 +11397,7 @@ "PolicyDocument": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A policy to attach to the endpoint that controls access to the\n service. The policy must be in valid JSON format. If this parameter is not specified, we\n attach a default policy that allows full access to the service.
" + "smithy.api#documentation": "(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the\n service. The policy must be in valid JSON format. If this parameter is not specified, we\n attach a default policy that allows full access to the service.
" } }, "RouteTableIds": { @@ -11404,7 +11410,7 @@ "SubnetIds": { "target": "com.amazonaws.ec2#VpcEndpointSubnetIdList", "traits": { - "smithy.api#documentation": "(Interface endpoint) The ID of one or more subnets in which to create an endpoint\n network interface.
", + "smithy.api#documentation": "(Interface and Gateway Load Balancer endpoints) The ID of one or more subnets in which to create an endpoint\n network interface. For a Gateway Load Balancer endpoint, you can specify one subnet only.
", "smithy.api#xmlName": "SubnetId" } }, @@ -11472,7 +11478,7 @@ "target": "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationResult" }, "traits": { - "smithy.api#documentation": "Creates a VPC endpoint service configuration to which service consumers (AWS accounts,\n IAM users, and IAM roles) can connect. Service consumers can create an interface VPC\n endpoint to connect to your service.
\nTo create an endpoint service configuration, you must first create a Network Load\n Balancer for your service. For more information, see VPC Endpoint Services in the\n Amazon Virtual Private Cloud User Guide.
\n\tIf you set the private DNS name, you must prove that you own the private DNS domain name. For more information, see VPC Endpoint Service Private DNS Name Verification in the Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Creates a VPC endpoint service configuration to which service consumers (AWS accounts,\n IAM users, and IAM roles) can connect.
\nTo create an endpoint service configuration, you must first create one of the\n following for your service:
\nA Network Load Balancer. Service consumers connect to your service using an\n interface endpoint.
\nA Gateway Load Balancer. Service consumers connect to your service using a\n Gateway Load Balancer endpoint.
\nFor more information, see VPC Endpoint Services in the\n Amazon Virtual Private Cloud User Guide.
\nIf you set the private DNS name, you must prove that you own the private DNS domain\n name. For more information, see VPC Endpoint Service\n Private DNS Name Verification in the\n Amazon Virtual Private Cloud User Guide.
" } }, "com.amazonaws.ec2#CreateVpcEndpointServiceConfigurationRequest": { @@ -11493,17 +11499,23 @@ "PrivateDnsName": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The private DNS name to assign to the VPC endpoint service.
" + "smithy.api#documentation": "(Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.
" } }, "NetworkLoadBalancerArns": { "target": "com.amazonaws.ec2#ValueStringList", "traits": { "smithy.api#documentation": "The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your\n service.
", - "smithy.api#required": {}, "smithy.api#xmlName": "NetworkLoadBalancerArn" } }, + "GatewayLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of one or more Gateway Load Balancers.
", + "smithy.api#xmlName": "GatewayLoadBalancerArn" + } + }, "ClientToken": { "target": "com.amazonaws.ec2#String", "traits": { @@ -14242,7 +14254,7 @@ "target": "com.amazonaws.ec2#DeleteVpcEndpointsResult" }, "traits": { - "smithy.api#documentation": "Deletes one or more specified VPC endpoints. Deleting a gateway endpoint also deletes\n the endpoint routes in the route tables that were associated with the endpoint. Deleting\n an interface endpoint deletes the endpoint network interfaces.
" + "smithy.api#documentation": "Deletes one or more specified VPC endpoints. Deleting a gateway endpoint also deletes\n the endpoint routes in the route tables that were associated with the endpoint. Deleting\n an interface endpoint or a Gateway Load Balancer endpoint deletes the endpoint network interfaces. Gateway Load Balancer endpoints can only be deleted if the routes that are associated with the endpoint are deleted.
" } }, "com.amazonaws.ec2#DeleteVpcEndpointsRequest": { @@ -23350,7 +23362,7 @@ "Filters": { "target": "com.amazonaws.ec2#FilterList", "traits": { - "smithy.api#documentation": "One or more filters.
\n\n service-name
- The name of the service.
\n vpc-id
- The ID of the VPC in which the endpoint resides.
\n vpc-endpoint-id
- The ID of the endpoint.
\n vpc-endpoint-state
- The state of the endpoint\n (pendingAcceptance
| pending
|\n available
| deleting
| deleted
|\n rejected
| failed
).
\n tag
:Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
\n tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more filters.
\n\n service-name
- The name of the service.
\n vpc-id
- The ID of the VPC in which the endpoint resides.
\n vpc-endpoint-id
- The ID of the endpoint.
\n vpc-endpoint-state
- The state of the endpoint\n (pendingAcceptance
| pending
|\n available
| deleting
| deleted
|\n rejected
| failed
).
\n vpc-endpoint-type
- The type of VPC endpoint (Interface
| Gateway
| GatewayLoadBalancer
).
\n tag
:Owner
and the value TeamA
, specify tag:Owner
for the filter name and TeamA
for the filter value.
\n tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Modifies attributes of a specified VPC endpoint. The attributes that you can modify\n depend on the type of VPC endpoint (interface or gateway). For more information, see\n VPC\n Endpoints in the Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Modifies attributes of a specified VPC endpoint. The attributes that you can modify\n depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see\n VPC\n Endpoints in the Amazon Virtual Private Cloud User Guide.
" } }, "com.amazonaws.ec2#ModifyVpcEndpointConnectionNotification": { @@ -41708,7 +41720,7 @@ "PolicyDocument": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "A policy to attach to the endpoint that controls access to the service. The policy must\n be in valid JSON format.
" + "smithy.api#documentation": "(Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must\n be in valid JSON format.
" } }, "AddRouteTableIds": { @@ -41728,7 +41740,7 @@ "AddSubnetIds": { "target": "com.amazonaws.ec2#VpcEndpointSubnetIdList", "traits": { - "smithy.api#documentation": "(Interface endpoint) One or more subnet IDs in which to serve the endpoint.
", + "smithy.api#documentation": "(Interface and Gateway Load Balancer endpoints) One or more subnet IDs in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.
", "smithy.api#xmlName": "AddSubnetId" } }, @@ -41786,7 +41798,7 @@ "target": "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationResult" }, "traits": { - "smithy.api#documentation": "Modifies the attributes of your VPC endpoint service configuration. You can change the\n Network Load Balancers for your service, and you can specify whether acceptance is\n required for requests to connect to your endpoint service through an interface VPC\n endpoint.
\n\tIf you set or modify the private DNS name, you must prove that you own the private DNS\n domain name. For more information, see VPC Endpoint Service\n Private DNS Name Verification in the\n Amazon Virtual Private Cloud User Guide.
" + "smithy.api#documentation": "Modifies the attributes of your VPC endpoint service configuration. You can change the\n Network Load Balancers or Gateway Load Balancers for your service, and you can specify whether acceptance is\n required for requests to connect to your endpoint service through an interface VPC\n endpoint.
\n\tIf you set or modify the private DNS name, you must prove that you own the private DNS\n domain name. For more information, see VPC Endpoint Service\n Private DNS Name Verification in the\n Amazon Virtual Private Cloud User Guide.
" } }, "com.amazonaws.ec2#ModifyVpcEndpointServiceConfigurationRequest": { @@ -41808,13 +41820,13 @@ "PrivateDnsName": { "target": "com.amazonaws.ec2#String", "traits": { - "smithy.api#documentation": "The private DNS name to assign to the endpoint service.
" + "smithy.api#documentation": "(Interface endpoint configuration) The private DNS name to assign to the endpoint service.
" } }, "RemovePrivateDnsName": { "target": "com.amazonaws.ec2#Boolean", "traits": { - "smithy.api#documentation": "Removes the private DNS name of the endpoint service.
" + "smithy.api#documentation": "(Interface endpoint configuration) Removes the private DNS name of the endpoint service.
" } }, "AcceptanceRequired": { @@ -41836,6 +41848,20 @@ "smithy.api#documentation": "The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service\n configuration.
", "smithy.api#xmlName": "RemoveNetworkLoadBalancerArn" } + }, + "AddGatewayLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service\n configuration.
", + "smithy.api#xmlName": "AddGatewayLoadBalancerArn" + } + }, + "RemoveGatewayLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service\n configuration.
", + "smithy.api#xmlName": "RemoveGatewayLoadBalancerArn" + } } } }, @@ -46964,6 +46990,12 @@ "smithy.api#xmlName": "dryRun" } }, + "VpcEndpointId": { + "target": "com.amazonaws.ec2#VpcEndpointId", + "traits": { + "smithy.api#documentation": "The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
" + } + }, "EgressOnlyInternetGatewayId": { "target": "com.amazonaws.ec2#EgressOnlyInternetGatewayId", "traits": { @@ -51809,6 +51841,14 @@ "smithy.api#xmlName": "networkLoadBalancerArnSet" } }, + "GatewayLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "GatewayLoadBalancerArnSet", + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
", + "smithy.api#xmlName": "gatewayLoadBalancerArnSet" + } + }, "BaseEndpointDnsNames": { "target": "com.amazonaws.ec2#ValueStringList", "traits": { @@ -52006,6 +52046,10 @@ { "value": "Gateway", "name": "Gateway" + }, + { + "value": "GatewayLoadBalancer", + "name": "GatewayLoadBalancer" } ] } @@ -59604,6 +59648,14 @@ "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the network load balancers for the service.
", "smithy.api#xmlName": "networkLoadBalancerArnSet" } + }, + "GatewayLoadBalancerArns": { + "target": "com.amazonaws.ec2#ValueStringList", + "traits": { + "aws.protocols#ec2QueryName": "GatewayLoadBalancerArnSet", + "smithy.api#documentation": "The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
", + "smithy.api#xmlName": "gatewayLoadBalancerArnSet" + } } }, "traits": { @@ -59690,6 +59742,10 @@ { "value": "Gateway", "name": "Gateway" + }, + { + "value": "GatewayLoadBalancer", + "name": "GatewayLoadBalancer" } ] } diff --git a/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json b/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json index 15e21eec52cd..cf0d14bbf48b 100644 --- a/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json +++ b/codegen/sdk-codegen/aws-models/ecs.2014-11-13.json @@ -235,7 +235,7 @@ "name": "ecs" }, "aws.protocols#awsJson1_1": {}, - "smithy.api#documentation": "Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes\n it easy to run, stop, and manage Docker containers on a cluster. You can host your\n cluster on a serverless infrastructure that is managed by Amazon ECS by launching your\n services or tasks using the Fargate launch type. For more control, you can host your\n tasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2\n launch type. For more information about launch types, see Amazon ECS Launch\n Types.
\nAmazon ECS lets you launch and stop container-based applications with simple API calls,\n allows you to get the state of your cluster from a centralized service, and gives you\n access to many familiar Amazon EC2 features.
\nYou can use Amazon ECS to schedule the placement of containers across your cluster based on\n your resource needs, isolation policies, and availability requirements. Amazon ECS eliminates\n the need for you to operate your own cluster management and configuration management\n systems or worry about scaling your management infrastructure.
", + "smithy.api#documentation": "Amazon Elastic Container Service (Amazon ECS) is a highly scalable, fast, container management service that makes\n\t\t\tit easy to run, stop, and manage Docker containers on a cluster. You can host your\n\t\t\tcluster on a serverless infrastructure that is managed by Amazon ECS by launching your\n\t\t\tservices or tasks using the Fargate launch type. For more control, you can host your\n\t\t\ttasks on a cluster of Amazon Elastic Compute Cloud (Amazon EC2) instances that you manage by using the EC2\n\t\t\tlaunch type. For more information about launch types, see Amazon ECS Launch\n\t\t\tTypes.
\n\t\tAmazon ECS lets you launch and stop container-based applications with simple API calls,\n\t\t\tallows you to get the state of your cluster from a centralized service, and gives you\n\t\t\taccess to many familiar Amazon EC2 features.
\n\t\tYou can use Amazon ECS to schedule the placement of containers across your cluster based on\n\t\t\tyour resource needs, isolation policies, and availability requirements. Amazon ECS eliminates\n\t\t\tthe need for you to operate your own cluster management and configuration management\n\t\t\tsystems or worry about scaling your management infrastructure.
", "smithy.api#title": "Amazon EC2 Container Service", "smithy.api#xmlNamespace": { "uri": "http://ecs.amazonaws.com/doc/2014-11-13/" @@ -263,7 +263,7 @@ "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": " The status of the attachment. Valid values are PRECREATED
,\n CREATED
, ATTACHING
, ATTACHED
,\n DETACHING
, DETACHED
, and DELETED
.
The status of the attachment. Valid values are PRECREATED
,\n\t\t\t\tCREATED
, ATTACHING
, ATTACHED
,\n\t\t\t\tDETACHING
, DETACHED
, and DELETED
.
Details of the attachment. For elastic network interfaces, this includes the network\n interface ID, the MAC address, the subnet ID, and the private IPv4 address.
" + "smithy.api#documentation": "Details of the attachment. For elastic network interfaces, this includes the network\n\t\t\tinterface ID, the MAC address, the subnet ID, and the private IPv4 address.
" } } }, @@ -332,34 +332,34 @@ "com.amazonaws.ecs#Attribute": { "type": "structure", "members": { - "name": { + "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of the attribute. Up to 128 letters (uppercase and lowercase), numbers,\n hyphens, underscores, and periods are allowed.
", - "smithy.api#required": {} + "smithy.api#documentation": "The value of the attribute. The value
must contain between 1 and 128\n\t\t\tcharacters and may contain letters (uppercase and lowercase), numbers, hyphens,\n\t\t\tunderscores, periods, at signs (@), forward slashes, back slashes, colons, or spaces.\n\t\t\tThe value cannot contain any leading or trailing whitespace.
The type of the target with which to attach the attribute. This parameter is required\n if you use the short form ID for a resource instead of the full ARN.
" + "smithy.api#documentation": "The ID of the target. You can specify the short form ID for a resource or the full\n\t\t\tAmazon Resource Name (ARN).
" } }, - "value": { - "target": "com.amazonaws.ecs#String", + "targetType": { + "target": "com.amazonaws.ecs#TargetType", "traits": { - "smithy.api#documentation": "The value of the attribute. Up to 128 letters (uppercase and lowercase), numbers,\n hyphens, underscores, periods, at signs (@), forward slashes, colons, and spaces are\n allowed.
" + "smithy.api#documentation": "The type of the target with which to attach the attribute. This parameter is required\n\t\t\tif you use the short form ID for a resource instead of the full ARN.
" } }, - "targetId": { + "name": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The ID of the target. You can specify the short form ID for a resource or the full\n Amazon Resource Name (ARN).
" + "smithy.api#documentation": "The name of the attribute. The name
must contain between 1 and 128\n\t\t\tcharacters and name may contain letters (uppercase and lowercase), numbers, hyphens,\n\t\t\tunderscores, forward slashes, back slashes, or periods.
An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable\n you to extend the Amazon ECS data model by adding custom metadata to your resources. For more\n information, see Attributes in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "An attribute is a name-value pair associated with an Amazon ECS object. Attributes enable\n\t\t\tyou to extend the Amazon ECS data model by adding custom metadata to your resources. For more\n\t\t\tinformation, see Attributes in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#AttributeLimitExceededException": { @@ -370,7 +370,7 @@ } }, "traits": { - "smithy.api#documentation": "You can apply up to 10 custom attributes per resource. You can view the attributes of\n a resource with ListAttributes. You can remove existing attributes on\n a resource with DeleteAttributes.
", + "smithy.api#documentation": "You can apply up to 10 custom attributes per resource. You can view the attributes of\n\t\t\ta resource with ListAttributes. You can remove existing attributes on\n\t\t\ta resource with DeleteAttributes.
", "smithy.api#error": "client" } }, @@ -383,6 +383,12 @@ "com.amazonaws.ecs#AutoScalingGroupProvider": { "type": "structure", "members": { + "managedTerminationProtection": { + "target": "com.amazonaws.ecs#ManagedTerminationProtection", + "traits": { + "smithy.api#documentation": "The managed termination protection setting to use for the Auto Scaling group capacity\n\t\t\tprovider. This determines whether the Auto Scaling group has managed termination\n\t\t\tprotection.
\n\t\tWhen using managed termination protection, managed scaling must also be used\n\t\t\t\totherwise managed termination protection will not work.
\n\t\tWhen managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n\t\t\tan Auto Scaling group that contain tasks from being terminated during a scale-in action.\n\t\t\tThe Auto Scaling group and each instance in the Auto Scaling group must have instance\n\t\t\tprotection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide.
\n\t\tWhen managed termination protection is disabled, your Amazon EC2 instances are not\n\t\t\tprotected from termination when the Auto Scaling group scales in.
" + } + }, "managedScaling": { "target": "com.amazonaws.ecs#ManagedScaling", "traits": { @@ -395,12 +401,6 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the Auto Scaling group.
", "smithy.api#required": {} } - }, - "managedTerminationProtection": { - "target": "com.amazonaws.ecs#ManagedTerminationProtection", - "traits": { - "smithy.api#documentation": "The managed termination protection setting to use for the Auto Scaling group capacity\n provider. This determines whether the Auto Scaling group has managed termination\n protection.
\nWhen using managed termination protection, managed scaling must also be used\n otherwise managed termination protection will not work.
\nWhen managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in\n an Auto Scaling group that contain tasks from being terminated during a scale-in action.\n The Auto Scaling group and each instance in the Auto Scaling group must have instance\n protection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide.
\nWhen managed termination protection is disabled, your Amazon EC2 instances are not\n protected from termination when the Auto Scaling group scales in.
" - } } }, "traits": { @@ -410,22 +410,22 @@ "com.amazonaws.ecs#AwsVpcConfiguration": { "type": "structure", "members": { - "assignPublicIp": { - "target": "com.amazonaws.ecs#AssignPublicIp", + "securityGroups": { + "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "Whether the task's elastic network interface receives a public IP address. The default\n value is DISABLED
.
The IDs of the security groups associated with the task or service. If you do not\n\t\t\tspecify a security group, the default security group for the VPC is used. There is a\n\t\t\tlimit of 5 security groups that can be specified per\n\t\t\tAwsVpcConfiguration
.
All specified security groups must be from the same VPC.
\n\t\tThe security groups associated with the task or service. If you do not specify a\n security group, the default security group for the VPC is used. There is a limit of 5\n security groups that can be specified per AwsVpcConfiguration
.
All specified security groups must be from the same VPC.
\nWhether the task's elastic network interface receives a public IP address. The default\n\t\t\tvalue is DISABLED
.
The subnets associated with the task or service. There is a limit of 16 subnets that\n can be specified per AwsVpcConfiguration
.
All specified subnets must be from the same VPC.
\nThe IDs of the subnets associated with the task or service. There is a limit of 16\n\t\t\tsubnets that can be specified per AwsVpcConfiguration
.
All specified subnets must be from the same VPC.
\n\t\tThe current status of the capacity provider. Only capacity providers in an\n ACTIVE
state can be used in a cluster. When a capacity provider is\n successfully deleted, it will have an INACTIVE
status.
The update status reason. This provides further details about the update status for\n\t\t\tthe capacity provider.
" } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "The metadata that you apply to the capacity provider to help you categorize and\n organize it. Each tag consists of a key and an optional value, both of which you\n define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The name of the capacity provider.
" + "smithy.api#documentation": "The metadata that you apply to the capacity provider to help you categorize and\n\t\t\torganize it. Each tag consists of a key and an optional value, both of which you\n\t\t\tdefine.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The update status of the capacity provider. The following are the possible states that\n will be returned.
\nThe capacity provider is in the process of being deleted.
\nThe capacity provider has been successfully deleted and will have an\n INACTIVE
status.
The capacity provider was unable to be deleted. The update status reason\n will provide further details about why the delete failed.
\nThe current status of the capacity provider. Only capacity providers in an\n\t\t\t\tACTIVE
state can be used in a cluster. When a capacity provider is\n\t\t\tsuccessfully deleted, it will have an INACTIVE
status.
The Auto Scaling group settings for the capacity provider.
" } }, - "updateStatusReason": { + "name": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The update status reason. This provides further details about the update status for\n the capacity provider.
" + "smithy.api#documentation": "The name of the capacity provider.
" + } + }, + "updateStatus": { + "target": "com.amazonaws.ecs#CapacityProviderUpdateStatus", + "traits": { + "smithy.api#documentation": "The update status of the capacity provider. The following are the possible states that\n\t\t\twill be returned.
\n\t\tThe capacity provider is in the process of being deleted.
\n\t\t\t\tThe capacity provider has been successfully deleted and will have an\n\t\t\t\t\t\t\tINACTIVE
status.
The capacity provider was unable to be deleted. The update status reason\n\t\t\t\t\t\twill provide further details about why the delete failed.
\n\t\t\t\tThe base value designates how many tasks, at a minimum, to run on\n the specified capacity provider. Only one capacity provider in a capacity provider\n strategy can have a base defined.
" + "smithy.api#documentation": "The weight value designates the relative percentage of the total\n\t\t\tnumber of tasks launched that should use the specified capacity provider.
\n\t\tFor example, if you have a strategy that contains two capacity providers and both have\n\t\t\ta weight of 1
, then when the base
is satisfied, the tasks will\n\t\t\tbe split evenly across the two capacity providers. Using that same logic, if you specify\n\t\t\ta weight of 1
for capacityProviderA and a weight of\n\t\t\t\t4
for capacityProviderB, then for every one task\n\t\t\tthat is run using capacityProviderA, four tasks would use\n\t\t\t\tcapacityProviderB.
The weight value designates the relative percentage of the total\n number of tasks launched that should use the specified capacity provider.
\nFor example, if you have a strategy that contains two capacity providers and both have\n a weight of 1
, then when the base
is satisfied, the tasks will\n be split evenly across the two capacity providers. Using that same logic, if you specify\n a weight of 1
for capacityProviderA and a weight of\n 4
for capacityProviderB, then for every one task\n that is run using capacityProviderA, four tasks would use\n capacityProviderB.
The base value designates how many tasks, at a minimum, to run on\n\t\t\tthe specified capacity provider. Only one capacity provider in a capacity provider\n\t\t\tstrategy can have a base defined.
" } } }, @@ -627,35 +627,35 @@ } }, "traits": { - "smithy.api#documentation": "These errors are usually caused by a client action, such as using an action or\n resource on behalf of a user that doesn't have permissions to use the action or\n resource, or specifying an identifier that is not valid.
", + "smithy.api#documentation": "These errors are usually caused by a client action, such as using an action or\n\t\t\tresource on behalf of a user that doesn't have permissions to use the action or\n\t\t\tresource, or specifying an identifier that is not valid.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#Cluster": { "type": "structure", "members": { - "activeServicesCount": { - "target": "com.amazonaws.ecs#Integer", - "traits": { - "smithy.api#documentation": "The number of services that are running on the cluster in an ACTIVE
\n state. You can view these services with ListServices.
The settings for the cluster. This parameter indicates whether CloudWatch Container Insights\n is enabled or disabled for a cluster.
" + "smithy.api#documentation": "The settings for the cluster. This parameter indicates whether CloudWatch Container Insights\n\t\t\tis enabled or disabled for a cluster.
" } }, - "registeredContainerInstancesCount": { + "activeServicesCount": { "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "The number of container instances registered into the cluster. This includes container\n instances in both ACTIVE
and DRAINING
status.
The number of services that are running on the cluster in an ACTIVE
\n\t\t\tstate. You can view these services with ListServices.
The resources attached to a cluster. When using a capacity provider with a cluster,\n\t\t\tthe Auto Scaling plan that is created will be returned as a cluster attachment.
" + } + }, + "capacityProviders": { + "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "The default capacity provider strategy for the cluster. When services or tasks are run\n in the cluster with no launch type or capacity provider strategy specified, the default\n capacity provider strategy is used.
" + "smithy.api#documentation": "The capacity providers associated with the cluster.
" } }, "runningTasksCount": { @@ -664,28 +664,28 @@ "smithy.api#documentation": "The number of tasks in the cluster that are in the RUNNING
state.
The resources attached to a cluster. When using a capacity provider with a cluster,\n the Auto Scaling plan that is created will be returned as a cluster attachment.
" + "smithy.api#documentation": "Additional information about your clusters that are separated by launch type,\n\t\t\tincluding:
\n\t\trunningEC2TasksCount
\n\t\t\tRunningFargateTasksCount
\n\t\t\tpendingEC2TasksCount
\n\t\t\tpendingFargateTasksCount
\n\t\t\tactiveEC2ServiceCount
\n\t\t\tactiveFargateServiceCount
\n\t\t\tdrainingEC2ServiceCount
\n\t\t\tdrainingFargateServiceCount
\n\t\t\tThe number of tasks in the cluster that are in the PENDING
state.
The default capacity provider strategy for the cluster. When services or tasks are run\n\t\t\tin the cluster with no launch type or capacity provider strategy specified, the default\n\t\t\tcapacity provider strategy is used.
" } }, "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The status of the cluster. The following are the possible states that will be\n returned.
\nThe cluster is ready to accept tasks and if applicable you can register\n container instances with the cluster.
\nThe cluster has capacity providers associated with it and the resources\n needed for the capacity provider are being created.
\nThe cluster has capacity providers associated with it and the resources\n needed for the capacity provider are being deleted.
\nThe cluster has capacity providers associated with it and the resources\n needed for the capacity provider have failed to create.
\nThe cluster has been deleted. Clusters with an INACTIVE
\n status may remain discoverable in your account for a period of time.\n However, this behavior is subject to change in the future, so you should not\n rely on INACTIVE
clusters persisting.
The status of the cluster. The following are the possible states that will be\n\t\t\treturned.
\n\t\tThe cluster is ready to accept tasks and if applicable you can register\n\t\t\t\t\t\tcontainer instances with the cluster.
\n\t\t\t\tThe cluster has capacity providers associated with it and the resources\n\t\t\t\t\t\tneeded for the capacity provider are being created.
\n\t\t\t\tThe cluster has capacity providers associated with it and the resources\n\t\t\t\t\t\tneeded for the capacity provider are being deleted.
\n\t\t\t\tThe cluster has capacity providers associated with it and the resources\n\t\t\t\t\t\tneeded for the capacity provider have failed to create.
\n\t\t\t\tThe cluster has been deleted. Clusters with an INACTIVE
\n\t\t\t\t\t\tstatus may remain discoverable in your account for a period of time.\n\t\t\t\t\t\tHowever, this behavior is subject to change in the future, so you should not\n\t\t\t\t\t\trely on INACTIVE
clusters persisting.
Additional information about your clusters that are separated by launch type,\n including:
\nrunningEC2TasksCount
\nRunningFargateTasksCount
\npendingEC2TasksCount
\npendingFargateTasksCount
\nactiveEC2ServiceCount
\nactiveFargateServiceCount
\ndrainingEC2ServiceCount
\ndrainingFargateServiceCount
\nThe number of tasks in the cluster that are in the PENDING
state.
A user-generated string that you use to identify your cluster.
" } }, - "attachmentsStatus": { - "target": "com.amazonaws.ecs#String", + "registeredContainerInstancesCount": { + "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "The status of the capacity providers associated with the cluster. The following are\n the states that will be returned:
\nThe available capacity providers for the cluster are updating. This occurs\n when the Auto Scaling plan is provisioning or deprovisioning.
\nThe capacity providers have successfully updated.
\nThe capacity provider updates failed.
\nThe number of container instances registered into the cluster. This includes container\n\t\t\tinstances in both ACTIVE
and DRAINING
status.
The capacity providers associated with the cluster.
" + "smithy.api#documentation": "The status of the capacity providers associated with the cluster. The following are\n\t\t\tthe states that will be returned:
\n\t\tThe available capacity providers for the cluster are updating. This occurs\n\t\t\t\t\t\twhen the Auto Scaling plan is provisioning or deprovisioning.
\n\t\t\t\tThe capacity providers have successfully updated.
\n\t\t\t\tThe capacity provider updates failed.
\n\t\t\t\tThe metadata that you apply to the cluster to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
A regional grouping of one or more container instances on which you can run task\n requests. Each account receives a default cluster the first time you use the Amazon ECS\n service, but you may also create other clusters. Clusters may contain more than one\n instance type simultaneously.
" + "smithy.api#documentation": "A regional grouping of one or more container instances on which you can run task\n\t\t\trequests. Each account receives a default cluster the first time you use the Amazon ECS\n\t\t\tservice, but you may also create other clusters. Clusters may contain more than one\n\t\t\tinstance type simultaneously.
" } }, "com.amazonaws.ecs#ClusterContainsContainerInstancesException": { @@ -731,7 +731,7 @@ } }, "traits": { - "smithy.api#documentation": "You cannot delete a cluster that has registered container instances. First, deregister\n the container instances before you can delete the cluster. For more information, see\n DeregisterContainerInstance.
", + "smithy.api#documentation": "You cannot delete a cluster that has registered container instances. First, deregister\n\t\t\tthe container instances before you can delete the cluster. For more information, see\n\t\t\t\tDeregisterContainerInstance.
", "smithy.api#error": "client" } }, @@ -743,7 +743,7 @@ } }, "traits": { - "smithy.api#documentation": "You cannot delete a cluster that contains services. First, update the service to\n reduce its desired task count to 0 and then delete the service. For more information,\n see UpdateService and DeleteService.
", + "smithy.api#documentation": "You cannot delete a cluster that contains services. First, update the service to\n\t\t\treduce its desired task count to 0 and then delete the service. For more information,\n\t\t\tsee UpdateService and DeleteService.
", "smithy.api#error": "client" } }, @@ -796,28 +796,28 @@ } }, "traits": { - "smithy.api#documentation": "The specified cluster could not be found. You can view your available clusters with\n ListClusters. Amazon ECS clusters are Region-specific.
", + "smithy.api#documentation": "The specified cluster could not be found. You can view your available clusters with\n\t\t\t\tListClusters. Amazon ECS clusters are Region-specific.
", "smithy.api#error": "client" } }, "com.amazonaws.ecs#ClusterSetting": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.ecs#String", + "name": { + "target": "com.amazonaws.ecs#ClusterSettingName", "traits": { - "smithy.api#documentation": "The value to set for the cluster setting. The supported values are\n enabled
and disabled
. If enabled
is\n specified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be\n disabled unless the containerInsights
account setting is enabled. If a\n cluster value is specified, it will override the containerInsights
value\n set with PutAccountSetting or PutAccountSettingDefault.
The name of the cluster setting. The only supported value is\n\t\t\t\tcontainerInsights
.
The name of the cluster setting. The only supported value is\n containerInsights
.
The value to set for the cluster setting. The supported values are\n\t\t\t\tenabled
and disabled
. If enabled
is\n\t\t\tspecified, CloudWatch Container Insights will be enabled for the cluster, otherwise it will be\n\t\t\tdisabled unless the containerInsights
account setting is enabled. If a\n\t\t\tcluster value is specified, it will override the containerInsights
value\n\t\t\tset with PutAccountSetting or PutAccountSettingDefault.
The settings to use when creating a cluster. This parameter is used to enable CloudWatch\n Container Insights for a cluster.
" + "smithy.api#documentation": "The settings to use when creating a cluster. This parameter is used to enable CloudWatch\n\t\t\tContainer Insights for a cluster.
" } }, "com.amazonaws.ecs#ClusterSettingName": { @@ -882,64 +882,58 @@ "com.amazonaws.ecs#Container": { "type": "structure", "members": { - "cpu": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The number of CPU units set for the container. The value will be 0
if no\n value was specified in the container definition when the task definition was\n registered.
The network bindings associated with the container.
" } }, - "gpuIds": { - "target": "com.amazonaws.ecs#GpuIds", + "memoryReservation": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The IDs of each GPU assigned to the container.
" + "smithy.api#documentation": "The soft limit (in MiB) of memory set for the container.
" } }, - "memoryReservation": { + "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The soft limit (in MiB) of memory set for the container.
" + "smithy.api#documentation": "The number of CPU units set for the container. The value will be 0
if no\n\t\t\tvalue was specified in the container definition when the task definition was\n\t\t\tregistered.
The image used for the container.
" + "smithy.api#documentation": "The hard limit (in MiB) of memory set for the container.
" } }, - "imageDigest": { + "image": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The container image manifest digest.
\nThe imageDigest
is only returned if the container is using an image\n hosted in Amazon ECR, otherwise it is omitted.
The image used for the container.
" } }, "reason": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details about\n a running or stopped container.
" + "smithy.api#documentation": "A short (255 max characters) human-readable string to provide additional details about\n\t\t\ta running or stopped container.
" } }, - "healthStatus": { - "target": "com.amazonaws.ecs#HealthStatus", + "imageDigest": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The health status of the container. If health checks are not configured for this\n container in its task definition, then it reports the health status as\n UNKNOWN
.
The container image manifest digest.
\n\t\tThe imageDigest
is only returned if the container is using an image\n\t\t\t\thosted in Amazon ECR, otherwise it is omitted.
The ID of the Docker container.
" + "smithy.api#documentation": "The IDs of each GPU assigned to the container.
" } }, - "name": { + "runtimeId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of the container.
" + "smithy.api#documentation": "The ID of the Docker container.
" } }, "containerArn": { @@ -948,16 +942,16 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the container.
" } }, - "taskArn": { - "target": "com.amazonaws.ecs#String", + "healthStatus": { + "target": "com.amazonaws.ecs#HealthStatus", "traits": { - "smithy.api#documentation": "The ARN of the task.
" + "smithy.api#documentation": "The health status of the container. If health checks are not configured for this\n\t\t\tcontainer in its task definition, then it reports the health status as\n\t\t\t\tUNKNOWN
.
The hard limit (in MiB) of memory set for the container.
" + "smithy.api#documentation": "The ARN of the task.
" } }, "networkInterfaces": { @@ -966,6 +960,12 @@ "smithy.api#documentation": "The network interfaces associated with the container.
" } }, + "name": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The name of the container.
" + } + }, "lastStatus": { "target": "com.amazonaws.ecs#String", "traits": { @@ -1009,184 +1009,166 @@ "com.amazonaws.ecs#ContainerDefinition": { "type": "structure", "members": { - "pseudoTerminal": { - "target": "com.amazonaws.ecs#BoxedBoolean", - "traits": { - "smithy.api#documentation": "When this parameter is true
, a TTY is allocated. This parameter maps to\n Tty
in the Create a container section of the\n Docker Remote API and the --tty
option to docker run.
A list of ulimits
to set in the container. If a ulimit value is specified\n in a task definition, it will override the default values set by Docker. This parameter\n maps to Ulimits
in the Create a container section of the\n Docker Remote API and the --ulimit
option to docker run. Valid naming values are displayed\n in the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
\n
This parameter is not supported for Windows containers.
\nThe container health check command and associated configuration parameters for the\n container. This parameter maps to HealthCheck
in the\n Create a container section of the Docker Remote API and the\n HEALTHCHECK
parameter of docker\n run.
When this parameter is true, networking is disabled within the container. This\n parameter maps to NetworkDisabled
in the Create a container\n section of the Docker Remote API.
This parameter is not supported for Windows containers.
\nWhen this parameter is true, networking is disabled within the container. This\n\t\t\tparameter maps to NetworkDisabled
in the Create a container\n\t\t\tsection of the Docker Remote API.
This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
\nA list of hostnames and IP address mappings to append to the /etc/hosts
\n file on the container. This parameter maps to ExtraHosts
in the\n Create a container section of the Docker Remote API and the\n --add-host
option to docker\n run.
This parameter is not supported for Windows containers or tasks that use the\n awsvpc
network mode.
A list of hostnames and IP address mappings to append to the /etc/hosts
\n\t\t\tfile on the container. This parameter maps to ExtraHosts
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--add-host
option to docker\n\t\t\t\trun.
This parameter is not supported for Windows containers or tasks that use the\n\t\t\t\t\tawsvpc
network mode.
The user name to use inside the container. This parameter maps to User
in\n the Create a container section of the Docker Remote API and the\n --user
option to docker\n run.
You can use the following formats. If specifying a UID or GID, you must specify it as\n a positive integer.
\n\n user
\n
\n user:group
\n
\n uid
\n
\n uid:gid
\n
\n user:gid
\n
\n uid:group
\n
This parameter is not supported for Windows containers.
\nA list of ulimits
to set in the container. If a ulimit value is specified\n\t\t\tin a task definition, it will override the default values set by Docker. This parameter\n\t\t\tmaps to Ulimits
in the Create a container section of the\n\t\t\tDocker Remote API and the --ulimit
option to docker run. Valid naming values are displayed\n\t\t\tin the Ulimit data type. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
\n
This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
\nA list of strings to provide custom labels for SELinux and AppArmor multi-level\n security systems. This field is not valid for containers in tasks using the\n Fargate launch type.
\nWith Windows containers, this parameter can be used to reference a credential spec\n file when configuring a container for Active Directory authentication. For more\n information, see Using gMSAs for Windows\n Containers in the Amazon Elastic Container Service Developer Guide.
\nThis parameter maps to SecurityOpt
in the\n Create a container section of the Docker Remote API and the\n --security-opt
option to docker\n run.
The Amazon ECS container agent running on a container instance must register with the\n ECS_SELINUX_CAPABLE=true
or ECS_APPARMOR_CAPABLE=true
\n environment variables before containers placed on that instance can use these\n security options. For more information, see Amazon ECS Container\n Agent Configuration in the Amazon Elastic Container Service Developer Guide.
When this parameter is true
, a TTY is allocated. This parameter maps to\n\t\t\t\tTty
in the Create a container section of the\n\t\t\tDocker Remote API and the --tty
option to docker run.
The links
parameter allows containers to communicate with each other\n without the need for port mappings. This parameter is only supported if the network mode\n of a task definition is bridge
. The name:internalName
\n construct is analogous to name:alias
in Docker links.\n Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. For more information about linking Docker containers, go to\n Legacy container links\n in the Docker documentation. This parameter maps to Links
in the\n Create a container section of the Docker Remote API and the\n --link
option to docker\n run.
This parameter is not supported for Windows containers.
\nContainers that are collocated on a single container instance may be able to\n communicate with each other without requiring links or host port mappings. Network\n isolation is achieved on the container instance using security groups and VPC\n settings.
\nData volumes to mount from another container. This parameter maps to\n\t\t\t\tVolumesFrom
in the Create a container section of the\n\t\t\tDocker Remote API and the --volumes-from
option to docker run.
Data volumes to mount from another container. This parameter maps to\n VolumesFrom
in the Create a container section of the\n Docker Remote API and the --volumes-from
option to docker run.
The container health check command and associated configuration parameters for the\n\t\t\tcontainer. This parameter maps to HealthCheck
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\tHEALTHCHECK
parameter of docker\n\t\t\t\trun.
The name of a container. If you are linking multiple containers together in a task\n definition, the name
of one container can be entered in the\n links
of another container to connect the containers.\n Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This parameter maps to name
in the\n Create a container section of the Docker Remote API and the\n --name
option to docker\n run.
A list of DNS search domains that are presented to the container. This parameter maps\n\t\t\tto DnsSearch
in the Create a container section of the\n\t\t\tDocker Remote API and the --dns-search
option to docker run.
This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
\nThe amount (in MiB) of memory to present to the container. If your container attempts\n to exceed the memory specified here, the container is killed. The total amount of memory\n reserved for all containers within a task must be lower than the task\n memory
value, if one is specified. This parameter maps to\n Memory
in the Create a container section of the\n Docker Remote API and the --memory
option to docker run.
If using the Fargate launch type, this parameter is optional.
\nIf using the EC2 launch type, you must specify either a task-level\n memory value or a container-level memory value. If you specify both a container-level\n memory
and memoryReservation
value, memory
\n must be greater than memoryReservation
. If you specify\n memoryReservation
, then that value is subtracted from the available\n memory resources for the container instance on which the container is placed. Otherwise,\n the value of memory
is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should\n not specify fewer than 4 MiB of memory for your containers.
" + "smithy.api#documentation": "The amount (in MiB) of memory to present to the container. If your container attempts\n\t\t\tto exceed the memory specified here, the container is killed. The total amount of memory\n\t\t\treserved for all containers within a task must be lower than the task\n\t\t\t\tmemory
value, if one is specified. This parameter maps to\n\t\t\t\tMemory
in the Create a container section of the\n\t\t\tDocker Remote API and the --memory
option to docker run.
If using the Fargate launch type, this parameter is optional.
\n\t\tIf using the EC2 launch type, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. If you specify both a container-level\n\t\t\t\tmemory
and memoryReservation
value, memory
\n\t\t\tmust be greater than memoryReservation
. If you specify\n\t\t\t\tmemoryReservation
, then that value is subtracted from the available\n\t\t\tmemory resources for the container instance on which the container is placed. Otherwise,\n\t\t\tthe value of memory
is used.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should\n\t\t\tnot specify fewer than 4 MiB of memory for your containers.
" } }, - "linuxParameters": { - "target": "com.amazonaws.ecs#LinuxParameters", + "user": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "Linux-specific modifications that are applied to the container, such as Linux kernel\n capabilities. For more information see KernelCapabilities.
\nThis parameter is not supported for Windows containers.
\nThe user name to use inside the container. This parameter maps to User
in\n\t\t\tthe Create a container section of the Docker Remote API and the\n\t\t\t\t--user
option to docker\n\t\t\trun.
You can use the following formats. If specifying a UID or GID, you must specify it as\n\t\t\ta positive integer.
\n\t\t\n user
\n
\n user:group
\n
\n uid
\n
\n uid:gid
\n
\n user:gid
\n
\n uid:group
\n
This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
\nA list of DNS search domains that are presented to the container. This parameter maps\n to DnsSearch
in the Create a container section of the\n Docker Remote API and the --dns-search
option to docker run.
This parameter is not supported for Windows containers.
\nEarly versions of the Amazon ECS container agent do not properly handle\n\t\t\t\t\tentryPoint
parameters. If you have problems using\n\t\t\t\t\tentryPoint
, update your container agent or enter your commands and\n\t\t\t\targuments as command
array items instead.
The entry point that is passed to the container. This parameter maps to\n\t\t\t\tEntrypoint
in the Create a container section of the\n\t\t\tDocker Remote API and the --entrypoint
option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.
If the essential
parameter of a container is marked as true
,\n and that container fails or stops for any reason, all other containers that are part of\n the task are stopped. If the essential
parameter of a container is marked\n as false
, then its failure does not affect the rest of the containers in a\n task. If this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that\n is composed of multiple containers, you should group containers that are used for a\n common purpose into components, and separate the different components into multiple task\n definitions. For more information, see Application\n Architecture in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "When this parameter is true
, this allows you to deploy containerized\n\t\t\tapplications that require stdin
or a tty
to be allocated. This\n\t\t\tparameter maps to OpenStdin
in the Create a container\n\t\t\tsection of the Docker Remote API and the --interactive
option to docker run.
A list of namespaced kernel parameters to set in the container. This parameter maps to\n Sysctls
in the Create a container section of the\n Docker Remote API and the --sysctl
option to docker run.
It is not recommended that you specify network-related systemControls
\n parameters for multiple containers in a single task that also uses either the\n awsvpc
or host
network modes. For tasks that use the\n awsvpc
network mode, the container that is started last determines\n which systemControls
parameters take effect. For tasks that use the\n host
network mode, it changes the container instance's namespaced\n kernel parameters as well as the containers.
The log configuration specification for the container.
\n\t\tThis parameter maps to LogConfig
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--log-driver
option to docker\n\t\t\t\trun. By default, containers use the same logging driver that the Docker\n\t\t\tdaemon uses. However the container may use a different logging driver than the Docker\n\t\t\tdaemon by specifying a log driver with this parameter in the container definition. To\n\t\t\tuse a different logging driver for a container, the log system must be configured\n\t\t\tproperly on the container instance (or on a different log server for remote logging\n\t\t\toptions). For more information on the options for different supported log drivers, see\n\t\t\t\tConfigure\n\t\t\t\tlogging drivers in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker\n\t\t\t\tdaemon (shown in the LogConfiguration data type). Additional log\n\t\t\t\tdrivers may be available in future releases of the Amazon ECS container agent.
\n\t\tThis parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
\n
The Amazon ECS container agent running on a container instance must register the\n\t\t\t\tlogging drivers available on that instance with the\n\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS
environment variable before\n\t\t\t\tcontainers placed on that instance can use these log configuration options. For more\n\t\t\t\tinformation, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.
A list of files containing the environment variables to pass to a container. This\n parameter maps to the --env-file
option to docker run.
You can specify up to ten environment files. The file must have a .env
\n file extension. Each line in an environment file should contain an environment variable\n in VARIABLE=VALUE
format. Lines beginning with #
are treated\n as comments and are ignored. For more information on the environment variable file\n syntax, see Declare default\n environment variables in file.
If there are environment variables specified using the environment
\n parameter in a container definition, they take precedence over the variables contained\n within an environment file. If multiple environment files are specified that contain the\n same variable, they are processed from the top down. It is recommended to use unique\n variable names. For more information, see Specifying Environment\n Variables in the Amazon Elastic Container Service Developer Guide.
This field is not valid for containers in tasks using the Fargate launch\n type.
" + "smithy.api#documentation": "The links
parameter allows containers to communicate with each other\n\t\t\twithout the need for port mappings. This parameter is only supported if the network mode\n\t\t\tof a task definition is bridge
. The name:internalName
\n\t\t\tconstruct is analogous to name:alias
in Docker links.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. For more information about linking Docker containers, go to\n\t\t\t\tLegacy container links\n\t\t\tin the Docker documentation. This parameter maps to Links
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--link
option to docker\n\t\t\trun.
This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
\nContainers that are collocated on a single container instance may be able to\n\t\t\t\tcommunicate with each other without requiring links or host port mappings. Network\n\t\t\t\tisolation is achieved on the container instance using security groups and VPC\n\t\t\t\tsettings.
\n\t\tThe environment variables to pass to a container. This parameter maps to\n Env
in the Create a container section of the\n Docker Remote API and the --env
option to docker run.
We do not recommend using plaintext environment variables for sensitive\n information, such as credential data.
\nTime duration (in seconds) to wait before giving up on resolving dependencies for a\n\t\t\tcontainer. For example, you specify two containers in a task definition with containerA\n\t\t\thaving a dependency on containerB reaching a COMPLETE
,\n\t\t\tSUCCESS
, or HEALTHY
status. If a startTimeout
\n\t\t\tvalue is specified for containerB and it does not reach the desired status within that\n\t\t\ttime then containerA will give up and not start. This results in the task transitioning\n\t\t\tto a STOPPED
state.
When the ECS_CONTAINER_START_TIMEOUT
container agent configuration\n\t\t\t\tvariable is used, it is enforced indendently from this start timeout value.
For tasks using the Fargate launch type, this parameter requires that\n\t\t\tthe task or service uses platform version 1.3.0 or later.
\n\t\tFor tasks using the EC2 launch type, your container instances require at\n\t\t\tleast version 1.26.0
of the container agent to enable a container start\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you are\n\t\t\tusing an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1
of\n\t\t\tthe ecs-init
package. If your container instances are launched from version\n\t\t\t\t20190301
or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
When this parameter is true, the container is given read-only access to its root file\n system. This parameter maps to ReadonlyRootfs
in the\n Create a container section of the Docker Remote API and the\n --read-only
option to docker\n run.
This parameter is not supported for Windows containers.
\nThe hostname to use for your container. This parameter maps to Hostname
\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\t--hostname
option to docker\n\t\t\t\trun.
The hostname
parameter is not supported if you are using the\n\t\t\t\t\tawsvpc
network mode.
The working directory in which to run commands inside the container. This parameter\n maps to WorkingDir
in the Create a container section of the\n Docker Remote API and the --workdir
option to docker run.
The type and amount of a resource to assign to a container. The only supported\n\t\t\tresource is a GPU.
" } }, - "secrets": { - "target": "com.amazonaws.ecs#SecretList", + "firelensConfiguration": { + "target": "com.amazonaws.ecs#FirelensConfiguration", "traits": { - "smithy.api#documentation": "The secrets to pass to the container. For more information, see Specifying\n Sensitive Data in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The FireLens configuration for the container. This is used to specify and configure a\n\t\t\tlog router for container logs. For more information, see Custom Log Routing\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" } }, - "command": { - "target": "com.amazonaws.ecs#StringList", + "image": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The command that is passed to the container. This parameter maps to Cmd
\n in the Create a container section of the Docker Remote API and the\n COMMAND
parameter to docker\n run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each\n argument should be a separated string in the array.
The image used to start a container. This string is passed directly to the Docker\n\t\t\tdaemon. Images in the Docker Hub registry are available by default. Other repositories\n\t\t\tare specified with either \n\t\t\t\t repository-url/image:tag\n\t\t\t
or \n\t\t\t\t repository-url/image@digest\n\t\t\t
. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\tIMAGE
parameter of docker\n\t\t\t\trun.
When a new task starts, the Amazon ECS container agent pulls the latest version of\n\t\t\t\t\tthe specified image and tag for the container to use. However, subsequent\n\t\t\t\t\tupdates to a repository image are not propagated to already running\n\t\t\t\t\ttasks.
\n\t\t\tImages in Amazon ECR repositories can be specified by either using the full\n\t\t\t\t\t\tregistry/repository:tag
or\n\t\t\t\t\t\tregistry/repository@digest
. For example,\n\t\t\t\t\t\t012345678910.dkr.ecr.
\n\t\t\t\t\tor\n\t\t\t\t\t\t012345678910.dkr.ecr.
.\n\t\t\t\t
Images in official repositories on Docker Hub use a single name (for example,\n\t\t\t\t\t\tubuntu
or mongo
).
Images in other repositories on Docker Hub are qualified with an organization\n\t\t\t\t\tname (for example, amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a domain name\n\t\t\t\t\t(for example, quay.io/assemblyline/ubuntu
).
A list of DNS servers that are presented to the container. This parameter maps to\n Dns
in the Create a container section of the\n Docker Remote API and the --dns
option to docker run.
This parameter is not supported for Windows containers.
\nThe soft limit (in MiB) of memory to reserve for the container. When system memory is\n\t\t\tunder heavy contention, Docker attempts to keep the container memory to this soft limit.\n\t\t\tHowever, your container can consume more memory when it needs to, up to either the hard\n\t\t\tlimit specified with the memory
parameter (if applicable), or all of the\n\t\t\tavailable memory on the container instance, whichever comes first. This parameter maps\n\t\t\tto MemoryReservation
in the Create a container section of\n\t\t\tthe Docker Remote API and the --memory-reservation
option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for\n\t\t\tone or both of memory
or memoryReservation
in a container\n\t\t\tdefinition. If you specify both, memory
must be greater than\n\t\t\t\tmemoryReservation
. If you specify memoryReservation
, then\n\t\t\tthat value is subtracted from the available memory resources for the container instance\n\t\t\ton which the container is placed. Otherwise, the value of memory
is\n\t\t\tused.
For example, if your container normally uses 128 MiB of memory, but occasionally\n\t\t\tbursts to 256 MiB of memory for short periods of time, you can set a\n\t\t\t\tmemoryReservation
of 128 MiB, and a memory
hard limit of\n\t\t\t300 MiB. This configuration would allow the container to only reserve 128 MiB of memory\n\t\t\tfrom the remaining resources on the container instance, but also allow the container to\n\t\t\tconsume more memory resources when needed.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should\n\t\t\tnot specify fewer than 4 MiB of memory for your containers.
" } }, - "resourceRequirements": { - "target": "com.amazonaws.ecs#ResourceRequirements", + "portMappings": { + "target": "com.amazonaws.ecs#PortMappingList", "traits": { - "smithy.api#documentation": "The type and amount of a resource to assign to a container. The only supported\n resource is a GPU.
" + "smithy.api#documentation": "The list of port mappings for the container. Port mappings allow containers to access\n\t\t\tports on the host container instance to send or receive traffic.
\n\t\tFor task definitions that use the awsvpc
network mode, you should only\n\t\t\tspecify the containerPort
. The hostPort
can be left blank or\n\t\t\tit must be the same value as the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than\n\t\t\t\tlocalhost
. There is no loopback for port mappings on Windows, so you\n\t\t\tcannot access a container's mapped port from the host itself.
This parameter maps to PortBindings
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--publish
option to docker\n\t\t\t\trun. If the network mode of a task definition is set to none
,\n\t\t\tthen you can't specify port mappings. If the network mode of a task definition is set to\n\t\t\t\thost
, then host ports must either be undefined or they must match the\n\t\t\tcontainer port in the port mapping.
After a task reaches the RUNNING
status, manual and automatic host\n\t\t\t\tand container port assignments are visible in the Network\n\t\t\t\t\tBindings section of a container description for a selected task in\n\t\t\t\tthe Amazon ECS console. The assignments are also visible in the\n\t\t\t\t\tnetworkBindings
section DescribeTasks\n\t\t\t\tresponses.
When this parameter is true, the container is given elevated privileges on the host\n container instance (similar to the root
user). This parameter maps to\n Privileged
in the Create a container section of the\n Docker Remote API and the --privileged
option to docker run.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
\nThe dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.
\n\t\tFor tasks using the EC2 launch type, the container instances require at\n\t\t\tleast version 1.26.0 of the container agent to enable container dependencies. However,\n\t\t\twe recommend using the latest container agent version. For information about checking\n\t\t\tyour agent version and updating to the latest version, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you are\n\t\t\tusing an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init
package. If your container instances are launched from version\n\t\t\t\t20190301
or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires\n\t\t\tplatform version 1.3.0
or later.
The number of cpu
units reserved for the container. This parameter maps\n to CpuShares
in the Create a container section of the\n Docker Remote API and the --cpu-shares
option to docker run.
This field is optional for tasks using the Fargate launch type, and the\n only requirement is that the total amount of CPU reserved for all containers within a\n task be lower than the task-level cpu
value.
You can determine the number of CPU units that are available per EC2 instance type\n by multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page\n by 1,024.
\nLinux containers share unallocated CPU units with other containers on the container\n instance with the same ratio as their allocated amount. For example, if you run a\n single-container task on a single-core instance type with 512 CPU units specified for\n that container, and that is the only task running on the container instance, that\n container could use the full 1,024 CPU unit share at any given time. However, if you\n launched another copy of the same task on that container instance, each task would be\n guaranteed a minimum of 512 CPU units when needed, and each container could float to\n higher CPU usage if the other container was not using it, but if both tasks were 100%\n active all of the time, they would be limited to 512 CPU units.
\nOn Linux container instances, the Docker daemon on the container instance uses the CPU\n value to calculate the relative CPU share ratios for running containers. For more\n information, see CPU share\n constraint in the Docker documentation. The minimum valid CPU share value\n that the Linux kernel allows is 2. However, the CPU parameter is not required, and you\n can use CPU values below 2 in your container definitions. For CPU values below 2\n (including null), the behavior varies based on your Amazon ECS container agent\n version:
\n\n Agent versions less than or equal to 1.1.0:\n Null and zero CPU values are passed to Docker as 0, which Docker then converts\n to 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux\n kernel converts to two CPU shares.
\n\n Agent versions greater than or equal to 1.2.0:\n Null, zero, and CPU values of 1 are passed to Docker as 2.
\nOn Windows container instances, the CPU limit is enforced as an absolute limit, or a\n quota. Windows containers only have access to the specified amount of CPU that is\n described in the task definition.
" + "smithy.api#documentation": "The number of cpu
units reserved for the container. This parameter maps\n\t\t\tto CpuShares
in the Create a container section of the\n\t\t\tDocker Remote API and the --cpu-shares
option to docker run.
This field is optional for tasks using the Fargate launch type, and the\n\t\t\tonly requirement is that the total amount of CPU reserved for all containers within a\n\t\t\ttask be lower than the task-level cpu
value.
You can determine the number of CPU units that are available per EC2 instance type\n\t\t\t\tby multiplying the vCPUs listed for that instance type on the Amazon EC2 Instances detail page\n\t\t\t\tby 1,024.
\n\t\tLinux containers share unallocated CPU units with other containers on the container\n\t\t\tinstance with the same ratio as their allocated amount. For example, if you run a\n\t\t\tsingle-container task on a single-core instance type with 512 CPU units specified for\n\t\t\tthat container, and that is the only task running on the container instance, that\n\t\t\tcontainer could use the full 1,024 CPU unit share at any given time. However, if you\n\t\t\tlaunched another copy of the same task on that container instance, each task would be\n\t\t\tguaranteed a minimum of 512 CPU units when needed, and each container could float to\n\t\t\thigher CPU usage if the other container was not using it, but if both tasks were 100%\n\t\t\tactive all of the time, they would be limited to 512 CPU units.
\n\t\tOn Linux container instances, the Docker daemon on the container instance uses the CPU\n\t\t\tvalue to calculate the relative CPU share ratios for running containers. For more\n\t\t\tinformation, see CPU share\n\t\t\t\tconstraint in the Docker documentation. The minimum valid CPU share value\n\t\t\tthat the Linux kernel allows is 2. However, the CPU parameter is not required, and you\n\t\t\tcan use CPU values below 2 in your container definitions. For CPU values below 2\n\t\t\t(including null), the behavior varies based on your Amazon ECS container agent\n\t\t\tversion:
\n\t\t\n\t\t\t\t\t Agent versions less than or equal to 1.1.0:\n\t\t\t\t\tNull and zero CPU values are passed to Docker as 0, which Docker then converts\n\t\t\t\t\tto 1,024 CPU shares. CPU values of 1 are passed to Docker as 1, which the Linux\n\t\t\t\t\tkernel converts to two CPU shares.
\n\t\t\t\n\t\t\t\t\t Agent versions greater than or equal to 1.2.0:\n\t\t\t\t\tNull, zero, and CPU values of 1 are passed to Docker as 2.
\n\t\t\tOn Windows container instances, the CPU limit is enforced as an absolute limit, or a\n\t\t\tquota. Windows containers only have access to the specified amount of CPU that is\n\t\t\tdescribed in the task definition. A null or zero CPU value is passed to Docker as\n\t\t\t\t0
, which Windows interprets as 1% of one CPU.
Time duration (in seconds) to wait before the container is forcefully killed if it\n doesn't exit normally on its own.
\nFor tasks using the Fargate launch type, the task or service requires\n platform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the\n parameter is not specified, the default value of 30 seconds is used.
\nFor tasks using the EC2 launch type, if the stopTimeout
\n parameter is not specified, the value set for the Amazon ECS container agent configuration\n variable ECS_CONTAINER_STOP_TIMEOUT
is used by default. If neither the\n stopTimeout
parameter or the ECS_CONTAINER_STOP_TIMEOUT
\n agent configuration variable are set, then the default values of 30 seconds for Linux\n containers and 30 seconds on Windows containers are used. Your container instances\n require at least version 1.26.0 of the container agent to enable a container stop\n timeout value. However, we recommend using the latest container agent version. For\n information about checking your agent version and updating to the latest version, see\n Updating the Amazon ECS\n Container Agent in the Amazon Elastic Container Service Developer Guide. If you are\n using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n ecs-init
package. If your container instances are launched from version\n 20190301
or later, then they contain the required versions of the\n container agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
Time duration (in seconds) to wait before the container is forcefully killed if it\n\t\t\tdoesn't exit normally on its own.
\n\t\tFor tasks using the Fargate launch type, the task or service requires\n\t\t\tplatform version 1.3.0 or later. The max stop timeout value is 120 seconds and if the\n\t\t\tparameter is not specified, the default value of 30 seconds is used.
\n\t\tFor tasks using the EC2 launch type, if the stopTimeout
\n\t\t\tparameter is not specified, the value set for the Amazon ECS container agent configuration\n\t\t\tvariable ECS_CONTAINER_STOP_TIMEOUT
is used by default. If neither the\n\t\t\t\tstopTimeout
parameter or the ECS_CONTAINER_STOP_TIMEOUT
\n\t\t\tagent configuration variable are set, then the default values of 30 seconds for Linux\n\t\t\tcontainers and 30 seconds on Windows containers are used. Your container instances\n\t\t\trequire at least version 1.26.0 of the container agent to enable a container stop\n\t\t\ttimeout value. However, we recommend using the latest container agent version. For\n\t\t\tinformation about checking your agent version and updating to the latest version, see\n\t\t\t\tUpdating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you are\n\t\t\tusing an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init
package. If your container instances are launched from version\n\t\t\t\t20190301
or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The dependencies defined for container startup and shutdown. A container can contain\n multiple dependencies. When a dependency is defined for container startup, for container\n shutdown it is reversed.
\nFor tasks using the EC2 launch type, the container instances require at\n least version 1.26.0 of the container agent to enable container dependencies. However,\n we recommend using the latest container agent version. For information about checking\n your agent version and updating to the latest version, see Updating the Amazon ECS\n Container Agent in the Amazon Elastic Container Service Developer Guide. If you are\n using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n ecs-init
package. If your container instances are launched from version\n 20190301
or later, then they contain the required versions of the\n container agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires\n platform version 1.3.0
or later.
A key/value map of labels to add to the container. This parameter maps to\n\t\t\t\tLabels
in the Create a container section of the\n\t\t\tDocker Remote API and the --label
option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
\n
The mount points for data volumes in your container.
\nThis parameter maps to Volumes
in the Create a container\n section of the Docker Remote API and the --volume
option to docker run.
Windows containers can mount whole directories on the same drive as\n $env:ProgramData
. Windows containers cannot mount directories on a\n different drive, and mount point cannot be across drives.
If the essential
parameter of a container is marked as true
,\n\t\t\tand that container fails or stops for any reason, all other containers that are part of\n\t\t\tthe task are stopped. If the essential
parameter of a container is marked\n\t\t\tas false
, then its failure does not affect the rest of the containers in a\n\t\t\ttask. If this parameter is omitted, a container is assumed to be essential.
All tasks must have at least one essential container. If you have an application that\n\t\t\tis composed of multiple containers, you should group containers that are used for a\n\t\t\tcommon purpose into components, and separate the different components into multiple task\n\t\t\tdefinitions. For more information, see Application\n\t\t\t\tArchitecture in the Amazon Elastic Container Service Developer Guide.
" } }, - "entryPoint": { - "target": "com.amazonaws.ecs#StringList", + "linuxParameters": { + "target": "com.amazonaws.ecs#LinuxParameters", "traits": { - "smithy.api#documentation": "Early versions of the Amazon ECS container agent do not properly handle\n entryPoint
parameters. If you have problems using\n entryPoint
, update your container agent or enter your commands and\n arguments as command
array items instead.
The entry point that is passed to the container. This parameter maps to\n Entrypoint
in the Create a container section of the\n Docker Remote API and the --entrypoint
option to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#entrypoint.
Linux-specific modifications that are applied to the container, such as Linux kernel\n\t\t\tcapabilities. For more information see KernelCapabilities.
\n\t\tThis parameter is not supported for Windows containers.
\n\t\tA key/value map of labels to add to the container. This parameter maps to\n Labels
in the Create a container section of the\n Docker Remote API and the --label
option to docker run. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
\n
A list of DNS servers that are presented to the container. This parameter maps to\n\t\t\t\tDns
in the Create a container section of the\n\t\t\tDocker Remote API and the --dns
option to docker run.
This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
\nThe private repository authentication credentials to use.
" } }, - "portMappings": { - "target": "com.amazonaws.ecs#PortMappingList", + "systemControls": { + "target": "com.amazonaws.ecs#SystemControls", "traits": { - "smithy.api#documentation": "The list of port mappings for the container. Port mappings allow containers to access\n ports on the host container instance to send or receive traffic.
\nFor task definitions that use the awsvpc
network mode, you should only\n specify the containerPort
. The hostPort
can be left blank or\n it must be the same value as the containerPort
.
Port mappings on Windows use the NetNAT
gateway address rather than\n localhost
. There is no loopback for port mappings on Windows, so you\n cannot access a container's mapped port from the host itself.
This parameter maps to PortBindings
in the\n Create a container section of the Docker Remote API and the\n --publish
option to docker\n run. If the network mode of a task definition is set to none
,\n then you can't specify port mappings. If the network mode of a task definition is set to\n host
, then host ports must either be undefined or they must match the\n container port in the port mapping.
After a task reaches the RUNNING
status, manual and automatic host\n and container port assignments are visible in the Network\n Bindings section of a container description for a selected task in\n the Amazon ECS console. The assignments are also visible in the\n networkBindings
section DescribeTasks\n responses.
A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls
in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl
option to docker run.
It is not recommended that you specify network-related systemControls
\n\t\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\t\tawsvpc
or host
network modes. For tasks that use the\n\t\t\t\t\tawsvpc
network mode, the container that is started last determines\n\t\t\t\twhich systemControls
parameters take effect. For tasks that use the\n\t\t\t\t\thost
network mode, it changes the container instance's namespaced\n\t\t\t\tkernel parameters as well as the containers.
When this parameter is true
, this allows you to deploy containerized\n applications that require stdin
or a tty
to be allocated. This\n parameter maps to OpenStdin
in the Create a container\n section of the Docker Remote API and the --interactive
option to docker run.
The mount points for data volumes in your container.
\n\t\tThis parameter maps to Volumes
in the Create a container\n\t\t\tsection of the Docker Remote API and the --volume
option to docker run.
Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData
. Windows containers cannot mount directories on a\n\t\t\tdifferent drive, and mount point cannot be across drives.
Time duration (in seconds) to wait before giving up on resolving dependencies for a\n container. For example, you specify two containers in a task definition with containerA\n having a dependency on containerB reaching a COMPLETE
,\n SUCCESS
, or HEALTHY
status. If a startTimeout
\n value is specified for containerB and it does not reach the desired status within that\n time then containerA will give up and not start. This results in the task transitioning\n to a STOPPED
state.
For tasks using the Fargate launch type, this parameter requires that\n the task or service uses platform version 1.3.0 or later. If this parameter is not\n specified, the default value of 3 minutes is used.
\nFor tasks using the EC2 launch type, if the startTimeout
\n parameter is not specified, the value set for the Amazon ECS container agent configuration\n variable ECS_CONTAINER_START_TIMEOUT
is used by default. If neither the\n startTimeout
parameter or the ECS_CONTAINER_START_TIMEOUT
\n agent configuration variable are set, then the default values of 3 minutes for Linux\n containers and 8 minutes on Windows containers are used. Your container instances\n require at least version 1.26.0 of the container agent to enable a container start\n timeout value. However, we recommend using the latest container agent version. For\n information about checking your agent version and updating to the latest version, see\n Updating the Amazon ECS\n Container Agent in the Amazon Elastic Container Service Developer Guide. If you are\n using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n ecs-init
package. If your container instances are launched from version\n 20190301
or later, then they contain the required versions of the\n container agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The name of a container. If you are linking multiple containers together in a task\n\t\t\tdefinition, the name
of one container can be entered in the\n\t\t\t\tlinks
of another container to connect the containers.\n\t\t\tUp to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This parameter maps to name
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--name
option to docker\n\t\t\trun.
The hostname to use for your container. This parameter maps to Hostname
\n in the Create a container section of the Docker Remote API and the\n --hostname
option to docker\n run.
The hostname
parameter is not supported if you are using the\n awsvpc
network mode.
A list of strings to provide custom labels for SELinux and AppArmor multi-level\n\t\t\tsecurity systems. This field is not valid for containers in tasks using the\n\t\t\tFargate launch type.
\n\t\tWith Windows containers, this parameter can be used to reference a credential spec\n\t\t\tfile when configuring a container for Active Directory authentication. For more\n\t\t\tinformation, see Using gMSAs for Windows\n\t\t\t\tContainers in the Amazon Elastic Container Service Developer Guide.
\n\t\tThis parameter maps to SecurityOpt
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--security-opt
option to docker\n\t\t\t\trun.
The Amazon ECS container agent running on a container instance must register with the\n\t\t\t\t\tECS_SELINUX_CAPABLE=true
or ECS_APPARMOR_CAPABLE=true
\n\t\t\t\tenvironment variables before containers placed on that instance can use these\n\t\t\t\tsecurity options. For more information, see Amazon ECS Container\n\t\t\t\t\tAgent Configuration in the Amazon Elastic Container Service Developer Guide.
For more information about valid values, see Docker\n\t\t\t\tRun Security Configuration.
\n\t\tValid values: \"no-new-privileges\" | \"apparmor:PROFILE\" | \"label:value\" |\n\t\t\t\"credentialspec:CredentialSpecFilePath\"
" } }, - "logConfiguration": { - "target": "com.amazonaws.ecs#LogConfiguration", + "environmentFiles": { + "target": "com.amazonaws.ecs#EnvironmentFiles", "traits": { - "smithy.api#documentation": "The log configuration specification for the container.
\nThis parameter maps to LogConfig
in the\n Create a container section of the Docker Remote API and the\n --log-driver
option to docker\n run. By default, containers use the same logging driver that the Docker\n daemon uses. However the container may use a different logging driver than the Docker\n daemon by specifying a log driver with this parameter in the container definition. To\n use a different logging driver for a container, the log system must be configured\n properly on the container instance (or on a different log server for remote logging\n options). For more information on the options for different supported log drivers, see\n Configure\n logging drivers in the Docker documentation.
Amazon ECS currently supports a subset of the logging drivers available to the Docker\n daemon (shown in the LogConfiguration data type). Additional log\n drivers may be available in future releases of the Amazon ECS container agent.
\nThis parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
\n
The Amazon ECS container agent running on a container instance must register the\n logging drivers available on that instance with the\n ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before\n containers placed on that instance can use these log configuration options. For more\n information, see Amazon ECS Container\n Agent Configuration in the Amazon Elastic Container Service Developer Guide.
A list of files containing the environment variables to pass to a container. This\n\t\t\tparameter maps to the --env-file
option to docker run.
You can specify up to ten environment files. The file must have a .env
\n\t\t\tfile extension. Each line in an environment file should contain an environment variable\n\t\t\tin VARIABLE=VALUE
format. Lines beginning with #
are treated\n\t\t\tas comments and are ignored. For more information on the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.
If there are environment variables specified using the environment
\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they are processed from the top down. It is recommended to use unique\n\t\t\tvariable names. For more information, see Specifying Environment\n\t\t\t\tVariables in the Amazon Elastic Container Service Developer Guide.
This field is not valid for containers in tasks using the Fargate launch\n\t\t\ttype.
" } }, - "image": { + "environment": { + "target": "com.amazonaws.ecs#EnvironmentVariables", + "traits": { + "smithy.api#documentation": "The environment variables to pass to a container. This parameter maps to\n\t\t\t\tEnv
in the Create a container section of the\n\t\t\tDocker Remote API and the --env
option to docker run.
We do not recommend using plaintext environment variables for sensitive\n\t\t\t\tinformation, such as credential data.
\n\t\tWhen this parameter is true, the container is given read-only access to its root file\n\t\t\tsystem. This parameter maps to ReadonlyRootfs
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--read-only
option to docker\n\t\t\t\trun.
This parameter is not supported for Windows containers or tasks that use the awsvpc network mode.
\nThe image used to start a container. This string is passed directly to the Docker\n daemon. Images in the Docker Hub registry are available by default. Other repositories\n are specified with either \n repository-url/image:tag\n
or \n repository-url/image@digest\n
. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image
in the\n Create a container section of the Docker Remote API and the\n IMAGE
parameter of docker\n run.
When a new task starts, the Amazon ECS container agent pulls the latest version of\n the specified image and tag for the container to use. However, subsequent\n updates to a repository image are not propagated to already running\n tasks.
\nImages in Amazon ECR repositories can be specified by either using the full\n registry/repository:tag
or\n registry/repository@digest
. For example,\n 012345678910.dkr.ecr.
\n or\n 012345678910.dkr.ecr.
.\n
Images in official repositories on Docker Hub use a single name (for example,\n ubuntu
or mongo
).
Images in other repositories on Docker Hub are qualified with an organization\n name (for example, amazon/amazon-ecs-agent
).
Images in other online repositories are qualified further by a domain name\n (for example, quay.io/assemblyline/ubuntu
).
The working directory in which to run commands inside the container. This parameter\n\t\t\tmaps to WorkingDir
in the Create a container section of the\n\t\t\tDocker Remote API and the --workdir
option to docker run.
The FireLens configuration for the container. This is used to specify and configure a\n log router for container logs. For more information, see Custom Log Routing\n in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "When this parameter is true, the container is given elevated privileges on the host\n\t\t\tcontainer instance (similar to the root
user). This parameter maps to\n\t\t\t\tPrivileged
in the Create a container section of the\n\t\t\tDocker Remote API and the --privileged
option to docker run.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
\nThe command that is passed to the container. This parameter maps to Cmd
\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\tCOMMAND
parameter to docker\n\t\t\t\trun. For more information, see https://docs.docker.com/engine/reference/builder/#cmd. If there are multiple arguments, each\n\t\t\targument should be a separated string in the array.
The soft limit (in MiB) of memory to reserve for the container. When system memory is\n under heavy contention, Docker attempts to keep the container memory to this soft limit.\n However, your container can consume more memory when it needs to, up to either the hard\n limit specified with the memory
parameter (if applicable), or all of the\n available memory on the container instance, whichever comes first. This parameter maps\n to MemoryReservation
in the Create a container section of\n the Docker Remote API and the --memory-reservation
option to docker run.
If a task-level memory value is not specified, you must specify a non-zero integer for\n one or both of memory
or memoryReservation
in a container\n definition. If you specify both, memory
must be greater than\n memoryReservation
. If you specify memoryReservation
, then\n that value is subtracted from the available memory resources for the container instance\n on which the container is placed. Otherwise, the value of memory
is\n used.
For example, if your container normally uses 128 MiB of memory, but occasionally\n bursts to 256 MiB of memory for short periods of time, you can set a\n memoryReservation
of 128 MiB, and a memory
hard limit of\n 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory\n from the remaining resources on the container instance, but also allow the container to\n consume more memory resources when needed.
The Docker daemon reserves a minimum of 4 MiB of memory for a container, so you should\n not specify fewer than 4 MiB of memory for your containers.
" + "smithy.api#documentation": "The secrets to pass to the container. For more information, see Specifying\n\t\t\t\tSensitive Data in the Amazon Elastic Container Service Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "Container definitions are used in task definitions to describe the different\n containers that are launched as part of a task.
" + "smithy.api#documentation": "Container definitions are used in task definitions to describe the different\n\t\t\tcontainers that are launched as part of a task.
" } }, "com.amazonaws.ecs#ContainerDefinitions": { @@ -1266,7 +1266,7 @@ "condition": { "target": "com.amazonaws.ecs#ContainerCondition", "traits": { - "smithy.api#documentation": "The dependency condition of the container. The following are the available conditions\n and their behavior:
\n\n START
- This condition emulates the behavior of links and\n volumes today. It validates that a dependent container is started before\n permitting other containers to start.
\n COMPLETE
- This condition validates that a dependent\n container runs to completion (exits) before permitting other containers to\n start. This can be useful for nonessential containers that run a script and then\n exit.
\n SUCCESS
- This condition is the same as\n COMPLETE
, but it also requires that the container exits with a\n zero
status.
\n HEALTHY
- This condition validates that the dependent\n container passes its Docker health check before permitting other containers to\n start. This requires that the dependent container has health checks configured.\n This condition is confirmed only at task startup.
The dependency condition of the container. The following are the available conditions\n\t\t\tand their behavior:
\n\t\t\n START
- This condition emulates the behavior of links and\n\t\t\t\t\tvolumes today. It validates that a dependent container is started before\n\t\t\t\t\tpermitting other containers to start.
\n COMPLETE
- This condition validates that a dependent\n\t\t\t\t\tcontainer runs to completion (exits) before permitting other containers to\n\t\t\t\t\tstart. This can be useful for nonessential containers that run a script and then\n\t\t\t\t\texit. This condition cannot be set on an essential container.
\n SUCCESS
- This condition is the same as\n\t\t\t\t\t\tCOMPLETE
, but it also requires that the container exits with a\n\t\t\t\t\t\tzero
status. This condition cannot be set on an essential\n\t\t\t\t\tcontainer.
\n HEALTHY
- This condition validates that the dependent\n\t\t\t\t\tcontainer passes its Docker health check before permitting other containers to\n\t\t\t\t\tstart. This requires that the dependent container has health checks configured.\n\t\t\t\t\tThis condition is confirmed only at task startup.
The dependencies defined for container startup and shutdown. A container can contain\n multiple dependencies. When a dependency is defined for container startup, for container\n shutdown it is reversed.
\nYour Amazon ECS container instances require at least version 1.26.0 of the container agent\n to enable container dependencies. However, we recommend using the latest container agent\n version. For information about checking your agent version and updating to the latest\n version, see Updating the Amazon ECS\n Container Agent in the Amazon Elastic Container Service Developer Guide. If you are\n using an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n ecs-init
package. If your container instances are launched from version\n 20190301
or later, then they contain the required versions of the\n container agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, this parameter requires\n that the task or service uses platform version 1.3.0 or later.
\nThe dependencies defined for container startup and shutdown. A container can contain\n\t\t\tmultiple dependencies. When a dependency is defined for container startup, for container\n\t\t\tshutdown it is reversed.
\n\t\tYour Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tto enable container dependencies. However, we recommend using the latest container agent\n\t\t\tversion. For information about checking your agent version and updating to the latest\n\t\t\tversion, see Updating the Amazon ECS\n\t\t\t\tContainer Agent in the Amazon Elastic Container Service Developer Guide. If you are\n\t\t\tusing an Amazon ECS-optimized Linux AMI, your instance needs at least version 1.26.0-1 of the\n\t\t\t\tecs-init
package. If your container instances are launched from version\n\t\t\t\t20190301
or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, this parameter requires\n\t\t\t\tthat the task or service uses platform version 1.3.0 or later.
\n\t\tThe status of the container instance. The valid values are REGISTERING
,\n REGISTRATION_FAILED
, ACTIVE
, INACTIVE
,\n DEREGISTERING
, or DRAINING
.
If your account has opted in to the awsvpcTrunking
account setting, then\n any newly registered container instance will transition to a REGISTERING
\n status while the trunk elastic network interface is provisioned for the instance. If the\n registration fails, the instance will transition to a REGISTRATION_FAILED
\n status. You can describe the container instance and see the reason for failure in the\n statusReason
parameter. Once the container instance is terminated, the\n instance transitions to a DEREGISTERING
status while the trunk elastic\n network interface is deprovisioned. The instance then transitions to an\n INACTIVE
status.
The ACTIVE
status indicates that the container instance can accept tasks.\n The DRAINING
indicates that new tasks are not placed on the container\n instance and any service tasks running on the container instance are removed if\n possible. For more information, see Container Instance Draining in the\n Amazon Elastic Container Service Developer Guide.
For CPU and memory resource types, this parameter describes the amount of each\n\t\t\tresource that was available on the container instance when the container agent\n\t\t\tregistered it with Amazon ECS. This value represents the total amount of CPU and memory that\n\t\t\tcan be allocated on this container instance to tasks. For port resource types, this\n\t\t\tparameter describes the ports that were reserved by the Amazon ECS container agent when it\n\t\t\tregistered the container instance with Amazon ECS.
" } }, "remainingResources": { "target": "com.amazonaws.ecs#Resources", "traits": { - "smithy.api#documentation": "For CPU and memory resource types, this parameter describes the remaining CPU and\n memory that has not already been allocated to tasks and is therefore available for new\n tasks. For port resource types, this parameter describes the ports that were reserved by\n the Amazon ECS container agent (at instance registration time) and any task containers that\n have reserved port mappings on the host (with the host
or\n bridge
network mode). Any port that is not specified here is available\n for new tasks.
For CPU and memory resource types, this parameter describes the remaining CPU and\n\t\t\tmemory that has not already been allocated to tasks and is therefore available for new\n\t\t\ttasks. For port resource types, this parameter describes the ports that were reserved by\n\t\t\tthe Amazon ECS container agent (at instance registration time) and any task containers that\n\t\t\thave reserved port mappings on the host (with the host
or\n\t\t\t\tbridge
network mode). Any port that is not specified here is available\n\t\t\tfor new tasks.
The metadata that you apply to the container instance to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value, both of which you\n\t\t\tdefine.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The capacity provider associated with the container instance.
" + "smithy.api#documentation": "The status of the container instance. The valid values are REGISTERING
,\n\t\t\t\tREGISTRATION_FAILED
, ACTIVE
, INACTIVE
,\n\t\t\t\tDEREGISTERING
, or DRAINING
.
If your account has opted in to the awsvpcTrunking
account setting, then\n\t\t\tany newly registered container instance will transition to a REGISTERING
\n\t\t\tstatus while the trunk elastic network interface is provisioned for the instance. If the\n\t\t\tregistration fails, the instance will transition to a REGISTRATION_FAILED
\n\t\t\tstatus. You can describe the container instance and see the reason for failure in the\n\t\t\t\tstatusReason
parameter. Once the container instance is terminated, the\n\t\t\tinstance transitions to a DEREGISTERING
status while the trunk elastic\n\t\t\tnetwork interface is deprovisioned. The instance then transitions to an\n\t\t\t\tINACTIVE
status.
The ACTIVE
status indicates that the container instance can accept tasks.\n\t\t\tThe DRAINING
indicates that new tasks are not placed on the container\n\t\t\tinstance and any service tasks running on the container instance are removed if\n\t\t\tpossible. For more information, see Container Instance Draining in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
The version counter for the container instance. Every time a container instance\n experiences a change that triggers a CloudWatch event, the version counter is\n incremented. If you are replicating your Amazon ECS container instance state with CloudWatch\n Events, you can compare the version of a container instance reported by the Amazon ECS APIs\n with the version reported in CloudWatch Events for the container instance (inside the\n detail
object) to verify that the version in your event stream is\n current.
The EC2 instance ID of the container instance.
" } }, - "containerInstanceArn": { + "capacityProviderName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance
namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
The capacity provider associated with the container instance.
" } }, - "attachments": { - "target": "com.amazonaws.ecs#Attachments", + "version": { + "target": "com.amazonaws.ecs#Long", "traits": { - "smithy.api#documentation": "The resources attached to a container instance, such as elastic network\n interfaces.
" + "smithy.api#documentation": "The version counter for the container instance. Every time a container instance\n\t\t\texperiences a change that triggers a CloudWatch event, the version counter is\n\t\t\tincremented. If you are replicating your Amazon ECS container instance state with CloudWatch\n\t\t\tEvents, you can compare the version of a container instance reported by the Amazon ECS APIs\n\t\t\twith the version reported in CloudWatch Events for the container instance (inside the\n\t\t\t\tdetail
object) to verify that the version in your event stream is\n\t\t\tcurrent.
The status of the most recent agent update. If an update has never been requested,\n this value is NULL
.
The Amazon Resource Name (ARN) of the container instance. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance
namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
The number of tasks on the container instance that are in the PENDING
\n status.
The EC2 instance ID of the container instance.
" + "smithy.api#documentation": "The number of tasks on the container instance that are in the PENDING
\n\t\t\tstatus.
The number of tasks on the container instance that are in the RUNNING
\n status.
The status of the most recent agent update. If an update has never been requested,\n\t\t\tthis value is NULL
.
For CPU and memory resource types, this parameter describes the amount of each\n resource that was available on the container instance when the container agent\n registered it with Amazon ECS. This value represents the total amount of CPU and memory that\n can be allocated on this container instance to tasks. For port resource types, this\n parameter describes the ports that were reserved by the Amazon ECS container agent when it\n registered the container instance with Amazon ECS.
" + "smithy.api#documentation": "The resources attached to a container instance, such as elastic network\n\t\t\tinterfaces.
" } }, "attributes": { "target": "com.amazonaws.ecs#Attributes", "traits": { - "smithy.api#documentation": "The attributes set for the container instance, either by the Amazon ECS container agent at\n instance registration or manually with the PutAttributes\n operation.
" + "smithy.api#documentation": "The attributes set for the container instance, either by the Amazon ECS container agent at\n\t\t\tinstance registration or manually with the PutAttributes\n\t\t\toperation.
" } }, - "agentConnected": { - "target": "com.amazonaws.ecs#Boolean", + "runningTasksCount": { + "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "This parameter returns true
if the agent is connected to Amazon ECS.\n Registered instances with an agent that may be unhealthy or stopped return\n false
. Only instances connected to an agent can accept placement\n requests.
The number of tasks on the container instance that are in the RUNNING
\n\t\t\tstatus.
The reason that the container instance reached its current status.
" } }, + "registeredAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for when the container instance was registered.
" + } + }, "versionInfo": { "target": "com.amazonaws.ecs#VersionInfo", "traits": { - "smithy.api#documentation": "The version information for the Amazon ECS container agent and Docker daemon running on the\n container instance.
" + "smithy.api#documentation": "The version information for the Amazon ECS container agent and Docker daemon running on the\n\t\t\tcontainer instance.
" } }, - "registeredAt": { - "target": "com.amazonaws.ecs#Timestamp", + "agentConnected": { + "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "The Unix timestamp for when the container instance was registered.
" + "smithy.api#documentation": "This parameter returns true
if the agent is connected to Amazon ECS.\n\t\t\tRegistered instances with an agent that may be unhealthy or stopped return\n\t\t\t\tfalse
. Only instances connected to an agent can accept placement\n\t\t\trequests.
An EC2 instance that is running the Amazon ECS agent and has been registered with a\n cluster.
" + "smithy.api#documentation": "An EC2 instance that is running the Amazon ECS agent and has been registered with a\n\t\t\tcluster.
" } }, "com.amazonaws.ecs#ContainerInstanceField": { @@ -1448,54 +1448,54 @@ "cpu": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The number of cpu
units reserved for the container, instead of the\n default value from the task definition. You must also specify a container name.
The name of the container that receives the override. This parameter is required if\n any override is specified.
" + "smithy.api#documentation": "The number of cpu
units reserved for the container, instead of the\n\t\t\tdefault value from the task definition. You must also specify a container name.
The command to send to the container that overrides the default command from the\n Docker image or the task definition. You must also specify a container name.
" + "smithy.api#documentation": "The command to send to the container that overrides the default command from the\n\t\t\tDocker image or the task definition. You must also specify a container name.
" } }, "memoryReservation": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The soft limit (in MiB) of memory to reserve for the container, instead of the default\n value from the task definition. You must also specify a container name.
" + "smithy.api#documentation": "The soft limit (in MiB) of memory to reserve for the container, instead of the default\n\t\t\tvalue from the task definition. You must also specify a container name.
" } }, "resourceRequirements": { "target": "com.amazonaws.ecs#ResourceRequirements", "traits": { - "smithy.api#documentation": "The type and amount of a resource to assign to a container, instead of the default\n value from the task definition. The only supported resource is a GPU.
" + "smithy.api#documentation": "The type and amount of a resource to assign to a container, instead of the default\n\t\t\tvalue from the task definition. The only supported resource is a GPU.
" } }, - "memory": { - "target": "com.amazonaws.ecs#BoxedInteger", + "name": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The hard limit (in MiB) of memory to present to the container, instead of the default\n value from the task definition. If your container attempts to exceed the memory\n specified here, the container is killed. You must also specify a container name.
" + "smithy.api#documentation": "The name of the container that receives the override. This parameter is required if\n\t\t\tany override is specified.
" } }, "environmentFiles": { "target": "com.amazonaws.ecs#EnvironmentFiles", "traits": { - "smithy.api#documentation": "A list of files containing the environment variables to pass to a container, instead\n of the value from the container definition.
" + "smithy.api#documentation": "A list of files containing the environment variables to pass to a container, instead\n\t\t\tof the value from the container definition.
" + } + }, + "memory": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The hard limit (in MiB) of memory to present to the container, instead of the default\n\t\t\tvalue from the task definition. If your container attempts to exceed the memory\n\t\t\tspecified here, the container is killed. You must also specify a container name.
" } }, "environment": { "target": "com.amazonaws.ecs#EnvironmentVariables", "traits": { - "smithy.api#documentation": "The environment variables to send to the container. You can add new environment\n variables, which are added to the container at launch, or you can override the existing\n environment variables from the Docker image or the task definition. You must also\n specify a container name.
" + "smithy.api#documentation": "The environment variables to send to the container. You can add new environment\n\t\t\tvariables, which are added to the container at launch, or you can override the existing\n\t\t\tenvironment variables from the Docker image or the task definition. You must also\n\t\t\tspecify a container name.
" } } }, "traits": { - "smithy.api#documentation": "The overrides that should be sent to a container. An empty container override can be\n passed in. An example of an empty container override would be\n {\"containerOverrides\": [ ] }
. If a non-empty container override is\n specified, the name
parameter must be included.
The overrides that should be sent to a container. An empty container override can be\n\t\t\tpassed in. An example of an empty container override would be\n\t\t\t\t{\"containerOverrides\": [ ] }
. If a non-empty container override is\n\t\t\tspecified, the name
parameter must be included.
The container image SHA 256 digest.
" + "smithy.api#documentation": "The exit code for the container, if the state change is a result of the container\n\t\t\texiting.
" } }, - "reason": { + "runtimeId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The reason for the state change.
" - } - }, - "exitCode": { - "target": "com.amazonaws.ecs#BoxedInteger", - "traits": { - "smithy.api#documentation": "The exit code for the container, if the state change is a result of the container\n exiting.
" + "smithy.api#documentation": "The ID of the Docker container.
" } }, "status": { @@ -1531,10 +1525,10 @@ "smithy.api#documentation": "The status of the container.
" } }, - "runtimeId": { + "imageDigest": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The ID of the Docker container.
" + "smithy.api#documentation": "The container image SHA 256 digest.
" } }, "networkBindings": { @@ -1543,6 +1537,12 @@ "smithy.api#documentation": "Any network bindings associated with the container.
" } }, + "reason": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The reason for the state change.
" + } + }, "containerName": { "target": "com.amazonaws.ecs#String", "traits": { @@ -1592,30 +1592,30 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new capacity provider. Capacity providers are associated with an Amazon ECS\n cluster and are used in capacity provider strategies to facilitate cluster auto\n scaling.
\nOnly capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on\n AWS Fargate use the FARGATE
and FARGATE_SPOT
capacity providers\n which are already created and available to all accounts in Regions supported by\n AWS Fargate.
Creates a new capacity provider. Capacity providers are associated with an Amazon ECS\n\t\t\tcluster and are used in capacity provider strategies to facilitate cluster auto\n\t\t\tscaling.
\n\t\tOnly capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on\n\t\t\tAWS Fargate use the FARGATE
and FARGATE_SPOT
capacity providers\n\t\t\twhich are already created and available to all accounts in Regions supported by\n\t\t\tAWS Fargate.
The metadata that you apply to the capacity provider to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The details of the Auto Scaling group for the capacity provider.
", + "smithy.api#required": {} } }, "name": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of the capacity provider. Up to 255 characters are allowed, including letters\n (upper and lowercase), numbers, underscores, and hyphens. The name cannot be prefixed\n with \"aws
\", \"ecs
\", or \"fargate
\".
The name of the capacity provider. Up to 255 characters are allowed, including letters\n\t\t\t(upper and lowercase), numbers, underscores, and hyphens. The name cannot be prefixed\n\t\t\twith \"aws
\", \"ecs
\", or \"fargate
\".
The details of the Auto Scaling group for the capacity provider.
", - "smithy.api#required": {} + "smithy.api#documentation": "The metadata that you apply to the capacity provider to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value, both of which you\n\t\t\tdefine.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Creates a new Amazon ECS cluster. By default, your account receives a default
\n cluster when you launch your first container instance. However, you can create your own\n cluster with a unique name with the CreateCluster
action.
When you call the CreateCluster API operation, Amazon ECS attempts to\n create the Amazon ECS service-linked role for your account so that required resources in\n other AWS services can be managed on your behalf. However, if the IAM user that\n makes the call does not have permissions to create the service-linked role, it is\n not created. For more information, see Using\n Service-Linked Roles for Amazon ECS in the\n Amazon Elastic Container Service Developer Guide.
\nCreates a new Amazon ECS cluster. By default, your account receives a default
\n\t\t\tcluster when you launch your first container instance. However, you can create your own\n\t\t\tcluster with a unique name with the CreateCluster
action.
When you call the CreateCluster API operation, Amazon ECS attempts to\n\t\t\t\tcreate the Amazon ECS service-linked role for your account so that required resources in\n\t\t\t\tother AWS services can be managed on your behalf. However, if the IAM user that\n\t\t\t\tmakes the call does not have permissions to create the service-linked role, it is\n\t\t\t\tnot created. For more information, see Using\n\t\t\t\t\tService-Linked Roles for Amazon ECS in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n\t\tThe capacity provider strategy to use by default for the cluster.
\nWhen creating a service or running a task on a cluster, if no capacity provider or\n launch type is specified then the default capacity provider strategy for the cluster is\n used.
\nA capacity provider strategy consists of one or more capacity providers along with the\n base
and weight
to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE
or\n UPDATING
status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.
If a default capacity provider strategy is not defined for a cluster during creation,\n it can be defined later with the PutClusterCapacityProviders API\n operation.
" + "smithy.api#documentation": "The name of your cluster. If you do not specify a name for your cluster, you create a\n\t\t\tcluster named default
. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
The name of your cluster. If you do not specify a name for your cluster, you create a\n cluster named default
. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
The metadata that you apply to the cluster to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The short name of one or more capacity providers to associate\n with the cluster.
\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created and not already associated with another cluster. New\n capacity providers can be created with the CreateCapacityProvider API\n operation.
\nTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.
The PutClusterCapacityProviders API operation is used to update the\n list of available capacity providers for a cluster after the cluster is created.
" + "smithy.api#documentation": "The capacity provider strategy to use by default for the cluster.
\n\t\tWhen creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified then the default capacity provider strategy for the cluster is\n\t\t\tused.
\n\t\tA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase
and weight
to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE
or\n\t\t\t\tUPDATING
status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\n\t\tTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n\t\t\t\tFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
If a default capacity provider strategy is not defined for a cluster during creation,\n\t\t\tit can be defined later with the PutClusterCapacityProviders API\n\t\t\toperation.
" } }, "settings": { "target": "com.amazonaws.ecs#ClusterSettings", "traits": { - "smithy.api#documentation": "The setting to use when creating a cluster. This parameter is used to enable CloudWatch\n Container Insights for a cluster. If this value is specified, it will override the\n containerInsights
value set with PutAccountSetting or\n PutAccountSettingDefault.
The setting to use when creating a cluster. This parameter is used to enable CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it will override the\n\t\t\t\tcontainerInsights
value set with PutAccountSetting or\n\t\t\t\tPutAccountSettingDefault.
The metadata that you apply to the cluster to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The short name of one or more capacity providers to associate\n\t\t\twith the cluster.
\n\t\tIf specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created and not already associated with another cluster. New\n\t\t\tcapacity providers can be created with the CreateCapacityProvider API\n\t\t\toperation.
\n\t\tTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n\t\t\t\tFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.
" } } } @@ -1735,137 +1735,137 @@ } ], "traits": { - "smithy.api#documentation": "Runs and maintains a desired number of tasks from a specified task definition. If the\n number of tasks running in a service drops below the desiredCount
, Amazon ECS\n runs another copy of the task in the specified cluster. To update an existing service,\n see the UpdateService action.
In addition to maintaining the desired count of tasks in your service, you can\n optionally run your service behind one or more load balancers. The load balancers\n distribute traffic across the tasks that are associated with the service. For more\n information, see Service Load Balancing in the\n Amazon Elastic Container Service Developer Guide.
\nTasks for services that do not use a load balancer are considered\n healthy if they're in the RUNNING
state. Tasks for services that\n do use a load balancer are considered healthy if they're in the\n RUNNING
state and the container instance that they're hosted on is\n reported as healthy by the load balancer.
There are two service scheduler strategies available:
\n\n REPLICA
- The replica scheduling strategy places and\n maintains the desired number of tasks across your cluster. By default, the\n service scheduler spreads tasks across Availability Zones. You can use task\n placement strategies and constraints to customize task placement decisions. For\n more information, see Service Scheduler Concepts in the\n Amazon Elastic Container Service Developer Guide.
\n DAEMON
- The daemon scheduling strategy deploys exactly one\n task on each active container instance that meets all of the task placement\n constraints that you specify in your cluster. The service scheduler also\n evaluates the task placement constraints for running tasks and will stop tasks\n that do not meet the placement constraints. When using this strategy, you don't\n need to specify a desired number of tasks, a task placement strategy, or use\n Service Auto Scaling policies. For more information, see Service Scheduler Concepts in the\n Amazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment\n is triggered by changing properties, such as the task definition or the desired count of\n a service, with an UpdateService operation. The default value for a\n replica service for minimumHealthyPercent
is 100%. The default value for a\n daemon service for minimumHealthyPercent
is 0%.
If a service is using the ECS
deployment controller, the minimum healthy\n percent represents a lower limit on the number of tasks in a service that must remain in\n the RUNNING
state during a deployment, as a percentage of the desired\n number of tasks (rounded up to the nearest integer), and while any container instances\n are in the DRAINING
state if the service contains tasks using the\n EC2 launch type. This parameter enables you to deploy without using\n additional cluster capacity. For example, if your service has a desired number of four\n tasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks\n to free up cluster capacity before starting two new tasks. Tasks for services that\n do not use a load balancer are considered healthy if they're in\n the RUNNING
state. Tasks for services that do use a\n load balancer are considered healthy if they're in the RUNNING
state and\n they're reported as healthy by the load balancer. The default value for minimum healthy\n percent is 100%.
If a service is using the ECS
deployment controller, the maximum percent parameter represents an upper limit on the\n number of tasks in a service that are allowed in the RUNNING
or\n PENDING
state during a deployment, as a percentage of the desired\n number of tasks (rounded down to the nearest integer), and while any container instances\n are in the DRAINING
state if the service contains tasks using the\n EC2 launch type. This parameter enables you to define the deployment batch\n size. For example, if your service has a desired number of four tasks and a maximum\n percent value of 200%, the scheduler may start four new tasks before stopping the four\n older tasks (provided that the cluster resources required to do this are available). The\n default value for maximum percent is 200%.
If a service is using either the CODE_DEPLOY
or EXTERNAL
\n deployment controller types and tasks that use the EC2 launch type, the\n minimum healthy percent and maximum percent values are used only to define the lower and upper limit\n on the number of the tasks in the service that remain in the RUNNING
state\n while the container instances are in the DRAINING
state. If the tasks in\n the service use the Fargate launch type, the minimum healthy percent and\n maximum percent values aren't used, although they're currently visible when describing\n your service.
When creating a service that uses the EXTERNAL
deployment controller, you\n can specify only parameters that aren't controlled at the task set level. The only\n required parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement in your\n cluster using the following logic:
\nDetermine which of the container instances in your cluster can support your\n service's task definition (for example, they have the required CPU, memory,\n ports, and container instance attributes).
\nBy default, the service scheduler attempts to balance tasks across\n Availability Zones in this manner (although you can choose a different placement\n strategy) with the placementStrategy
parameter):
Sort the valid container instances, giving priority to instances that\n have the fewest number of running tasks for this service in their\n respective Availability Zone. For example, if zone A has one running\n service task and zones B and C each have zero, valid container instances\n in either zone B or C are considered optimal for placement.
\nPlace the new service task on a valid container instance in an optimal\n Availability Zone (based on the previous steps), favoring container\n instances with the fewest number of running tasks for this\n service.
\nRuns and maintains a desired number of tasks from a specified task definition. If the\n\t\t\tnumber of tasks running in a service drops below the desiredCount
, Amazon ECS\n\t\t\truns another copy of the task in the specified cluster. To update an existing service,\n\t\t\tsee the UpdateService action.
In addition to maintaining the desired count of tasks in your service, you can\n\t\t\toptionally run your service behind one or more load balancers. The load balancers\n\t\t\tdistribute traffic across the tasks that are associated with the service. For more\n\t\t\tinformation, see Service Load Balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n\t\tTasks for services that do not use a load balancer are considered\n\t\t\thealthy if they're in the RUNNING
state. Tasks for services that\n\t\t\t\tdo use a load balancer are considered healthy if they're in the\n\t\t\t\tRUNNING
state and the container instance that they're hosted on is\n\t\t\treported as healthy by the load balancer.
There are two service scheduler strategies available:
\n\t\t\n REPLICA
- The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. For\n\t\t\t\t\tmore information, see Service Scheduler Concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n DAEMON
- The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks and will stop tasks\n\t\t\t\t\tthat do not meet the placement constraints. When using this strategy, you don't\n\t\t\t\t\tneed to specify a desired number of tasks, a task placement strategy, or use\n\t\t\t\t\tService Auto Scaling policies. For more information, see Service Scheduler Concepts in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
You can optionally specify a deployment configuration for your service. The deployment\n\t\t\tis triggered by changing properties, such as the task definition or the desired count of\n\t\t\ta service, with an UpdateService operation. The default value for a\n\t\t\treplica service for minimumHealthyPercent
is 100%. The default value for a\n\t\t\tdaemon service for minimumHealthyPercent
is 0%.
If a service is using the ECS
deployment controller, the minimum healthy\n\t\t\tpercent represents a lower limit on the number of tasks in a service that must remain in\n\t\t\tthe RUNNING
state during a deployment, as a percentage of the desired\n\t\t\tnumber of tasks (rounded up to the nearest integer), and while any container instances\n\t\t\tare in the DRAINING
state if the service contains tasks using the\n\t\t\tEC2 launch type. This parameter enables you to deploy without using\n\t\t\tadditional cluster capacity. For example, if your service has a desired number of four\n\t\t\ttasks and a minimum healthy percent of 50%, the scheduler might stop two existing tasks\n\t\t\tto free up cluster capacity before starting two new tasks. Tasks for services that\n\t\t\t\tdo not use a load balancer are considered healthy if they're in\n\t\t\tthe RUNNING
state. Tasks for services that do use a\n\t\t\tload balancer are considered healthy if they're in the RUNNING
state and\n\t\t\tthey're reported as healthy by the load balancer. The default value for minimum healthy\n\t\t\tpercent is 100%.
If a service is using the ECS
deployment controller, the maximum percent parameter represents an upper limit on the\n\t\t\tnumber of tasks in a service that are allowed in the RUNNING
or\n\t\t\t\tPENDING
state during a deployment, as a percentage of the desired\n\t\t\tnumber of tasks (rounded down to the nearest integer), and while any container instances\n\t\t\tare in the DRAINING
state if the service contains tasks using the\n\t\t\tEC2 launch type. This parameter enables you to define the deployment batch\n\t\t\tsize. For example, if your service has a desired number of four tasks and a maximum\n\t\t\tpercent value of 200%, the scheduler may start four new tasks before stopping the four\n\t\t\tolder tasks (provided that the cluster resources required to do this are available). The\n\t\t\tdefault value for maximum percent is 200%.
If a service is using either the CODE_DEPLOY
or EXTERNAL
\n\t\t\tdeployment controller types and tasks that use the EC2 launch type, the\n\t\t\t\tminimum healthy percent and maximum percent values are used only to define the lower and upper limit\n\t\t\ton the number of the tasks in the service that remain in the RUNNING
state\n\t\t\twhile the container instances are in the DRAINING
state. If the tasks in\n\t\t\tthe service use the Fargate launch type, the minimum healthy percent and\n\t\t\tmaximum percent values aren't used, although they're currently visible when describing\n\t\t\tyour service.
When creating a service that uses the EXTERNAL
deployment controller, you\n\t\t\tcan specify only parameters that aren't controlled at the task set level. The only\n\t\t\trequired parameter is the service name. You control your services using the CreateTaskSet operation. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster using the following logic:
\n\t\tDetermine which of the container instances in your cluster can support your\n\t\t\t\t\tservice's task definition (for example, they have the required CPU, memory,\n\t\t\t\t\tports, and container instance attributes).
\n\t\t\tBy default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner (although you can choose a different placement\n\t\t\t\t\tstrategy) with the placementStrategy
parameter):
Sort the valid container instances, giving priority to instances that\n\t\t\t\t\t\t\thave the fewest number of running tasks for this service in their\n\t\t\t\t\t\t\trespective Availability Zone. For example, if zone A has one running\n\t\t\t\t\t\t\tservice task and zones B and C each have zero, valid container instances\n\t\t\t\t\t\t\tin either zone B or C are considered optimal for placement.
\n\t\t\t\t\tPlace the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone (based on the previous steps), favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.
\n\t\t\t\t\tThe network configuration for the service. This parameter is required for task\n definitions that use the awsvpc
network mode to receive their own elastic\n network interface, and it is not supported for other network modes. For more\n information, see Task Networking\n in the Amazon Elastic Container Service Developer Guide.
A load balancer object representing the load balancers to use with your service. For\n\t\t\tmore information, see Service Load Balancing in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n\t\tIf the service is using the rolling update (ECS
) deployment controller\n\t\t\tand using either an Application Load Balancer or Network Load Balancer, you must specify one or more target group ARNs to\n\t\t\tattach to the service. The service-linked role is required for services that make use of\n\t\t\tmultiple target groups. For more information, see Using Service-Linked Roles for Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
If the service is using the CODE_DEPLOY
deployment controller, the\n\t\t\tservice is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment\n\t\t\tgroup, you specify two target groups (referred to as a targetGroupPair
).\n\t\t\tDuring a deployment, AWS CodeDeploy determines which task set in your service has the status\n\t\t\t\tPRIMARY
and associates one target group with it, and then associates\n\t\t\tthe other target group with the replacement task set. The load balancer can also have up\n\t\t\tto two listeners: a required listener for production traffic and an optional listener\n\t\t\tthat allows you perform validation tests with Lambda functions before routing production\n\t\t\ttraffic to it.
After you create a service using the ECS
deployment controller, the load\n\t\t\tbalancer name or target group ARN, container name, and container port specified in the\n\t\t\tservice definition are immutable. If you are using the CODE_DEPLOY
\n\t\t\tdeployment controller, these values can be changed when updating the service.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,\n\t\t\tthe container name (as it appears in a container definition), and the container port to\n\t\t\taccess from the load balancer. The load balancer name parameter must be omitted. When a\n\t\t\ttask from this service is placed on a container instance, the container instance and\n\t\t\tport combination is registered as a target in the target group specified here.
\n\t\tFor Classic Load Balancers, this object must contain the load balancer name, the container name (as it\n\t\t\tappears in a container definition), and the container port to access from the load\n\t\t\tbalancer. The target group ARN parameter must be omitted. When a task from this service\n\t\t\tis placed on a container instance, the container instance is registered with the load\n\t\t\tbalancer specified here.
\n\t\tServices with tasks that use the awsvpc
network mode (for example, those\n\t\t\twith the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are\n\t\t\tnot supported. Also, when you create any target groups for these services, you must\n\t\t\tchoose ip
as the target type, not instance
, because tasks that\n\t\t\tuse the awsvpc
network mode are associated with an elastic network\n\t\t\tinterface, not an Amazon EC2 instance.
The deployment controller to use for the service.
" + "smithy.api#documentation": "The details of the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.
\n\t\tService discovery is supported for Fargate tasks if you are using\n\t\t\t\tplatform version v1.1.0 or later. For more information, see AWS Fargate Platform\n\t\t\t\t\tVersions.
\n\t\tThe details of the service discovery registries to assign to this service. For more\n information, see Service\n Discovery.
\nService discovery is supported for Fargate tasks if you are using\n platform version v1.1.0 or later. For more information, see AWS Fargate Platform\n Versions.
\nThe deployment controller to use for the service.
" } }, - "cluster": { - "target": "com.amazonaws.ecs#String", + "propagateTags": { + "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service.\n If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "Specifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttasks in the service. If no value is specified, the tags are not propagated. Tags can\n\t\t\tonly be propagated to the tasks within the service during service creation. To add tags\n\t\t\tto a task after service creation, use the TagResource API\n\t\t\taction.
" } }, "schedulingStrategy": { "target": "com.amazonaws.ecs#SchedulingStrategy", "traits": { - "smithy.api#documentation": "The scheduling strategy to use for the service. For more information, see Services.
\nThere are two service scheduler strategies available:
\n\n REPLICA
-The replica scheduling strategy places and\n maintains the desired number of tasks across your cluster. By default, the\n service scheduler spreads tasks across Availability Zones. You can use task\n placement strategies and constraints to customize task placement decisions. This\n scheduler strategy is required if the service is using the\n CODE_DEPLOY
or EXTERNAL
deployment controller\n types.
\n DAEMON
-The daemon scheduling strategy deploys exactly one\n task on each active container instance that meets all of the task placement\n constraints that you specify in your cluster. The service scheduler also\n evaluates the task placement constraints for running tasks and will stop tasks\n that do not meet the placement constraints. When you're using this strategy, you\n don't need to specify a desired number of tasks, a task placement strategy, or\n use Service Auto Scaling policies.
Tasks using the Fargate launch type or the\n CODE_DEPLOY
or EXTERNAL
deployment controller\n types don't support the DAEMON
scheduling strategy.
The scheduling strategy to use for the service. For more information, see Services.
\n\t\tThere are two service scheduler strategies available:
\n\t\t\n REPLICA
-The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement decisions. This\n\t\t\t\t\tscheduler strategy is required if the service is using the\n\t\t\t\t\t\tCODE_DEPLOY
or EXTERNAL
deployment controller\n\t\t\t\t\ttypes.
\n DAEMON
-The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks and will stop tasks\n\t\t\t\t\tthat do not meet the placement constraints. When you're using this strategy, you\n\t\t\t\t\tdon't need to specify a desired number of tasks, a task placement strategy, or\n\t\t\t\t\tuse Service Auto Scaling policies.
Tasks using the Fargate launch type or the\n\t\t\t\t\t\t\tCODE_DEPLOY
or EXTERNAL
deployment controller\n\t\t\t\t\t\ttypes don't support the DAEMON
scheduling strategy.
Specifies whether to propagate the tags from the task definition or the service to the\n tasks in the service. If no value is specified, the tags are not propagated. Tags can\n only be propagated to the tasks within the service during service creation. To add tags\n to a task after service creation, use the TagResource API\n action.
" + "smithy.api#documentation": "The network configuration for the service. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc
network mode to receive their own elastic\n\t\t\tnetwork interface, and it is not supported for other network modes. For more\n\t\t\tinformation, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
A load balancer object representing the load balancers to use with your service. For\n more information, see Service Load Balancing in the\n Amazon Elastic Container Service Developer Guide.
\nIf the service is using the rolling update (ECS
) deployment controller\n and using either an Application Load Balancer or Network Load Balancer, you can specify multiple target groups to attach to\n the service. The service-linked role is required for services that make use of multiple\n target groups. For more information, see Using Service-Linked Roles for Amazon ECS in the\n Amazon Elastic Container Service Developer Guide.
If the service is using the CODE_DEPLOY
deployment controller, the\n service is required to use either an Application Load Balancer or Network Load Balancer. When creating an AWS CodeDeploy deployment\n group, you specify two target groups (referred to as a targetGroupPair
).\n During a deployment, AWS CodeDeploy determines which task set in your service has the status\n PRIMARY
and associates one target group with it, and then associates\n the other target group with the replacement task set. The load balancer can also have up\n to two listeners: a required listener for production traffic and an optional listener\n that allows you perform validation tests with Lambda functions before routing production\n traffic to it.
After you create a service using the ECS
deployment controller, the load\n balancer name or target group ARN, container name, and container port specified in the\n service definition are immutable. If you are using the CODE_DEPLOY
\n deployment controller, these values can be changed when updating the service.
For Application Load Balancers and Network Load Balancers, this object must contain the load balancer target group ARN,\n the container name (as it appears in a container definition), and the container port to\n access from the load balancer. When a task from this service is placed on a container\n instance, the container instance and port combination is registered as a target in the\n target group specified here.
\nFor Classic Load Balancers, this object must contain the load balancer name, the container name (as it\n appears in a container definition), and the container port to access from the load\n balancer. When a task from this service is placed on a container instance, the container\n instance is registered with the load balancer specified here.
\nServices with tasks that use the awsvpc
network mode (for example, those\n with the Fargate launch type) only support Application Load Balancers and Network Load Balancers. Classic Load Balancers are\n not supported. Also, when you create any target groups for these services, you must\n choose ip
as the target type, not instance
, because tasks that\n use the awsvpc
network mode are associated with an elastic network\n interface, not an Amazon EC2 instance.
The platform version that your tasks in the service are running on. A platform version\n\t\t\tis specified only for tasks using the Fargate launch type. If one isn't\n\t\t\tspecified, the LATEST
platform version is used by default. For more\n\t\t\tinformation, see AWS Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
The number of instantiations of the specified task definition to place and keep\n running on your cluster.
\nThis is required if schedulingStrategy
is REPLICA
or is not\n specified. If schedulingStrategy
is DAEMON
then this is not\n required.
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your service.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, - "serviceName": { + "role": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within\n a cluster, but you can have similarly named services in multiple clusters within a\n Region or across multiple Regions.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your\n\t\t\tload balancer on your behalf. This parameter is only permitted if you are using a load\n\t\t\tbalancer with your service and your task definition does not use the awsvpc
\n\t\t\tnetwork mode. If you specify the role
parameter, you must also specify a\n\t\t\tload balancer object with the loadBalancers
parameter.
If your account has already created the Amazon ECS service-linked role, that role is\n\t\t\t\tused by default for your service unless you specify a role here. The service-linked\n\t\t\t\trole is required if your task definition uses the awsvpc
network mode\n\t\t\t\tor if the service is configured to use service discovery, an external deployment\n\t\t\t\tcontroller, multiple target groups, or Elastic Inference accelerators in which case\n\t\t\t\tyou should not specify a role here. For more information, see Using\n\t\t\t\t\tService-Linked Roles for Amazon ECS in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
If your specified role has a path other than /
, then you must either\n\t\t\tspecify the full role ARN (this is recommended) or prefix the role name with the path.\n\t\t\tFor example, if a role with the name bar
has a path of /foo/
\n\t\t\tthen you would specify /foo/bar
as the role name. For more information, see\n\t\t\t\tFriendly Names and Paths in the IAM User Guide.
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your\n load balancer on your behalf. This parameter is only permitted if you are using a load\n balancer with your service and your task definition does not use the awsvpc
\n network mode. If you specify the role
parameter, you must also specify a\n load balancer object with the loadBalancers
parameter.
If your account has already created the Amazon ECS service-linked role, that role is\n used by default for your service unless you specify a role here. The service-linked\n role is required if your task definition uses the awsvpc
network mode\n or if the service is configured to use service discovery, an external deployment\n controller, multiple target groups, or Elastic Inference accelerators in which case\n you should not specify a role here. For more information, see Using\n Service-Linked Roles for Amazon ECS in the\n Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /
, then you must either\n specify the full role ARN (this is recommended) or prefix the role name with the path.\n For example, if a role with the name bar
has a path of /foo/
\n then you would specify /foo/bar
as the role name. For more information, see\n Friendly Names and Paths in the IAM User Guide.
Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.
" } }, - "tags": { - "target": "com.amazonaws.ecs#Tags", + "serviceName": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The metadata that you apply to the service to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define. When a\n service is deleted, the tags are deleted as well.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within\n\t\t\ta cluster, but you can have similarly named services in multiple clusters within a\n\t\t\tRegion or across multiple Regions.
", + "smithy.api#required": {} } }, - "placementStrategy": { - "target": "com.amazonaws.ecs#PlacementStrategies", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "The placement strategy objects to use for tasks in your service. You can specify a\n maximum of five strategy rules per service.
" + "smithy.api#documentation": "The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define. When a\n\t\t\tservice is deleted, the tags are deleted as well.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For\n more information, see Tagging Your Amazon ECS\n Resources in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Specifies whether to enable Amazon ECS managed tags for the tasks within the service. For\n\t\t\tmore information, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" } }, - "deploymentConfiguration": { - "target": "com.amazonaws.ecs#DeploymentConfiguration", + "placementStrategy": { + "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment\n and the ordering of stopping and starting tasks.
" + "smithy.api#documentation": "The placement strategy objects to use for tasks in your service. You can specify a\n\t\t\tmaximum of five strategy rules per service.
" } }, - "clientToken": { - "target": "com.amazonaws.ecs#String", + "desiredCount": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Up to 32 ASCII characters are allowed.
" + "smithy.api#documentation": "The number of instantiations of the specified task definition to place and keep\n\t\t\trunning on your cluster.
\n\t\tThis is required if schedulingStrategy
is REPLICA
or is not\n\t\t\tspecified. If schedulingStrategy
is DAEMON
then this is not\n\t\t\trequired.
The platform version that your tasks in the service are running on. A platform version\n is specified only for tasks using the Fargate launch type. If one isn't\n specified, the LATEST
platform version is used by default. For more\n information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. Up to 32 ASCII characters are allowed.
" } }, "placementConstraints": { "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "An array of placement constraint objects to use for tasks in your service. You can\n specify a maximum of 10 constraints per task (this limit includes constraints in the\n task definition and those specified at runtime).
" + "smithy.api#documentation": "An array of placement constraint objects to use for tasks in your service. You can\n\t\t\tspecify a maximum of 10 constraints per task (this limit includes constraints in the\n\t\t\ttask definition and those specified at runtime).
" } }, "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The family
and revision
(family:revision
) or\n full ARN of the task definition to run in your service. If a revision
is\n not specified, the latest ACTIVE
revision is used.
A task definition must be specified if the service is using the ECS
\n deployment controller.
The family
and revision
(family:revision
) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision
is\n\t\t\tnot specified, the latest ACTIVE
revision is used.
A task definition must be specified if the service is using either the\n\t\t\t\tECS
or CODE_DEPLOY
deployment controllers.
The period of time, in seconds, that the Amazon ECS service scheduler should ignore\n unhealthy Elastic Load Balancing target health checks after a task has first started. This is only used\n when your service is configured to use a load balancer. If your service has a load\n balancer defined and you don't specify a health check grace period value, the default\n value of 0
is used.
If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you\n can specify a health check grace period of up to 2,147,483,647 seconds. During that\n time, the Amazon ECS service scheduler ignores health check status. This grace period can\n prevent the service scheduler from marking tasks as unhealthy and stopping them before\n they have time to come up.
" + "smithy.api#documentation": "The period of time, in seconds, that the Amazon ECS service scheduler should ignore\n\t\t\tunhealthy Elastic Load Balancing target health checks after a task has first started. This is only used\n\t\t\twhen your service is configured to use a load balancer. If your service has a load\n\t\t\tbalancer defined and you don't specify a health check grace period value, the default\n\t\t\tvalue of 0
is used.
If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you\n\t\t\tcan specify a health check grace period of up to 2,147,483,647 seconds. During that\n\t\t\ttime, the Amazon ECS service scheduler ignores health check status. This grace period can\n\t\t\tprevent the service scheduler from marking tasks as unhealthy and stopping them before\n\t\t\tthey have time to come up.
" } }, "capacityProviderStrategy": { "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "The capacity provider strategy to use for the service.
\nA capacity provider strategy consists of one or more capacity providers along with the\n base
and weight
to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE
or\n UPDATING
status can be used.
If a capacityProviderStrategy
is specified, the launchType
\n parameter must be omitted. If no capacityProviderStrategy
or\n launchType
is specified, the\n defaultCapacityProviderStrategy
for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.
The PutClusterCapacityProviders API operation is used to update the\n list of available capacity providers for a cluster after the cluster is created.
" + "smithy.api#documentation": "The capacity provider strategy to use for the service.
\n\t\tA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase
and weight
to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE
or\n\t\t\t\tUPDATING
status can be used.
If a capacityProviderStrategy
is specified, the launchType
\n\t\t\tparameter must be omitted. If no capacityProviderStrategy
or\n\t\t\t\tlaunchType
is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy
for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\n\t\tTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n\t\t\t\tFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.
" } }, "launchType": { "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "The launch type on which to run your service. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.
\nIf a launchType
is specified, the capacityProviderStrategy
\n parameter must be omitted.
The launch type on which to run your service. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.
\n\t\tIf a launchType
is specified, the capacityProviderStrategy
\n\t\t\tparameter must be omitted.
The full description of your service following the create call.
\nIf a service is using the ECS
deployment controller, the\n deploymentController
and taskSets
parameters will not be\n returned.
If the service is using the CODE_DEPLOY
deployment controller, the\n deploymentController
, taskSets
and\n deployments
parameters will be returned, however the\n deployments
parameter will be an empty list.
The full description of your service following the create call.
\n\t\tIf a service is using the ECS
deployment controller, the\n\t\t\t\tdeploymentController
and taskSets
parameters will not be\n\t\t\treturned.
If the service is using the CODE_DEPLOY
deployment controller, the\n\t\t\t\tdeploymentController
, taskSets
and\n\t\t\t\tdeployments
parameters will be returned, however the\n\t\t\t\tdeployments
parameter will be an empty list.
Create a task set in the specified cluster and service. This is used when a service\n uses the EXTERNAL
deployment controller type. For more information, see\n Amazon ECS Deployment\n Types in the Amazon Elastic Container Service Developer Guide.
Create a task set in the specified cluster and service. This is used when a service\n\t\t\tuses the EXTERNAL
deployment controller type. For more information, see\n\t\t\t\tAmazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
The metadata that you apply to the task set to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define. When a\n service is deleted, the tags are deleted as well.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The capacity provider strategy to use for the task set.
\n\t\tA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase
and weight
to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE
or\n\t\t\t\tUPDATING
status can be used.
If a capacityProviderStrategy
is specified, the launchType
\n\t\t\tparameter must be omitted. If no capacityProviderStrategy
or\n\t\t\t\tlaunchType
is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy
for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\n\t\tTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n\t\t\t\tFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.
" } }, "scale": { "target": "com.amazonaws.ecs#Scale" }, - "loadBalancers": { - "target": "com.amazonaws.ecs#LoadBalancers", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "A load balancer object representing the load balancer to use with the task set. The\n supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
" + "smithy.api#documentation": "The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define. When a\n\t\t\tservice is deleted, the tags are deleted as well.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The launch type that new tasks in the task set will use. For more information, see\n\t\t\t\tAmazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
\n\t\tIf a launchType
is specified, the capacityProviderStrategy
\n\t\t\tparameter must be omitted.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. Up to 32 ASCII characters are allowed.
" + "smithy.api#documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the\n\t\t\trequest. Up to 32 ASCII characters are allowed.
" } }, - "externalId": { + "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "An optional non-unique tag that identifies this task set in external systems. If the\n task set is associated with a service discovery registry, the tasks in this task set\n will have the ECS_TASK_SET_EXTERNAL_ID
AWS Cloud Map attribute set to the provided\n value.
The platform version that the tasks in the task set should use. A platform version is\n\t\t\tspecified only for tasks using the Fargate launch type. If one isn't\n\t\t\tspecified, the LATEST
platform version is used by default.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the\n task set in.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the\n\t\t\ttask set in.
", "smithy.api#required": {} } }, - "taskDefinition": { - "target": "com.amazonaws.ecs#String", + "loadBalancers": { + "target": "com.amazonaws.ecs#LoadBalancers", "traits": { - "smithy.api#documentation": "The task definition for the tasks in the task set to use.
", - "smithy.api#required": {} + "smithy.api#documentation": "A load balancer object representing the load balancer to use with the task set. The\n\t\t\tsupported load balancer types are either an Application Load Balancer or a Network Load Balancer.
" } }, - "platformVersion": { + "externalId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The platform version that the tasks in the task set should use. A platform version is\n specified only for tasks using the Fargate launch type. If one isn't\n specified, the LATEST
platform version is used by default.
An optional non-unique tag that identifies this task set in external systems. If the\n\t\t\ttask set is associated with a service discovery registry, the tasks in this task set\n\t\t\twill have the ECS_TASK_SET_EXTERNAL_ID
AWS Cloud Map attribute set to the provided\n\t\t\tvalue.
The details of the service discovery registries to assign to this task set. For more\n information, see Service\n Discovery.
" - } - }, - "capacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "taskDefinition": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The capacity provider strategy to use for the task set.
\nA capacity provider strategy consists of one or more capacity providers along with the\n base
and weight
to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE
or\n UPDATING
status can be used.
If a capacityProviderStrategy
is specified, the launchType
\n parameter must be omitted. If no capacityProviderStrategy
or\n launchType
is specified, the\n defaultCapacityProviderStrategy
for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.
The PutClusterCapacityProviders API operation is used to update the\n list of available capacity providers for a cluster after the cluster is created.
" + "smithy.api#documentation": "The task definition for the tasks in the task set to use.
", + "smithy.api#required": {} } }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", + "serviceRegistries": { + "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { - "smithy.api#documentation": "The launch type that new tasks in the task set will use. For more information, see\n Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
\nIf a launchType
is specified, the capacityProviderStrategy
\n parameter must be omitted.
The details of the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.
" } } } @@ -2033,23 +2033,23 @@ } ], "traits": { - "smithy.api#documentation": "Disables an account setting for a specified IAM user, IAM role, or the root user for\n an account.
" + "smithy.api#documentation": "Disables an account setting for a specified IAM user, IAM role, or the root user for\n\t\t\tan account.
" } }, "com.amazonaws.ecs#DeleteAccountSettingRequest": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.ecs#SettingName", + "principalArn": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The resource name for which to disable the account setting. If\n serviceLongArnFormat
is specified, the ARN for your Amazon ECS services is\n affected. If taskLongArnFormat
is specified, the ARN and resource ID for\n your Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is\n specified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n awsvpcTrunking
is specified, the ENI limit for your Amazon ECS container\n instances is affected.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you\n\t\t\tspecify the root user, it disables the account setting for all IAM users, IAM roles, and\n\t\t\tthe root user of the account unless an IAM user or role explicitly overrides these\n\t\t\tsettings. If this field is omitted, the setting is changed only for the authenticated\n\t\t\tuser.
" } }, - "principalArn": { - "target": "com.amazonaws.ecs#String", + "name": { + "target": "com.amazonaws.ecs#SettingName", "traits": { - "smithy.api#documentation": "The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you\n specify the root user, it disables the account setting for all IAM users, IAM roles, and\n the root user of the account unless an IAM user or role explicitly overrides these\n settings. If this field is omitted, the setting is changed only for the authenticated\n user.
" + "smithy.api#documentation": "The resource name for which to disable the account setting. If\n\t\t\t\tserviceLongArnFormat
is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat
is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking
is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected.
The attributes to delete from your resource. You can specify up to 10 attributes per\n request. For custom attributes, specify the attribute name and target ID, but do not\n specify the value. If you specify the target ID using the short form, you must also\n specify the target type.
", + "smithy.api#documentation": "The attributes to delete from your resource. You can specify up to 10 attributes per\n\t\t\trequest. For custom attributes, specify the attribute name and target ID, but do not\n\t\t\tspecify the value. If you specify the target ID using the short form, you must also\n\t\t\tspecify the target type.
", "smithy.api#required": {} } }, "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete\n attributes. If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to delete\n\t\t\tattributes. If you do not specify a cluster, the default cluster is assumed.
" } } } @@ -2137,7 +2137,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified capacity provider.
\nThe FARGATE
and FARGATE_SPOT
capacity providers are\n reserved and cannot be deleted. You can disassociate them from a cluster using\n either the PutClusterCapacityProviders API or by deleting the\n cluster.
Prior to a capacity provider being deleted, the capacity provider must be removed from\n the capacity provider strategy from all services. The UpdateService\n API can be used to remove a capacity provider from a service's capacity provider\n strategy. When updating a service, the forceNewDeployment
option can be\n used to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity\n provider are transitioned to use the capacity from the remaining capacity providers.\n Only capacity providers that are not associated with a cluster can be deleted. To remove\n a capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.
Deletes the specified capacity provider.
\n\t\tThe FARGATE
and FARGATE_SPOT
capacity providers are\n\t\t\t\treserved and cannot be deleted. You can disassociate them from a cluster using\n\t\t\t\teither the PutClusterCapacityProviders API or by deleting the\n\t\t\t\tcluster.
Prior to a capacity provider being deleted, the capacity provider must be removed from\n\t\t\tthe capacity provider strategy from all services. The UpdateService\n\t\t\tAPI can be used to remove a capacity provider from a service's capacity provider\n\t\t\tstrategy. When updating a service, the forceNewDeployment
option can be\n\t\t\tused to ensure that any tasks using the Amazon EC2 instance capacity provided by the capacity\n\t\t\tprovider are transitioned to use the capacity from the remaining capacity providers.\n\t\t\tOnly capacity providers that are not associated with a cluster can be deleted. To remove\n\t\t\ta capacity provider from a cluster, you can either use PutClusterCapacityProviders or delete the cluster.
Deletes the specified cluster. The cluster will transition to the\n INACTIVE
state. Clusters with an INACTIVE
status may\n remain discoverable in your account for a period of time. However, this behavior is\n subject to change in the future, so you should not rely on INACTIVE
\n clusters persisting.
You must deregister all container instances from this cluster before you may delete\n it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
" + "smithy.api#documentation": "Deletes the specified cluster. The cluster will transition to the\n\t\t\t\tINACTIVE
state. Clusters with an INACTIVE
status may\n\t\t\tremain discoverable in your account for a period of time. However, this behavior is\n\t\t\tsubject to change in the future, so you should not rely on INACTIVE
\n\t\t\tclusters persisting.
You must deregister all container instances from this cluster before you may delete\n\t\t\tit. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
" } }, "com.amazonaws.ecs#DeleteClusterRequest": { @@ -2247,22 +2247,22 @@ } ], "traits": { - "smithy.api#documentation": "Deletes a specified service within a cluster. You can delete a service if you have no\n running tasks in it and the desired task count is zero. If the service is actively\n maintaining tasks, you cannot delete it, and you must update the service to a desired\n task count of zero. For more information, see UpdateService.
\nWhen you delete a service, if there are still running tasks that require cleanup,\n the service status moves from ACTIVE
to DRAINING
, and the\n service is no longer visible in the console or in the ListServices\n API operation. After all tasks have transitioned to either STOPPING
or\n STOPPED
status, the service status moves from DRAINING
\n to INACTIVE
. Services in the DRAINING
or\n INACTIVE
status can still be viewed with the DescribeServices API operation. However, in the future,\n INACTIVE
services may be cleaned up and purged from Amazon ECS record\n keeping, and DescribeServices calls on those services return a\n ServiceNotFoundException
error.
If you attempt to create a new service with the same name as an existing service\n in either ACTIVE
or DRAINING
status, you receive an\n error.
Deletes a specified service within a cluster. You can delete a service if you have no\n\t\t\trunning tasks in it and the desired task count is zero. If the service is actively\n\t\t\tmaintaining tasks, you cannot delete it, and you must update the service to a desired\n\t\t\ttask count of zero. For more information, see UpdateService.
\n\t\tWhen you delete a service, if there are still running tasks that require cleanup,\n\t\t\t\tthe service status moves from ACTIVE
to DRAINING
, and the\n\t\t\t\tservice is no longer visible in the console or in the ListServices\n\t\t\t\tAPI operation. After all tasks have transitioned to either STOPPING
or\n\t\t\t\t\tSTOPPED
status, the service status moves from DRAINING
\n\t\t\t\tto INACTIVE
. Services in the DRAINING
or\n\t\t\t\t\tINACTIVE
status can still be viewed with the DescribeServices API operation. However, in the future,\n\t\t\t\t\tINACTIVE
services may be cleaned up and purged from Amazon ECS record\n\t\t\t\tkeeping, and DescribeServices calls on those services return a\n\t\t\t\t\tServiceNotFoundException
error.
If you attempt to create a new service with the same name as an existing service\n\t\t\t\tin either ACTIVE
or DRAINING
status, you receive an\n\t\t\t\terror.
If true
, allows you to delete a service even if it has not been scaled\n down to zero tasks. It is only necessary to use this if the service is using the\n REPLICA
scheduling strategy.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, - "cluster": { - "target": "com.amazonaws.ecs#String", + "force": { + "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to delete.\n If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "If true
, allows you to delete a service even if it has not been scaled\n\t\t\tdown to zero tasks. It is only necessary to use this if the service is using the\n\t\t\t\tREPLICA
scheduling strategy.
Deletes a specified task set within a service. This is used when a service uses the\n EXTERNAL
deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
Deletes a specified task set within a service. This is used when a service uses the\n\t\t\t\tEXTERNAL
deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
The task set ID or full Amazon Resource Name (ARN) of the task set to delete.
", - "smithy.api#required": {} + "smithy.api#documentation": "If true
, this allows you to delete a task set even if it hasn't been\n\t\t\tscaled down to zero.
The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to\n delete.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset exists in to delete.
", "smithy.api#required": {} } }, - "cluster": { + "service": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n set exists in to delete.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that hosts the task set to\n\t\t\tdelete.
", "smithy.api#required": {} } }, - "force": { - "target": "com.amazonaws.ecs#BoxedBoolean", + "taskSet": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "If true
, this allows you to delete a task set even if it hasn't been\n scaled down to zero.
The task set ID or full Amazon Resource Name (ARN) of the task set to delete.
", + "smithy.api#required": {} } } } @@ -2375,28 +2375,28 @@ "smithy.api#documentation": "The capacity provider strategy that the deployment is using.
" } }, - "updatedAt": { - "target": "com.amazonaws.ecs#Timestamp", + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "The Unix timestamp for when the service deployment was last updated.
" + "smithy.api#documentation": "The launch type the tasks in the service are using. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.
" } }, - "desiredCount": { - "target": "com.amazonaws.ecs#Integer", + "updatedAt": { + "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "The most recent desired count of tasks that was specified for the service to deploy or\n maintain.
" + "smithy.api#documentation": "The Unix timestamp for when the service deployment was last updated.
" } }, - "networkConfiguration": { - "target": "com.amazonaws.ecs#NetworkConfiguration", + "id": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc
networking mode.
The ID of the deployment.
" } }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", + "runningCount": { + "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "The platform version on which your tasks in the service are running. A platform\n version is only specified for tasks using the Fargate launch type. If one\n is not specified, the LATEST
platform version is used by default. For more\n information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.
The number of tasks in the deployment that are in the RUNNING
\n\t\t\tstatus.
The number of tasks in the deployment that are in the PENDING
\n status.
The number of tasks in the deployment that are in the PENDING
\n\t\t\tstatus.
The status of the deployment. The following describes each state:
\nThe most recent deployment of a service.
\nA service deployment that still has running tasks, but are in the process\n of being replaced with a new PRIMARY
deployment.
A deployment that has been completely replaced.
\nThe VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc
networking mode.
The number of tasks in the deployment that are in the RUNNING
\n status.
The most recent desired count of tasks that was specified for the service to deploy or\n\t\t\tmaintain.
" } }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", + "status": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The launch type the tasks in the service are using. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The status of the deployment. The following describes each state:
\n\t\tThe most recent deployment of a service.
\n\t\t\t\tA service deployment that still has running tasks, but are in the process\n\t\t\t\t\t\tof being replaced with a new PRIMARY
deployment.
A deployment that has been completely replaced.
\n\t\t\t\tThe ID of the deployment.
" + "smithy.api#documentation": "The platform version on which your tasks in the service are running. A platform\n\t\t\tversion is only specified for tasks using the Fargate launch type. If one\n\t\t\tis not specified, the LATEST
platform version is used by default. For more\n\t\t\tinformation, see AWS Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
The most recent task definition that was specified for the tasks in the service to\n use.
" + "smithy.api#documentation": "The most recent task definition that was specified for the tasks in the service to\n\t\t\tuse.
" } } }, "traits": { - "smithy.api#documentation": "The details of an Amazon ECS service deployment. This is used only when a service uses the\n ECS
deployment controller type.
The details of an Amazon ECS service deployment. This is used only when a service uses the\n\t\t\t\tECS
deployment controller type.
If a service is using the rolling update (ECS
) deployment type, the\n minimum healthy percent represents a lower limit on\n the number of tasks in a service that must remain in the RUNNING
state\n during a deployment, as a percentage of the desired number of tasks (rounded up to the\n nearest integer), and while any container instances are in the DRAINING
\n state if the service contains tasks using the EC2 launch type. This\n parameter enables you to deploy without using additional cluster capacity. For example,\n if your service has a desired number of four tasks and a minimum healthy percent of 50%,\n the scheduler may stop two existing tasks to free up cluster capacity before starting\n two new tasks. Tasks for services that do not use a load balancer\n are considered healthy if they are in the RUNNING
state; tasks for services\n that do use a load balancer are considered healthy if they are in\n the RUNNING
state and they are reported as healthy by the load balancer.\n The default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY
) or\n EXTERNAL
deployment types and tasks that use the EC2\n launch type, the minimum healthy percent value is set\n to the default value and is used to define the lower limit on the number of the tasks in\n the service that remain in the RUNNING
state while the container instances\n are in the DRAINING
state. If the tasks in the service use the\n Fargate launch type, the minimum healthy percent value is not used,\n although it is returned when describing your service.
If a service is using the rolling update (ECS
) deployment type, the\n\t\t\t\tminimum healthy percent represents a lower limit on\n\t\t\tthe number of tasks in a service that must remain in the RUNNING
state\n\t\t\tduring a deployment, as a percentage of the desired number of tasks (rounded up to the\n\t\t\tnearest integer), and while any container instances are in the DRAINING
\n\t\t\tstate if the service contains tasks using the EC2 launch type. This\n\t\t\tparameter enables you to deploy without using additional cluster capacity. For example,\n\t\t\tif your service has a desired number of four tasks and a minimum healthy percent of 50%,\n\t\t\tthe scheduler may stop two existing tasks to free up cluster capacity before starting\n\t\t\ttwo new tasks. Tasks for services that do not use a load balancer\n\t\t\tare considered healthy if they are in the RUNNING
state; tasks for services\n\t\t\tthat do use a load balancer are considered healthy if they are in\n\t\t\tthe RUNNING
state and they are reported as healthy by the load balancer.\n\t\t\tThe default value for minimum healthy percent is 100%.
If a service is using the blue/green (CODE_DEPLOY
) or\n\t\t\t\tEXTERNAL
deployment types and tasks that use the EC2\n\t\t\tlaunch type, the minimum healthy percent value is set\n\t\t\tto the default value and is used to define the lower limit on the number of the tasks in\n\t\t\tthe service that remain in the RUNNING
state while the container instances\n\t\t\tare in the DRAINING
state. If the tasks in the service use the\n\t\t\tFargate launch type, the minimum healthy percent value is not used,\n\t\t\talthough it is returned when describing your service.
If a service is using the rolling update (ECS
) deployment type, the\n maximum percent parameter represents an upper limit\n on the number of tasks in a service that are allowed in the RUNNING
or\n PENDING
state during a deployment, as a percentage of the desired\n number of tasks (rounded down to the nearest integer), and while any container instances\n are in the DRAINING
state if the service contains tasks using the\n EC2 launch type. This parameter enables you to define the deployment batch\n size. For example, if your service has a desired number of four tasks and a maximum\n percent value of 200%, the scheduler may start four new tasks before stopping the four\n older tasks (provided that the cluster resources required to do this are available). The\n default value for maximum percent is 200%.
If a service is using the blue/green (CODE_DEPLOY
) or\n EXTERNAL
deployment types and tasks that use the EC2\n launch type, the maximum percent value is set to the\n default value and is used to define the upper limit on the number of the tasks in the\n service that remain in the RUNNING
state while the container instances are\n in the DRAINING
state. If the tasks in the service use the\n Fargate launch type, the maximum percent value is not used, although it is\n returned when describing your service.
If a service is using the rolling update (ECS
) deployment type, the\n\t\t\t\tmaximum percent parameter represents an upper limit\n\t\t\ton the number of tasks in a service that are allowed in the RUNNING
or\n\t\t\t\tPENDING
state during a deployment, as a percentage of the desired\n\t\t\tnumber of tasks (rounded down to the nearest integer), and while any container instances\n\t\t\tare in the DRAINING
state if the service contains tasks using the\n\t\t\tEC2 launch type. This parameter enables you to define the deployment batch\n\t\t\tsize. For example, if your service has a desired number of four tasks and a maximum\n\t\t\tpercent value of 200%, the scheduler may start four new tasks before stopping the four\n\t\t\tolder tasks (provided that the cluster resources required to do this are available). The\n\t\t\tdefault value for maximum percent is 200%.
If a service is using the blue/green (CODE_DEPLOY
) or\n\t\t\t\tEXTERNAL
deployment types and tasks that use the EC2\n\t\t\tlaunch type, the maximum percent value is set to the\n\t\t\tdefault value and is used to define the upper limit on the number of the tasks in the\n\t\t\tservice that remain in the RUNNING
state while the container instances are\n\t\t\tin the DRAINING
state. If the tasks in the service use the\n\t\t\tFargate launch type, the maximum percent value is not used, although it is\n\t\t\treturned when describing your service.
Optional deployment parameters that control how many tasks run during a deployment and\n the ordering of stopping and starting tasks.
" + "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during a deployment and\n\t\t\tthe ordering of stopping and starting tasks.
" } }, "com.amazonaws.ecs#DeploymentController": { @@ -2472,7 +2472,7 @@ "type": { "target": "com.amazonaws.ecs#DeploymentControllerType", "traits": { - "smithy.api#documentation": "The deployment controller type to use.
\nThere are three deployment controller types available:
\nThe rolling update (ECS
) deployment type involves replacing\n the current running version of the container with the latest version. The\n number of containers Amazon ECS adds or removes from the service during a rolling\n update is controlled by adjusting the minimum and maximum number of healthy\n tasks allowed during a service deployment, as specified in the DeploymentConfiguration.
The blue/green (CODE_DEPLOY
) deployment type uses the\n blue/green deployment model powered by AWS CodeDeploy, which allows you to verify a\n new deployment of a service before sending production traffic to it.
The external (EXTERNAL
) deployment type enables you to use\n any third-party deployment controller for full control over the deployment\n process for an Amazon ECS service.
The deployment controller type to use.
\n\t\tThere are three deployment controller types available:
\n\t\tThe rolling update (ECS
) deployment type involves replacing\n\t\t\t\t\t\tthe current running version of the container with the latest version. The\n\t\t\t\t\t\tnumber of containers Amazon ECS adds or removes from the service during a rolling\n\t\t\t\t\t\tupdate is controlled by adjusting the minimum and maximum number of healthy\n\t\t\t\t\t\ttasks allowed during a service deployment, as specified in the DeploymentConfiguration.
The blue/green (CODE_DEPLOY
) deployment type uses the\n\t\t\t\t\t\tblue/green deployment model powered by AWS CodeDeploy, which allows you to verify a\n\t\t\t\t\t\tnew deployment of a service before sending production traffic to it.
The external (EXTERNAL
) deployment type enables you to use\n\t\t\t\t\t\tany third-party deployment controller for full control over the deployment\n\t\t\t\t\t\tprocess for an Amazon ECS service.
Deregisters an Amazon ECS container instance from the specified cluster. This instance is\n no longer available to run tasks.
\nIf you intend to use the container instance for some other purpose after\n deregistration, you should stop all of the tasks running on the container instance\n before deregistration. That prevents any orphaned tasks from consuming resources.
\nDeregistering a container instance removes the instance from a cluster, but it does\n not terminate the EC2 instance. If you are finished using the instance, be sure to\n terminate it in the Amazon EC2 console to stop billing.
\nIf you terminate a running container instance, Amazon ECS automatically deregisters the\n instance from your cluster (stopped container instances or instances with\n disconnected agents are not automatically deregistered when terminated).
\nDeregisters an Amazon ECS container instance from the specified cluster. This instance is\n\t\t\tno longer available to run tasks.
\n\t\tIf you intend to use the container instance for some other purpose after\n\t\t\tderegistration, you should stop all of the tasks running on the container instance\n\t\t\tbefore deregistration. That prevents any orphaned tasks from consuming resources.
\n\t\tDeregistering a container instance removes the instance from a cluster, but it does\n\t\t\tnot terminate the EC2 instance. If you are finished using the instance, be sure to\n\t\t\tterminate it in the Amazon EC2 console to stop billing.
\n\t\tIf you terminate a running container instance, Amazon ECS automatically deregisters the\n\t\t\t\tinstance from your cluster (stopped container instances or instances with\n\t\t\t\tdisconnected agents are not automatically deregistered when terminated).
\n\t\tThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n deregister. If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n\t\t\tderegister. If you do not specify a cluster, the default cluster is assumed.
" } }, "containerInstance": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The container instance ID or full ARN of the container instance to deregister.\n The ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance
namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
The container instance ID or full ARN of the container instance to deregister.\n\t\t\tThe ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance
namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
Forces the deregistration of the container instance. If you have tasks running on the\n container instance when you deregister it with the force
option, these\n tasks remain running until you terminate the instance or the tasks stop through some\n other means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If\n an orphaned task on your container instance is part of an Amazon ECS service, then the\n service scheduler starts another copy of that task, on a different container instance if\n possible.
Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer\n target group are deregistered. They begin connection draining according to the settings\n on the load balancer or target group.
" + "smithy.api#documentation": "Forces the deregistration of the container instance. If you have tasks running on the\n\t\t\tcontainer instance when you deregister it with the force
option, these\n\t\t\ttasks remain running until you terminate the instance or the tasks stop through some\n\t\t\tother means, but they are orphaned (no longer monitored or accounted for by Amazon ECS). If\n\t\t\tan orphaned task on your container instance is part of an Amazon ECS service, then the\n\t\t\tservice scheduler starts another copy of that task, on a different container instance if\n\t\t\tpossible.
Any containers in orphaned service tasks that are registered with a Classic Load Balancer or an Application Load Balancer\n\t\t\ttarget group are deregistered. They begin connection draining according to the settings\n\t\t\ton the load balancer or target group.
" } } } @@ -2587,7 +2587,7 @@ } ], "traits": { - "smithy.api#documentation": "Deregisters the specified task definition by family and revision. Upon deregistration,\n the task definition is marked as INACTIVE
. Existing tasks and services that\n reference an INACTIVE
task definition continue to run without disruption.\n Existing services that reference an INACTIVE
task definition can still\n scale up or down by modifying the service's desired count.
You cannot use an INACTIVE
task definition to run new tasks or create new\n services, and you cannot update an existing service to reference an\n INACTIVE
task definition. However, there may be up to a 10-minute\n window following deregistration where these restrictions have not yet taken\n effect.
At this time, INACTIVE
task definitions remain discoverable in your\n account indefinitely. However, this behavior is subject to change in the future, so\n you should not rely on INACTIVE
task definitions persisting beyond the\n lifecycle of any associated tasks and services.
Deregisters the specified task definition by family and revision. Upon deregistration,\n\t\t\tthe task definition is marked as INACTIVE
. Existing tasks and services that\n\t\t\treference an INACTIVE
task definition continue to run without disruption.\n\t\t\tExisting services that reference an INACTIVE
task definition can still\n\t\t\tscale up or down by modifying the service's desired count.
You cannot use an INACTIVE
task definition to run new tasks or create new\n\t\t\tservices, and you cannot update an existing service to reference an\n\t\t\t\tINACTIVE
task definition. However, there may be up to a 10-minute\n\t\t\twindow following deregistration where these restrictions have not yet taken\n\t\t\teffect.
At this time, INACTIVE
task definitions remain discoverable in your\n\t\t\t\taccount indefinitely. However, this behavior is subject to change in the future, so\n\t\t\t\tyou should not rely on INACTIVE
task definitions persisting beyond the\n\t\t\t\tlifecycle of any associated tasks and services.
The family
and revision
(family:revision
) or\n full Amazon Resource Name (ARN) of the task definition to deregister. You must specify a\n revision
.
The family
and revision
(family:revision
) or\n\t\t\tfull Amazon Resource Name (ARN) of the task definition to deregister. You must specify a\n\t\t\t\trevision
.
The maximum number of account setting results returned by\n DescribeCapacityProviders
in paginated output. When this parameter is\n used, DescribeCapacityProviders
only returns maxResults
\n results in a single page along with a nextToken
response element. The\n remaining results of the initial request can be seen by sending another\n DescribeCapacityProviders
request with the returned\n nextToken
value. This value can be between\n 1 and 10. If this\n parameter is not used, then DescribeCapacityProviders
returns up to\n 10 results and a nextToken
value\n if applicable.
The maximum number of account setting results returned by\n\t\t\t\tDescribeCapacityProviders
in paginated output. When this parameter is\n\t\t\tused, DescribeCapacityProviders
only returns maxResults
\n\t\t\tresults in a single page along with a nextToken
response element. The\n\t\t\tremaining results of the initial request can be seen by sending another\n\t\t\t\tDescribeCapacityProviders
request with the returned\n\t\t\t\tnextToken
value. This value can be between\n\t\t\t1 and 10. If this\n\t\t\tparameter is not used, then DescribeCapacityProviders
returns up to\n\t\t\t10 results and a nextToken
value\n\t\t\tif applicable.
The nextToken
value returned from a previous paginated\n DescribeCapacityProviders
request where maxResults
was\n used and the results exceeded the value of that parameter. Pagination continues from the\n end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to\n\t\t\t\t100
capacity providers can be described in an action.
The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to\n 100
capacity providers can be described in an action.
The nextToken
value returned from a previous paginated\n\t\t\t\tDescribeCapacityProviders
request where maxResults
was\n\t\t\tused and the results exceeded the value of that parameter. Pagination continues from the\n\t\t\tend of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nSpecifies whether or not you want to see the resource tags for the capacity provider.\n If TAGS
is specified, the tags are included in the response. If this field\n is omitted, tags are not included in the response.
Specifies whether or not you want to see the resource tags for the capacity provider.\n\t\t\tIf TAGS
is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.
The list of capacity providers.
" } }, - "failures": { - "target": "com.amazonaws.ecs#Failures", + "nextToken": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "Any failures associated with the call.
" + "smithy.api#documentation": "The nextToken
value to include in a future\n\t\t\t\tDescribeCapacityProviders
request. When the results of a\n\t\t\t\tDescribeCapacityProviders
request exceed maxResults
, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null
\n\t\t\twhen there are no more results to return.
The nextToken
value to include in a future\n DescribeCapacityProviders
request. When the results of a\n DescribeCapacityProviders
request exceed maxResults
, this\n value can be used to retrieve the next page of results. This value is null
\n when there are no more results to return.
Any failures associated with the call.
" } } } @@ -2717,13 +2717,13 @@ "clusters": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries.\n If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "A list of up to 100 cluster names or full cluster Amazon Resource Name (ARN) entries.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "include": { "target": "com.amazonaws.ecs#ClusterFieldList", "traits": { - "smithy.api#documentation": "Whether to include additional information about your clusters in the response. If this\n field is omitted, the attachments, statistics, and tags are not included.
\nIf ATTACHMENTS
is specified, the attachments for the container instances\n or tasks within the cluster are included.
If SETTINGS
is specified, the settings for the cluster are\n included.
If STATISTICS
is specified, the following additional information,\n separated by launch type, is included:
runningEC2TasksCount
\nrunningFargateTasksCount
\npendingEC2TasksCount
\npendingFargateTasksCount
\nactiveEC2ServiceCount
\nactiveFargateServiceCount
\ndrainingEC2ServiceCount
\ndrainingFargateServiceCount
\nIf TAGS
is specified, the metadata tags associated with the cluster are\n included.
Whether to include additional information about your clusters in the response. If this\n\t\t\tfield is omitted, the attachments, statistics, and tags are not included.
\n\t\tIf ATTACHMENTS
is specified, the attachments for the container instances\n\t\t\tor tasks within the cluster are included.
If SETTINGS
is specified, the settings for the cluster are\n\t\t\tincluded.
If STATISTICS
is specified, the following additional information,\n\t\t\tseparated by launch type, is included:
runningEC2TasksCount
\n\t\t\trunningFargateTasksCount
\n\t\t\tpendingEC2TasksCount
\n\t\t\tpendingFargateTasksCount
\n\t\t\tactiveEC2ServiceCount
\n\t\t\tactiveFargateServiceCount
\n\t\t\tdrainingEC2ServiceCount
\n\t\t\tdrainingFargateServiceCount
\n\t\t\tIf TAGS
is specified, the metadata tags associated with the cluster are\n\t\t\tincluded.
Describes Amazon Elastic Container Service container instances. Returns metadata about registered and\n remaining resources on each container instance requested.
" + "smithy.api#documentation": "Describes Amazon Elastic Container Service container instances. Returns metadata about registered and\n\t\t\tremaining resources on each container instance requested.
" } }, "com.amazonaws.ecs#DescribeContainerInstancesRequest": { "type": "structure", "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", + "include": { + "target": "com.amazonaws.ecs#ContainerInstanceFieldList", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to\n describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance\n or container instances you are describing were launched in any cluster other than the\n default cluster.
" + "smithy.api#documentation": "Specifies whether you want to see the resource tags for the container instance. If\n\t\t\t\tTAGS
is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.
Specifies whether you want to see the resource tags for the container instance. If\n TAGS
is specified, the tags are included in the response. If this field\n is omitted, tags are not included in the response.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to\n\t\t\tdescribe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the container instance\n\t\t\tor container instances you are describing were launched in any cluster other than the\n\t\t\tdefault cluster.
" } }, "containerInstances": { @@ -2798,17 +2798,17 @@ "com.amazonaws.ecs#DescribeContainerInstancesResponse": { "type": "structure", "members": { - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "Any failures associated with the call.
" - } - }, "containerInstances": { "target": "com.amazonaws.ecs#ContainerInstances", "traits": { "smithy.api#documentation": "The list of container instances.
" } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
" + } } } }, @@ -2841,23 +2841,23 @@ "com.amazonaws.ecs#DescribeServicesRequest": { "type": "structure", "members": { - "include": { - "target": "com.amazonaws.ecs#ServiceFieldList", - "traits": { - "smithy.api#documentation": "Specifies whether you want to see the resource tags for the service. If\n TAGS
is specified, the tags are included in the response. If this field\n is omitted, tags are not included in the response.
A list of services to describe. You may specify up to 10 services to describe in a\n single operation.
", + "smithy.api#documentation": "A list of services to describe. You may specify up to 10 services to describe in a\n\t\t\tsingle operation.
", "smithy.api#required": {} } }, + "include": { + "target": "com.amazonaws.ecs#ServiceFieldList", + "traits": { + "smithy.api#documentation": "Specifies whether you want to see the resource tags for the service. If\n\t\t\t\tTAGS
is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.
The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe.\n If you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are\n describing were launched in any cluster other than the default cluster.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN)the cluster that hosts the service to describe.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed. This parameter is required if the service or services you are\n\t\t\tdescribing were launched in any cluster other than the default cluster.
" } } } @@ -2865,17 +2865,17 @@ "com.amazonaws.ecs#DescribeServicesResponse": { "type": "structure", "members": { - "failures": { - "target": "com.amazonaws.ecs#Failures", - "traits": { - "smithy.api#documentation": "Any failures associated with the call.
" - } - }, "services": { "target": "com.amazonaws.ecs#Services", "traits": { "smithy.api#documentation": "The list of services described.
" } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
" + } } } }, @@ -2899,23 +2899,23 @@ } ], "traits": { - "smithy.api#documentation": "Describes a task definition. You can specify a family
and\n revision
to find information about a specific task definition, or you\n can simply specify the family to find the latest ACTIVE
revision in that\n family.
You can only describe INACTIVE
task definitions while an active task\n or service references them.
Describes a task definition. You can specify a family
and\n\t\t\t\trevision
to find information about a specific task definition, or you\n\t\t\tcan simply specify the family to find the latest ACTIVE
revision in that\n\t\t\tfamily.
You can only describe INACTIVE
task definitions while an active task\n\t\t\t\tor service references them.
The family
for the latest ACTIVE
revision,\n family
and revision
(family:revision
) for a\n specific revision in the family, or full Amazon Resource Name (ARN) of the task definition to\n describe.
Specifies whether to see the resource tags for the task definition. If\n\t\t\t\tTAGS
is specified, the tags are included in the response. If this field\n\t\t\tis omitted, tags are not included in the response.
Specifies whether to see the resource tags for the task definition. If\n TAGS
is specified, the tags are included in the response. If this field\n is omitted, tags are not included in the response.
The family
for the latest ACTIVE
revision,\n\t\t\t\tfamily
and revision
(family:revision
) for a\n\t\t\tspecific revision in the family, or full Amazon Resource Name (ARN) of the task definition to\n\t\t\tdescribe.
The metadata that is applied to the task definition to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that is applied to the task definition to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value, both of which you\n\t\t\tdefine.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Describes the task sets in the specified cluster and service. This is used when a\n service uses the EXTERNAL
deployment controller type. For more information,\n see Amazon ECS Deployment\n Types in the Amazon Elastic Container Service Developer Guide.
Describes the task sets in the specified cluster and service. This is used when a\n\t\t\tservice uses the EXTERNAL
deployment controller type. For more information,\n\t\t\tsee Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
Specifies whether to see the resource tags for the task set. If TAGS
is\n specified, the tags are included in the response. If this field is omitted, tags are not\n included in the response.
The ID or full Amazon Resource Name (ARN) of task sets to\n\t\t\tdescribe.
" } }, "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n sets exist in.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tsets exist in.
", "smithy.api#required": {} } }, - "taskSets": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "The ID or full Amazon Resource Name (ARN) of task sets to\n describe.
" - } - }, "service": { "target": "com.amazonaws.ecs#String", "traits": { "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that the task sets exist in.
", "smithy.api#required": {} } + }, + "include": { + "target": "com.amazonaws.ecs#TaskSetFieldList", + "traits": { + "smithy.api#documentation": "Specifies whether to see the resource tags for the task set. If TAGS
is\n\t\t\tspecified, the tags are included in the response. If this field is omitted, tags are not\n\t\t\tincluded in the response.
Any failures associated with the call.
" - } - }, "taskSets": { "target": "com.amazonaws.ecs#TaskSets", "traits": { "smithy.api#documentation": "The list of task sets described.
" } + }, + "failures": { + "target": "com.amazonaws.ecs#Failures", + "traits": { + "smithy.api#documentation": "Any failures associated with the call.
" + } } } }, @@ -3052,10 +3052,10 @@ "com.amazonaws.ecs#DescribeTasksRequest": { "type": "structure", "members": { - "include": { - "target": "com.amazonaws.ecs#TaskFieldList", + "cluster": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "Specifies whether you want to see the resource tags for the task. If TAGS
\n is specified, the tags are included in the response. If this field is omitted, tags are\n not included in the response.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to\n\t\t\tdescribe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you\n\t\t\tare describing were launched in any cluster other than the default cluster.
" } }, "tasks": { @@ -3065,10 +3065,10 @@ "smithy.api#required": {} } }, - "cluster": { - "target": "com.amazonaws.ecs#String", + "include": { + "target": "com.amazonaws.ecs#TaskFieldList", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task or tasks to\n describe. If you do not specify a cluster, the default cluster is assumed. This parameter is required if the task or tasks you\n are describing were launched in any cluster other than the default cluster.
" + "smithy.api#documentation": "Specifies whether you want to see the resource tags for the task. If TAGS
\n\t\t\tis specified, the tags are included in the response. If this field is omitted, tags are\n\t\t\tnot included in the response.
The explicit permissions to provide to the container for the device. By default, the\n container has permissions for read
, write
, and\n mknod
for the device.
The explicit permissions to provide to the container for the device. By default, the\n\t\t\tcontainer has permissions for read
, write
, and\n\t\t\t\tmknod
for the device.
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nReturns an endpoint for\n the Amazon ECS agent to poll for updates.
" + "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nReturns an endpoint for\n\t\t\tthe Amazon ECS agent to poll for updates.
" } }, "com.amazonaws.ecs#DiscoverPollEndpointRequest": { @@ -3193,13 +3193,13 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance\n belongs.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to which the container instance\n\t\t\tbelongs.
" } }, "containerInstance": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The container instance ID or full ARN of the container instance.\n The ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance
namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
The container instance ID or full ARN of the container instance.\n\t\t\tThe ARN contains the arn:aws:ecs
namespace, followed by the Region of the container instance, the AWS account ID of the container instance owner, the container-instance
namespace, and then the container instance ID. For example, arn:aws:ecs:region:aws_account_id:container-instance/container_instance_ID
.
Custom metadata to add to your Docker volume. This parameter maps to\n Labels
in the Create a volume section of the\n Docker Remote API and the xxlabel
option to docker\n volume create.
If this value is true
, the Docker volume is created if it does not\n\t\t\talready exist.
This field is only used if the scope
is shared
.
A map of Docker driver-specific options passed through. This parameter maps to\n DriverOpts
in the Create a volume section of the\n Docker Remote API and the xxopt
option to docker\n volume create.
Custom metadata to add to your Docker volume. This parameter maps to\n\t\t\t\tLabels
in the Create a volume section of the\n\t\t\tDocker Remote API and the xxlabel
option to docker\n\t\t\t\tvolume create.
The Docker volume driver to use. The driver value must match the driver name provided\n by Docker because it is used for task placement. If the driver was installed using the\n Docker plugin CLI, use docker plugin ls
to retrieve the driver name from\n your container instance. If the driver was installed using another method, use Docker\n plugin discovery to retrieve the driver name. For more information, see Docker\n plugin discovery. This parameter maps to Driver
in the\n Create a volume section of the Docker Remote API and the\n xxdriver
option to docker\n volume create.
The Docker volume driver to use. The driver value must match the driver name provided\n\t\t\tby Docker because it is used for task placement. If the driver was installed using the\n\t\t\tDocker plugin CLI, use docker plugin ls
to retrieve the driver name from\n\t\t\tyour container instance. If the driver was installed using another method, use Docker\n\t\t\tplugin discovery to retrieve the driver name. For more information, see Docker\n\t\t\t\tplugin discovery. This parameter maps to Driver
in the\n\t\t\tCreate a volume section of the Docker Remote API and the\n\t\t\t\txxdriver
option to docker\n\t\t\t\tvolume create.
If this value is true
, the Docker volume is created if it does not\n already exist.
This field is only used if the scope
is shared
.
A map of Docker driver-specific options passed through. This parameter maps to\n\t\t\t\tDriverOpts
in the Create a volume section of the\n\t\t\tDocker Remote API and the xxopt
option to docker\n\t\t\t\tvolume create.
The scope for the Docker volume that determines its lifecycle. Docker volumes that are\n scoped to a task
are automatically provisioned when the task starts and\n destroyed when the task stops. Docker volumes that are scoped as shared
\n persist after the task stops.
The scope for the Docker volume that determines its lifecycle. Docker volumes that are\n\t\t\tscoped to a task
are automatically provisioned when the task starts and\n\t\t\tdestroyed when the task stops. Docker volumes that are scoped as shared
\n\t\t\tpersist after the task stops.
This parameter is specified when you are using Docker volumes. Docker volumes are only\n supported when you are using the EC2 launch type. Windows containers only\n support the use of the local
driver. To use bind mounts, specify a\n host
instead.
This parameter is specified when you are using Docker volumes. Docker volumes are only\n\t\t\tsupported when you are using the EC2 launch type. Windows containers only\n\t\t\tsupport the use of the local
driver. To use bind mounts, specify a\n\t\t\t\thost
instead.
The Amazon EFS access point ID to use. If an access point is specified, the root directory\n value specified in the EFSVolumeConfiguration
will be relative to the\n directory set for the access point. If an access point is used, transit encryption must\n be enabled in the EFSVolumeConfiguration
. For more information, see Working with Amazon\n EFS Access Points in the Amazon Elastic File System User Guide.
Whether or not to use the Amazon ECS task IAM role defined in a task definition when\n\t\t\tmounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the\n\t\t\t\tEFSVolumeConfiguration
. If this parameter is omitted, the default value\n\t\t\tof DISABLED
is used. For more information, see Using\n\t\t\t\tAmazon EFS Access Points in the Amazon Elastic Container Service Developer Guide.
Whether or not to use the Amazon ECS task IAM role defined in a task definition when\n mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the\n EFSVolumeConfiguration
. If this parameter is omitted, the default value\n of DISABLED
is used. For more information, see Using\n Amazon EFS Access Points in the Amazon Elastic Container Service Developer Guide.
The Amazon EFS access point ID to use. If an access point is specified, the root directory\n\t\t\tvalue specified in the EFSVolumeConfiguration
must either be omitted or set\n\t\t\tto /
which will enforce the path set on the EFS access point. If an access\n\t\t\tpoint is used, transit encryption must be enabled in the\n\t\t\t\tEFSVolumeConfiguration
. For more information, see Working with Amazon\n\t\t\t\tEFS Access Points in the Amazon Elastic File System User Guide.
The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS\n server. If you do not specify a transit encryption port, it will use the port selection\n strategy that the Amazon EFS mount helper uses. For more information, see EFS Mount\n Helper in the Amazon Elastic File System User Guide.
" + "smithy.api#documentation": "The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS\n\t\t\tserver. If you do not specify a transit encryption port, it will use the port selection\n\t\t\tstrategy that the Amazon EFS mount helper uses. For more information, see EFS Mount\n\t\t\t\tHelper in the Amazon Elastic File System User Guide.
" } }, "fileSystemId": { @@ -3337,16 +3337,16 @@ "smithy.api#required": {} } }, - "rootDirectory": { - "target": "com.amazonaws.ecs#String", + "transitEncryption": { + "target": "com.amazonaws.ecs#EFSTransitEncryption", "traits": { - "smithy.api#documentation": "The directory within the Amazon EFS file system to mount as the root directory inside the\n host. If this parameter is omitted, the root of the Amazon EFS volume will be used.\n Specifying /
will have the same effect as omitting this parameter.
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host\n\t\t\tand the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is\n\t\t\tused. If this parameter is omitted, the default value of DISABLED
is used.\n\t\t\tFor more information, see Encrypting Data in Transit in\n\t\t\tthe Amazon Elastic File System User Guide.
Whether or not to enable encryption for Amazon EFS data in transit between the Amazon ECS host\n and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is\n used. If this parameter is omitted, the default value of DISABLED
is used.\n For more information, see Encrypting Data in Transit in\n the Amazon Elastic File System User Guide.
The directory within the Amazon EFS file system to mount as the root directory inside the\n\t\t\thost. If this parameter is omitted, the root of the Amazon EFS volume will be used.\n\t\t\tSpecifying /
will have the same effect as omitting this parameter.
If an EFS access point is specified in the authorizationConfig
, the\n\t\t\t\troot directory parameter must either be omitted or set to /
which will\n\t\t\t\tenforce the path set on the EFS access point.
This parameter is specified when you are using an Amazon Elastic File System file system for task\n storage. For more information, see Amazon EFS Volumes in the\n Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "This parameter is specified when you are using an Amazon Elastic File System file system for task\n\t\t\tstorage. For more information, see Amazon EFS Volumes in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#EnvironmentFile": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.ecs#EnvironmentFileType", + "value": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The file type to use. The only supported value is s3
.
The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment\n\t\t\tvariable file.
", "smithy.api#required": {} } }, - "value": { - "target": "com.amazonaws.ecs#String", + "type": { + "target": "com.amazonaws.ecs#EnvironmentFileType", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon S3 object containing the environment\n variable file.
", + "smithy.api#documentation": "The file type to use. The only supported value is s3
.
A list of files containing the environment variables to pass to a container. You can\n specify up to ten environment files. The file must have a .env
file\n extension. Each line in an environment file should contain an environment variable in\n VARIABLE=VALUE
format. Lines beginning with #
are treated\n as comments and are ignored. For more information on the environment variable file\n syntax, see Declare default\n environment variables in file.
If there are environment variables specified using the environment
\n parameter in a container definition, they take precedence over the variables contained\n within an environment file. If multiple environment files are specified that contain the\n same variable, they are processed from the top down. It is recommended to use unique\n variable names. For more information, see Specifying Environment\n Variables in the Amazon Elastic Container Service Developer Guide.
This field is not valid for containers in tasks using the Fargate launch\n type.
" + "smithy.api#documentation": "A list of files containing the environment variables to pass to a container. You can\n\t\t\tspecify up to ten environment files. The file must have a .env
file\n\t\t\textension. Each line in an environment file should contain an environment variable in\n\t\t\t\tVARIABLE=VALUE
format. Lines beginning with #
are treated\n\t\t\tas comments and are ignored. For more information on the environment variable file\n\t\t\tsyntax, see Declare default\n\t\t\t\tenvironment variables in file.
If there are environment variables specified using the environment
\n\t\t\tparameter in a container definition, they take precedence over the variables contained\n\t\t\twithin an environment file. If multiple environment files are specified that contain the\n\t\t\tsame variable, they are processed from the top down. It is recommended to use unique\n\t\t\tvariable names. For more information, see Specifying Environment\n\t\t\t\tVariables in the Amazon Elastic Container Service Developer Guide.
This field is not valid for containers in tasks using the Fargate launch\n\t\t\ttype.
" } }, "com.amazonaws.ecs#EnvironmentFileType": { @@ -3405,60 +3405,111 @@ "target": "com.amazonaws.ecs#KeyValuePair" } }, - "com.amazonaws.ecs#Failure": { + "com.amazonaws.ecs#FSxWindowsFileServerAuthorizationConfig": { "type": "structure", "members": { - "arn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the failed resource.
" - } - }, - "reason": { + "domain": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The reason for the failure.
" + "smithy.api#documentation": "A fully qualified domain name hosted by an AWS Directory Service Managed Microsoft AD (Active Directory) or self-hosted EC2\n\t\t\tAD.
", + "smithy.api#required": {} } }, - "detail": { + "credentialsParameter": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The details of the failure.
" + "smithy.api#documentation": "The authorization credential option to use.
\n\t\tThe authorization credential options can be provided using either the AWS Secrets Manager ARN or\n\t\t\tthe AWS Systems Manager ARN. The ARNs refer to the stored credentials.
\n\t\t\n options:\n
\n\n ARN of an\n\t\t\t\t\t\tAWS Secrets Manager\n\t\t\t\t\tsecret.
\n\t\t\t\n ARN of an\n\t\t\t\t\t\tAWS Systems Manager parameter.
\n\t\t\tA failed resource.
" - } - }, - "com.amazonaws.ecs#Failures": { - "type": "list", - "member": { - "target": "com.amazonaws.ecs#Failure" + "smithy.api#documentation": "The authorization configuration details for Amazon FSx for Windows File Server file system. See FSxWindowsFileServerVolumeConfiguration in the Amazon Elastic\n\t\t\t\tContainer Service API Reference.
\n\t\tFor more information and the input format, see Amazon FSx for Windows File Server Volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" } }, - "com.amazonaws.ecs#FirelensConfiguration": { + "com.amazonaws.ecs#FSxWindowsFileServerVolumeConfiguration": { "type": "structure", "members": { - "type": { - "target": "com.amazonaws.ecs#FirelensConfigurationType", + "rootDirectory": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The log router to use. The valid values are fluentd
or\n fluentbit
.
The directory within the Amazon FSx for Windows File Server file system to mount as the root directory\n\t\t\tinside the host.
", "smithy.api#required": {} } }, - "options": { - "target": "com.amazonaws.ecs#FirelensConfigurationOptionsMap", + "fileSystemId": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon FSx for Windows File Server file system ID to use.
", + "smithy.api#required": {} + } + }, + "authorizationConfig": { + "target": "com.amazonaws.ecs#FSxWindowsFileServerAuthorizationConfig", "traits": { - "smithy.api#documentation": "The options to use when configuring the log router. This field is optional and can be\n used to specify a custom configuration file or to add additional metadata, such as the\n task, task definition, cluster, and container instance details to the log event. If\n specified, the syntax to use is\n \"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}
.\n For more information, see Creating\n a Task Definition that Uses a FireLens Configuration in the\n Amazon Elastic Container Service Developer Guide.
The authorization configuration details for the Amazon FSx for Windows File Server file system.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The FireLens configuration for the container. This is used to specify and configure a\n log router for container logs. For more information, see Custom Log Routing\n in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "This parameter is specified when you are using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.
\n\t\tFor more information and the input format, see Amazon FSx for Windows File Server Volumes\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" } }, - "com.amazonaws.ecs#FirelensConfigurationOptionsMap": { + "com.amazonaws.ecs#Failure": { + "type": "structure", + "members": { + "reason": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The reason for the failure.
" + } + }, + "detail": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The details of the failure.
" + } + }, + "arn": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the failed resource.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A failed resource. For a list of common causes, see API failure\n\t\t\t\treasons in the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#Failures": { + "type": "list", + "member": { + "target": "com.amazonaws.ecs#Failure" + } + }, + "com.amazonaws.ecs#FirelensConfiguration": { + "type": "structure", + "members": { + "type": { + "target": "com.amazonaws.ecs#FirelensConfigurationType", + "traits": { + "smithy.api#documentation": "The log router to use. The valid values are fluentd
or\n\t\t\t\tfluentbit
.
The options to use when configuring the log router. This field is optional and can be\n\t\t\tused to specify a custom configuration file or to add additional metadata, such as the\n\t\t\ttask, task definition, cluster, and container instance details to the log event. If\n\t\t\tspecified, the syntax to use is\n\t\t\t\t\"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}
.\n\t\t\tFor more information, see Creating\n\t\t\t\ta Task Definition that Uses a FireLens Configuration in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
The FireLens configuration for the container. This is used to specify and configure a\n\t\t\tlog router for container logs. For more information, see Custom Log Routing\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
" + } + }, + "com.amazonaws.ecs#FirelensConfigurationOptionsMap": { "type": "map", "key": { "target": "com.amazonaws.ecs#String" @@ -3491,40 +3542,40 @@ "com.amazonaws.ecs#HealthCheck": { "type": "structure", "members": { - "startPeriod": { + "retries": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The optional grace period within which to provide containers time to bootstrap before\n failed health checks count towards the maximum number of retries. You may specify\n between 0 and 300 seconds. The startPeriod
is disabled by default.
If a health check succeeds within the startPeriod
, then the container\n is considered healthy and any subsequent failures count toward the maximum number of\n retries.
The number of times to retry a failed health check before the container is considered\n\t\t\tunhealthy. You may specify between 1 and 10 retries. The default value is 3.
" } }, "timeout": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The time period in seconds to wait for a health check to succeed before it is\n considered a failure. You may specify between 2 and 60 seconds. The default value is\n 5.
" + "smithy.api#documentation": "The time period in seconds to wait for a health check to succeed before it is\n\t\t\tconsidered a failure. You may specify between 2 and 60 seconds. The default value is\n\t\t\t5.
" + } + }, + "startPeriod": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The optional grace period within which to provide containers time to bootstrap before\n\t\t\tfailed health checks count towards the maximum number of retries. You may specify\n\t\t\tbetween 0 and 300 seconds. The startPeriod
is disabled by default.
If a health check succeeds within the startPeriod
, then the container\n\t\t\t\tis considered healthy and any subsequent failures count toward the maximum number of\n\t\t\t\tretries.
The time period in seconds between each health check execution. You may specify\n between 5 and 300 seconds. The default value is 30 seconds.
" + "smithy.api#documentation": "The time period in seconds between each health check execution. You may specify\n\t\t\tbetween 5 and 300 seconds. The default value is 30 seconds.
" } }, "command": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "A string array representing the command that the container runs to determine if it is\n healthy. The string array must start with CMD
to execute the command\n arguments directly, or CMD-SHELL
to run the command with the container's\n default shell. For example:
\n [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]
\n
An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n more information, see HealthCheck
in the Create a container\n section of the Docker Remote API.
A string array representing the command that the container runs to determine if it is\n\t\t\thealthy. The string array must start with CMD
to execute the command\n\t\t\targuments directly, or CMD-SHELL
to run the command with the container's\n\t\t\tdefault shell. For example:
\n\t\t\t [ \"CMD-SHELL\", \"curl -f http://localhost/ || exit 1\" ]
\n\t\t
An exit code of 0 indicates success, and non-zero exit code indicates failure. For\n\t\t\tmore information, see HealthCheck
in the Create a container\n\t\t\tsection of the Docker Remote API.
The number of times to retry a failed health check before the container is considered\n unhealthy. You may specify between 1 and 10 retries. The default value is 3.
" - } } }, "traits": { - "smithy.api#documentation": "An object representing a container health check. Health check parameters that are\n specified in a container definition override any Docker health checks that exist in the\n container image (such as those specified in a parent image or from the image's\n Dockerfile).
\nYou can view the health status of both individual containers and a task with the\n DescribeTasks API operation or when viewing the task details in the console.
\nThe following describes the possible healthStatus
values for a\n container:
\n HEALTHY
-The container health check has passed\n successfully.
\n UNHEALTHY
-The container health check has failed.
\n UNKNOWN
-The container health check is being evaluated or\n there is no container health check defined.
The following describes the possible healthStatus
values for a task. The\n container health check status of nonessential containers do not have an effect on the\n health status of a task.
\n HEALTHY
-All essential containers within the task have\n passed their health checks.
\n UNHEALTHY
-One or more essential containers have failed\n their health check.
\n UNKNOWN
-The essential containers within the task are still\n having their health checks evaluated or there are no container health checks\n defined.
If a task is run manually, and not as part of a service, the task will continue its\n lifecycle regardless of its health status. For tasks that are part of a service, if the\n task reports as unhealthy then the task will be stopped and the service scheduler will\n replace it.
\nThe following are notes about container health check support:
\nContainer health checks require version 1.17.0 or greater of the Amazon ECS\n container agent. For more information, see Updating the\n Amazon ECS Container Agent.
\nContainer health checks are supported for Fargate tasks if you\n are using platform version 1.1.0 or greater. For more information, see AWS Fargate\n Platform Versions.
\nContainer health checks are not supported for tasks that are part of a service\n that is configured to use a Classic Load Balancer.
\nAn object representing a container health check. Health check parameters that are\n\t\t\tspecified in a container definition override any Docker health checks that exist in the\n\t\t\tcontainer image (such as those specified in a parent image or from the image's\n\t\t\tDockerfile).
\n\t\tYou can view the health status of both individual containers and a task with the\n\t\t\tDescribeTasks API operation or when viewing the task details in the console.
\n\t\tThe following describes the possible healthStatus
values for a\n\t\t\tcontainer:
\n HEALTHY
-The container health check has passed\n\t\t\t\t\tsuccessfully.
\n UNHEALTHY
-The container health check has failed.
\n UNKNOWN
-The container health check is being evaluated or\n\t\t\t\t\tthere is no container health check defined.
The following describes the possible healthStatus
values for a task. The\n\t\t\tcontainer health check status of nonessential containers do not have an effect on the\n\t\t\thealth status of a task.
\n HEALTHY
-All essential containers within the task have\n\t\t\t\t\tpassed their health checks.
\n UNHEALTHY
-One or more essential containers have failed\n\t\t\t\t\ttheir health check.
\n UNKNOWN
-The essential containers within the task are still\n\t\t\t\t\thaving their health checks evaluated or there are no container health checks\n\t\t\t\t\tdefined.
If a task is run manually, and not as part of a service, the task will continue its\n\t\t\tlifecycle regardless of its health status. For tasks that are part of a service, if the\n\t\t\ttask reports as unhealthy then the task will be stopped and the service scheduler will\n\t\t\treplace it.
\n\t\tThe following are notes about container health check support:
\n\t\tContainer health checks require version 1.17.0 or greater of the Amazon ECS\n\t\t\t\t\tcontainer agent. For more information, see Updating the\n\t\t\t\t\t\tAmazon ECS Container Agent.
\n\t\t\tContainer health checks are supported for Fargate tasks if you\n\t\t\t\t\tare using platform version 1.1.0 or greater. For more information, see AWS Fargate\n\t\t\t\t\t\tPlatform Versions.
\n\t\t\tContainer health checks are not supported for tasks that are part of a service\n\t\t\t\t\tthat is configured to use a Classic Load Balancer.
\n\t\t\tHostnames and IP address entries that are added to the /etc/hosts
file of\n a container via the extraHosts
parameter of its ContainerDefinition.
Hostnames and IP address entries that are added to the /etc/hosts
file of\n\t\t\ta container via the extraHosts
parameter of its ContainerDefinition.
When the host
parameter is used, specify a sourcePath
to\n declare the path on the host container instance that is presented to the container. If\n this parameter is empty, then the Docker daemon has assigned a host path for you. If the\n host
parameter contains a sourcePath
file location, then\n the data volume persists at the specified location on the host container instance until\n you delete it manually. If the sourcePath
value does not exist on the host\n container instance, the Docker daemon creates it. If the location does exist, the\n contents of the source path folder are exported.
If you are using the Fargate launch type, the sourcePath
\n parameter is not supported.
When the host
parameter is used, specify a sourcePath
to\n\t\t\tdeclare the path on the host container instance that is presented to the container. If\n\t\t\tthis parameter is empty, then the Docker daemon has assigned a host path for you. If the\n\t\t\t\thost
parameter contains a sourcePath
file location, then\n\t\t\tthe data volume persists at the specified location on the host container instance until\n\t\t\tyou delete it manually. If the sourcePath
value does not exist on the host\n\t\t\tcontainer instance, the Docker daemon creates it. If the location does exist, the\n\t\t\tcontents of the source path folder are exported.
If you are using the Fargate launch type, the sourcePath
\n\t\t\tparameter is not supported.
The Elastic Inference accelerator type to use.
", + "smithy.api#documentation": "The Elastic Inference accelerator device name. The deviceName
must also\n\t\t\tbe referenced in a container definition as a ResourceRequirement.
The Elastic Inference accelerator device name. The deviceName
must also\n be referenced in a container definition as a ResourceRequirement.
The Elastic Inference accelerator type to use.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Details on a Elastic Inference accelerator. For more information, see Working with\n Amazon Elastic Inference on Amazon ECS in the\n Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Details on a Elastic Inference accelerator. For more information, see Working with\n\t\t\t\tAmazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#InferenceAcceleratorOverride": { @@ -3616,7 +3667,7 @@ "deviceName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Elastic Inference accelerator device name to override for the task. This parameter\n must match a deviceName
specified in the task definition.
The Elastic Inference accelerator device name to override for the task. This parameter\n\t\t\tmust match a deviceName
specified in the task definition.
Details on an Elastic Inference accelerator task override. This parameter is used to\n override the Elastic Inference accelerator specified in the task definition. For more\n information, see Working with Amazon Elastic Inference on Amazon ECS in the\n Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Details on an Elastic Inference accelerator task override. This parameter is used to\n\t\t\toverride the Elastic Inference accelerator specified in the task definition. For more\n\t\t\tinformation, see Working with Amazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#InferenceAcceleratorOverrides": { @@ -3653,7 +3704,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified parameter is invalid. Review the available parameters for the API\n request.
", + "smithy.api#documentation": "The specified parameter is invalid. Review the available parameters for the API\n\t\t\trequest.
", "smithy.api#error": "client" } }, @@ -3682,33 +3733,33 @@ "add": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "The Linux capabilities for the container that have been added to the default\n configuration provided by Docker. This parameter maps to CapAdd
in the\n Create a container section of the Docker Remote API and the\n --cap-add
option to docker\n run.
The SYS_PTRACE
capability is supported for tasks that use the\n Fargate launch type if they are also using platform version 1.4.0. The\n other capabilities are not supported for any platform versions.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n \"WAKE_ALARM\"
\n
The Linux capabilities for the container that have been added to the default\n\t\t\tconfiguration provided by Docker. This parameter maps to CapAdd
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--cap-add
option to docker\n\t\t\t\trun.
Tasks launched on AWS Fargate only support adding the SYS_PTRACE
kernel\n\t\t\t\tcapability.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\t\t\t\t\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\t\t\t\t\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\t\t\t\t\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n\t\t\t\t| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\t\t\t\t\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\t\t\t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"
\n
The Linux capabilities for the container that have been removed from the default\n configuration provided by Docker. This parameter maps to CapDrop
in the\n Create a container section of the Docker Remote API and the\n --cap-drop
option to docker\n run.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n \"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n \"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n \"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n | \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n \"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n \"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n \"WAKE_ALARM\"
\n
The Linux capabilities for the container that have been removed from the default\n\t\t\tconfiguration provided by Docker. This parameter maps to CapDrop
in the\n\t\t\tCreate a container section of the Docker Remote API and the\n\t\t\t\t--cap-drop
option to docker\n\t\t\t\trun.
Valid values: \"ALL\" | \"AUDIT_CONTROL\" | \"AUDIT_WRITE\" | \"BLOCK_SUSPEND\" |\n\t\t\t\t\"CHOWN\" | \"DAC_OVERRIDE\" | \"DAC_READ_SEARCH\" | \"FOWNER\" | \"FSETID\" | \"IPC_LOCK\" |\n\t\t\t\t\"IPC_OWNER\" | \"KILL\" | \"LEASE\" | \"LINUX_IMMUTABLE\" | \"MAC_ADMIN\" | \"MAC_OVERRIDE\" |\n\t\t\t\t\"MKNOD\" | \"NET_ADMIN\" | \"NET_BIND_SERVICE\" | \"NET_BROADCAST\" | \"NET_RAW\" | \"SETFCAP\"\n\t\t\t\t| \"SETGID\" | \"SETPCAP\" | \"SETUID\" | \"SYS_ADMIN\" | \"SYS_BOOT\" | \"SYS_CHROOT\" |\n\t\t\t\t\"SYS_MODULE\" | \"SYS_NICE\" | \"SYS_PACCT\" | \"SYS_PTRACE\" | \"SYS_RAWIO\" |\n\t\t\t\t\"SYS_RESOURCE\" | \"SYS_TIME\" | \"SYS_TTY_CONFIG\" | \"SYSLOG\" |\n\t\t\t\"WAKE_ALARM\"
\n
The Linux capabilities for the container that are added to or dropped from the default\n configuration provided by Docker. For more information on the default capabilities and\n the non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run\n reference. For more detailed information on these Linux capabilities, see\n the capabilities(7) Linux manual page.
" + "smithy.api#documentation": "The Linux capabilities for the container that are added to or dropped from the default\n\t\t\tconfiguration provided by Docker. For more information on the default capabilities and\n\t\t\tthe non-default available capabilities, see Runtime privilege and Linux capabilities in the Docker run\n\t\t\t\treference. For more detailed information on these Linux capabilities, see\n\t\t\tthe capabilities(7) Linux manual page.
" } }, "com.amazonaws.ecs#KeyValuePair": { "type": "structure", "members": { - "name": { + "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of the key-value pair. For environment variables, this is the name of the\n environment variable.
" + "smithy.api#documentation": "The value of the key-value pair. For environment variables, this is the value of the\n\t\t\tenvironment variable.
" } }, - "value": { + "name": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The value of the key-value pair. For environment variables, this is the value of the\n environment variable.
" + "smithy.api#documentation": "The name of the key-value pair. For environment variables, this is the name of the\n\t\t\tenvironment variable.
" } } }, @@ -3746,46 +3797,46 @@ "com.amazonaws.ecs#LinuxParameters": { "type": "structure", "members": { - "devices": { - "target": "com.amazonaws.ecs#DevicesList", - "traits": { - "smithy.api#documentation": "Any host devices to expose to the container. This parameter maps to\n Devices
in the Create a container section of the\n Docker Remote API and the --device
option to docker run.
If you are using tasks that use the Fargate launch type, the\n devices
parameter is not supported.
The total amount of swap memory (in MiB) a container can use. This parameter will be\n translated to the --memory-swap
option to docker run where the value would be the sum of\n the container memory plus the maxSwap
value.
If a maxSwap
value of 0
is specified, the container will not\n use swap. Accepted values are 0
or any positive integer. If the\n maxSwap
parameter is omitted, the container will use the swap\n configuration for the container instance it is running on. A maxSwap
value\n must be set for the swappiness
parameter to be used.
If you are using tasks that use the Fargate launch type, the\n maxSwap
parameter is not supported.
The container path, mount options, and size (in MiB) of the tmpfs mount. This\n\t\t\tparameter maps to the --tmpfs
option to docker run.
If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\ttmpfs
parameter is not supported.
The Linux capabilities for the container that are added to or dropped from the default\n configuration provided by Docker.
\nFor tasks that use the Fargate launch type,\n capabilities
is supported for all platform versions but the\n add
parameter is only supported if using platform version 1.4.0 or\n later.
The Linux capabilities for the container that are added to or dropped from the default\n\t\t\tconfiguration provided by Docker.
\n\t\tFor tasks that use the Fargate launch type,\n\t\t\t\t\tcapabilities
is supported for all platform versions but the\n\t\t\t\t\tadd
parameter is only supported if using platform version 1.4.0 or\n\t\t\t\tlater.
Run an init
process inside the container that forwards signals and reaps\n processes. This parameter maps to the --init
option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
\n
Run an init
process inside the container that forwards signals and reaps\n\t\t\tprocesses. This parameter maps to the --init
option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'
\n
The container path, mount options, and size (in MiB) of the tmpfs mount. This\n parameter maps to the --tmpfs
option to docker run.
If you are using tasks that use the Fargate launch type, the\n tmpfs
parameter is not supported.
The value for the size (in MiB) of the /dev/shm
volume. This parameter\n\t\t\tmaps to the --shm-size
option to docker\n\t\t\t\trun.
If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tsharedMemorySize
parameter is not supported.
This allows you to tune a container's memory swappiness behavior. A\n swappiness
value of 0
will cause swapping to not happen\n unless absolutely necessary. A swappiness
value of 100
will\n cause pages to be swapped very aggressively. Accepted values are whole numbers between\n 0
and 100
. If the swappiness
parameter is not\n specified, a default value of 60
is used. If a value is not specified for\n maxSwap
then this parameter is ignored. This parameter maps to the\n --memory-swappiness
option to docker run.
If you are using tasks that use the Fargate launch type, the\n swappiness
parameter is not supported.
The total amount of swap memory (in MiB) a container can use. This parameter will be\n\t\t\ttranslated to the --memory-swap
option to docker run where the value would be the sum of\n\t\t\tthe container memory plus the maxSwap
value.
If a maxSwap
value of 0
is specified, the container will not\n\t\t\tuse swap. Accepted values are 0
or any positive integer. If the\n\t\t\t\tmaxSwap
parameter is omitted, the container will use the swap\n\t\t\tconfiguration for the container instance it is running on. A maxSwap
value\n\t\t\tmust be set for the swappiness
parameter to be used.
If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tmaxSwap
parameter is not supported.
The value for the size (in MiB) of the /dev/shm
volume. This parameter\n maps to the --shm-size
option to docker\n run.
If you are using tasks that use the Fargate launch type, the\n sharedMemorySize
parameter is not supported.
This allows you to tune a container's memory swappiness behavior. A\n\t\t\t\tswappiness
value of 0
will cause swapping to not happen\n\t\t\tunless absolutely necessary. A swappiness
value of 100
will\n\t\t\tcause pages to be swapped very aggressively. Accepted values are whole numbers between\n\t\t\t\t0
and 100
. If the swappiness
parameter is not\n\t\t\tspecified, a default value of 60
is used. If a value is not specified for\n\t\t\t\tmaxSwap
then this parameter is ignored. This parameter maps to the\n\t\t\t\t--memory-swappiness
option to docker run.
If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tswappiness
parameter is not supported.
Any host devices to expose to the container. This parameter maps to\n\t\t\t\tDevices
in the Create a container section of the\n\t\t\tDocker Remote API and the --device
option to docker run.
If you are using tasks that use the Fargate launch type, the\n\t\t\t\t\tdevices
parameter is not supported.
The nextToken
value returned from a ListAccountSettings
\n request indicating that more results are available to fulfill the request and further\n calls will be needed. If maxResults
was provided, it is possible the number\n of results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken
value returned from a ListAccountSettings
\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults
was provided, it is possible the number\n\t\t\tof results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe name of the account setting you want to list the settings for.
" + "smithy.api#documentation": "The value of the account settings with which to filter results. You must also specify\n\t\t\tan account setting name to use this parameter.
" } }, - "value": { - "target": "com.amazonaws.ecs#String", + "name": { + "target": "com.amazonaws.ecs#SettingName", "traits": { - "smithy.api#documentation": "The value of the account settings with which to filter results. You must also specify\n an account setting name to use this parameter.
" + "smithy.api#documentation": "The name of the account setting you want to list the settings for.
" } }, "effectiveSettings": { "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "Specifies whether to return the effective settings. If true
, the account\n settings for the root user or the default setting for the principalArn
are\n returned. If false
, the account settings for the principalArn
\n are returned if they are set. Otherwise, no account settings are returned.
Specifies whether to return the effective settings. If true
, the account\n\t\t\tsettings for the root user or the default setting for the principalArn
are\n\t\t\treturned. If false
, the account settings for the principalArn
\n\t\t\tare returned if they are set. Otherwise, no account settings are returned.
The maximum number of account setting results returned by\n ListAccountSettings
in paginated output. When this parameter is used,\n ListAccountSettings
only returns maxResults
results in a\n single page along with a nextToken
response element. The remaining results\n of the initial request can be seen by sending another ListAccountSettings
\n request with the returned nextToken
value. This value can be between\n 1 and 10. If this\n parameter is not used, then ListAccountSettings
returns up to\n 10 results and a nextToken
value\n if applicable.
The maximum number of account setting results returned by\n\t\t\t\tListAccountSettings
in paginated output. When this parameter is used,\n\t\t\t\tListAccountSettings
only returns maxResults
results in a\n\t\t\tsingle page along with a nextToken
response element. The remaining results\n\t\t\tof the initial request can be seen by sending another ListAccountSettings
\n\t\t\trequest with the returned nextToken
value. This value can be between\n\t\t\t1 and 10. If this\n\t\t\tparameter is not used, then ListAccountSettings
returns up to\n\t\t\t10 results and a nextToken
value\n\t\t\tif applicable.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If\n this field is omitted, the account settings are listed only for the authenticated\n user.
" + "smithy.api#documentation": "The ARN of the principal, which can be an IAM user, IAM role, or the root user. If\n\t\t\tthis field is omitted, the account settings are listed only for the authenticated\n\t\t\tuser.
" } } } @@ -3866,17 +3917,17 @@ "com.amazonaws.ecs#ListAccountSettingsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The nextToken
value to include in a future\n ListAccountSettings
request. When the results of a\n ListAccountSettings
request exceed maxResults
, this value\n can be used to retrieve the next page of results. This value is null
when\n there are no more results to return.
The account settings for the resource.
" } + }, + "nextToken": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The nextToken
value to include in a future\n\t\t\t\tListAccountSettings
request. When the results of a\n\t\t\t\tListAccountSettings
request exceed maxResults
, this value\n\t\t\tcan be used to retrieve the next page of results. This value is null
when\n\t\t\tthere are no more results to return.
Lists the attributes for Amazon ECS resources within a specified target type and cluster.\n When you specify a target type and cluster, ListAttributes
returns a list\n of attribute objects, one for each attribute on each resource. You can filter the list\n of results to a single attribute name to only return results that have that name. You\n can also filter the results by attribute name and value, for example, to see which\n container instances in a cluster are running a Linux AMI\n (ecs.os-type=linux
).
Lists the attributes for Amazon ECS resources within a specified target type and cluster.\n\t\t\tWhen you specify a target type and cluster, ListAttributes
returns a list\n\t\t\tof attribute objects, one for each attribute on each resource. You can filter the list\n\t\t\tof results to a single attribute name to only return results that have that name. You\n\t\t\tcan also filter the results by attribute name and value, for example, to see which\n\t\t\tcontainer instances in a cluster are running a Linux AMI\n\t\t\t(ecs.os-type=linux
).
The value of the attribute with which to filter results. You must also specify an\n attribute name to use this parameter.
" + "smithy.api#documentation": "The maximum number of cluster results returned by ListAttributes
in\n\t\t\tpaginated output. When this parameter is used, ListAttributes
only returns\n\t\t\t\tmaxResults
results in a single page along with a nextToken
\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListAttributes
request with the returned nextToken
\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter is not used, then ListAttributes
returns up to\n\t\t\t100 results and a nextToken
value if applicable.
The nextToken
value returned from a ListAttributes
request\n indicating that more results are available to fulfill the request and further calls will\n be needed. If maxResults
was provided, it is possible the number of results\n to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken
value returned from a ListAttributes
request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults
was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of cluster results returned by ListAttributes
in\n paginated output. When this parameter is used, ListAttributes
only returns\n maxResults
results in a single page along with a nextToken
\n response element. The remaining results of the initial request can be seen by sending\n another ListAttributes
request with the returned nextToken
\n value. This value can be between 1 and 100. If this\n parameter is not used, then ListAttributes
returns up to\n 100 results and a nextToken
value if applicable.
The value of the attribute with which to filter results. You must also specify an\n\t\t\tattribute name to use this parameter.
" } }, "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to list attributes.\n If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to list attributes.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "attributeName": { @@ -3960,7 +4011,7 @@ "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The nextToken
value to include in a future ListAttributes
\n request. When the results of a ListAttributes
request exceed\n maxResults
, this value can be used to retrieve the next page of\n results. This value is null
when there are no more results to\n return.
The nextToken
value to include in a future ListAttributes
\n\t\t\trequest. When the results of a ListAttributes
request exceed\n\t\t\t\tmaxResults
, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null
when there are no more results to\n\t\t\treturn.
The nextToken
value returned from a ListClusters
request\n indicating that more results are available to fulfill the request and further calls will\n be needed. If maxResults
was provided, it is possible the number of results\n to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken
value returned from a ListClusters
request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults
was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of cluster results returned by ListClusters
in\n paginated output. When this parameter is used, ListClusters
only returns\n maxResults
results in a single page along with a nextToken
\n response element. The remaining results of the initial request can be seen by sending\n another ListClusters
request with the returned nextToken
\n value. This value can be between 1 and 100. If this\n parameter is not used, then ListClusters
returns up to\n 100 results and a nextToken
value if applicable.
The maximum number of cluster results returned by ListClusters
in\n\t\t\tpaginated output. When this parameter is used, ListClusters
only returns\n\t\t\t\tmaxResults
results in a single page along with a nextToken
\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListClusters
request with the returned nextToken
\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter is not used, then ListClusters
returns up to\n\t\t\t100 results and a nextToken
value if applicable.
The nextToken
value to include in a future ListClusters
\n request. When the results of a ListClusters
request exceed\n maxResults
, this value can be used to retrieve the next page of\n results. This value is null
when there are no more results to\n return.
The nextToken
value to include in a future ListClusters
\n\t\t\trequest. When the results of a ListClusters
request exceed\n\t\t\t\tmaxResults
, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null
when there are no more results to\n\t\t\treturn.
The list of full Amazon Resource Name (ARN) entries for each cluster associated with your\n account.
" + "smithy.api#documentation": "The list of full Amazon Resource Name (ARN) entries for each cluster associated with your\n\t\t\taccount.
" } } } @@ -4051,7 +4102,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of container instances in a specified cluster. You can filter the\n results of a ListContainerInstances
operation with cluster query language\n statements inside the filter
parameter. For more information, see Cluster Query Language in the\n Amazon Elastic Container Service Developer Guide.
Returns a list of container instances in a specified cluster. You can filter the\n\t\t\tresults of a ListContainerInstances
operation with cluster query language\n\t\t\tstatements inside the filter
parameter. For more information, see Cluster Query Language in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
You can filter the results of a ListContainerInstances
operation with\n cluster query language statements. For more information, see Cluster Query Language in the\n Amazon Elastic Container Service Developer Guide.
You can filter the results of a ListContainerInstances
operation with\n\t\t\tcluster query language statements. For more information, see Cluster Query Language in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
The nextToken
value returned from a ListContainerInstances
\n request indicating that more results are available to fulfill the request and further\n calls will be needed. If maxResults
was provided, it is possible the number\n of results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to\n\t\t\tlist. If you do not specify a cluster, the default cluster is assumed.
" } }, - "maxResults": { - "target": "com.amazonaws.ecs#BoxedInteger", + "nextToken": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The maximum number of container instance results returned by\n ListContainerInstances
in paginated output. When this parameter is\n used, ListContainerInstances
only returns maxResults
results\n in a single page along with a nextToken
response element. The remaining\n results of the initial request can be seen by sending another\n ListContainerInstances
request with the returned nextToken
\n value. This value can be between 1 and 100. If this\n parameter is not used, then ListContainerInstances
returns up to\n 100 results and a nextToken
value if applicable.
The nextToken
value returned from a ListContainerInstances
\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults
was provided, it is possible the number\n\t\t\tof results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instances to\n list. If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The maximum number of container instance results returned by\n\t\t\t\tListContainerInstances
in paginated output. When this parameter is\n\t\t\tused, ListContainerInstances
only returns maxResults
results\n\t\t\tin a single page along with a nextToken
response element. The remaining\n\t\t\tresults of the initial request can be seen by sending another\n\t\t\t\tListContainerInstances
request with the returned nextToken
\n\t\t\tvalue. This value can be between 1 and 100. If this\n\t\t\tparameter is not used, then ListContainerInstances
returns up to\n\t\t\t100 results and a nextToken
value if applicable.
Filters the container instances by status. For example, if you specify the\n DRAINING
status, the results include only container instances that have\n been set to DRAINING
using UpdateContainerInstancesState.\n If you do not specify this parameter, the default is to include container instances set\n to all states other than INACTIVE
.
Filters the container instances by status. For example, if you specify the\n\t\t\t\tDRAINING
status, the results include only container instances that have\n\t\t\tbeen set to DRAINING
using UpdateContainerInstancesState.\n\t\t\tIf you do not specify this parameter, the default is to include container instances set\n\t\t\tto all states other than INACTIVE
.
The nextToken
value to include in a future\n ListContainerInstances
request. When the results of a\n ListContainerInstances
request exceed maxResults
, this\n value can be used to retrieve the next page of results. This value is null
\n when there are no more results to return.
The nextToken
value to include in a future\n\t\t\t\tListContainerInstances
request. When the results of a\n\t\t\t\tListContainerInstances
request exceed maxResults
, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null
\n\t\t\twhen there are no more results to return.
The list of container instances with full ARN entries for each container instance\n associated with the specified cluster.
" + "smithy.api#documentation": "The list of container instances with full ARN entries for each container instance\n\t\t\tassociated with the specified cluster.
" } } } @@ -4147,10 +4198,10 @@ "com.amazonaws.ecs#ListServicesRequest": { "type": "structure", "members": { - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", + "nextToken": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The launch type for the services to list.
" + "smithy.api#documentation": "The nextToken
value returned from a ListServices
request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults
was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe scheduling strategy for services to list.
" } }, - "cluster": { - "target": "com.amazonaws.ecs#String", + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list.\n If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The launch type for the services to list.
" } }, - "nextToken": { - "target": "com.amazonaws.ecs#String", + "maxResults": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The nextToken
value returned from a ListServices
request\n indicating that more results are available to fulfill the request and further calls will\n be needed. If maxResults
was provided, it is possible the number of results\n to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe maximum number of service results returned by ListServices
in\n\t\t\tpaginated output. When this parameter is used, ListServices
only returns\n\t\t\t\tmaxResults
results in a single page along with a nextToken
\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListServices
request with the returned nextToken
\n\t\t\tvalue. This value can be between 1 and 100. If\n\t\t\tthis parameter is not used, then ListServices
returns up to\n\t\t\t10 results and a nextToken
value if\n\t\t\tapplicable.
The maximum number of service results returned by ListServices
in\n paginated output. When this parameter is used, ListServices
only returns\n maxResults
results in a single page along with a nextToken
\n response element. The remaining results of the initial request can be seen by sending\n another ListServices
request with the returned nextToken
\n value. This value can be between 1 and 100. If\n this parameter is not used, then ListServices
returns up to\n 10 results and a nextToken
value if\n applicable.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the services to list.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } } } @@ -4185,13 +4236,13 @@ "serviceArns": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "The list of full ARN entries for each service associated with the specified\n cluster.
" + "smithy.api#documentation": "The list of full ARN entries for each service associated with the specified\n\t\t\tcluster.
" } }, "nextToken": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The nextToken
value to include in a future ListServices
\n request. When the results of a ListServices
request exceed\n maxResults
, this value can be used to retrieve the next page of\n results. This value is null
when there are no more results to\n return.
The nextToken
value to include in a future ListServices
\n\t\t\trequest. When the results of a ListServices
request exceed\n\t\t\t\tmaxResults
, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null
when there are no more results to\n\t\t\treturn.
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the\n supported resources are Amazon ECS tasks, services, task definitions, clusters, and container\n instances.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the\n\t\t\tsupported resources are Amazon ECS tasks, services, task definitions, clusters, and container\n\t\t\tinstances.
", "smithy.api#required": {} } } @@ -4265,7 +4316,7 @@ } ], "traits": { - "smithy.api#documentation": "Returns a list of task definition families that are registered to your account (which\n may include task definition families that no longer have any ACTIVE
task\n definition revisions).
You can filter out task definition families that do not contain any\n ACTIVE
task definition revisions by setting the status
\n parameter to ACTIVE
. You can also filter the results with the\n familyPrefix
parameter.
Returns a list of task definition families that are registered to your account (which\n\t\t\tmay include task definition families that no longer have any ACTIVE
task\n\t\t\tdefinition revisions).
You can filter out task definition families that do not contain any\n\t\t\t\tACTIVE
task definition revisions by setting the status
\n\t\t\tparameter to ACTIVE
. You can also filter the results with the\n\t\t\t\tfamilyPrefix
parameter.
The task definition family status with which to filter the\n ListTaskDefinitionFamilies
results. By default, both\n ACTIVE
and INACTIVE
task definition families are listed.\n If this parameter is set to ACTIVE
, only task definition families that have\n an ACTIVE
task definition revision are returned. If this parameter is set\n to INACTIVE
, only task definition families that do not have any\n ACTIVE
task definition revisions are returned. If you paginate the\n resulting output, be sure to keep the status
value constant in each\n subsequent request.
The maximum number of task definition family results returned by\n\t\t\t\tListTaskDefinitionFamilies
in paginated output. When this parameter is\n\t\t\tused, ListTaskDefinitions
only returns maxResults
results in a\n\t\t\tsingle page along with a nextToken
response element. The remaining results\n\t\t\tof the initial request can be seen by sending another\n\t\t\t\tListTaskDefinitionFamilies
request with the returned\n\t\t\t\tnextToken
value. This value can be between 1 and\n\t\t\t100. If this parameter is not used, then\n\t\t\t\tListTaskDefinitionFamilies
returns up to 100 results\n\t\t\tand a nextToken
value if applicable.
The nextToken
value returned from a\n ListTaskDefinitionFamilies
request indicating that more results are\n available to fulfill the request and further calls will be needed. If\n maxResults
was provided, it is possible the number of results to be\n fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe task definition family status with which to filter the\n\t\t\t\tListTaskDefinitionFamilies
results. By default, both\n\t\t\t\tACTIVE
and INACTIVE
task definition families are listed.\n\t\t\tIf this parameter is set to ACTIVE
, only task definition families that have\n\t\t\tan ACTIVE
task definition revision are returned. If this parameter is set\n\t\t\tto INACTIVE
, only task definition families that do not have any\n\t\t\t\tACTIVE
task definition revisions are returned. If you paginate the\n\t\t\tresulting output, be sure to keep the status
value constant in each\n\t\t\tsubsequent request.
The maximum number of task definition family results returned by\n ListTaskDefinitionFamilies
in paginated output. When this parameter is\n used, ListTaskDefinitions
only returns maxResults
results in a\n single page along with a nextToken
response element. The remaining results\n of the initial request can be seen by sending another\n ListTaskDefinitionFamilies
request with the returned\n nextToken
value. This value can be between 1 and\n 100. If this parameter is not used, then\n ListTaskDefinitionFamilies
returns up to 100 results\n and a nextToken
value if applicable.
The familyPrefix
is a string that is used to filter the results of\n\t\t\t\tListTaskDefinitionFamilies
. If you specify a familyPrefix
,\n\t\t\tonly task definition family names that begin with the familyPrefix
string\n\t\t\tare returned.
The familyPrefix
is a string that is used to filter the results of\n ListTaskDefinitionFamilies
. If you specify a familyPrefix
,\n only task definition family names that begin with the familyPrefix
string\n are returned.
The nextToken
value returned from a\n\t\t\t\tListTaskDefinitionFamilies
request indicating that more results are\n\t\t\tavailable to fulfill the request and further calls will be needed. If\n\t\t\t\tmaxResults
was provided, it is possible the number of results to be\n\t\t\tfewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe nextToken
value to include in a future\n ListTaskDefinitionFamilies
request. When the results of a\n ListTaskDefinitionFamilies
request exceed maxResults
, this\n value can be used to retrieve the next page of results. This value is null
\n when there are no more results to return.
The nextToken
value to include in a future\n\t\t\t\tListTaskDefinitionFamilies
request. When the results of a\n\t\t\t\tListTaskDefinitionFamilies
request exceed maxResults
, this\n\t\t\tvalue can be used to retrieve the next page of results. This value is null
\n\t\t\twhen there are no more results to return.
The list of task definition family names that match the\n ListTaskDefinitionFamilies
request.
The list of task definition family names that match the\n\t\t\t\tListTaskDefinitionFamilies
request.
Returns a list of task definitions that are registered to your account. You can filter\n the results by family name with the familyPrefix
parameter or by status\n with the status
parameter.
Returns a list of task definitions that are registered to your account. You can filter\n\t\t\tthe results by family name with the familyPrefix
parameter or by status\n\t\t\twith the status
parameter.
The maximum number of task definition results returned by\n ListTaskDefinitions
in paginated output. When this parameter is used,\n ListTaskDefinitions
only returns maxResults
results in a\n single page along with a nextToken
response element. The remaining results\n of the initial request can be seen by sending another ListTaskDefinitions
\n request with the returned nextToken
value. This value can be between\n 1 and 100. If this parameter is not used, then\n ListTaskDefinitions
returns up to 100 results and a\n nextToken
value if applicable.
The maximum number of task definition results returned by\n\t\t\t\tListTaskDefinitions
in paginated output. When this parameter is used,\n\t\t\t\tListTaskDefinitions
only returns maxResults
results in a\n\t\t\tsingle page along with a nextToken
response element. The remaining results\n\t\t\tof the initial request can be seen by sending another ListTaskDefinitions
\n\t\t\trequest with the returned nextToken
value. This value can be between\n\t\t\t1 and 100. If this parameter is not used, then\n\t\t\t\tListTaskDefinitions
returns up to 100 results and a\n\t\t\t\tnextToken
value if applicable.
The nextToken
value returned from a ListTaskDefinitions
\n request indicating that more results are available to fulfill the request and further\n calls will be needed. If maxResults
was provided, it is possible the number\n of results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe full family name with which to filter the ListTaskDefinitions
\n\t\t\tresults. Specifying a familyPrefix
limits the listed task definitions to\n\t\t\ttask definition revisions that belong to that family.
The full family name with which to filter the ListTaskDefinitions
\n results. Specifying a familyPrefix
limits the listed task definitions to\n task definition revisions that belong to that family.
The nextToken
value returned from a ListTaskDefinitions
\n\t\t\trequest indicating that more results are available to fulfill the request and further\n\t\t\tcalls will be needed. If maxResults
was provided, it is possible the number\n\t\t\tof results to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe order in which to sort the results. Valid values are ASC
and\n DESC
. By default (ASC
), task definitions are listed\n lexicographically by family name and in ascending numerical order by revision so that\n the newest task definitions in a family are listed last. Setting this parameter to\n DESC
reverses the sort order on family name and revision so that the\n newest task definitions in a family are listed first.
The order in which to sort the results. Valid values are ASC
and\n\t\t\t\tDESC
. By default (ASC
), task definitions are listed\n\t\t\tlexicographically by family name and in ascending numerical order by revision so that\n\t\t\tthe newest task definitions in a family are listed last. Setting this parameter to\n\t\t\t\tDESC
reverses the sort order on family name and revision so that the\n\t\t\tnewest task definitions in a family are listed first.
The task definition status with which to filter the ListTaskDefinitions
\n results. By default, only ACTIVE
task definitions are listed. By setting\n this parameter to INACTIVE
, you can view task definitions that are\n INACTIVE
as long as an active task or service still references them. If\n you paginate the resulting output, be sure to keep the status
value\n constant in each subsequent request.
The task definition status with which to filter the ListTaskDefinitions
\n\t\t\tresults. By default, only ACTIVE
task definitions are listed. By setting\n\t\t\tthis parameter to INACTIVE
, you can view task definitions that are\n\t\t\t\tINACTIVE
as long as an active task or service still references them. If\n\t\t\tyou paginate the resulting output, be sure to keep the status
value\n\t\t\tconstant in each subsequent request.
The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions
\n request.
The list of task definition Amazon Resource Name (ARN) entries for the ListTaskDefinitions
\n\t\t\trequest.
The nextToken
value to include in a future\n ListTaskDefinitions
request. When the results of a\n ListTaskDefinitions
request exceed maxResults
, this value\n can be used to retrieve the next page of results. This value is null
when\n there are no more results to return.
The nextToken
value to include in a future\n\t\t\t\tListTaskDefinitions
request. When the results of a\n\t\t\t\tListTaskDefinitions
request exceed maxResults
, this value\n\t\t\tcan be used to retrieve the next page of results. This value is null
when\n\t\t\tthere are no more results to return.
Returns a list of tasks for a specified cluster. You can filter the results by family\n name, by a particular container instance, or by the desired status of the task with the\n family
, containerInstance
, and desiredStatus
\n parameters.
Recently stopped tasks might appear in the returned results. Currently, stopped tasks\n appear in the returned results for at least one hour.
", + "smithy.api#documentation": "Returns a list of tasks for a specified cluster. You can filter the results by family\n\t\t\tname, by a particular container instance, or by the desired status of the task with the\n\t\t\t\tfamily
, containerInstance
, and desiredStatus
\n\t\t\tparameters.
Recently stopped tasks might appear in the returned results. Currently, stopped tasks\n\t\t\tappear in the returned results for at least one hour.
", "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", @@ -4439,58 +4490,58 @@ "com.amazonaws.ecs#ListTasksRequest": { "type": "structure", "members": { - "containerInstance": { + "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The container instance ID or full ARN of the container instance with which to filter\n the ListTasks
results. Specifying a containerInstance
limits\n the results to tasks that belong to that container instance.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, - "family": { - "target": "com.amazonaws.ecs#String", + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "The name of the family with which to filter the ListTasks
results.\n Specifying a family
limits the results to tasks that belong to that\n family.
The launch type for services to list.
" } }, "serviceName": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of the service with which to filter the ListTasks
results.\n Specifying a serviceName
limits the results to tasks that belong to that\n service.
The name of the service with which to filter the ListTasks
results.\n\t\t\tSpecifying a serviceName
limits the results to tasks that belong to that\n\t\t\tservice.
The task desired status with which to filter the ListTasks
results.\n Specifying a desiredStatus
of STOPPED
limits the results to\n tasks that Amazon ECS has set the desired status to STOPPED
. This can be useful\n for debugging tasks that are not starting properly or have died or finished. The default\n status filter is RUNNING
, which shows tasks that Amazon ECS has set the desired\n status to RUNNING
.
Although you can filter results based on a desired status of PENDING
,\n this does not return any results. Amazon ECS never sets the desired status of a task to\n that value (only a task's lastStatus
may have a value of\n PENDING
).
The name of the family with which to filter the ListTasks
results.\n\t\t\tSpecifying a family
limits the results to tasks that belong to that\n\t\t\tfamily.
The launch type for services to list.
" + "smithy.api#documentation": "The task desired status with which to filter the ListTasks
results.\n\t\t\tSpecifying a desiredStatus
of STOPPED
limits the results to\n\t\t\ttasks that Amazon ECS has set the desired status to STOPPED
. This can be useful\n\t\t\tfor debugging tasks that are not starting properly or have died or finished. The default\n\t\t\tstatus filter is RUNNING
, which shows tasks that Amazon ECS has set the desired\n\t\t\tstatus to RUNNING
.
Although you can filter results based on a desired status of PENDING
,\n\t\t\t\tthis does not return any results. Amazon ECS never sets the desired status of a task to\n\t\t\t\tthat value (only a task's lastStatus
may have a value of\n\t\t\t\t\tPENDING
).
The maximum number of task results returned by ListTasks
in paginated\n output. When this parameter is used, ListTasks
only returns\n maxResults
results in a single page along with a nextToken
\n response element. The remaining results of the initial request can be seen by sending\n another ListTasks
request with the returned nextToken
value.\n This value can be between 1 and 100. If this parameter is\n not used, then ListTasks
returns up to 100 results and a\n nextToken
value if applicable.
The startedBy
value with which to filter the task results. Specifying a\n\t\t\t\tstartedBy
value limits the results to tasks that were started with that\n\t\t\tvalue.
The nextToken
value returned from a ListTasks
request\n indicating that more results are available to fulfill the request and further calls will\n be needed. If maxResults
was provided, it is possible the number of results\n to be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe container instance ID or full ARN of the container instance with which to filter\n\t\t\tthe ListTasks
results. Specifying a containerInstance
limits\n\t\t\tthe results to tasks that belong to that container instance.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the tasks to list.\n If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The nextToken
value returned from a ListTasks
request\n\t\t\tindicating that more results are available to fulfill the request and further calls will\n\t\t\tbe needed. If maxResults
was provided, it is possible the number of results\n\t\t\tto be fewer than maxResults
.
This token should be treated as an opaque identifier that is only used to\n retrieve the next items in a list and not for other programmatic purposes.
\nThe startedBy
value with which to filter the task results. Specifying a\n startedBy
value limits the results to tasks that were started with that\n value.
The maximum number of task results returned by ListTasks
in paginated\n\t\t\toutput. When this parameter is used, ListTasks
only returns\n\t\t\t\tmaxResults
results in a single page along with a nextToken
\n\t\t\tresponse element. The remaining results of the initial request can be seen by sending\n\t\t\tanother ListTasks
request with the returned nextToken
value.\n\t\t\tThis value can be between 1 and 100. If this parameter is\n\t\t\tnot used, then ListTasks
returns up to 100 results and a\n\t\t\t\tnextToken
value if applicable.
The list of task ARN entries for the ListTasks
request.
The nextToken
value to include in a future ListTasks
\n\t\t\trequest. When the results of a ListTasks
request exceed\n\t\t\t\tmaxResults
, this value can be used to retrieve the next page of\n\t\t\tresults. This value is null
when there are no more results to\n\t\t\treturn.
The nextToken
value to include in a future ListTasks
\n request. When the results of a ListTasks
request exceed\n maxResults
, this value can be used to retrieve the next page of\n results. This value is null
when there are no more results to\n return.
The list of task ARN entries for the ListTasks
request.
The name of the container (as it appears in a container definition) to associate with\n the load balancer.
" + "smithy.api#documentation": "The name of the container (as it appears in a container definition) to associate with\n\t\t\tthe load balancer.
" } }, - "targetGroupArn": { - "target": "com.amazonaws.ecs#String", + "containerPort": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n task set.
\nA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a\n Classic Load Balancer the target group ARN should be omitted.
\nFor services using the ECS
deployment controller, you can specify one or\n multiple target groups. For more information, see Registering Multiple Target Groups with a Service in\n the Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY
deployment controller, you are\n required to define two target groups for the load balancer. For more information, see\n Blue/Green Deployment with CodeDeploy in the\n Amazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc
network mode (which\n is required for the Fargate launch type), you must choose\n ip
as the target type, not instance
, when creating\n your target groups because tasks that use the awsvpc
network mode are\n associated with an elastic network interface, not an Amazon EC2 instance.
The port on the container to associate with the load balancer. This port must\n\t\t\tcorrespond to a containerPort
in the task definition the tasks in the\n\t\t\tservice are using. For tasks that use the EC2 launch type, the container\n\t\t\tinstance they are launched on must allow ingress traffic on the hostPort
of\n\t\t\tthe port mapping.
The name of the load balancer to associate with the Amazon ECS service or task set.
\nA load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer\n or a Network Load Balancer the load balancer name parameter should be omitted.
" + "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the Elastic Load Balancing target group or groups associated with a service or\n\t\t\ttask set.
\n\t\tA target group ARN is only specified when using an Application Load Balancer or Network Load Balancer. If you are using a\n\t\t\tClassic Load Balancer the target group ARN should be omitted.
\n\t\tFor services using the ECS
deployment controller, you can specify one or\n\t\t\tmultiple target groups. For more information, see Registering Multiple Target Groups with a Service in\n\t\t\tthe Amazon Elastic Container Service Developer Guide.
For services using the CODE_DEPLOY
deployment controller, you are\n\t\t\trequired to define two target groups for the load balancer. For more information, see\n\t\t\t\tBlue/Green Deployment with CodeDeploy in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
If your service's task definition uses the awsvpc
network mode (which\n\t\t\t\tis required for the Fargate launch type), you must choose\n\t\t\t\t\tip
as the target type, not instance
, when creating\n\t\t\t\tyour target groups because tasks that use the awsvpc
network mode are\n\t\t\t\tassociated with an elastic network interface, not an Amazon EC2 instance.
The port on the container to associate with the load balancer. This port must\n correspond to a containerPort
in the task definition the tasks in the\n service are using. For tasks that use the EC2 launch type, the container\n instance they are launched on must allow ingress traffic on the hostPort
of\n the port mapping.
The name of the load balancer to associate with the Amazon ECS service or task set.
\n\t\tA load balancer name is only specified when using a Classic Load Balancer. If you are using an Application Load Balancer\n\t\t\tor a Network Load Balancer the load balancer name parameter should be omitted.
" } } }, "traits": { - "smithy.api#documentation": "The load balancer configuration to use with a service or task set.
\nFor specific notes and restrictions regarding the use of load balancers with services\n and task sets, see the CreateService and CreateTaskSet actions.
" + "smithy.api#documentation": "The load balancer configuration to use with a service or task set.
\n\t\tFor specific notes and restrictions regarding the use of load balancers with services\n\t\t\tand task sets, see the CreateService and CreateTaskSet actions.
" } }, "com.amazonaws.ecs#LoadBalancers": { @@ -4556,7 +4607,7 @@ "logDriver": { "target": "com.amazonaws.ecs#LogDriver", "traits": { - "smithy.api#documentation": "The log driver to use for the container. The valid values listed earlier are log\n drivers that the Amazon ECS container agent can communicate with by default.
\nFor tasks using the Fargate launch type, the supported log drivers are\n awslogs
, splunk
, and awsfirelens
.
For tasks using the EC2 launch type, the supported log drivers are\n awslogs
, fluentd
, gelf
,\n json-file
, journald
,\n logentries
,syslog
, splunk
, and\n awsfirelens
.
For more information about using the awslogs
log driver, see Using\n the awslogs Log Driver in the Amazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens
log driver, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.
If you have a custom driver that is not listed, you can fork the Amazon ECS container\n agent project that is available\n on GitHub and customize it to work with that driver. We encourage you to\n submit pull requests for changes that you would like to have included. However, we\n do not currently provide support for running modified copies of this\n software.
\nThe log driver to use for the container.
\n\t\tFor tasks on AWS Fargate, the supported log drivers are awslogs
,\n\t\t\t\tsplunk
, and awsfirelens
.
For tasks hosted on Amazon EC2 instances, the supported log drivers are\n\t\t\t\tawslogs
, fluentd
, gelf
,\n\t\t\t\tjson-file
, journald
,\n\t\t\t\tlogentries
,syslog
, splunk
, and\n\t\t\t\tawsfirelens
.
For more information about using the awslogs
log driver, see Using\n\t\t\t\tthe awslogs log driver in the Amazon Elastic Container Service Developer Guide.
For more information about using the awsfirelens
log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.
If you have a custom driver that is not listed, you can fork the Amazon ECS container\n\t\t\t\tagent project that is available\n\t\t\t\t\ton GitHub and customize it to work with that driver. We encourage you to\n\t\t\t\tsubmit pull requests for changes that you would like to have included. However, we\n\t\t\t\tdo not currently provide support for running modified copies of this\n\t\t\t\tsoftware.
\n\t\tThe secrets to pass to the log configuration. For more information, see Specifying\n Sensitive Data in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The secrets to pass to the log configuration. For more information, see Specifying\n\t\t\t\tSensitive Data in the Amazon Elastic Container Service Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "The log configuration specification for the container.
\nThis parameter maps to LogConfig
in the\n Create a container section of the Docker Remote API and the\n --log-driver
option to \n docker\n run
\n . By default, containers use the same logging driver that the\n Docker daemon uses; however the container may use a different logging driver than the\n Docker daemon by specifying a log driver with this parameter in the container\n definition. To use a different logging driver for a container, the log system must be\n configured properly on the container instance (or on a different log server for remote\n logging options). For more information on the options for different supported log\n drivers, see Configure logging drivers in the Docker documentation.
The following should be noted when specifying a log configuration for your\n containers:
\nAmazon ECS currently supports a subset of the logging drivers available to the\n Docker daemon (shown in the valid values below). Additional log drivers may be\n available in future releases of the Amazon ECS container agent.
\nThis parameter requires version 1.18 of the Docker Remote API or greater on\n your container instance.
\nFor tasks using the EC2 launch type, the Amazon ECS container agent\n running on a container instance must register the logging drivers available on\n that instance with the ECS_AVAILABLE_LOGGING_DRIVERS
environment\n variable before containers placed on that instance can use these log\n configuration options. For more information, see Amazon ECS Container Agent Configuration in the\n Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, because you do not have\n access to the underlying infrastructure your tasks are hosted on, any additional\n software needed will have to be installed outside of the task. For example, the\n Fluentd output aggregators or a remote host running Logstash to send Gelf logs\n to.
\nThe log configuration for the container. This parameter maps to LogConfig
\n\t\t\tin the Create a container section of the Docker Remote API and the\n\t\t\t\t--log-driver
option to \n docker\n\t\t\t\t\trun
\n .
By default, containers use the same logging driver that the Docker daemon uses;\n\t\t\thowever the container may use a different logging driver than the Docker daemon by\n\t\t\tspecifying a log driver configuration in the container definition. For more information\n\t\t\ton the options for different supported log drivers, see Configure logging\n\t\t\t\tdrivers in the Docker documentation.
\n\t\tThe following should be noted when specifying a log configuration for your\n\t\t\tcontainers:
\n\t\tAmazon ECS currently supports a subset of the logging drivers available to the\n\t\t\t\t\tDocker daemon (shown in the valid values below). Additional log drivers may be\n\t\t\t\t\tavailable in future releases of the Amazon ECS container agent.
\n\t\t\tThis parameter requires version 1.18 of the Docker Remote API or greater on\n\t\t\t\t\tyour container instance.
\n\t\t\tFor tasks hosted on Amazon EC2 instances, the Amazon ECS container agent must register\n\t\t\t\t\tthe available logging drivers with the\n\t\t\t\t\t\tECS_AVAILABLE_LOGGING_DRIVERS
environment variable before\n\t\t\t\t\tcontainers placed on that instance can use these log configuration options. For\n\t\t\t\t\tmore information, see Amazon ECS container agent configuration in the\n\t\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
For tasks on AWS Fargate, because you do not have access to the underlying\n\t\t\t\t\tinfrastructure your tasks are hosted on, any additional software needed will\n\t\t\t\t\thave to be installed outside of the task. For example, the Fluentd output\n\t\t\t\t\taggregators or a remote host running Logstash to send Gelf logs to.
\n\t\t\tWhether or not to enable managed scaling for the capacity provider.
" + "smithy.api#documentation": "The minimum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale\n\t\t\tin process is not affected by this parameter If this parameter is omitted, the default\n\t\t\tvalue of 1
is used.
When additional capacity is required, Amazon ECS will scale up the minimum scaling step\n\t\t\tsize even if the actual demand is less than the minimum scaling step size.
\n\t\tIf you use a capacity provider with an Auto Scaling group configured with more than\n\t\t\tone Amazon EC2 instance type or Availability Zone, Amazon ECS will scale up by the exact minimum\n\t\t\tscaling step size value and will ignore both the maximum scaling step size as well as\n\t\t\tthe capacity demand.
" } }, "maximumScalingStepSize": { "target": "com.amazonaws.ecs#ManagedScalingStepSize", "traits": { - "smithy.api#documentation": "The maximum number of container instances that Amazon ECS will scale in or scale out at one\n time. If this parameter is omitted, the default value of 10000
is\n used.
The maximum number of Amazon EC2 instances that Amazon ECS will scale out at one time. The scale\n\t\t\tin process is not affected by this parameter. If this parameter is omitted, the default\n\t\t\tvalue of 10000
is used.
The minimum number of container instances that Amazon ECS will scale in or scale out at one\n time. If this parameter is omitted, the default value of 1
is used.
The target capacity value for the capacity provider. The specified value must be\n\t\t\tgreater than 0
and less than or equal to 100
. A value of\n\t\t\t\t100
will result in the Amazon EC2 instances in your Auto Scaling group being\n\t\t\tcompletely utilized.
The target capacity value for the capacity provider. The specified value must be\n greater than 0
and less than or equal to 100
. A value of\n 100
will result in the Amazon EC2 instances in your Auto Scaling group being\n completely utilized.
Whether or not to enable managed scaling for the capacity provider.
" } } }, "traits": { - "smithy.api#documentation": "The managed scaling settings for the Auto Scaling group capacity provider.
\nWhen managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of\n the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an\n Amazon ECS-managed CloudWatch metric with the specified targetCapacity
value as the\n target value for the metric. For more information, see Using Managed Scaling in the Amazon Elastic Container Service Developer Guide.
If managed scaling is disabled, the user must manage the scaling of the Auto Scaling\n group.
" + "smithy.api#documentation": "The managed scaling settings for the Auto Scaling group capacity provider.
\n\t\tWhen managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of\n\t\t\tthe Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an\n\t\t\tAmazon ECS-managed CloudWatch metric with the specified targetCapacity
value as the\n\t\t\ttarget value for the metric. For more information, see Using Managed Scaling in the Amazon Elastic Container Service Developer Guide.
If managed scaling is disabled, the user must manage the scaling of the Auto Scaling\n\t\t\tgroup.
" } }, "com.amazonaws.ecs#ManagedScalingStatus": { @@ -4718,7 +4769,7 @@ } }, "traits": { - "smithy.api#documentation": "Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the\n container instance and does not have enough information to proceed with an update. This\n could be because the agent running on the container instance is an older or custom\n version that does not use our version information.
", + "smithy.api#documentation": "Amazon ECS is unable to determine the current version of the Amazon ECS container agent on the\n\t\t\tcontainer instance and does not have enough information to proceed with an update. This\n\t\t\tcould be because the agent running on the container instance is an older or custom\n\t\t\tversion that does not use our version information.
", "smithy.api#error": "client" } }, @@ -4728,7 +4779,7 @@ "readOnly": { "target": "com.amazonaws.ecs#BoxedBoolean", "traits": { - "smithy.api#documentation": "If this value is true
, the container has read-only access to the volume.\n If this value is false
, then the container can write to the volume. The\n default value is false
.
If this value is true
, the container has read-only access to the volume.\n\t\t\tIf this value is false
, then the container can write to the volume. The\n\t\t\tdefault value is false
.
The name of the volume to mount. Must be a volume name referenced in the\n name
parameter of task definition volume
.
The name of the volume to mount. Must be a volume name referenced in the\n\t\t\t\tname
parameter of task definition volume
.
The port number on the container that is used with the network binding.
" + "smithy.api#documentation": "The port number on the host that is used with the network binding.
" } }, - "hostPort": { + "containerPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The port number on the host that is used with the network binding.
" + "smithy.api#documentation": "The port number on the container that is used with the network binding.
" } }, "bindIP": { @@ -4783,7 +4834,7 @@ } }, "traits": { - "smithy.api#documentation": "Details on the network bindings between a container and its host container instance.\n After a task reaches the RUNNING
status, manual and automatic host and\n container port assignments are visible in the networkBindings
section of\n DescribeTasks API responses.
Details on the network bindings between a container and its host container instance.\n\t\t\tAfter a task reaches the RUNNING
status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings
section of\n\t\t\t\tDescribeTasks API responses.
The VPC subnets and security groups associated with a task.
\nAll specified subnets and security groups must be from the same VPC.
\nThe VPC subnets and security groups associated with a task.
\n\t\tAll specified subnets and security groups must be from the same VPC.
\n\t\tAn object representing the elastic network interface for tasks that use the\n awsvpc
network mode.
An object representing the elastic network interface for tasks that use the\n\t\t\t\tawsvpc
network mode.
There is no update available for this Amazon ECS container agent. This could be because the\n agent is already running the latest version, or it is so old that there is no update\n path to the current version.
", + "smithy.api#documentation": "There is no update available for this Amazon ECS container agent. This could be because the\n\t\t\tagent is already running the latest version, or it is so old that there is no update\n\t\t\tpath to the current version.
", "smithy.api#error": "client" } }, @@ -4894,18 +4945,18 @@ "type": { "target": "com.amazonaws.ecs#PlacementConstraintType", "traits": { - "smithy.api#documentation": "The type of constraint. Use distinctInstance
to ensure that each task in\n a particular group is running on a different container instance. Use\n memberOf
to restrict the selection to a group of valid\n candidates.
The type of constraint. Use distinctInstance
to ensure that each task in\n\t\t\ta particular group is running on a different container instance. Use\n\t\t\t\tmemberOf
to restrict the selection to a group of valid\n\t\t\tcandidates.
A cluster query language expression to apply to the constraint. You cannot specify an\n expression if the constraint type is distinctInstance
. For more\n information, see Cluster Query Language in the\n Amazon Elastic Container Service Developer Guide.
A cluster query language expression to apply to the constraint. You cannot specify an\n\t\t\texpression if the constraint type is distinctInstance
. For more\n\t\t\tinformation, see Cluster Query Language in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
An object representing a constraint on task placement. For more information, see\n Task Placement Constraints in the\n Amazon Elastic Container Service Developer Guide.
\nIf you are using the Fargate launch type, task placement constraints\n are not supported.
\nAn object representing a constraint on task placement. For more information, see\n\t\t\t\tTask Placement Constraints in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n\t\tIf you are using the Fargate launch type, task placement constraints\n\t\t\t\tare not supported.
\n\t\tThe type of placement strategy. The random
placement strategy randomly\n places tasks on available candidates. The spread
placement strategy spreads\n placement across available candidates evenly based on the field
parameter.\n The binpack
strategy places tasks on available candidates that have the\n least available amount of the resource that is specified with the field
\n parameter. For example, if you binpack on memory, a task is placed on the instance with\n the least amount of remaining memory (but still enough to run the task).
The field to apply the placement strategy against. For the spread
\n\t\t\tplacement strategy, valid values are instanceId
(or host
,\n\t\t\twhich has the same effect), or any platform or custom attribute that is applied to a\n\t\t\tcontainer instance, such as attribute:ecs.availability-zone
. For the\n\t\t\t\tbinpack
placement strategy, valid values are cpu
and\n\t\t\t\tmemory
. For the random
placement strategy, this field is\n\t\t\tnot used.
The field to apply the placement strategy against. For the spread
\n placement strategy, valid values are instanceId
(or host
,\n which has the same effect), or any platform or custom attribute that is applied to a\n container instance, such as attribute:ecs.availability-zone
. For the\n binpack
placement strategy, valid values are cpu
and\n memory
. For the random
placement strategy, this field is\n not used.
The type of placement strategy. The random
placement strategy randomly\n\t\t\tplaces tasks on available candidates. The spread
placement strategy spreads\n\t\t\tplacement across available candidates evenly based on the field
parameter.\n\t\t\tThe binpack
strategy places tasks on available candidates that have the\n\t\t\tleast available amount of the resource that is specified with the field
\n\t\t\tparameter. For example, if you binpack on memory, a task is placed on the instance with\n\t\t\tthe least amount of remaining memory (but still enough to run the task).
The task placement strategy for a task or service. For more information, see Task Placement Strategies in the\n Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The task placement strategy for a task or service. For more information, see Task Placement Strategies in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#PlacementStrategyType": { @@ -4980,20 +5031,20 @@ "type": { "target": "com.amazonaws.ecs#PlatformDeviceType", "traits": { - "smithy.api#documentation": "The type of device that is available on the container instance. The only supported\n value is GPU
.
The type of device that is available on the container instance. The only supported\n\t\t\tvalue is GPU
.
The ID for the GPU(s) on the container instance. The available GPU IDs can also be\n obtained on the container instance in the\n /var/lib/ecs/gpu/nvidia_gpu_info.json
file.
The ID for the GPU(s) on the container instance. The available GPU IDs can also be\n\t\t\tobtained on the container instance in the\n\t\t\t\t/var/lib/ecs/gpu/nvidia_gpu_info.json
file.
The devices that are available on the container instance. The only supported device\n type is a GPU.
" + "smithy.api#documentation": "The devices that are available on the container instance. The only supported device\n\t\t\ttype is a GPU.
" } }, "com.amazonaws.ecs#PlatformDeviceType": { @@ -5021,7 +5072,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified platform version does not satisfy the task definition's required\n capabilities.
", + "smithy.api#documentation": "The specified platform version does not satisfy the task definition's required\n\t\t\tcapabilities.
", "smithy.api#error": "client" } }, @@ -5043,24 +5094,24 @@ "protocol": { "target": "com.amazonaws.ecs#TransportProtocol", "traits": { - "smithy.api#documentation": "The protocol used for the port mapping. Valid values are tcp
and\n udp
. The default is tcp
.
The protocol used for the port mapping. Valid values are tcp
and\n\t\t\t\tudp
. The default is tcp
.
The port number on the container instance to reserve for your container.
\nIf you are using containers in a task with the awsvpc
or\n host
network mode, the hostPort
can either be left blank\n or set to the same value as the containerPort
.
If you are using containers in a task with the bridge
network mode, you\n can specify a non-reserved host port for your container port mapping, or you can omit\n the hostPort
(or set it to 0
) while specifying a\n containerPort
and your container automatically receives a port in the\n ephemeral port range for your container instance operating system and Docker\n version.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n instance under /proc/sys/net/ipv4/ip_local_port_range
. If this kernel\n parameter is unavailable, the default ephemeral port range from 49153 through 65535 is\n used. Do not attempt to specify a host port in the ephemeral port range as these are\n reserved for automatic assignment. In general, ports below 32768 are outside of the\n ephemeral port range.
The default ephemeral port range from 49153 through 65535 is always used for\n Docker versions before 1.6.0.
\nThe default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n Amazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n a running task is also reserved while the task is running (after a task stops, the host\n port is released). The current reserved ports are displayed in the\n remainingResources
of DescribeContainerInstances\n output. A container instance can have up to 100 reserved ports at a time, including the\n default reserved ports. Automatically assigned ports don't count toward the 100 reserved\n ports limit.
The port number on the container instance to reserve for your container.
\n\t\tIf you are using containers in a task with the awsvpc
or\n\t\t\t\thost
network mode, the hostPort
can either be left blank\n\t\t\tor set to the same value as the containerPort
.
If you are using containers in a task with the bridge
network mode, you\n\t\t\tcan specify a non-reserved host port for your container port mapping, or you can omit\n\t\t\tthe hostPort
(or set it to 0
) while specifying a\n\t\t\t\tcontainerPort
and your container automatically receives a port in the\n\t\t\tephemeral port range for your container instance operating system and Docker\n\t\t\tversion.
The default ephemeral port range for Docker version 1.6.0 and later is listed on the\n\t\t\tinstance under /proc/sys/net/ipv4/ip_local_port_range
. If this kernel\n\t\t\tparameter is unavailable, the default ephemeral port range from 49153 through 65535 is\n\t\t\tused. Do not attempt to specify a host port in the ephemeral port range as these are\n\t\t\treserved for automatic assignment. In general, ports below 32768 are outside of the\n\t\t\tephemeral port range.
The default ephemeral port range from 49153 through 65535 is always used for\n\t\t\t\tDocker versions before 1.6.0.
\n\t\tThe default reserved ports are 22 for SSH, the Docker ports 2375 and 2376, and the\n\t\t\tAmazon ECS container agent ports 51678-51680. Any host port that was previously specified in\n\t\t\ta running task is also reserved while the task is running (after a task stops, the host\n\t\t\tport is released). The current reserved ports are displayed in the\n\t\t\t\tremainingResources
of DescribeContainerInstances\n\t\t\toutput. A container instance can have up to 100 reserved ports at a time, including the\n\t\t\tdefault reserved ports. Automatically assigned ports don't count toward the 100 reserved\n\t\t\tports limit.
The port number on the container that is bound to the user-specified or automatically\n assigned host port.
\nIf you are using containers in a task with the awsvpc
or\n host
network mode, exposed ports should be specified using\n containerPort
.
If you are using containers in a task with the bridge
network mode and\n you specify a container port and not a host port, your container automatically receives\n a host port in the ephemeral port range. For more information, see\n hostPort
. Port mappings that are automatically assigned in this way do not\n count toward the 100 reserved ports limit of a container instance.
You cannot expose the same container port for multiple protocols. An error will be\n returned if this is attempted.
\nThe port number on the container that is bound to the user-specified or automatically\n\t\t\tassigned host port.
\n\t\tIf you are using containers in a task with the awsvpc
or\n\t\t\t\thost
network mode, exposed ports should be specified using\n\t\t\t\tcontainerPort
.
If you are using containers in a task with the bridge
network mode and\n\t\t\tyou specify a container port and not a host port, your container automatically receives\n\t\t\ta host port in the ephemeral port range. For more information, see\n\t\t\thostPort
. Port mappings that are automatically assigned in this way do not\n\t\t\tcount toward the 100 reserved ports limit of a container instance.
Port mappings allow containers to access ports on the host container instance to send\n or receive traffic. Port mappings are specified as part of the container\n definition.
\nIf you are using containers in a task with the awsvpc
or\n host
network mode, exposed ports should be specified using\n containerPort
. The hostPort
can be left blank or it must\n be the same value as the containerPort
.
After a task reaches the RUNNING
status, manual and automatic host and\n container port assignments are visible in the networkBindings
section of\n DescribeTasks API responses.
Port mappings allow containers to access ports on the host container instance to send\n\t\t\tor receive traffic. Port mappings are specified as part of the container\n\t\t\tdefinition.
\n\t\tIf you are using containers in a task with the awsvpc
or\n\t\t\t\thost
network mode, exposed ports should be specified using\n\t\t\t\tcontainerPort
. The hostPort
can be left blank or it must\n\t\t\tbe the same value as the containerPort
.
After a task reaches the RUNNING
status, manual and automatic host and\n\t\t\tcontainer port assignments are visible in the networkBindings
section of\n\t\t\t\tDescribeTasks API responses.
The set of network configuration parameters to provide the Container Network Interface\n (CNI) plugin, specified as key-value pairs.
\n\n IgnoredUID
- (Required) The user ID (UID) of the proxy\n container as defined by the user
parameter in a container\n definition. This is used to ensure the proxy ignores its own traffic. If\n IgnoredGID
is specified, this field can be empty.
\n IgnoredGID
- (Required) The group ID (GID) of the proxy\n container as defined by the user
parameter in a container\n definition. This is used to ensure the proxy ignores its own traffic. If\n IgnoredUID
is specified, this field can be empty.
\n AppPorts
- (Required) The list of ports that the\n application uses. Network traffic to these ports is forwarded to the\n ProxyIngressPort
and ProxyEgressPort
.
\n ProxyIngressPort
- (Required) Specifies the port that\n incoming traffic to the AppPorts
is directed to.
\n ProxyEgressPort
- (Required) Specifies the port that\n outgoing traffic from the AppPorts
is directed to.
\n EgressIgnoredPorts
- (Required) The egress traffic going to\n the specified ports is ignored and not redirected to the\n ProxyEgressPort
. It can be an empty list.
\n EgressIgnoredIPs
- (Required) The egress traffic going to\n the specified IP addresses is ignored and not redirected to the\n ProxyEgressPort
. It can be an empty list.
The set of network configuration parameters to provide the Container Network Interface\n\t\t\t(CNI) plugin, specified as key-value pairs.
\n\t\t\n IgnoredUID
- (Required) The user ID (UID) of the proxy\n\t\t\t\t\tcontainer as defined by the user
parameter in a container\n\t\t\t\t\tdefinition. This is used to ensure the proxy ignores its own traffic. If\n\t\t\t\t\t\tIgnoredGID
is specified, this field can be empty.
\n IgnoredGID
- (Required) The group ID (GID) of the proxy\n\t\t\t\t\tcontainer as defined by the user
parameter in a container\n\t\t\t\t\tdefinition. This is used to ensure the proxy ignores its own traffic. If\n\t\t\t\t\t\tIgnoredUID
is specified, this field can be empty.
\n AppPorts
- (Required) The list of ports that the\n\t\t\t\t\tapplication uses. Network traffic to these ports is forwarded to the\n\t\t\t\t\t\tProxyIngressPort
and ProxyEgressPort
.
\n ProxyIngressPort
- (Required) Specifies the port that\n\t\t\t\t\tincoming traffic to the AppPorts
is directed to.
\n ProxyEgressPort
- (Required) Specifies the port that\n\t\t\t\t\toutgoing traffic from the AppPorts
is directed to.
\n EgressIgnoredPorts
- (Required) The egress traffic going to\n\t\t\t\t\tthe specified ports is ignored and not redirected to the\n\t\t\t\t\t\tProxyEgressPort
. It can be an empty list.
\n EgressIgnoredIPs
- (Required) The egress traffic going to\n\t\t\t\t\tthe specified IP addresses is ignored and not redirected to the\n\t\t\t\t\t\tProxyEgressPort
. It can be an empty list.
The proxy type. The only supported value is APPMESH
.
The name of the container that will serve as the App Mesh proxy.
", "smithy.api#required": {} } - }, - "type": { - "target": "com.amazonaws.ecs#ProxyConfigurationType", - "traits": { - "smithy.api#documentation": "The proxy type. The only supported value is APPMESH
.
The configuration details for the App Mesh proxy.
\nFor tasks using the EC2 launch type, the container instances require at\n least version 1.26.0 of the container agent and at least version 1.26.0-1 of the\n ecs-init
package to enable a proxy configuration. If your container\n instances are launched from the Amazon ECS-optimized AMI version 20190301
or\n later, then they contain the required versions of the container agent and\n ecs-init
. For more information, see Amazon ECS-optimized Linux AMI\n in the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires\n platform version 1.3.0 or later.
" + "smithy.api#documentation": "The configuration details for the App Mesh proxy.
\n\t\tFor tasks using the EC2 launch type, the container instances require at\n\t\t\tleast version 1.26.0 of the container agent and at least version 1.26.0-1 of the\n\t\t\t\tecs-init
package to enable a proxy configuration. If your container\n\t\t\tinstances are launched from the Amazon ECS-optimized AMI version 20190301
or\n\t\t\tlater, then they contain the required versions of the container agent and\n\t\t\t\tecs-init
. For more information, see Amazon ECS-optimized Linux AMI\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
For tasks using the Fargate launch type, the task or service requires\n\t\t\tplatform version 1.3.0 or later.
" } }, "com.amazonaws.ecs#ProxyConfigurationProperties": { @@ -5148,7 +5199,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies an account setting. Account settings are set on a per-Region basis.
\nIf you change the account setting for the root user, the default settings for all of\n the IAM users and roles for which no individual account setting has been specified are\n reset. For more information, see Account\n Settings in the Amazon Elastic Container Service Developer Guide.
\nWhen serviceLongArnFormat
, taskLongArnFormat
, or\n containerInstanceLongArnFormat
are specified, the Amazon Resource Name\n (ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or\n the root user for an account is affected. The opt-in and opt-out account setting must be\n set for each Amazon ECS resource separately. The ARN and resource ID format of a resource\n will be defined by the opt-in status of the IAM user or role that created the resource.\n You must enable this setting to use Amazon ECS features such as resource tagging.
When awsvpcTrunking
is specified, the elastic network interface (ENI)\n limit for any new container instances that support the feature is changed. If\n awsvpcTrunking
is enabled, any new container instances that support the\n feature are launched have the increased ENI limits available to them. For more\n information, see Elastic Network\n Interface Trunking in the Amazon Elastic Container Service Developer Guide.
When containerInsights
is specified, the default setting indicating\n whether CloudWatch Container Insights is enabled for your clusters is changed. If\n containerInsights
is enabled, any new clusters that are created will\n have Container Insights enabled unless you disable it during cluster creation. For more\n information, see CloudWatch\n Container Insights in the Amazon Elastic Container Service Developer Guide.
Modifies an account setting. Account settings are set on a per-Region basis.
\n\t\tIf you change the account setting for the root user, the default settings for all of\n\t\t\tthe IAM users and roles for which no individual account setting has been specified are\n\t\t\treset. For more information, see Account\n\t\t\t\tSettings in the Amazon Elastic Container Service Developer Guide.
\n\t\tWhen serviceLongArnFormat
, taskLongArnFormat
, or\n\t\t\t\tcontainerInstanceLongArnFormat
are specified, the Amazon Resource Name\n\t\t\t(ARN) and resource ID format of the resource type for a specified IAM user, IAM role, or\n\t\t\tthe root user for an account is affected. The opt-in and opt-out account setting must be\n\t\t\tset for each Amazon ECS resource separately. The ARN and resource ID format of a resource\n\t\t\twill be defined by the opt-in status of the IAM user or role that created the resource.\n\t\t\tYou must enable this setting to use Amazon ECS features such as resource tagging.
When awsvpcTrunking
is specified, the elastic network interface (ENI)\n\t\t\tlimit for any new container instances that support the feature is changed. If\n\t\t\t\tawsvpcTrunking
is enabled, any new container instances that support the\n\t\t\tfeature are launched have the increased ENI limits available to them. For more\n\t\t\tinformation, see Elastic Network\n\t\t\t\tInterface Trunking in the Amazon Elastic Container Service Developer Guide.
When containerInsights
is specified, the default setting indicating\n\t\t\twhether CloudWatch Container Insights is enabled for your clusters is changed. If\n\t\t\t\tcontainerInsights
is enabled, any new clusters that are created will\n\t\t\thave Container Insights enabled unless you disable it during cluster creation. For more\n\t\t\tinformation, see CloudWatch\n\t\t\t\tContainer Insights in the Amazon Elastic Container Service Developer Guide.
Modifies an account setting for all IAM users on an account for whom no individual\n account setting has been specified. Account settings are set on a per-Region\n basis.
" + "smithy.api#documentation": "Modifies an account setting for all IAM users on an account for whom no individual\n\t\t\taccount setting has been specified. Account settings are set on a per-Region\n\t\t\tbasis.
" } }, "com.amazonaws.ecs#PutAccountSettingDefaultRequest": { @@ -5180,14 +5231,14 @@ "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The account setting value for the specified principal ARN. Accepted values are\n enabled
and disabled
.
The account setting value for the specified principal ARN. Accepted values are\n\t\t\t\tenabled
and disabled
.
The resource name for which to modify the account setting. If\n serviceLongArnFormat
is specified, the ARN for your Amazon ECS services is\n affected. If taskLongArnFormat
is specified, the ARN and resource ID for\n your Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is\n specified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n awsvpcTrunking
is specified, the ENI limit for your Amazon ECS container\n instances is affected. If containerInsights
is specified, the default\n setting for CloudWatch Container Insights for your clusters is affected.
The resource name for which to modify the account setting. If\n\t\t\t\tserviceLongArnFormat
is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat
is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking
is specified, the ENI limit for your Amazon ECS container\n\t\t\tinstances is affected. If containerInsights
is specified, the default\n\t\t\tsetting for CloudWatch Container Insights for your clusters is affected.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you\n specify the root user, it modifies the account setting for all IAM users, IAM roles, and\n the root user of the account unless an IAM user or role explicitly overrides these\n settings. If this field is omitted, the setting is changed only for the authenticated\n user.
" + "smithy.api#documentation": "The ARN of the principal, which can be an IAM user, IAM role, or the root user. If you\n\t\t\tspecify the root user, it modifies the account setting for all IAM users, IAM roles, and\n\t\t\tthe root user of the account unless an IAM user or role explicitly overrides these\n\t\t\tsettings. If this field is omitted, the setting is changed only for the authenticated\n\t\t\tuser.
" } }, "value": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The account setting value for the specified principal ARN. Accepted values are\n enabled
and disabled
.
The account setting value for the specified principal ARN. Accepted values are\n\t\t\t\tenabled
and disabled
.
The Amazon ECS resource name for which to modify the account setting. If\n serviceLongArnFormat
is specified, the ARN for your Amazon ECS services is\n affected. If taskLongArnFormat
is specified, the ARN and resource ID for\n your Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is\n specified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n awsvpcTrunking
is specified, the elastic network interface (ENI) limit\n for your Amazon ECS container instances is affected. If containerInsights
is\n specified, the default setting for CloudWatch Container Insights for your clusters is\n affected.
The Amazon ECS resource name for which to modify the account setting. If\n\t\t\t\tserviceLongArnFormat
is specified, the ARN for your Amazon ECS services is\n\t\t\taffected. If taskLongArnFormat
is specified, the ARN and resource ID for\n\t\t\tyour Amazon ECS tasks is affected. If containerInstanceLongArnFormat
is\n\t\t\tspecified, the ARN and resource ID for your Amazon ECS container instances is affected. If\n\t\t\t\tawsvpcTrunking
is specified, the elastic network interface (ENI) limit\n\t\t\tfor your Amazon ECS container instances is affected. If containerInsights
is\n\t\t\tspecified, the default setting for CloudWatch Container Insights for your clusters is\n\t\t\taffected.
Create or update an attribute on an Amazon ECS resource. If the attribute does not exist,\n it is created. If the attribute exists, its value is replaced with the specified value.\n To delete an attribute, use DeleteAttributes. For more information,\n see Attributes in the\n Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Create or update an attribute on an Amazon ECS resource. If the attribute does not exist,\n\t\t\tit is created. If the attribute exists, its value is replaced with the specified value.\n\t\t\tTo delete an attribute, use DeleteAttributes. For more information,\n\t\t\tsee Attributes in the\n\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#PutAttributesRequest": { @@ -5269,14 +5320,14 @@ "attributes": { "target": "com.amazonaws.ecs#Attributes", "traits": { - "smithy.api#documentation": "The attributes to apply to your resource. You can specify up to 10 custom attributes\n per resource. You can specify up to 10 attributes in a single call.
", + "smithy.api#documentation": "The attributes to apply to your resource. You can specify up to 10 custom attributes\n\t\t\tper resource. You can specify up to 10 attributes in a single call.
", "smithy.api#required": {} } }, "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply\n attributes. If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that contains the resource to apply\n\t\t\tattributes. If you do not specify a cluster, the default cluster is assumed.
" } } } @@ -5321,30 +5372,30 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the available capacity providers and the default capacity provider strategy\n for a cluster.
\nYou must specify both the available capacity providers and a default capacity provider\n strategy for the cluster. If the specified cluster has existing capacity providers\n associated with it, you must specify all existing capacity providers in addition to any\n new ones you want to add. Any existing capacity providers associated with a cluster that\n are omitted from a PutClusterCapacityProviders API call will be\n disassociated with the cluster. You can only disassociate an existing capacity provider\n from a cluster if it's not being used by any existing tasks.
\nWhen creating a service or running a task on a cluster, if no capacity provider or\n launch type is specified, then the cluster's default capacity provider strategy is used.\n It is recommended to define a default capacity provider strategy for your cluster,\n however you may specify an empty array ([]
) to bypass defining a default\n strategy.
Modifies the available capacity providers and the default capacity provider strategy\n\t\t\tfor a cluster.
\n\t\tYou must specify both the available capacity providers and a default capacity provider\n\t\t\tstrategy for the cluster. If the specified cluster has existing capacity providers\n\t\t\tassociated with it, you must specify all existing capacity providers in addition to any\n\t\t\tnew ones you want to add. Any existing capacity providers associated with a cluster that\n\t\t\tare omitted from a PutClusterCapacityProviders API call will be\n\t\t\tdisassociated with the cluster. You can only disassociate an existing capacity provider\n\t\t\tfrom a cluster if it's not being used by any existing tasks.
\n\t\tWhen creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified, then the cluster's default capacity provider strategy is used.\n\t\t\tIt is recommended to define a default capacity provider strategy for your cluster,\n\t\t\thowever you may specify an empty array ([]
) to bypass defining a default\n\t\t\tstrategy.
The capacity provider strategy to use by default for the cluster.
\nWhen creating a service or running a task on a cluster, if no capacity provider or\n launch type is specified then the default capacity provider strategy for the cluster is\n used.
\nA capacity provider strategy consists of one or more capacity providers along with the\n base
and weight
to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE
or\n UPDATING
status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.
The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider\n settings for. If you do not specify a cluster, the default cluster is assumed.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider\n\t\t\tsettings for. If you do not specify a cluster, the default cluster is assumed.
", "smithy.api#required": {} } }, "capacityProviders": { "target": "com.amazonaws.ecs#StringList", "traits": { - "smithy.api#documentation": "The name of one or more capacity providers to associate with the cluster.
\nIf specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.
The name of one or more capacity providers to associate with the cluster.
\n\t\tIf specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\n\t\tTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n\t\t\t\tFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The capacity provider strategy to use by default for the cluster.
\n\t\tWhen creating a service or running a task on a cluster, if no capacity provider or\n\t\t\tlaunch type is specified then the default capacity provider strategy for the cluster is\n\t\t\tused.
\n\t\tA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase
and weight
to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE
or\n\t\t\t\tUPDATING
status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\n\t\tTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n\t\t\t\tFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nRegisters an EC2\n instance into the specified cluster. This instance becomes available to place containers\n on.
" + "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nRegisters an EC2\n\t\t\tinstance into the specified cluster. This instance becomes available to place containers\n\t\t\ton.
" } }, "com.amazonaws.ecs#RegisterContainerInstanceRequest": { "type": "structure", "members": { - "versionInfo": { - "target": "com.amazonaws.ecs#VersionInfo", - "traits": { - "smithy.api#documentation": "The version information for the Amazon ECS container agent and Docker daemon running on the\n container instance.
" - } - }, - "tags": { - "target": "com.amazonaws.ecs#Tags", - "traits": { - "smithy.api#documentation": "The metadata that you apply to the container instance to help you categorize and\n organize them. Each tag consists of a key and an optional value, both of which you\n define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The devices that are available on the container instance. The only supported device\n type is a GPU.
" + "smithy.api#documentation": "The devices that are available on the container instance. The only supported device\n\t\t\ttype is a GPU.
" } }, - "cluster": { + "instanceIdentityDocument": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container\n instance. If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The instance identity document for the EC2 instance to register. This document can be\n\t\t\tfound by running the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/document/
\n\t\t
The instance identity document signature for the EC2 instance to register. This\n signature can be found by running the following command from the instance: curl\n http://169.254.169.254/latest/dynamic/instance-identity/signature/
\n
The instance identity document signature for the EC2 instance to register. This\n\t\t\tsignature can be found by running the following command from the instance: curl\n\t\t\t\thttp://169.254.169.254/latest/dynamic/instance-identity/signature/
\n\t\t
The resources available on the instance.
" } }, - "containerInstanceArn": { - "target": "com.amazonaws.ecs#String", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "The ARN of the container instance (if it was previously registered).
" + "smithy.api#documentation": "The metadata that you apply to the container instance to help you categorize and\n\t\t\torganize them. Each tag consists of a key and an optional value, both of which you\n\t\t\tdefine.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The instance identity document for the EC2 instance to register. This document can be\n found by running the following command from the instance: curl\n http://169.254.169.254/latest/dynamic/instance-identity/document/
\n
The ARN of the container instance (if it was previously registered).
" } }, "attributes": { @@ -5437,6 +5476,18 @@ "traits": { "smithy.api#documentation": "The container instance attributes that this container instance supports.
" } + }, + "versionInfo": { + "target": "com.amazonaws.ecs#VersionInfo", + "traits": { + "smithy.api#documentation": "The version information for the Amazon ECS container agent and Docker daemon running on the\n\t\t\tcontainer instance.
" + } + }, + "cluster": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster with which to register your container\n\t\t\tinstance. If you do not specify a cluster, the default cluster is assumed.
" + } } } }, @@ -5471,7 +5522,7 @@ } ], "traits": { - "smithy.api#documentation": "Registers a new task definition from the supplied family
and\n containerDefinitions
. Optionally, you can add data volumes to your\n containers with the volumes
parameter. For more information about task\n definition parameters and defaults, see Amazon ECS Task\n Definitions in the Amazon Elastic Container Service Developer Guide.
You can specify an IAM role for your task with the taskRoleArn
parameter.\n When you specify an IAM role for a task, its containers can then use the latest versions\n of the AWS CLI or SDKs to make API requests to the AWS services that are specified in\n the IAM policy associated with the role. For more information, see IAM\n Roles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition\n with the networkMode
parameter. The available network modes correspond to\n those described in Network\n settings in the Docker run reference. If you specify the awsvpc
\n network mode, the task is allocated an elastic network interface, and you must specify a\n NetworkConfiguration when you create a service or run a task with\n the task definition. For more information, see Task Networking\n in the Amazon Elastic Container Service Developer Guide.
Registers a new task definition from the supplied family
and\n\t\t\t\tcontainerDefinitions
. Optionally, you can add data volumes to your\n\t\t\tcontainers with the volumes
parameter. For more information about task\n\t\t\tdefinition parameters and defaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.
You can specify an IAM role for your task with the taskRoleArn
parameter.\n\t\t\tWhen you specify an IAM role for a task, its containers can then use the latest versions\n\t\t\tof the AWS CLI or SDKs to make API requests to the AWS services that are specified in\n\t\t\tthe IAM policy associated with the role. For more information, see IAM\n\t\t\t\tRoles for Tasks in the Amazon Elastic Container Service Developer Guide.
You can specify a Docker networking mode for the containers in your task definition\n\t\t\twith the networkMode
parameter. The available network modes correspond to\n\t\t\tthose described in Network\n\t\t\t\tsettings in the Docker run reference. If you specify the awsvpc
\n\t\t\tnetwork mode, the task is allocated an elastic network interface, and you must specify a\n\t\t\t\tNetworkConfiguration when you create a service or run a task with\n\t\t\tthe task definition. For more information, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
You must specify a family
for a task definition, which allows you to\n track multiple versions of the same task definition. The family
is used as\n a name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
You must specify a family
for a task definition, which allows you to\n\t\t\ttrack multiple versions of the same task definition. The family
is used as\n\t\t\ta name for your task definition. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed.
The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can\n assume. All containers in this task are granted the permissions that are specified in\n this role. For more information, see IAM Roles for\n Tasks in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the IAM role that containers in this task can\n\t\t\tassume. All containers in this task are granted the permissions that are specified in\n\t\t\tthis role. For more information, see IAM Roles for\n\t\t\t\tTasks in the Amazon Elastic Container Service Developer Guide.
" } }, "volumes": { "target": "com.amazonaws.ecs#VolumeList", "traits": { - "smithy.api#documentation": "A list of volume definitions in JSON format that containers in your task may\n use.
" + "smithy.api#documentation": "A list of volume definitions in JSON format that containers in your task may\n\t\t\tuse.
" } }, "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The number of CPU units used by the task. It can be expressed as an integer using CPU\n units, for example 1024
, or as a string using vCPUs, for example 1\n vCPU
or 1 vcpu
, in a task definition. String values are\n converted to an integer indicating the CPU units when the task definition is\n registered.
Task-level CPU and memory parameters are ignored for Windows containers. We\n recommend specifying container-level resources for Windows containers.
\nIf you are using the EC2 launch type, this field is optional. Supported\n values are between 128
CPU units (0.125
vCPUs) and\n 10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you\n must use one of the following values, which determines your range of supported values\n for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The number of CPU units used by the task. It can be expressed as an integer using CPU\n\t\t\tunits, for example 1024
, or as a string using vCPUs, for example 1\n\t\t\t\tvCPU
or 1 vcpu
, in a task definition. String values are\n\t\t\tconverted to an integer indicating the CPU units when the task definition is\n\t\t\tregistered.
Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.
\n\t\tIf you are using the EC2 launch type, this field is optional. Supported\n\t\t\tvalues are between 128
CPU units (0.125
vCPUs) and\n\t\t\t\t10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The launch type required by the task. If no value is specified, it defaults to\n EC2
.
The process namespace to use for the containers in the task. The valid\n values are host
or task
. If host
\n is specified, then all containers within the tasks that specified the\n host
PID mode on the same container instance share the\n same process namespace with the host Amazon EC2 instance. If task
is\n specified, all containers within the specified task share the same\n process namespace. If no value is specified, the default is a private\n namespace. For more information, see PID settings in the Docker run\n reference.
If the host
PID mode is used, be aware that there is a\n heightened risk of undesired process namespace expose. For more\n information, see Docker\n security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
\nThe task launch type that Amazon ECS should validate the task definition against. This\n\t\t\tensures that the task definition parameters are compatible with the specified launch\n\t\t\ttype. If no value is specified, it defaults to EC2
.
An array of placement constraint objects to use for the task. You can specify a\n maximum of 10 constraints per task (this limit includes constraints in the task\n definition and those specified at runtime).
" + "smithy.api#documentation": "The amount of memory (in MiB) used by the task. It can be expressed as an integer\n\t\t\tusing MiB, for example 1024
, or as a string using GB, for example\n\t\t\t\t1GB
or 1 GB
, in a task definition. String values are\n\t\t\tconverted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.
Task-level CPU and memory parameters are ignored for Windows containers. We\n\t\t\t\trecommend specifying container-level resources for Windows containers.
\n\t\tIf using the EC2 launch type, this field is optional.
\n\t\tIf using the Fargate launch type, this field is required and you must\n\t\t\tuse one of the following values, which determines your range of supported values for the\n\t\t\t\tcpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4 vCPU)
The Docker networking mode to use for the containers in the task. The valid values are\n none
, bridge
, awsvpc
, and host
.\n The default Docker network mode is bridge
. If you are using the\n Fargate launch type, the awsvpc
network mode is required. If\n you are using the EC2 launch type, any network mode can be used. If the network\n mode is set to none
, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host
and awsvpc
network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host
\n network mode) or the attached elastic network interface port (for the\n awsvpc
network mode), so you cannot take advantage of dynamic host port\n mappings.
If the network mode is awsvpc
, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the\n ecs-init
package, or AWS Fargate infrastructure support the\n awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you\n register a task definition with Windows containers, you must not specify a network mode.\n If you use the console to register a task definition with Windows containers, you must\n choose the
network mode object.
For more information, see Network\n settings in the Docker run reference.
" } }, - "inferenceAccelerators": { - "target": "com.amazonaws.ecs#InferenceAccelerators", + "placementConstraints": { + "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraints", "traits": { - "smithy.api#documentation": "The Elastic Inference accelerators to use for the containers in the task.
" + "smithy.api#documentation": "An array of placement constraint objects to use for the task. You can specify a\n\t\t\tmaximum of 10 constraints per task (this limit includes constraints in the task\n\t\t\tdefinition and those specified at runtime).
" } }, "containerDefinitions": { "target": "com.amazonaws.ecs#ContainerDefinitions", "traits": { - "smithy.api#documentation": "A list of container definitions in JSON format that describe the different containers\n that make up your task.
", + "smithy.api#documentation": "A list of container definitions in JSON format that describe the different containers\n\t\t\tthat make up your task.
", "smithy.api#required": {} } }, - "memory": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The amount of memory (in MiB) used by the task. It can be expressed as an integer\n using MiB, for example 1024
, or as a string using GB, for example\n 1GB
or 1 GB
, in a task definition. String values are\n converted to an integer indicating the MiB when the task definition is\n registered.
Task-level CPU and memory parameters are ignored for Windows containers. We\n recommend specifying container-level resources for Windows containers.
\nIf using the EC2 launch type, this field is optional.
\nIf using the Fargate launch type, this field is required and you must\n use one of the following values, which determines your range of supported values for the\n cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4 vCPU)
The IPC resource namespace to use for the containers in the task. The valid values are\n host
, task
, or none
. If host
is\n specified, then all containers within the tasks that specified the host
IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task
is specified, all containers within the specified task\n share the same IPC resources. If none
is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.
If you are setting namespaced kernel parameters using systemControls
for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related\n systemControls
are not supported.
For tasks that use the task
IPC mode, IPC namespace related\n systemControls
will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
\nThe process namespace to use for the containers in the task. The valid\n values are host
or task
. If host
\n is specified, then all containers within the tasks that specified the\n host
PID mode on the same container instance share the\n same process namespace with the host Amazon EC2 instance. If task
is\n specified, all containers within the specified task share the same\n process namespace. If no value is specified, the default is a private\n namespace. For more information, see PID settings in the Docker run\n reference.
If the host
PID mode is used, be aware that there is a\n heightened risk of undesired process namespace expose. For more\n information, see Docker\n security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
\nThe Elastic Inference accelerators to use for the containers in the task.
" } }, "executionRoleArn": { @@ -5563,7 +5614,7 @@ "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "The metadata that you apply to the task definition to help you categorize and organize\n them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the task definition to help you categorize and organize\n\t\t\tthem. Each tag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The full description of the registered task definition.
" - } - }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { "smithy.api#documentation": "The list of tags associated with the task definition.
" } + }, + "taskDefinition": { + "target": "com.amazonaws.ecs#TaskDefinition", + "traits": { + "smithy.api#documentation": "The full description of the registered task definition.
" + } } } }, @@ -5591,7 +5642,7 @@ "credentialsParameter": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the secret containing the private repository\n credentials.
\nWhen you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the\n same Region as the task that you are launching then you can use either the full ARN\n or the name of the secret. When you are using the AWS Management Console, you must specify the\n full ARN of the secret.
\nThe Amazon Resource Name (ARN) of the secret containing the private repository\n\t\t\tcredentials.
\n\t\tWhen you are using the Amazon ECS API, AWS CLI, or AWS SDK, if the secret exists in the\n\t\t\t\tsame Region as the task that you are launching then you can use either the full ARN\n\t\t\t\tor the name of the secret. When you are using the AWS Management Console, you must specify the\n\t\t\t\tfull ARN of the secret.
\n\t\tWhen the doubleValue
type is set, the value of the resource must be a\n\t\t\tdouble precision floating-point type.
The name of the resource, such as CPU
, MEMORY
,\n PORTS
, PORTS_UDP
, or a user-defined resource.
The name of the resource, such as CPU
, MEMORY
,\n\t\t\t\tPORTS
, PORTS_UDP
, or a user-defined resource.
When the integerValue
type is set, the value of the resource must be an\n integer.
When the doubleValue
type is set, the value of the resource must be a\n double precision floating-point type.
The type of the resource, such as INTEGER
, DOUBLE
,\n LONG
, or STRINGSET
.
When the integerValue
type is set, the value of the resource must be an\n\t\t\tinteger.
When the stringSetValue
type is set, the value of the resource must be a\n string type.
When the stringSetValue
type is set, the value of the resource must be a\n\t\t\tstring type.
When the longValue
type is set, the value of the resource must be an\n extended precision floating-point type.
When the longValue
type is set, the value of the resource must be an\n\t\t\textended precision floating-point type.
The type of the resource, such as INTEGER
, DOUBLE
,\n\t\t\t\tLONG
, or STRINGSET
.
The value for the specified resource type.
\nIf the GPU
type is used, the value is the number of physical\n GPUs
the Amazon ECS container agent will reserve for the container. The\n number of GPUs reserved for all containers in a task should not exceed the number of\n available GPUs on the container instance the task is launched on.
If the InferenceAccelerator
type is used, the value
should\n match the deviceName
for an InferenceAccelerator\n specified in a task definition.
The value for the specified resource type.
\n\t\tIf the GPU
type is used, the value is the number of physical\n\t\t\t\tGPUs
the Amazon ECS container agent will reserve for the container. The\n\t\t\tnumber of GPUs reserved for all containers in a task should not exceed the number of\n\t\t\tavailable GPUs on the container instance the task is launched on.
If the InferenceAccelerator
type is used, the value
should\n\t\t\tmatch the deviceName
for an InferenceAccelerator\n\t\t\tspecified in a task definition.
The type of resource to assign to a container. The supported values are\n GPU
or InferenceAccelerator
.
The type of resource to assign to a container. The supported values are\n\t\t\t\tGPU
or InferenceAccelerator
.
The type and amount of a resource to assign to a container. The supported resource\n types are GPUs and Elastic Inference accelerators. For more information, see Working with\n GPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the\n Amazon Elastic Container Service Developer Guide\n
" + "smithy.api#documentation": "The type and amount of a resource to assign to a container. The supported resource\n\t\t\ttypes are GPUs and Elastic Inference accelerators. For more information, see Working with\n\t\t\t\tGPUs on Amazon ECS or Working with Amazon Elastic Inference on Amazon ECS in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide\n
" } }, "com.amazonaws.ecs#ResourceRequirements": { @@ -5761,77 +5812,83 @@ } ], "traits": { - "smithy.api#documentation": "Starts a new task using the specified task definition.
\nYou can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n tasks using placement constraints and placement strategies. For more information, see\n Scheduling Tasks in the\n Amazon Elastic Container Service Developer Guide.
\nAlternatively, you can use StartTask to use your own scheduler or\n place tasks manually on specific container instances.
\nThe Amazon ECS API follows an eventual consistency model, due to the distributed nature of\n the system supporting the API. This means that the result of an API command you run that\n affects your Amazon ECS resources might not be immediately visible to all subsequent commands\n you run. Keep this in mind when you carry out an API command that immediately follows a\n previous API command.
\nTo manage eventual consistency, you can do the following:
\nConfirm the state of the resource before you run a command to modify it. Run\n the DescribeTasks command using an exponential backoff algorithm to ensure that\n you allow enough time for the previous command to propagate through the system.\n To do this, run the DescribeTasks command repeatedly, starting with a couple of\n seconds of wait time and increasing gradually up to five minutes of wait\n time.
\nAdd wait time between subsequent commands, even if the DescribeTasks command\n returns an accurate response. Apply an exponential backoff algorithm starting\n with a couple of seconds of wait time, and increase gradually up to about five\n minutes of wait time.
\nStarts a new task using the specified task definition.
\n\t\tYou can allow Amazon ECS to place tasks for you, or you can customize how Amazon ECS places\n\t\t\ttasks using placement constraints and placement strategies. For more information, see\n\t\t\t\tScheduling Tasks in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n\t\tAlternatively, you can use StartTask to use your own scheduler or\n\t\t\tplace tasks manually on specific container instances.
\n\t\tThe Amazon ECS API follows an eventual consistency model, due to the distributed nature of\n\t\t\tthe system supporting the API. This means that the result of an API command you run that\n\t\t\taffects your Amazon ECS resources might not be immediately visible to all subsequent commands\n\t\t\tyou run. Keep this in mind when you carry out an API command that immediately follows a\n\t\t\tprevious API command.
\n\t\tTo manage eventual consistency, you can do the following:
\n\t\tConfirm the state of the resource before you run a command to modify it. Run\n\t\t\t\t\tthe DescribeTasks command using an exponential backoff algorithm to ensure that\n\t\t\t\t\tyou allow enough time for the previous command to propagate through the system.\n\t\t\t\t\tTo do this, run the DescribeTasks command repeatedly, starting with a couple of\n\t\t\t\t\tseconds of wait time and increasing gradually up to five minutes of wait\n\t\t\t\t\ttime.
\n\t\t\tAdd wait time between subsequent commands, even if the DescribeTasks command\n\t\t\t\t\treturns an accurate response. Apply an exponential backoff algorithm starting\n\t\t\t\t\twith a couple of seconds of wait time, and increase gradually up to about five\n\t\t\t\t\tminutes of wait time.
\n\t\t\tThe platform version the task should run. A platform version is only specified for\n\t\t\ttasks using the Fargate launch type. If one is not specified, the\n\t\t\t\tLATEST
platform version is used by default. For more information, see\n\t\t\t\tAWS Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
The family
and revision
(family:revision
) or\n full ARN of the task definition to run. If a revision
is not specified,\n the latest ACTIVE
revision is used.
The family
and revision
(family:revision
) or\n\t\t\tfull ARN of the task definition to run. If a revision
is not specified,\n\t\t\tthe latest ACTIVE
revision is used.
The network configuration for the task. This parameter is required for task\n definitions that use the awsvpc
network mode to receive their own elastic\n network interface, and it is not supported for other network modes. For more\n information, see Task Networking\n in the Amazon Elastic Container Service Developer Guide.
The launch type on which to run your task. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.
\n\t\tIf a launchType
is specified, the capacityProviderStrategy
\n\t\t\tparameter must be omitted.
The platform version the task should run. A platform version is only specified for\n tasks using the Fargate launch type. If one is not specified, the\n LATEST
platform version is used by default. For more information, see\n AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.
The capacity provider strategy to use for the task.
\n\t\tA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase
and weight
to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE
or\n\t\t\t\tUPDATING
status can be used.
If a capacityProviderStrategy
is specified, the launchType
\n\t\t\tparameter must be omitted. If no capacityProviderStrategy
or\n\t\t\t\tlaunchType
is specified, the\n\t\t\t\tdefaultCapacityProviderStrategy
for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\n\t\tTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n\t\t\t\tFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.
" } }, "propagateTags": { "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "smithy.api#documentation": "Specifies whether to propagate the tags from the task definition to the task. If no\n value is specified, the tags are not propagated. Tags can only be propagated to the task\n during task creation. To add tags to a task after task creation, use the TagResource API action.
\nAn error will be received if you specify the SERVICE
option when\n running a task.
Specifies whether to propagate the tags from the task definition to the task. If no\n\t\t\tvalue is specified, the tags are not propagated. Tags can only be propagated to the task\n\t\t\tduring task creation. To add tags to a task after task creation, use the TagResource API action.
\n\t\tAn error will be received if you specify the SERVICE
option when\n\t\t\t\trunning a task.
The name of the task group to associate with the task. The default value is the family\n name of the task definition (for example, family:my-family-name).
" + "smithy.api#documentation": "The placement strategy objects to use for the task. You can specify a maximum of five\n\t\t\tstrategy rules per task.
" } }, - "placementStrategy": { - "target": "com.amazonaws.ecs#PlacementStrategies", + "group": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The placement strategy objects to use for the task. You can specify a maximum of five\n strategy rules per task.
" + "smithy.api#documentation": "The name of the task group to associate with the task. The default value is the family\n\t\t\tname of the task definition (for example, family:my-family-name).
" } }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", + "enableECSManagedTags": { + "target": "com.amazonaws.ecs#Boolean", "traits": { - "smithy.api#documentation": "The launch type on which to run your task. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.
\nIf a launchType
is specified, the capacityProviderStrategy
\n parameter must be omitted.
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see\n\t\t\t\tTagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" } }, "placementConstraints": { "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "An array of placement constraint objects to use for the task. You can specify up to 10\n constraints per task (including constraints in the task definition and those specified\n at runtime).
" + "smithy.api#documentation": "An array of placement constraint objects to use for the task. You can specify up to 10\n\t\t\tconstraints per task (including constraints in the task definition and those specified\n\t\t\tat runtime).
" } }, - "capacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "The capacity provider strategy to use for the task.
\nA capacity provider strategy consists of one or more capacity providers along with the\n base
and weight
to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE
or\n UPDATING
status can be used.
If a capacityProviderStrategy
is specified, the launchType
\n parameter must be omitted. If no capacityProviderStrategy
or\n launchType
is specified, the\n defaultCapacityProviderStrategy
for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.
The PutClusterCapacityProviders API operation is used to update the\n list of available capacity providers for a cluster after the cluster is created.
" + "smithy.api#documentation": "The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The number of instantiations of the specified task to place on your cluster. You can\n specify up to 10 tasks per call.
" + "smithy.api#documentation": "The number of instantiations of the specified task to place on your cluster. You can\n\t\t\tspecify up to 10 tasks per call.
" } }, - "enableECSManagedTags": { - "target": "com.amazonaws.ecs#Boolean", + "overrides": { + "target": "com.amazonaws.ecs#TaskOverride", "traits": { - "smithy.api#documentation": "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see\n Tagging Your Amazon ECS\n Resources in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it should receive. You can override the\n\t\t\tdefault command for a container (that is specified in the task definition or Docker\n\t\t\timage) with a command
override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\t\tformatting characters of the override structure.
\n\t\tThe reference ID to use for the task.
" } }, - "cluster": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.\n If you do not specify a cluster, the default cluster is assumed.
" - } - }, "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "An optional tag specified when a task is started. For example, if you automatically\n trigger a task to run a batch process job, you could apply a unique identifier for that\n job to your task with the startedBy
parameter. You can then identify which\n tasks belong to that job by filtering the results of a ListTasks call\n with the startedBy
value. Up to 36 letters (uppercase and lowercase),\n numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter\n contains the deployment ID of the service that starts it.
An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy
parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call\n\t\t\twith the startedBy
value. Up to 36 letters (uppercase and lowercase),\n\t\t\tnumbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter\n\t\t\tcontains the deployment ID of the service that starts it.
A list of container overrides in JSON format that specify the name of a container in\n the specified task definition and the overrides it should receive. You can override the\n default command for a container (that is specified in the task definition or Docker\n image) with a command
override. You can also override existing environment\n variables (that are specified in the task definition or Docker image) on a container or\n add new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON\n formatting characters of the override structure.
\nThe network configuration for the task. This parameter is required for task\n\t\t\tdefinitions that use the awsvpc
network mode to receive their own elastic\n\t\t\tnetwork interface, and it is not supported for other network modes. For more\n\t\t\tinformation, see Task Networking\n\t\t\tin the Amazon Elastic Container Service Developer Guide.
The metadata that you apply to the task to help you categorize and organize them. Each\n tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } } } @@ -5878,7 +5929,7 @@ "tasks": { "target": "com.amazonaws.ecs#Tasks", "traits": { - "smithy.api#documentation": "A full description of the tasks that were run. The tasks that were successfully placed\n on your cluster are described here.
" + "smithy.api#documentation": "A full description of the tasks that were run. The tasks that were successfully placed\n\t\t\ton your cluster are described here.
" } } } @@ -5886,21 +5937,21 @@ "com.amazonaws.ecs#Scale": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.ecs#Double", - "traits": { - "smithy.api#documentation": "The value, specified as a percent total of a service's desiredCount
, to\n scale the task set. Accepted values are numbers between 0 and 100.
The unit of measure for the scale value.
" } + }, + "value": { + "target": "com.amazonaws.ecs#Double", + "traits": { + "smithy.api#documentation": "The value, specified as a percent total of a service's desiredCount
, to\n\t\t\tscale the task set. Accepted values are numbers between 0 and 100.
A floating-point percentage of the desired number of tasks to place and keep running\n in the task set.
" + "smithy.api#documentation": "A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.
" } }, "com.amazonaws.ecs#ScaleUnit": { @@ -5957,13 +6008,13 @@ "valueFrom": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The secret to expose to the container. The supported values are either the full ARN of\n the AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
\nIf the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you\n are launching, then you can use either the full ARN or name of the parameter. If the\n parameter exists in a different Region, then the full ARN must be specified.
\nThe secret to expose to the container. The supported values are either the full ARN of\n\t\t\tthe AWS Secrets Manager secret or the full ARN of the parameter in the AWS Systems Manager Parameter Store.
\n\t\tIf the AWS Systems Manager Parameter Store parameter exists in the same Region as the task you\n\t\t\t\tare launching, then you can use either the full ARN or name of the parameter. If the\n\t\t\t\tparameter exists in a different Region, then the full ARN must be specified.
\n\t\tAn object representing the secret to expose to your container. Secrets can be exposed\n to a container in the following ways:
\nTo inject sensitive data into your containers as environment variables, use\n the secrets
container definition parameter.
To reference sensitive information in the log configuration of a container,\n use the secretOptions
container definition parameter.
For more information, see Specifying\n Sensitive Data in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "An object representing the secret to expose to your container. Secrets can be exposed\n\t\t\tto a container in the following ways:
\n\t\tTo inject sensitive data into your containers as environment variables, use\n\t\t\t\t\tthe secrets
container definition parameter.
To reference sensitive information in the log configuration of a container,\n\t\t\t\t\tuse the secretOptions
container definition parameter.
For more information, see Specifying\n\t\t\t\tSensitive Data in the Amazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#SecretList": { @@ -5987,178 +6038,178 @@ "com.amazonaws.ecs#Service": { "type": "structure", "members": { - "placementStrategy": { - "target": "com.amazonaws.ecs#PlacementStrategies", + "taskSets": { + "target": "com.amazonaws.ecs#TaskSets", "traits": { - "smithy.api#documentation": "The placement strategy that determines how tasks for the service are placed.
" + "smithy.api#documentation": "Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL
\n\t\t\tdeployment. An Amazon ECS task set includes details such as the desired number of tasks, how\n\t\t\tmany tasks are running, and whether the task set serves production traffic.
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL
\n deployment. An Amazon ECS task set includes details such as the desired number of tasks, how\n many tasks are running, and whether the task set serves production traffic.
The placement strategy that determines how tasks for the service are placed.
" } }, "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The status of the service. The valid values are ACTIVE
,\n DRAINING
, or INACTIVE
.
The status of the service. The valid values are ACTIVE
,\n\t\t\t\tDRAINING
, or INACTIVE
.
The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc
networking mode.
A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the\n\t\t\tcontainer name (as it appears in a container definition), and the container port to\n\t\t\taccess from the load balancer.
" } }, - "schedulingStrategy": { - "target": "com.amazonaws.ecs#SchedulingStrategy", + "propagateTags": { + "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "smithy.api#documentation": "The scheduling strategy to use for the service. For more information, see Services.
\nThere are two service scheduler strategies available:
\n\n REPLICA
-The replica scheduling strategy places and\n maintains the desired number of tasks across your cluster. By default, the\n service scheduler spreads tasks across Availability Zones. You can use task\n placement strategies and constraints to customize task placement\n decisions.
\n DAEMON
-The daemon scheduling strategy deploys exactly one\n task on each active container instance that meets all of the task placement\n constraints that you specify in your cluster. The service scheduler also\n evaluates the task placement constraints for running tasks and will stop tasks\n that do not meet the placement constraints.
Fargate tasks do not support the DAEMON
\n scheduling strategy.
Specifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttask. If no value is specified, the tags are not propagated.
" } }, - "serviceName": { + "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within\n a cluster, but you can have similarly named services in multiple clusters within a\n Region or across multiple Regions.
" + "smithy.api#documentation": "The task definition to use for tasks in the service. This value is specified when the\n\t\t\tservice is created with CreateService, and it can be modified with\n\t\t\t\tUpdateService.
" } }, - "enableECSManagedTags": { - "target": "com.amazonaws.ecs#Boolean", + "platformVersion": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more\n information, see Tagging Your Amazon ECS\n Resources in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The platform version on which to run your service. A platform version is only\n\t\t\tspecified for tasks using the Fargate launch type. If one is not\n\t\t\tspecified, the LATEST
platform version is used by default. For more\n\t\t\tinformation, see AWS Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
The number of tasks in the cluster that are in the PENDING
state.
The current state of deployments for the service.
" } }, - "runningCount": { - "target": "com.amazonaws.ecs#Integer", + "roleArn": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The number of tasks in the cluster that are in the RUNNING
state.
The ARN of the IAM role associated with the service that allows the Amazon ECS container\n\t\t\tagent to register container instances with an Elastic Load Balancing load balancer.
" } }, - "desiredCount": { - "target": "com.amazonaws.ecs#Integer", + "serviceArn": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The desired number of instantiations of the task definition to keep running on the\n service. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
" + "smithy.api#documentation": "The ARN that identifies the service. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the service, the AWS account ID of the service owner, the service
namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service
.
The Unix timestamp for when the service was created.
" + "smithy.api#documentation": "The principal that created the service.
" } }, - "taskDefinition": { - "target": "com.amazonaws.ecs#String", + "deploymentController": { + "target": "com.amazonaws.ecs#DeploymentController", "traits": { - "smithy.api#documentation": "The task definition to use for tasks in the service. This value is specified when the\n service is created with CreateService, and it can be modified with\n UpdateService.
" + "smithy.api#documentation": "The deployment controller type the service is using. When using the DescribeServices\n\t\t\tAPI, this field is omitted if the service is using the ECS
deployment\n\t\t\tcontroller type.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n Elastic Load Balancing target health checks after a task has first started.
" + "smithy.api#documentation": "The details of the service discovery registries to assign to this service. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.
" } }, - "capacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "deploymentConfiguration": { + "target": "com.amazonaws.ecs#DeploymentConfiguration", "traits": { - "smithy.api#documentation": "The capacity provider strategy associated with the service.
" + "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.
" } }, - "placementConstraints": { - "target": "com.amazonaws.ecs#PlacementConstraints", + "clusterArn": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The placement constraints for the tasks in the service.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the cluster that hosts the service.
" } }, - "events": { - "target": "com.amazonaws.ecs#ServiceEvents", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "The event stream for your service. A maximum of 100 of the latest events are\n displayed.
" + "smithy.api#documentation": "The metadata that you apply to the service to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The launch type on which your service is running. If no value is specified, it will\n default to EC2
. Valid values include EC2
and\n FARGATE
. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.
Specifies whether to enable Amazon ECS managed tags for the tasks in the service. For more\n\t\t\tinformation, see Tagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" } }, - "serviceArn": { - "target": "com.amazonaws.ecs#String", + "runningCount": { + "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "The ARN that identifies the service. The ARN contains the arn:aws:ecs
namespace, followed by the Region of the service, the AWS account ID of the service owner, the service
namespace, and then the service name. For example, arn:aws:ecs:region:012345678910:service/my-service
.
The number of tasks in the cluster that are in the RUNNING
state.
The details of the service discovery registries to assign to this service. For more\n information, see Service\n Discovery.
" + "smithy.api#documentation": "The number of tasks in the cluster that are in the PENDING
state.
The ARN of the IAM role associated with the service that allows the Amazon ECS container\n agent to register container instances with an Elastic Load Balancing load balancer.
" + "smithy.api#documentation": "The desired number of instantiations of the task definition to keep running on the\n\t\t\tservice. This value is specified when the service is created with CreateService, and it can be modified with UpdateService.
" } }, - "loadBalancers": { - "target": "com.amazonaws.ecs#LoadBalancers", + "placementConstraints": { + "target": "com.amazonaws.ecs#PlacementConstraints", "traits": { - "smithy.api#documentation": "A list of Elastic Load Balancing load balancer objects, containing the load balancer name, the\n container name (as it appears in a container definition), and the container port to\n access from the load balancer.
" + "smithy.api#documentation": "The placement constraints for the tasks in the service.
" } }, - "propagateTags": { - "target": "com.amazonaws.ecs#PropagateTags", + "createdAt": { + "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "Specifies whether to propagate the tags from the task definition or the service to the\n task. If no value is specified, the tags are not propagated.
" + "smithy.api#documentation": "The Unix timestamp for when the service was created.
" } }, - "createdBy": { - "target": "com.amazonaws.ecs#String", + "capacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "The principal that created the service.
" + "smithy.api#documentation": "The capacity provider strategy associated with the service.
" } }, - "deploymentController": { - "target": "com.amazonaws.ecs#DeploymentController", + "healthCheckGracePeriodSeconds": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The deployment controller type the service is using. When using the DescribeServices\n API, this field is omitted if the service is using the ECS
deployment\n controller type.
The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy\n\t\t\tElastic Load Balancing target health checks after a task has first started.
" } }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "The platform version on which to run your service. A platform version is only\n specified for tasks using the Fargate launch type. If one is not\n specified, the LATEST
platform version is used by default. For more\n information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.
The launch type on which your service is running. If no value is specified, it will\n\t\t\tdefault to EC2
. Valid values include EC2
and\n\t\t\t\tFARGATE
. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.
The current state of deployments for the service.
" + "smithy.api#documentation": "The event stream for your service. A maximum of 100 of the latest events are\n\t\t\tdisplayed.
" } }, - "tags": { - "target": "com.amazonaws.ecs#Tags", + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { - "smithy.api#documentation": "The metadata that you apply to the service to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc
networking mode.
The Amazon Resource Name (ARN) of the cluster that hosts the service.
" + "smithy.api#documentation": "The name of your service. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. Service names must be unique within\n\t\t\ta cluster, but you can have similarly named services in multiple clusters within a\n\t\t\tRegion or across multiple Regions.
" } }, - "deploymentConfiguration": { - "target": "com.amazonaws.ecs#DeploymentConfiguration", + "schedulingStrategy": { + "target": "com.amazonaws.ecs#SchedulingStrategy", "traits": { - "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment\n and the ordering of stopping and starting tasks.
" + "smithy.api#documentation": "The scheduling strategy to use for the service. For more information, see Services.
\n\t\tThere are two service scheduler strategies available:
\n\t\t\n REPLICA
-The replica scheduling strategy places and\n\t\t\t\t\tmaintains the desired number of tasks across your cluster. By default, the\n\t\t\t\t\tservice scheduler spreads tasks across Availability Zones. You can use task\n\t\t\t\t\tplacement strategies and constraints to customize task placement\n\t\t\t\t\tdecisions.
\n DAEMON
-The daemon scheduling strategy deploys exactly one\n\t\t\t\t\ttask on each active container instance that meets all of the task placement\n\t\t\t\t\tconstraints that you specify in your cluster. The service scheduler also\n\t\t\t\t\tevaluates the task placement constraints for running tasks and will stop tasks\n\t\t\t\t\tthat do not meet the placement constraints.
Fargate tasks do not support the DAEMON
\n\t\t\t\t\t\tscheduling strategy.
The event message.
" - } - }, "id": { "target": "com.amazonaws.ecs#String", "traits": { @@ -6186,6 +6231,12 @@ "traits": { "smithy.api#documentation": "The Unix timestamp for when the event was triggered.
" } + }, + "message": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The event message.
" + } } }, "traits": { @@ -6223,7 +6274,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified service is not active. You can't update a service that is inactive. If\n you have previously deleted a service, you can re-create it with CreateService.
", + "smithy.api#documentation": "The specified service is not active. You can't update a service that is inactive. If\n\t\t\tyou have previously deleted a service, you can re-create it with CreateService.
", "smithy.api#error": "client" } }, @@ -6235,7 +6286,7 @@ } }, "traits": { - "smithy.api#documentation": "The specified service could not be found. You can view your available services with\n ListServices. Amazon ECS services are cluster-specific and\n Region-specific.
", + "smithy.api#documentation": "The specified service could not be found. You can view your available services with\n\t\t\t\tListServices. Amazon ECS services are cluster-specific and\n\t\t\tRegion-specific.
", "smithy.api#error": "client" } }, @@ -6248,28 +6299,28 @@ "com.amazonaws.ecs#ServiceRegistry": { "type": "structure", "members": { - "registryArn": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is\n AWS Cloud Map. For more information, see CreateService.
" - } - }, - "port": { + "containerPort": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The port value used if your service discovery service specified an SRV record. This\n field may be used if both the awsvpc
network mode and SRV records are\n used.
The port value, already specified in the task definition, to be used for your service\n\t\t\tdiscovery service. If the task definition your service task specifies uses the\n\t\t\t\tbridge
or host
network mode, you must specify a\n\t\t\t\tcontainerName
and containerPort
combination from the task\n\t\t\tdefinition. If the task definition your service task specifies uses the\n\t\t\t\tawsvpc
network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a containerName
and containerPort
combination or a\n\t\t\t\tport
value, but not both.
The port value, already specified in the task definition, to be used for your service\n discovery service. If the task definition your service task specifies uses the\n bridge
or host
network mode, you must specify a\n containerName
and containerPort
combination from the task\n definition. If the task definition your service task specifies uses the\n awsvpc
network mode and a type SRV DNS record is used, you must specify\n either a containerName
and containerPort
combination or a\n port
value, but not both.
The container name value, already specified in the task definition, to be used for\n\t\t\tyour service discovery service. If the task definition that your service task specifies\n\t\t\tuses the bridge
or host
network mode, you must specify a\n\t\t\t\tcontainerName
and containerPort
combination from the task\n\t\t\tdefinition. If the task definition that your service task specifies uses the\n\t\t\t\tawsvpc
network mode and a type SRV DNS record is used, you must specify\n\t\t\teither a containerName
and containerPort
combination or a\n\t\t\t\tport
value, but not both.
The container name value, already specified in the task definition, to be used for\n your service discovery service. If the task definition that your service task specifies\n uses the bridge
or host
network mode, you must specify a\n containerName
and containerPort
combination from the task\n definition. If the task definition that your service task specifies uses the\n awsvpc
network mode and a type SRV DNS record is used, you must specify\n either a containerName
and containerPort
combination or a\n port
value, but not both.
The Amazon Resource Name (ARN) of the service registry. The currently supported service registry is\n\t\t\tAWS Cloud Map. For more information, see CreateService.
" + } + }, + "port": { + "target": "com.amazonaws.ecs#BoxedInteger", + "traits": { + "smithy.api#documentation": "The port value used if your service discovery service specified an SRV record. This\n\t\t\tfield may be used if both the awsvpc
network mode and SRV records are\n\t\t\tused.
The ARN of the principal, which can be an IAM user, IAM role, or the root user. If\n this field is omitted, the authenticated user is assumed.
" + "smithy.api#documentation": "The ARN of the principal, which can be an IAM user, IAM role, or the root user. If\n\t\t\tthis field is omitted, the authenticated user is assumed.
" } }, "name": { @@ -6395,78 +6446,78 @@ } ], "traits": { - "smithy.api#documentation": "Starts a new task from the specified task definition on the specified container\n instance or instances.
\nAlternatively, you can use RunTask to place tasks for you. For more\n information, see Scheduling Tasks in the\n Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Starts a new task from the specified task definition on the specified container\n\t\t\tinstance or instances.
\n\t\tAlternatively, you can use RunTask to place tasks for you. For more\n\t\t\tinformation, see Scheduling Tasks in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" } }, "com.amazonaws.ecs#StartTaskRequest": { "type": "structure", "members": { - "cluster": { - "target": "com.amazonaws.ecs#String", + "propagateTags": { + "target": "com.amazonaws.ecs#PropagateTags", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster on which to start your task.\n If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "Specifies whether to propagate the tags from the task definition or the service to the\n\t\t\ttask. If no value is specified, the tags are not propagated.
" } }, - "group": { + "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of the task group to associate with the task. The default value is the family\n name of the task definition (for example, family:my-family-name).
" + "smithy.api#documentation": "An optional tag specified when a task is started. For example, if you automatically\n\t\t\ttrigger a task to run a batch process job, you could apply a unique identifier for that\n\t\t\tjob to your task with the startedBy
parameter. You can then identify which\n\t\t\ttasks belong to that job by filtering the results of a ListTasks call\n\t\t\twith the startedBy
value. Up to 36 letters (uppercase and lowercase),\n\t\t\tnumbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter\n\t\t\tcontains the deployment ID of the service that starts it.
The metadata that you apply to the task to help you categorize and organize them. Each\n tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
A list of container overrides in JSON format that specify the name of a container in\n\t\t\tthe specified task definition and the overrides it should receive. You can override the\n\t\t\tdefault command for a container (that is specified in the task definition or Docker\n\t\t\timage) with a command
override. You can also override existing environment\n\t\t\tvariables (that are specified in the task definition or Docker image) on a container or\n\t\t\tadd new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON\n\t\t\t\tformatting characters of the override structure.
\n\t\tThe family
and revision
(family:revision
) or\n full ARN of the task definition to start. If a revision
is not specified,\n the latest ACTIVE
revision is used.
The container instance IDs or full ARN entries for the container instances on which\n\t\t\tyou would like to place your task. You can specify up to 10 container instances.
", "smithy.api#required": {} } }, - "referenceId": { + "group": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The reference ID to use for the task.
" + "smithy.api#documentation": "The name of the task group to associate with the task. The default value is the family\n\t\t\tname of the task definition (for example, family:my-family-name).
" } }, - "enableECSManagedTags": { - "target": "com.amazonaws.ecs#Boolean", + "tags": { + "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "Specifies whether to enable Amazon ECS managed tags for the task. For more information, see\n Tagging Your Amazon ECS\n Resources in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The container instance IDs or full ARN entries for the container instances on which\n you would like to place your task. You can specify up to 10 container instances.
", - "smithy.api#required": {} + "smithy.api#documentation": "The reference ID to use for the task.
" } }, - "startedBy": { + "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "An optional tag specified when a task is started. For example, if you automatically\n trigger a task to run a batch process job, you could apply a unique identifier for that\n job to your task with the startedBy
parameter. You can then identify which\n tasks belong to that job by filtering the results of a ListTasks call\n with the startedBy
value. Up to 36 letters (uppercase and lowercase),\n numbers, hyphens, and underscores are allowed.
If a task is started by an Amazon ECS service, then the startedBy
parameter\n contains the deployment ID of the service that starts it.
The family
and revision
(family:revision
) or\n\t\t\tfull ARN of the task definition to start. If a revision
is not specified,\n\t\t\tthe latest ACTIVE
revision is used.
The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc
networking mode.
Specifies whether to enable Amazon ECS managed tags for the task. For more information, see\n\t\t\t\tTagging Your Amazon ECS\n\t\t\t\tResources in the Amazon Elastic Container Service Developer Guide.
" } }, - "overrides": { - "target": "com.amazonaws.ecs#TaskOverride", + "cluster": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "A list of container overrides in JSON format that specify the name of a container in\n the specified task definition and the overrides it should receive. You can override the\n default command for a container (that is specified in the task definition or Docker\n image) with a command
override. You can also override existing environment\n variables (that are specified in the task definition or Docker image) on a container or\n add new environment variables to it with an environment
override.
A total of 8192 characters are allowed for overrides. This limit includes the JSON\n formatting characters of the override structure.
\nThe short name or full Amazon Resource Name (ARN) of the cluster on which to start your task.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, - "propagateTags": { - "target": "com.amazonaws.ecs#PropagateTags", + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration", "traits": { - "smithy.api#documentation": "Specifies whether to propagate the tags from the task definition or the service to the\n task. If no value is specified, the tags are not propagated.
" + "smithy.api#documentation": "The VPC subnet and security group configuration for tasks that receive their own\n elastic network interface by using the awsvpc
networking mode.
A full description of the tasks that were started. Each task that was successfully\n placed on your container instances is described.
" - } - }, "failures": { "target": "com.amazonaws.ecs#Failures", "traits": { "smithy.api#documentation": "Any failures associated with the call.
" } + }, + "tasks": { + "target": "com.amazonaws.ecs#Tasks", + "traits": { + "smithy.api#documentation": "A full description of the tasks that were started. Each task that was successfully\n\t\t\tplaced on your container instances is described.
" + } } } }, @@ -6517,7 +6568,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops a running task. Any tags associated with the task will be deleted.
\nWhen StopTask is called on a task, the equivalent of docker\n stop
is issued to the containers running in the task. This results in a\n SIGTERM
value and a default 30-second timeout, after which the\n SIGKILL
value is sent and the containers are forcibly stopped. If the\n container handles the SIGTERM
value gracefully and exits within 30 seconds\n from receiving it, no SIGKILL
value is sent.
The default 30-second timeout can be configured on the Amazon ECS container agent with\n the ECS_CONTAINER_STOP_TIMEOUT
variable. For more information, see\n Amazon ECS Container Agent Configuration in the\n Amazon Elastic Container Service Developer Guide.
Stops a running task. Any tags associated with the task will be deleted.
\n\t\tWhen StopTask is called on a task, the equivalent of docker\n\t\t\t\tstop
is issued to the containers running in the task. This results in a\n\t\t\t\tSIGTERM
value and a default 30-second timeout, after which the\n\t\t\t\tSIGKILL
value is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM
value gracefully and exits within 30 seconds\n\t\t\tfrom receiving it, no SIGKILL
value is sent.
The default 30-second timeout can be configured on the Amazon ECS container agent with\n\t\t\t\tthe ECS_CONTAINER_STOP_TIMEOUT
variable. For more information, see\n\t\t\t\t\tAmazon ECS Container Agent Configuration in the\n\t\t\t\t\tAmazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop.\n If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, "task": { @@ -6539,7 +6590,7 @@ "reason": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "An optional message specified when a task is stopped. For example, if you are using a\n custom scheduler, you can use this parameter to specify the reason for stopping the task\n here, and the message appears in subsequent DescribeTasks API\n operations on this task. Up to 255 characters are allowed in this message.
" + "smithy.api#documentation": "An optional message specified when a task is stopped. For example, if you are using a\n\t\t\tcustom scheduler, you can use this parameter to specify the reason for stopping the task\n\t\t\there, and the message appears in subsequent DescribeTasks API\n\t\t\toperations on this task. Up to 255 characters are allowed in this message.
" } } } @@ -6596,7 +6647,7 @@ } ], "traits": { - "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nSent to\n acknowledge that an attachment changed states.
" + "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nSent to\n\t\t\tacknowledge that an attachment changed states.
" } }, "com.amazonaws.ecs#SubmitAttachmentStateChangesRequest": { @@ -6612,7 +6663,7 @@ "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full ARN of the cluster that hosts the container instance the\n attachment belongs to.
" + "smithy.api#documentation": "The short name or full ARN of the cluster that hosts the container instance the\n\t\t\tattachment belongs to.
" } } } @@ -6648,40 +6699,40 @@ } ], "traits": { - "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nSent to\n acknowledge that a container changed states.
" + "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nSent to\n\t\t\tacknowledge that a container changed states.
" } }, "com.amazonaws.ecs#SubmitContainerStateChangeRequest": { "type": "structure", "members": { - "cluster": { + "task": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full ARN of the cluster that hosts the container.
" + "smithy.api#documentation": "The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.
" } }, - "reason": { + "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The reason for the state change request.
" + "smithy.api#documentation": "The short name or full ARN of the cluster that hosts the container.
" } }, - "task": { - "target": "com.amazonaws.ecs#String", + "exitCode": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The task ID or full Amazon Resource Name (ARN) of the task that hosts the container.
" + "smithy.api#documentation": "The exit code returned for the state change request.
" } }, - "runtimeId": { + "status": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The ID of the Docker container.
" + "smithy.api#documentation": "The status of the state change request.
" } }, - "status": { + "runtimeId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The status of the state change request.
" + "smithy.api#documentation": "The ID of the Docker container.
" } }, "networkBindings": { @@ -6690,16 +6741,16 @@ "smithy.api#documentation": "The network bindings of the container.
" } }, - "exitCode": { - "target": "com.amazonaws.ecs#BoxedInteger", + "containerName": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The exit code returned for the state change request.
" + "smithy.api#documentation": "The name of the container.
" } }, - "containerName": { + "reason": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of the container.
" + "smithy.api#documentation": "The reason for the state change request.
" } } } @@ -6738,40 +6789,40 @@ } ], "traits": { - "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nSent to acknowledge\n that a task changed states.
" + "smithy.api#documentation": "This action is only used by the Amazon ECS agent, and it is not intended for use outside of the agent.
\nSent to acknowledge\n\t\t\tthat a task changed states.
" } }, "com.amazonaws.ecs#SubmitTaskStateChangeRequest": { "type": "structure", "members": { - "attachments": { - "target": "com.amazonaws.ecs#AttachmentStateChanges", + "containers": { + "target": "com.amazonaws.ecs#ContainerStateChanges", "traits": { - "smithy.api#documentation": "Any attachments associated with the state change request.
" + "smithy.api#documentation": "Any containers associated with the state change request.
" } }, - "pullStoppedAt": { + "pullStartedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp for when the container image pull completed.
" + "smithy.api#documentation": "The Unix timestamp for when the container image pull began.
" } }, - "task": { + "reason": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The task ID or full ARN of the task in the state change request.
" + "smithy.api#documentation": "The reason for the state change request.
" } }, - "reason": { - "target": "com.amazonaws.ecs#String", + "pullStoppedAt": { + "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "The reason for the state change request.
" + "smithy.api#documentation": "The Unix timestamp for when the container image pull completed.
" } }, - "containers": { - "target": "com.amazonaws.ecs#ContainerStateChanges", + "task": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "Any containers associated with the state change request.
" + "smithy.api#documentation": "The task ID or full ARN of the task in the state change request.
" } }, "status": { @@ -6780,10 +6831,10 @@ "smithy.api#documentation": "The status of the state change request.
" } }, - "pullStartedAt": { + "executionStoppedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp for when the container image pull began.
" + "smithy.api#documentation": "The Unix timestamp for when the task execution stopped.
" } }, "cluster": { @@ -6792,10 +6843,10 @@ "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task.
" } }, - "executionStoppedAt": { - "target": "com.amazonaws.ecs#Timestamp", + "attachments": { + "target": "com.amazonaws.ecs#AttachmentStateChanges", "traits": { - "smithy.api#documentation": "The Unix timestamp for when the task execution stopped.
" + "smithy.api#documentation": "Any attachments associated with the state change request.
" } } } @@ -6814,21 +6865,21 @@ "com.amazonaws.ecs#SystemControl": { "type": "structure", "members": { - "value": { + "namespace": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The value for the namespaced kernel parameter specified in\n namespace
.
The namespaced kernel parameter for which to set a value
.
The namespaced kernel parameter for which to set a value
.
The value for the namespaced kernel parameter specified in\n\t\t\tnamespace
.
A list of namespaced kernel parameters to set in the container. This parameter maps to\n Sysctls
in the Create a container section of the\n Docker Remote API and the --sysctl
option to docker run.
It is not recommended that you specify network-related systemControls
\n parameters for multiple containers in a single task that also uses either the\n awsvpc
or host
network mode for the following\n reasons:
For tasks that use the awsvpc
network mode, if you set\n systemControls
for any container, it applies to all containers\n in the task. If you set different systemControls
for multiple\n containers in a single task, the container that is started last determines which\n systemControls
take effect.
For tasks that use the host
network mode, the\n systemControls
parameter applies to the container instance's\n kernel parameter as well as that of all containers of any tasks running on that\n container instance.
A list of namespaced kernel parameters to set in the container. This parameter maps to\n\t\t\t\tSysctls
in the Create a container section of the\n\t\t\tDocker Remote API and the --sysctl
option to docker run.
It is not recommended that you specify network-related systemControls
\n\t\t\tparameters for multiple containers in a single task that also uses either the\n\t\t\t\tawsvpc
or host
network mode for the following\n\t\t\treasons:
For tasks that use the awsvpc
network mode, if you set\n\t\t\t\t\t\tsystemControls
for any container, it applies to all containers\n\t\t\t\t\tin the task. If you set different systemControls
for multiple\n\t\t\t\t\tcontainers in a single task, the container that is started last determines which\n\t\t\t\t\t\tsystemControls
take effect.
For tasks that use the host
network mode, the\n\t\t\t\t\t\tsystemControls
parameter applies to the container instance's\n\t\t\t\t\tkernel parameter as well as that of all containers of any tasks running on that\n\t\t\t\t\tcontainer instance.
The optional part of a key-value pair that make up a tag. A value
acts as\n a descriptor within a tag category (key).
The optional part of a key-value pair that make up a tag. A value
acts as\n\t\t\ta descriptor within a tag category (key).
One part of a key-value pair that make up a tag. A key
is a general label\n that acts like a category for more specific tag values.
One part of a key-value pair that make up a tag. A key
is a general label\n\t\t\tthat acts like a category for more specific tag values.
The metadata that you apply to a resource to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to a resource to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
Associates the specified tags to a resource with the specified\n resourceArn
. If existing tags on a resource are not specified in the\n request parameters, they are not changed. When a resource is deleted, the tags\n associated with that resource are deleted as well.
Associates the specified tags to a resource with the specified\n\t\t\t\tresourceArn
. If existing tags on a resource are not specified in the\n\t\t\trequest parameters, they are not changed. When a resource is deleted, the tags\n\t\t\tassociated with that resource are deleted as well.
The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources\n are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n instances.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources\n\t\t\tare Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container\n\t\t\tinstances.
", "smithy.api#required": {} } }, "tags": { "target": "com.amazonaws.ecs#Tags", "traits": { - "smithy.api#documentation": "The tags to add to the resource. A tag is an array of key-value pairs.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The tags to add to the resource. A tag is an array of key-value pairs.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The specified target could not be found. You can view your available container\n instances with ListContainerInstances. Amazon ECS container instances are\n cluster-specific and Region-specific.
", + "smithy.api#documentation": "The specified target could not be found. You can view your available container\n\t\t\tinstances with ListContainerInstances. Amazon ECS container instances are\n\t\t\tcluster-specific and Region-specific.
", "smithy.api#error": "client" } }, @@ -6979,22 +7030,10 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task.
" } }, - "launchType": { - "target": "com.amazonaws.ecs#LaunchType", - "traits": { - "smithy.api#documentation": "The launch type on which your task is running. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.
" - } - }, - "attachments": { - "target": "com.amazonaws.ecs#Attachments", - "traits": { - "smithy.api#documentation": "The Elastic Network Adapter associated with the task if the task uses the\n awsvpc
network mode.
The platform version on which your task is running. A platform version is only\n specified for tasks using the Fargate launch type. If one is not\n specified, the LATEST
platform version is used by default. For more\n information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.
The platform version on which your task is running. A platform version is only\n\t\t\tspecified for tasks using the Fargate launch type. If one is not\n\t\t\tspecified, the LATEST
platform version is used by default. For more\n\t\t\tinformation, see AWS Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
The Unix timestamp for when the task started (the task transitioned from the\n PENDING
state to the RUNNING
state).
The Unix timestamp for when the task started (the task transitioned from the\n\t\t\t\tPENDING
state to the RUNNING
state).
The reason that the task was stopped.
" + "smithy.api#documentation": "The number of CPU units used by the task as expressed in a task definition. It can be\n\t\t\texpressed as an integer using CPU units, for example 1024
. It can also be\n\t\t\texpressed as a string using vCPUs, for example 1 vCPU
or 1\n\t\t\t\tvcpu
. String values are converted to an integer indicating the CPU units when\n\t\t\tthe task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported\n\t\t\tvalues are between 128
CPU units (0.125
vCPUs) and\n\t\t\t\t10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The containers associated with the task.
" + "smithy.api#documentation": "The Unix timestamp for when the container image pull began.
" } }, - "attributes": { - "target": "com.amazonaws.ecs#Attributes", + "createdAt": { + "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "The attributes of the task
" + "smithy.api#documentation": "The Unix timestamp for when the task was created (the task entered the\n\t\t\t\tPENDING
state).
The ARN of the task definition that creates the task.
" + "smithy.api#documentation": "The Elastic Inference accelerator associated with the task.
" } }, - "lastStatus": { + "containerInstanceArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The last known status of the task. For more information, see Task\n Lifecycle.
" + "smithy.api#documentation": "The ARN of the container instances that host the task.
" } }, - "stopCode": { - "target": "com.amazonaws.ecs#TaskStopCode", + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "The stop code indicating why a task was stopped. The stoppedReason
may\n contain additional details.
The launch type on which your task is running. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.
" } }, - "stoppingAt": { - "target": "com.amazonaws.ecs#Timestamp", + "attachments": { + "target": "com.amazonaws.ecs#Attachments", "traits": { - "smithy.api#documentation": "The Unix timestamp for when the task stops (transitions from the RUNNING
\n state to STOPPED
).
The Elastic Network Adapter associated with the task if the task uses the\n\t\t\t\tawsvpc
network mode.
The amount of memory (in MiB) used by the task as expressed in a task definition. It\n can be expressed as an integer using MiB, for example 1024
. It can also be\n expressed as a string using GB, for example 1GB
or 1 GB
.\n String values are converted to an integer indicating the MiB when the task definition is\n registered.
If you are using the EC2 launch type, this field is optional.
\nIf you are using the Fargate launch type, this field is required and you\n must use one of the following values, which determines your range of supported values\n for the cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4 vCPU)
One or more container overrides.
" + "smithy.api#documentation": "The name of the task group associated with the task.
" } }, - "connectivityAt": { - "target": "com.amazonaws.ecs#Timestamp", + "desiredStatus": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Unix timestamp for when the task last went into CONNECTED
\n status.
The desired status of the task. For more information, see Task\n\t\t\tLifecycle.
" } }, - "desiredStatus": { + "startedBy": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The desired status of the task. For more information, see Task\n Lifecycle.
" + "smithy.api#documentation": "The tag specified when a task is started. If the task is started by an Amazon ECS service,\n\t\t\tthen the startedBy
parameter contains the deployment ID of the service that\n\t\t\tstarts it.
The Elastic Inference accelerator associated with the task.
" + "smithy.api#documentation": "The Unix timestamp for when the container image pull completed.
" } }, - "startedBy": { - "target": "com.amazonaws.ecs#String", + "connectivity": { + "target": "com.amazonaws.ecs#Connectivity", "traits": { - "smithy.api#documentation": "The tag specified when a task is started. If the task is started by an Amazon ECS service,\n then the startedBy
parameter contains the deployment ID of the service that\n starts it.
The connectivity status of a task.
" } }, - "pullStoppedAt": { + "connectivityAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp for when the container image pull completed.
" + "smithy.api#documentation": "The Unix timestamp for when the task last went into CONNECTED
\n\t\t\tstatus.
The health status for the task, which is determined by the health of the essential\n containers in the task. If all essential containers in the task are reporting as\n HEALTHY
, then the task status also reports as HEALTHY
. If\n any essential containers in the task are reporting as UNHEALTHY
or\n UNKNOWN
, then the task status also reports as UNHEALTHY
or\n UNKNOWN
, accordingly.
The Amazon ECS container agent does not monitor or report on Docker health checks that\n are embedded in a container image (such as those specified in a parent image or from\n the image's Dockerfile) and not specified in the container definition. Health check\n parameters that are specified in a container definition override any Docker health\n checks that exist in the container image.
\nThe health status for the task, which is determined by the health of the essential\n\t\t\tcontainers in the task. If all essential containers in the task are reporting as\n\t\t\t\tHEALTHY
, then the task status also reports as HEALTHY
. If\n\t\t\tany essential containers in the task are reporting as UNHEALTHY
or\n\t\t\t\tUNKNOWN
, then the task status also reports as UNHEALTHY
or\n\t\t\t\tUNKNOWN
, accordingly.
The Amazon ECS container agent does not monitor or report on Docker health checks that\n\t\t\t\tare embedded in a container image (such as those specified in a parent image or from\n\t\t\t\tthe image's Dockerfile) and not specified in the container definition. Health check\n\t\t\t\tparameters that are specified in a container definition override any Docker health\n\t\t\t\tchecks that exist in the container image.
\n\t\tThe version counter for the task. Every time a task experiences a change that triggers\n\t\t\ta CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task\n\t\t\tstate with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API\n\t\t\tactions with the version reported in CloudWatch Events for the task (inside the\n\t\t\t\tdetail
object) to verify that the version in your event stream is\n\t\t\tcurrent.
The metadata that you apply to the task to help you categorize and organize them. Each\n tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The metadata that you apply to the task to help you categorize and organize them. Each\n\t\t\ttag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The version counter for the task. Every time a task experiences a change that triggers\n a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS task\n state with CloudWatch Events, you can compare the version of a task reported by the Amazon ECS API\n actions with the version reported in CloudWatch Events for the task (inside the\n detail
object) to verify that the version in your event stream is\n current.
One or more container overrides.
" } }, "stoppedAt": { "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "The Unix timestamp for when the task was stopped (the task transitioned from the\n RUNNING
state to the STOPPED
state).
The Unix timestamp for when the task was stopped (the task transitioned from the\n\t\t\t\tRUNNING
state to the STOPPED
state).
The number of CPU units used by the task as expressed in a task definition. It can be\n expressed as an integer using CPU units, for example 1024
. It can also be\n expressed as a string using vCPUs, for example 1 vCPU
or 1\n vcpu
. String values are converted to an integer indicating the CPU units when\n the task definition is registered.
If you are using the EC2 launch type, this field is optional. Supported\n values are between 128
CPU units (0.125
vCPUs) and\n 10240
CPU units (10
vCPUs).
If you are using the Fargate launch type, this field is required and you\n must use one of the following values, which determines your range of supported values\n for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The attributes of the task
" } }, - "pullStartedAt": { - "target": "com.amazonaws.ecs#Timestamp", + "stoppedReason": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Unix timestamp for when the container image pull began.
" + "smithy.api#documentation": "The reason that the task was stopped.
" } }, - "connectivity": { - "target": "com.amazonaws.ecs#Connectivity", + "containers": { + "target": "com.amazonaws.ecs#Containers", "traits": { - "smithy.api#documentation": "The connectivity status of a task.
" + "smithy.api#documentation": "The containers associated with the task.
" } }, - "createdAt": { - "target": "com.amazonaws.ecs#Timestamp", + "taskDefinitionArn": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Unix timestamp for when the task was created (the task entered the\n PENDING
state).
The ARN of the task definition that creates the task.
" } }, - "group": { + "memory": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The name of the task group associated with the task.
" + "smithy.api#documentation": "The amount of memory (in MiB) used by the task as expressed in a task definition. It\n\t\t\tcan be expressed as an integer using MiB, for example 1024
. It can also be\n\t\t\texpressed as a string using GB, for example 1GB
or 1 GB
.\n\t\t\tString values are converted to an integer indicating the MiB when the task definition is\n\t\t\tregistered.
If you are using the EC2 launch type, this field is optional.
\n\t\tIf you are using the Fargate launch type, this field is required and you\n\t\t\tmust use one of the following values, which determines your range of supported values\n\t\t\tfor the cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4 vCPU)
The ARN of the container instances that host the task.
" + "smithy.api#documentation": "The last known status of the task. For more information, see Task\n\t\t\t\tLifecycle.
" + } + }, + "stoppingAt": { + "target": "com.amazonaws.ecs#Timestamp", + "traits": { + "smithy.api#documentation": "The Unix timestamp for when the task stops (transitions from the RUNNING
\n\t\t\tstate to STOPPED
).
The stop code indicating why a task was stopped. The stoppedReason
may\n\t\t\tcontain additional details.
The name of a family that this task definition is registered to. Up to 255 letters\n (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
\nA family groups multiple versions of a task definition. Amazon ECS gives the first task\n definition that you registered to a family a revision number of 1. Amazon ECS gives\n sequential revision numbers to each task definition that you add.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants containers in the\n\t\t\ttask permission to call AWS APIs on your behalf. For more information, see Amazon ECS\n\t\t\t\tTask Role in the Amazon Elastic Container Service Developer Guide.
\n\t\tIAM roles for tasks on Windows require that the -EnableTaskIAMRole
option\n\t\t\tis set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some\n\t\t\tconfiguration code in order to take advantage of the feature. For more information, see\n\t\t\t\tWindows IAM Roles\n\t\t\t\tfor Tasks in the Amazon Elastic Container Service Developer Guide.
The revision of the task in a particular family. The revision is a version number of a\n task definition in a family. When you register a task definition for the first time, the\n revision is 1
. Each time that you register a new revision of a task\n definition in the same family, the revision value always increases by one, even if you\n have deregistered previous revisions in this family.
The revision of the task in a particular family. The revision is a version number of a\n\t\t\ttask definition in a family. When you register a task definition for the first time, the\n\t\t\trevision is 1
. Each time that you register a new revision of a task\n\t\t\tdefinition in the same family, the revision value always increases by one, even if you\n\t\t\thave deregistered previous revisions in this family.
The status of the task definition.
" } }, - "requiresCompatibilities": { - "target": "com.amazonaws.ecs#CompatibilityList", + "proxyConfiguration": { + "target": "com.amazonaws.ecs#ProxyConfiguration", "traits": { - "smithy.api#documentation": "The launch type the task requires. If no value is specified, it will default to\n EC2
. Valid values include EC2
and\n FARGATE
.
The configuration details for the App Mesh proxy.
\n\t\tYour Amazon ECS container instances require at least version 1.26.0 of the container agent\n\t\t\tand at least version 1.26.0-1 of the ecs-init
package to enable a proxy\n\t\t\tconfiguration. If your container instances are launched from the Amazon ECS-optimized AMI\n\t\t\tversion 20190301
or later, then they contain the required versions of the\n\t\t\tcontainer agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
The configuration details for the App Mesh proxy.
\nYour Amazon ECS container instances require at least version 1.26.0 of the container agent\n and at least version 1.26.0-1 of the ecs-init
package to enable a proxy\n configuration. If your container instances are launched from the Amazon ECS-optimized AMI\n version 20190301
or later, then they contain the required versions of the\n container agent and ecs-init
. For more information, see Amazon ECS-optimized Linux AMI in the Amazon Elastic Container Service Developer Guide.
An array of placement constraint objects to use for tasks. This field is not valid if\n\t\t\tyou are using the Fargate launch type for your task.
" } }, - "status": { - "target": "com.amazonaws.ecs#TaskDefinitionStatus", + "networkMode": { + "target": "com.amazonaws.ecs#NetworkMode", "traits": { - "smithy.api#documentation": "The status of the task definition.
" + "smithy.api#documentation": "The Docker networking mode to use for the containers in the task. The valid values are\n none
, bridge
, awsvpc
, and host
.\n The default Docker network mode is bridge
. If you are using the\n Fargate launch type, the awsvpc
network mode is required. If\n you are using the EC2 launch type, any network mode can be used. If the network\n mode is set to none
, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host
and awsvpc
network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host
\n network mode) or the attached elastic network interface port (for the\n awsvpc
network mode), so you cannot take advantage of dynamic host port\n mappings.
If the network mode is awsvpc
, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the\n ecs-init
package, or AWS Fargate infrastructure support the\n awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you\n register a task definition with Windows containers, you must not specify a network mode.\n If you use the console to register a task definition with Windows containers, you must\n choose the
network mode object.
For more information, see Network\n settings in the Docker run reference.
" } }, - "taskDefinitionArn": { + "family": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The full Amazon Resource Name (ARN) of the task definition.
" + "smithy.api#documentation": "The name of a family that this task definition is registered to. Up to 255 letters\n\t\t\t(uppercase and lowercase), numbers, hyphens, and underscores are allowed.
\n\t\tA family groups multiple versions of a task definition. Amazon ECS gives the first task\n\t\t\tdefinition that you registered to a family a revision number of 1. Amazon ECS gives\n\t\t\tsequential revision numbers to each task definition that you add.
" } }, - "taskRoleArn": { - "target": "com.amazonaws.ecs#String", + "requiresCompatibilities": { + "target": "com.amazonaws.ecs#CompatibilityList", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants containers in the\n task permission to call AWS APIs on your behalf. For more information, see Amazon ECS\n Task Role in the Amazon Elastic Container Service Developer Guide.
\nIAM roles for tasks on Windows require that the -EnableTaskIAMRole
option\n is set when you launch the Amazon ECS-optimized Windows AMI. Your containers must also run some\n configuration code in order to take advantage of the feature. For more information, see\n Windows IAM Roles\n for Tasks in the Amazon Elastic Container Service Developer Guide.
The launch type the task requires. If no value is specified, it will default to\n\t\t\t\tEC2
. Valid values include EC2
and\n\t\t\tFARGATE
.
The process namespace to use for the containers in the task. The valid\n values are host
or task
. If host
\n is specified, then all containers within the tasks that specified the\n host
PID mode on the same container instance share the\n same process namespace with the host Amazon EC2 instance. If task
is\n specified, all containers within the specified task share the same\n process namespace. If no value is specified, the default is a private\n namespace. For more information, see PID settings in the Docker run\n reference.
If the host
PID mode is used, be aware that there is a\n heightened risk of undesired process namespace expose. For more\n information, see Docker\n security.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
\nThe IPC resource namespace to use for the containers in the task. The valid values are\n host
, task
, or none
. If host
is\n specified, then all containers within the tasks that specified the host
IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task
is specified, all containers within the specified task\n share the same IPC resources. If none
is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.
If you are setting namespaced kernel parameters using systemControls
for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related\n systemControls
are not supported.
For tasks that use the task
IPC mode, IPC namespace related\n systemControls
will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
\nThe full Amazon Resource Name (ARN) of the task definition.
" } }, "compatibilities": { "target": "com.amazonaws.ecs#CompatibilityList", "traits": { - "smithy.api#documentation": "The launch type to use with your task. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The launch type to use with your task. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.
" } }, - "requiresAttributes": { - "target": "com.amazonaws.ecs#RequiresAttributes", + "containerDefinitions": { + "target": "com.amazonaws.ecs#ContainerDefinitions", "traits": { - "smithy.api#documentation": "The container instance attributes required by your task. This field is not valid if\n you are using the Fargate launch type for your task.
" + "smithy.api#documentation": "A list of container definitions in JSON format that describe the different containers\n\t\t\tthat make up your task. For more information about container definition parameters and\n\t\t\tdefaults, see Amazon ECS Task\n\t\t\t\tDefinitions in the Amazon Elastic Container Service Developer Guide.
" } }, "inferenceAccelerators": { @@ -7251,51 +7308,45 @@ "smithy.api#documentation": "The Elastic Inference accelerator associated with the task.
" } }, - "memory": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The amount (in MiB) of memory used by the task.
\nIf using the EC2 launch type, this field is optional and any value can\n be used. If a task-level memory value is specified then the container-level memory value\n is optional.
\nIf using the Fargate launch type, this field is required and you must\n use one of the following values, which determines your range of valid values for the\n cpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4 vCPU)
A list of container definitions in JSON format that describe the different containers\n that make up your task. For more information about container definition parameters and\n defaults, see Amazon ECS Task\n Definitions in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The IPC resource namespace to use for the containers in the task. The valid values are\n host
, task
, or none
. If host
is\n specified, then all containers within the tasks that specified the host
IPC\n mode on the same container instance share the same IPC resources with the host Amazon EC2\n instance. If task
is specified, all containers within the specified task\n share the same IPC resources. If none
is specified, then IPC resources\n within the containers of a task are private and not shared with other containers in a\n task or on the container instance. If no value is specified, then the IPC resource\n namespace sharing depends on the Docker daemon setting on the container instance. For\n more information, see IPC\n settings in the Docker run reference.
If the host
IPC mode is used, be aware that there is a heightened risk of\n undesired IPC namespace expose. For more information, see Docker\n security.
If you are setting namespaced kernel parameters using systemControls
for\n the containers in the task, the following will apply to your IPC resource namespace. For\n more information, see System\n Controls in the Amazon Elastic Container Service Developer Guide.
For tasks that use the host
IPC mode, IPC namespace related\n systemControls
are not supported.
For tasks that use the task
IPC mode, IPC namespace related\n systemControls
will apply to all containers within a\n task.
This parameter is not supported for Windows containers or tasks using the Fargate launch type.
\nThe Docker networking mode to use for the containers in the task. The valid values are\n none
, bridge
, awsvpc
, and host
.\n The default Docker network mode is bridge
. If you are using the\n Fargate launch type, the awsvpc
network mode is required. If\n you are using the EC2 launch type, any network mode can be used. If the network\n mode is set to none
, you cannot specify port mappings in your container\n definitions, and the tasks containers do not have external connectivity. The\n host
and awsvpc
network modes offer the highest networking\n performance for containers because they use the EC2 network stack instead of the\n virtualized network stack provided by the bridge
mode.
With the host
and awsvpc
network modes, exposed container\n ports are mapped directly to the corresponding host port (for the host
\n network mode) or the attached elastic network interface port (for the\n awsvpc
network mode), so you cannot take advantage of dynamic host port\n mappings.
If the network mode is awsvpc
, the task is allocated an elastic network\n interface, and you must specify a NetworkConfiguration value when you create\n a service or run a task with the task definition. For more information, see Task Networking in the\n Amazon Elastic Container Service Developer Guide.
Currently, only Amazon ECS-optimized AMIs, other Amazon Linux variants with the\n ecs-init
package, or AWS Fargate infrastructure support the\n awsvpc
network mode.
If the network mode is host
, you cannot run multiple instantiations of the\n same task on a single container instance when port mappings are used.
Docker for Windows uses different network modes than Docker for Linux. When you\n register a task definition with Windows containers, you must not specify a network mode.\n If you use the console to register a task definition with Windows containers, you must\n choose the
network mode object.
For more information, see Network\n settings in the Docker run reference.
" + "smithy.api#documentation": "The amount (in MiB) of memory used by the task.
\n\t\tIf using the EC2 launch type, you must specify either a task-level\n\t\t\tmemory value or a container-level memory value. This field is optional and any value can\n\t\t\tbe used. If a task-level memory value is specified then the container-level memory value\n\t\t\tis optional. For more information regarding container-level memory and memory\n\t\t\treservation, see ContainerDefinition.
\n\t\tIf using the Fargate launch type, this field is required and you must\n\t\t\tuse one of the following values, which determines your range of valid values for the\n\t\t\t\tcpu
parameter:
512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu
values: 256 (.25 vCPU)
1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu
values: 512 (.5 vCPU)
2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu
values: 1024 (1 vCPU)
Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu
values: 2048 (2 vCPU)
Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu
values: 4096 (4 vCPU)
An array of placement constraint objects to use for tasks. This field is not valid if\n you are using the Fargate launch type for your task.
" + "smithy.api#documentation": "The container instance attributes required by your task. This field is not valid if\n\t\t\tyou are using the Fargate launch type for your task.
" } }, - "volumes": { - "target": "com.amazonaws.ecs#VolumeList", + "executionRoleArn": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The list of volume definitions for the task.
\nIf your tasks are using the Fargate launch type, the host
\n and sourcePath
parameters are not supported.
For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent\n permission to make AWS API calls on your behalf. The task execution IAM role is required\n depending on the requirements of your task. For more information, see Amazon ECS task\n execution IAM role in the Amazon Elastic Container Service Developer Guide.
" } }, "cpu": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The number of cpu
units used by the task. If you are using the EC2 launch\n type, this field is optional and any value can be used. If you are using the Fargate\n launch type, this field is required and you must use one of the following values, which\n determines your range of valid values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The number of cpu
units used by the task. If you are using the EC2 launch\n\t\t\ttype, this field is optional and any value can be used. If you are using the Fargate\n\t\t\tlaunch type, this field is required and you must use one of the following values, which\n\t\t\tdetermines your range of valid values for the memory
parameter:
256 (.25 vCPU) - Available memory
values: 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB)
512 (.5 vCPU) - Available memory
values: 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB)
1024 (1 vCPU) - Available memory
values: 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB)
2048 (2 vCPU) - Available memory
values: Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB)
4096 (4 vCPU) - Available memory
values: Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB)
The Amazon Resource Name (ARN) of the task execution role that grants the Amazon ECS container agent\n permission to make AWS API calls on your behalf. The task execution IAM role is required\n depending on the requirements of your task. For more information, see Amazon ECS task\n execution IAM role in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "The list of volume definitions for the task.
\n\t\tIf your tasks are using the Fargate launch type, the host
\n\t\t\tand sourcePath
parameters are not supported.
For more information about volume definition parameters and defaults, see Amazon ECS Task Definitions in the Amazon Elastic Container Service Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "The details of a task definition which describes the container and volume definitions\n of an Amazon Elastic Container Service task. You can specify which Docker images to use, the required\n resources, and other configurations related to launching the task definition through an\n Amazon ECS service or task.
" + "smithy.api#documentation": "The details of a task definition which describes the container and volume definitions\n\t\t\tof an Amazon Elastic Container Service task. You can specify which Docker images to use, the required\n\t\t\tresources, and other configurations related to launching the task definition through an\n\t\t\tAmazon ECS service or task.
" } }, "com.amazonaws.ecs#TaskDefinitionFamilyStatus": { @@ -7340,18 +7391,18 @@ "type": { "target": "com.amazonaws.ecs#TaskDefinitionPlacementConstraintType", "traits": { - "smithy.api#documentation": "The type of constraint. The MemberOf
constraint restricts selection to be\n from a group of valid candidates.
The type of constraint. The MemberOf
constraint restricts selection to be\n\t\t\tfrom a group of valid candidates.
A cluster query language expression to apply to the constraint. For more information,\n see Cluster Query Language in the\n Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "A cluster query language expression to apply to the constraint. For more information,\n\t\t\tsee Cluster Query Language in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "An object representing a constraint on task placement in the task definition. For more\n information, see Task Placement Constraints in the\n Amazon Elastic Container Service Developer Guide.
\nIf you are using the Fargate launch type, task placement constraints\n are not supported.
\nAn object representing a constraint on task placement in the task definition. For more\n\t\t\tinformation, see Task Placement Constraints in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
\n\t\tIf you are using the Fargate launch type, task placement constraints\n\t\t\t\tare not supported.
\n\t\tOne or more container overrides sent to a task.
" } }, - "cpu": { + "memory": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The cpu override for the task.
" + "smithy.api#documentation": "The memory override for the task.
" } }, "executionRoleArn": { @@ -7424,22 +7475,22 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task execution IAM role override for the task.
" } }, - "inferenceAcceleratorOverrides": { - "target": "com.amazonaws.ecs#InferenceAcceleratorOverrides", + "cpu": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Elastic Inference accelerator override for the task.
" + "smithy.api#documentation": "The cpu override for the task.
" } }, "taskRoleArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers\n in this task are granted the permissions that are specified in this role.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM role that containers in this task can assume. All containers\n\t\t\tin this task are granted the permissions that are specified in this role.
" } }, - "memory": { - "target": "com.amazonaws.ecs#String", + "inferenceAcceleratorOverrides": { + "target": "com.amazonaws.ecs#InferenceAcceleratorOverrides", "traits": { - "smithy.api#documentation": "The memory override for the task.
" + "smithy.api#documentation": "The Elastic Inference accelerator override for the task.
" } } }, @@ -7450,10 +7501,10 @@ "com.amazonaws.ecs#TaskSet": { "type": "structure", "members": { - "loadBalancers": { - "target": "com.amazonaws.ecs#LoadBalancers", + "serviceRegistries": { + "target": "com.amazonaws.ecs#ServiceRegistries", "traits": { - "smithy.api#documentation": "Details on a load balancer that is used with a task set.
" + "smithy.api#documentation": "The details of the service discovery registries to assign to this task set. For more\n\t\t\tinformation, see Service\n\t\t\t\tDiscovery.
" } }, "serviceArn": { @@ -7465,37 +7516,25 @@ "externalId": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The external ID associated with the task set.
\nIf a task set is created by an AWS CodeDeploy deployment, the externalId
parameter\n contains the AWS CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service\n discovery registry, the externalId
parameter contains the\n ECS_TASK_SET_EXTERNAL_ID
AWS Cloud Map attribute.
The details of the service discovery registries to assign to this task set. For more\n information, see Service\n Discovery.
" + "smithy.api#documentation": "The external ID associated with the task set.
\n\t\tIf a task set is created by an AWS CodeDeploy deployment, the externalId
parameter\n\t\t\tcontains the AWS CodeDeploy deployment ID.
If a task set is created for an external deployment and is associated with a service\n\t\t\tdiscovery registry, the externalId
parameter contains the\n\t\t\t\tECS_TASK_SET_EXTERNAL_ID
AWS Cloud Map attribute.
The launch type the tasks in the task set are using. For more information, see Amazon ECS\n Launch Types in the Amazon Elastic Container Service Developer Guide.
" + "smithy.api#documentation": "Details on a load balancer that is used with a task set.
" } }, - "taskDefinition": { + "platformVersion": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The task definition the task set is using.
" - } - }, - "stabilityStatus": { - "target": "com.amazonaws.ecs#StabilityStatus", - "traits": { - "smithy.api#documentation": "The stability status, which indicates whether the task set has reached a steady state.\n If the following conditions are met, the task set will be in\n STEADY_STATE
:
The task runningCount
is equal to the\n computedDesiredCount
.
The pendingCount
is 0
.
There are no tasks running on container instances in the DRAINING
\n status.
All tasks are reporting a healthy status from the load balancers, service\n discovery, and container health checks.
\nIf any of those conditions are not met, the stability status returns\n STABILIZING
.
The platform version on which the tasks in the task set are running. A platform\n\t\t\tversion is only specified for tasks using the Fargate launch type. If one\n\t\t\tis not specified, the LATEST
platform version is used by default. For more\n\t\t\tinformation, see AWS Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
The computed desired count for the task set. This is calculated by multiplying the\n service's desiredCount
by the task set's scale
percentage. The\n result is always rounded up. For example, if the computed desired count is 1.2, it\n rounds up to 2 tasks.
The computed desired count for the task set. This is calculated by multiplying the\n\t\t\tservice's desiredCount
by the task set's scale
percentage. The\n\t\t\tresult is always rounded up. For example, if the computed desired count is 1.2, it\n\t\t\trounds up to 2 tasks.
The ID of the task set.
" } }, - "createdAt": { - "target": "com.amazonaws.ecs#Timestamp", + "taskDefinition": { + "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Unix timestamp for when the task set was created.
" + "smithy.api#documentation": "The task definition the task set is using.
" } }, - "taskSetArn": { - "target": "com.amazonaws.ecs#String", + "launchType": { + "target": "com.amazonaws.ecs#LaunchType", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the task set.
" + "smithy.api#documentation": "The launch type the tasks in the task set are using. For more information, see Amazon ECS\n\t\t\t\tLaunch Types in the Amazon Elastic Container Service Developer Guide.
" } }, "updatedAt": { @@ -7522,52 +7561,58 @@ "smithy.api#documentation": "The Unix timestamp for when the task set was last updated.
" } }, - "status": { - "target": "com.amazonaws.ecs#String", - "traits": { - "smithy.api#documentation": "The status of the task set. The following describes each state:
\nThe task set is serving production traffic.
\nThe task set is not serving production traffic.
\nThe tasks in the task set are being stopped and their corresponding\n targets are being deregistered from their target group.
\nThe capacity provider strategy associated with the task set.
" } }, - "pendingCount": { - "target": "com.amazonaws.ecs#Integer", + "createdAt": { + "target": "com.amazonaws.ecs#Timestamp", "traits": { - "smithy.api#documentation": "The number of tasks in the task set that are in the PENDING
status during\n a deployment. A task in the PENDING
state is preparing to enter the\n RUNNING
state. A task set enters the PENDING
status when\n it launches for the first time or when it is restarted after being in the\n STOPPED
state.
The Unix timestamp for when the task set was created.
" } }, - "runningCount": { + "pendingCount": { "target": "com.amazonaws.ecs#Integer", "traits": { - "smithy.api#documentation": "The number of tasks in the task set that are in the RUNNING
status during\n a deployment. A task in the RUNNING
state is running and ready for\n use.
The number of tasks in the task set that are in the PENDING
status during\n\t\t\ta deployment. A task in the PENDING
state is preparing to enter the\n\t\t\t\tRUNNING
state. A task set enters the PENDING
status when\n\t\t\tit launches for the first time or when it is restarted after being in the\n\t\t\t\tSTOPPED
state.
A floating-point percentage of the desired number of tasks to place and keep running\n in the task set.
" + "smithy.api#documentation": "The metadata that you apply to the task set to help you categorize and organize them.\n\t\t\tEach tag consists of a key and an optional value, both of which you define.
\n\t\tThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists\n in.
" + "smithy.api#documentation": "The status of the task set. The following describes each state:
\n\t\tThe task set is serving production traffic.
\n\t\t\t\tThe task set is not serving production traffic.
\n\t\t\t\tThe tasks in the task set are being stopped and their corresponding\n\t\t\t\t\t\ttargets are being deregistered from their target group.
\n\t\t\t\tThe number of tasks in the task set that are in the RUNNING
status during\n\t\t\ta deployment. A task in the RUNNING
state is running and ready for\n\t\t\tuse.
The platform version on which the tasks in the task set are running. A platform\n version is only specified for tasks using the Fargate launch type. If one\n is not specified, the LATEST
platform version is used by default. For more\n information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.
The Amazon Resource Name (ARN) of the task set.
" } }, - "tags": { - "target": "com.amazonaws.ecs#Tags", + "scale": { + "target": "com.amazonaws.ecs#Scale", + "traits": { + "smithy.api#documentation": "A floating-point percentage of the desired number of tasks to place and keep running\n\t\t\tin the task set.
" + } + }, + "stabilityStatus": { + "target": "com.amazonaws.ecs#StabilityStatus", "traits": { - "smithy.api#documentation": "The metadata that you apply to the task set to help you categorize and organize them.\n Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50
\nFor each resource, each tag key must be unique, and each tag key can have only\n one value.
\nMaximum key length - 128 Unicode characters in UTF-8
\nMaximum value length - 256 Unicode characters in UTF-8
\nIf your tagging schema is used across multiple services and resources,\n remember that other services may have restrictions on allowed characters.\n Generally allowed characters are: letters, numbers, and spaces representable in\n UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case-sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase\n combination of such as a prefix for either keys or values as it is reserved for\n AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with\n this prefix do not count against your tags per resource limit.
The stability status, which indicates whether the task set has reached a steady state.\n\t\t\tIf the following conditions are met, the task set will be in\n\t\t\tSTEADY_STATE
:
The task runningCount
is equal to the\n\t\t\t\t\t\tcomputedDesiredCount
.
The pendingCount
is 0
.
There are no tasks running on container instances in the DRAINING
\n\t\t\t\t\tstatus.
All tasks are reporting a healthy status from the load balancers, service\n\t\t\t\t\tdiscovery, and container health checks.
\n\t\t\tIf any of those conditions are not met, the stability status returns\n\t\t\t\tSTABILIZING
.
The Unix timestamp for when the task set stability status was retrieved.
" } }, - "startedBy": { + "clusterArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy\n deployment, the startedBy
parameter is CODE_DEPLOY
. For a task\n set created for an external deployment, the startedBy field isn't used.
The Amazon Resource Name (ARN) of the cluster that the service that hosts the task set exists\n\t\t\tin.
" } }, "networkConfiguration": { @@ -7587,10 +7632,16 @@ "traits": { "smithy.api#documentation": "The network configuration for the task set.
" } + }, + "startedBy": { + "target": "com.amazonaws.ecs#String", + "traits": { + "smithy.api#documentation": "The tag specified when a task set is started. If the task set is created by an AWS CodeDeploy\n\t\t\tdeployment, the startedBy
parameter is CODE_DEPLOY
. For a task\n\t\t\tset created for an external deployment, the startedBy field isn't used.
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL
\n deployment. An Amazon ECS task set includes details such as the desired number of tasks, how\n many tasks are running, and whether the task set serves production traffic.
Information about a set of Amazon ECS tasks in either an AWS CodeDeploy or an EXTERNAL
\n\t\t\tdeployment. An Amazon ECS task set includes details such as the desired number of tasks, how\n\t\t\tmany tasks are running, and whether the task set serves production traffic.
The specified task set could not be found. You can view your available task sets with\n DescribeTaskSets. Task sets are specific to each cluster, service\n and Region.
", + "smithy.api#documentation": "The specified task set could not be found. You can view your available task sets with\n\t\t\t\tDescribeTaskSets. Task sets are specific to each cluster, service\n\t\t\tand Region.
", "smithy.api#error": "client" } }, @@ -7659,10 +7710,16 @@ "com.amazonaws.ecs#Tmpfs": { "type": "structure", "members": { + "mountOptions": { + "target": "com.amazonaws.ecs#StringList", + "traits": { + "smithy.api#documentation": "The list of tmpfs volume mount options.
\n\t\tValid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" |\n\t\t\t\t\"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" |\n\t\t\t\t\"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" |\n\t\t\t\t\"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" |\n\t\t\t\t\"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\"\n\t\t\t\t| \"nr_inodes\" | \"nr_blocks\" | \"mpol\"
\n
The size (in MiB) of the tmpfs volume.
", + "smithy.api#documentation": "The maximum size (in MiB) of the tmpfs volume.
", "smithy.api#required": {} } }, @@ -7672,12 +7729,6 @@ "smithy.api#documentation": "The absolute file path where the tmpfs volume is to be mounted.
", "smithy.api#required": {} } - }, - "mountOptions": { - "target": "com.amazonaws.ecs#StringList", - "traits": { - "smithy.api#documentation": "The list of tmpfs volume mount options.
\nValid values: \"defaults\" | \"ro\" | \"rw\" | \"suid\" | \"nosuid\" | \"dev\" | \"nodev\" |\n \"exec\" | \"noexec\" | \"sync\" | \"async\" | \"dirsync\" | \"remount\" | \"mand\" | \"nomand\" |\n \"atime\" | \"noatime\" | \"diratime\" | \"nodiratime\" | \"bind\" | \"rbind\" | \"unbindable\" |\n \"runbindable\" | \"private\" | \"rprivate\" | \"shared\" | \"rshared\" | \"slave\" | \"rslave\" |\n \"relatime\" | \"norelatime\" | \"strictatime\" | \"nostrictatime\" | \"mode\" | \"uid\" | \"gid\"\n | \"nr_inodes\" | \"nr_blocks\" | \"mpol\"
\n
The hard limit for the ulimit type.
", + "smithy.api#documentation": "The type
of the ulimit
.
The type
of the ulimit
.
The hard limit for the ulimit type.
", "smithy.api#required": {} } }, @@ -7861,7 +7912,7 @@ "resourceArn": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported\n resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and\n container instances.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported\n\t\t\tresources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and\n\t\t\tcontainer instances.
", "smithy.api#required": {} } } @@ -7910,7 +7961,7 @@ "settings": { "target": "com.amazonaws.ecs#ClusterSettings", "traits": { - "smithy.api#documentation": "The setting to use by default for a cluster. This parameter is used to enable CloudWatch\n Container Insights for a cluster. If this value is specified, it will override the\n containerInsights
value set with PutAccountSetting or\n PutAccountSettingDefault.
The setting to use by default for a cluster. This parameter is used to enable CloudWatch\n\t\t\tContainer Insights for a cluster. If this value is specified, it will override the\n\t\t\t\tcontainerInsights
value set with PutAccountSetting or\n\t\t\t\tPutAccountSettingDefault.
Updates the Amazon ECS container agent on a specified container instance. Updating the\n Amazon ECS container agent does not interrupt running tasks or services on the container\n instance. The process for updating the agent differs depending on whether your container\n instance was launched with the Amazon ECS-optimized AMI or another operating system.
\n\n UpdateContainerAgent
requires the Amazon ECS-optimized AMI or Amazon Linux with\n the ecs-init
service installed and running. For help updating the Amazon ECS\n container agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the\n Amazon Elastic Container Service Developer Guide.
Updates the Amazon ECS container agent on a specified container instance. Updating the\n\t\t\tAmazon ECS container agent does not interrupt running tasks or services on the container\n\t\t\tinstance. The process for updating the agent differs depending on whether your container\n\t\t\tinstance was launched with the Amazon ECS-optimized AMI or another operating system.
\n\t\t\n\t\t\t UpdateContainerAgent
requires the Amazon ECS-optimized AMI or Amazon Linux with\n\t\t\tthe ecs-init
service installed and running. For help updating the Amazon ECS\n\t\t\tcontainer agent on other operating systems, see Manually Updating the Amazon ECS Container Agent in the\n\t\t\t\tAmazon Elastic Container Service Developer Guide.
The container instance ID or full ARN entries for the container instance on which\n you would like to update the Amazon ECS container agent.
", + "smithy.api#documentation": "The container instance ID or full ARN entries for the container instance on which\n\t\t\tyou would like to update the Amazon ECS container agent.
", "smithy.api#required": {} } }, "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is\n running on. If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that your container instance is\n\t\t\trunning on. If you do not specify a cluster, the default cluster is assumed.
" } } } @@ -8011,7 +8062,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the status of an Amazon ECS container instance.
\nOnce a container instance has reached an ACTIVE
state, you can change the\n status of a container instance to DRAINING
to manually remove an instance\n from a cluster, for example to perform system updates, update the Docker daemon, or\n scale down the cluster size.
A container instance cannot be changed to DRAINING
until it has\n reached an ACTIVE
status. If the instance is in any other status, an\n error will be received.
When you set a container instance to DRAINING
, Amazon ECS prevents new tasks\n from being scheduled for placement on the container instance and replacement service\n tasks are started on other container instances in the cluster if the resources are\n available. Service tasks on the container instance that are in the PENDING
\n state are stopped immediately.
Service tasks on the container instance that are in the RUNNING
state are\n stopped and replaced according to the service's deployment configuration parameters,\n minimumHealthyPercent
and maximumPercent
. You can change\n the deployment configuration of your service using UpdateService.
If minimumHealthyPercent
is below 100%, the scheduler can ignore\n desiredCount
temporarily during task replacement. For example,\n desiredCount
is four tasks, a minimum of 50% allows the\n scheduler to stop two existing tasks before starting two new tasks. If the\n minimum is 100%, the service scheduler can't remove existing tasks until the\n replacement tasks are considered healthy. Tasks for services that do not use a\n load balancer are considered healthy if they are in the RUNNING
\n state. Tasks for services that use a load balancer are considered healthy if\n they are in the RUNNING
state and the container instance they are\n hosted on is reported as healthy by the load balancer.
The maximumPercent
parameter represents an upper limit on the\n number of running tasks during task replacement, which enables you to define the\n replacement batch size. For example, if desiredCount
is four tasks,\n a maximum of 200% starts four new tasks before stopping the four tasks to be\n drained, provided that the cluster resources required to do this are available.\n If the maximum is 100%, then replacement tasks can't start until the draining\n tasks have stopped.
Any PENDING
or RUNNING
tasks that do not belong to a service\n are not affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING
\n tasks. You can verify this using ListTasks.
When a container instance has been drained, you can set a container instance to\n ACTIVE
status and once it has reached that status the Amazon ECS scheduler\n can begin scheduling tasks on the instance again.
Modifies the status of an Amazon ECS container instance.
\n\t\tOnce a container instance has reached an ACTIVE
state, you can change the\n\t\t\tstatus of a container instance to DRAINING
to manually remove an instance\n\t\t\tfrom a cluster, for example to perform system updates, update the Docker daemon, or\n\t\t\tscale down the cluster size.
A container instance cannot be changed to DRAINING
until it has\n\t\t\t\treached an ACTIVE
status. If the instance is in any other status, an\n\t\t\t\terror will be received.
When you set a container instance to DRAINING
, Amazon ECS prevents new tasks\n\t\t\tfrom being scheduled for placement on the container instance and replacement service\n\t\t\ttasks are started on other container instances in the cluster if the resources are\n\t\t\tavailable. Service tasks on the container instance that are in the PENDING
\n\t\t\tstate are stopped immediately.
Service tasks on the container instance that are in the RUNNING
state are\n\t\t\tstopped and replaced according to the service's deployment configuration parameters,\n\t\t\t\tminimumHealthyPercent
and maximumPercent
. You can change\n\t\t\tthe deployment configuration of your service using UpdateService.
If minimumHealthyPercent
is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount
temporarily during task replacement. For example,\n\t\t\t\t\t\tdesiredCount
is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. If the\n\t\t\t\t\tminimum is 100%, the service scheduler can't remove existing tasks until the\n\t\t\t\t\treplacement tasks are considered healthy. Tasks for services that do not use a\n\t\t\t\t\tload balancer are considered healthy if they are in the RUNNING
\n\t\t\t\t\tstate. Tasks for services that use a load balancer are considered healthy if\n\t\t\t\t\tthey are in the RUNNING
state and the container instance they are\n\t\t\t\t\thosted on is reported as healthy by the load balancer.
The maximumPercent
parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during task replacement, which enables you to define the\n\t\t\t\t\treplacement batch size. For example, if desiredCount
is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four tasks to be\n\t\t\t\t\tdrained, provided that the cluster resources required to do this are available.\n\t\t\t\t\tIf the maximum is 100%, then replacement tasks can't start until the draining\n\t\t\t\t\ttasks have stopped.
Any PENDING
or RUNNING
tasks that do not belong to a service\n\t\t\tare not affected. You must wait for them to finish or stop them manually.
A container instance has completed draining when it has no more RUNNING
\n\t\t\ttasks. You can verify this using ListTasks.
When a container instance has been drained, you can set a container instance to\n\t\t\t\tACTIVE
status and once it has reached that status the Amazon ECS scheduler\n\t\t\tcan begin scheduling tasks on the instance again.
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n update. If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the container instance to\n\t\t\tupdate. If you do not specify a cluster, the default cluster is assumed.
" } }, - "containerInstances": { - "target": "com.amazonaws.ecs#StringList", + "status": { + "target": "com.amazonaws.ecs#ContainerInstanceStatus", "traits": { - "smithy.api#documentation": "A list of container instance IDs or full ARN entries.
", + "smithy.api#documentation": "The container instance state with which to update the container instance. The only\n\t\t\tvalid values for this action are ACTIVE
and DRAINING
. A\n\t\t\tcontainer instance can only be updated to DRAINING
status once it has\n\t\t\treached an ACTIVE
state. If a container instance is in\n\t\t\t\tREGISTERING
, DEREGISTERING
, or\n\t\t\t\tREGISTRATION_FAILED
state you can describe the container instance but\n\t\t\twill be unable to update the container instance state.
The container instance state with which to update the container instance. The only\n valid values for this action are ACTIVE
and DRAINING
. A\n container instance can only be updated to DRAINING
status once it has\n reached an ACTIVE
state. If a container instance is in\n REGISTERING
, DEREGISTERING
, or\n REGISTRATION_FAILED
state you can describe the container instance but\n will be unable to update the container instance state.
A list of container instance IDs or full ARN entries.
", "smithy.api#required": {} } } @@ -8064,7 +8115,7 @@ } }, "traits": { - "smithy.api#documentation": "There is already a current Amazon ECS container agent update in progress on the specified\n container instance. If the container agent becomes disconnected while it is in a\n transitional stage, such as PENDING
or STAGING
, the update\n process can get stuck in that state. However, when the agent reconnects, it resumes\n where it stopped previously.
There is already a current Amazon ECS container agent update in progress on the specified\n\t\t\tcontainer instance. If the container agent becomes disconnected while it is in a\n\t\t\ttransitional stage, such as PENDING
or STAGING
, the update\n\t\t\tprocess can get stuck in that state. However, when the agent reconnects, it resumes\n\t\t\twhere it stopped previously.
Updating the task placement strategies and constraints on an Amazon ECS service remains\n in preview and is a Beta Service as defined by and subject to the Beta Service\n Participation Service Terms located at https://aws.amazon.com/service-terms (\"Beta Terms\"). These Beta Terms\n apply to your participation in this preview.
\nModifies the parameters of a service.
\nFor services using the rolling update (ECS
) deployment controller, the\n desired count, deployment configuration, network configuration, task placement\n constraints and strategies, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY
) deployment controller,\n only the desired count, deployment configuration, task placement constraints and\n strategies, and health check grace period can be updated using this API. If the network\n configuration, platform version, or task definition need to be updated, a new AWS CodeDeploy\n deployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired\n count, task placement constraints and strategies, and health check grace period using\n this API. If the launch type, load balancer, network configuration, platform version, or\n task definition need to be updated, you should create a new task set. For more\n information, see CreateTaskSet.
\nYou can add to or subtract from the number of instantiations of a task definition in a\n service by specifying the cluster that the service is running in and a new\n desiredCount
parameter.
If you have updated the Docker image of your application, you can create a new task\n definition with that image and deploy it to your service. The service scheduler uses the\n minimum healthy percent and maximum percent parameters (in the service's deployment\n configuration) to determine the deployment strategy.
\nIf your updated Docker image uses the same tag as what is in the existing task\n definition for your service (for example, my_image:latest
), you do not\n need to create a new revision of your task definition. You can update the service\n using the forceNewDeployment
option. The new tasks launched by the\n deployment pull the current image/tag combination from your repository when they\n start.
You can also update the deployment configuration of a service. When a deployment is\n triggered by updating the task definition of a service, the service scheduler uses the\n deployment configuration parameters, minimumHealthyPercent
and\n maximumPercent
, to determine the deployment strategy.
If minimumHealthyPercent
is below 100%, the scheduler can ignore\n desiredCount
temporarily during a deployment. For example, if\n desiredCount
is four tasks, a minimum of 50% allows the\n scheduler to stop two existing tasks before starting two new tasks. Tasks for\n services that do not use a load balancer are considered healthy if they are in\n the RUNNING
state. Tasks for services that use a load balancer are\n considered healthy if they are in the RUNNING
state and the\n container instance they are hosted on is reported as healthy by the load\n balancer.
The maximumPercent
parameter represents an upper limit on the\n number of running tasks during a deployment, which enables you to define the\n deployment batch size. For example, if desiredCount
is four tasks,\n a maximum of 200% starts four new tasks before stopping the four older tasks\n (provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent\n of docker stop
is issued to the containers running in the task. This\n results in a SIGTERM
and a 30-second timeout, after which\n SIGKILL
is sent and the containers are forcibly stopped. If the\n container handles the SIGTERM
gracefully and exits within 30 seconds from\n receiving it, no SIGKILL
is sent.
When the service scheduler launches new tasks, it determines task placement in your\n cluster with the following logic:
\nDetermine which of the container instances in your cluster can support your\n service's task definition (for example, they have the required CPU, memory,\n ports, and container instance attributes).
\nBy default, the service scheduler attempts to balance tasks across\n Availability Zones in this manner (although you can choose a different placement\n strategy):
\nSort the valid container instances by the fewest number of running\n tasks for this service in the same Availability Zone as the instance.\n For example, if zone A has one running service task and zones B and C\n each have zero, valid container instances in either zone B or C are\n considered optimal for placement.
\nPlace the new service task on a valid container instance in an optimal\n Availability Zone (based on the previous steps), favoring container\n instances with the fewest number of running tasks for this\n service.
\nWhen the service scheduler stops running tasks, it attempts to maintain balance across\n the Availability Zones in your cluster using the following logic:
\nSort the container instances by the largest number of running tasks for this\n service in the same Availability Zone as the instance. For example, if zone A\n has one running service task and zones B and C each have two, container\n instances in either zone B or C are considered optimal for termination.
\nStop the task on a container instance in an optimal Availability Zone (based\n on the previous steps), favoring container instances with the largest number of\n running tasks for this service.
\nUpdating the task placement strategies and constraints on an Amazon ECS service remains\n\t\t\t\tin preview and is a Beta Service as defined by and subject to the Beta Service\n\t\t\t\tParticipation Service Terms located at https://aws.amazon.com/service-terms (\"Beta Terms\"). These Beta Terms\n\t\t\t\tapply to your participation in this preview.
\n\t\tModifies the parameters of a service.
\n\t\tFor services using the rolling update (ECS
) deployment controller, the\n\t\t\tdesired count, deployment configuration, network configuration, task placement\n\t\t\tconstraints and strategies, or task definition used can be updated.
For services using the blue/green (CODE_DEPLOY
) deployment controller,\n\t\t\tonly the desired count, deployment configuration, task placement constraints and\n\t\t\tstrategies, and health check grace period can be updated using this API. If the network\n\t\t\tconfiguration, platform version, or task definition need to be updated, a new AWS CodeDeploy\n\t\t\tdeployment should be created. For more information, see CreateDeployment in the AWS CodeDeploy API Reference.
For services using an external deployment controller, you can update only the desired\n\t\t\tcount, task placement constraints and strategies, and health check grace period using\n\t\t\tthis API. If the launch type, load balancer, network configuration, platform version, or\n\t\t\ttask definition need to be updated, you should create a new task set. For more\n\t\t\tinformation, see CreateTaskSet.
\n\t\tYou can add to or subtract from the number of instantiations of a task definition in a\n\t\t\tservice by specifying the cluster that the service is running in and a new\n\t\t\t\tdesiredCount
parameter.
If you have updated the Docker image of your application, you can create a new task\n\t\t\tdefinition with that image and deploy it to your service. The service scheduler uses the\n\t\t\tminimum healthy percent and maximum percent parameters (in the service's deployment\n\t\t\tconfiguration) to determine the deployment strategy.
\n\t\tIf your updated Docker image uses the same tag as what is in the existing task\n\t\t\t\tdefinition for your service (for example, my_image:latest
), you do not\n\t\t\t\tneed to create a new revision of your task definition. You can update the service\n\t\t\t\tusing the forceNewDeployment
option. The new tasks launched by the\n\t\t\t\tdeployment pull the current image/tag combination from your repository when they\n\t\t\t\tstart.
You can also update the deployment configuration of a service. When a deployment is\n\t\t\ttriggered by updating the task definition of a service, the service scheduler uses the\n\t\t\tdeployment configuration parameters, minimumHealthyPercent
and\n\t\t\t\tmaximumPercent
, to determine the deployment strategy.
If minimumHealthyPercent
is below 100%, the scheduler can ignore\n\t\t\t\t\t\tdesiredCount
temporarily during a deployment. For example, if\n\t\t\t\t\t\tdesiredCount
is four tasks, a minimum of 50% allows the\n\t\t\t\t\tscheduler to stop two existing tasks before starting two new tasks. Tasks for\n\t\t\t\t\tservices that do not use a load balancer are considered healthy if they are in\n\t\t\t\t\tthe RUNNING
state. Tasks for services that use a load balancer are\n\t\t\t\t\tconsidered healthy if they are in the RUNNING
state and the\n\t\t\t\t\tcontainer instance they are hosted on is reported as healthy by the load\n\t\t\t\t\tbalancer.
The maximumPercent
parameter represents an upper limit on the\n\t\t\t\t\tnumber of running tasks during a deployment, which enables you to define the\n\t\t\t\t\tdeployment batch size. For example, if desiredCount
is four tasks,\n\t\t\t\t\ta maximum of 200% starts four new tasks before stopping the four older tasks\n\t\t\t\t\t(provided that the cluster resources required to do this are available).
When UpdateService stops a task during a deployment, the equivalent\n\t\t\tof docker stop
is issued to the containers running in the task. This\n\t\t\tresults in a SIGTERM
and a 30-second timeout, after which\n\t\t\t\tSIGKILL
is sent and the containers are forcibly stopped. If the\n\t\t\tcontainer handles the SIGTERM
gracefully and exits within 30 seconds from\n\t\t\treceiving it, no SIGKILL
is sent.
When the service scheduler launches new tasks, it determines task placement in your\n\t\t\tcluster with the following logic:
\n\t\tDetermine which of the container instances in your cluster can support your\n\t\t\t\t\tservice's task definition (for example, they have the required CPU, memory,\n\t\t\t\t\tports, and container instance attributes).
\n\t\t\tBy default, the service scheduler attempts to balance tasks across\n\t\t\t\t\tAvailability Zones in this manner (although you can choose a different placement\n\t\t\t\t\tstrategy):
\n\t\t\t\tSort the valid container instances by the fewest number of running\n\t\t\t\t\t\t\ttasks for this service in the same Availability Zone as the instance.\n\t\t\t\t\t\t\tFor example, if zone A has one running service task and zones B and C\n\t\t\t\t\t\t\teach have zero, valid container instances in either zone B or C are\n\t\t\t\t\t\t\tconsidered optimal for placement.
\n\t\t\t\t\tPlace the new service task on a valid container instance in an optimal\n\t\t\t\t\t\t\tAvailability Zone (based on the previous steps), favoring container\n\t\t\t\t\t\t\tinstances with the fewest number of running tasks for this\n\t\t\t\t\t\t\tservice.
\n\t\t\t\t\tWhen the service scheduler stops running tasks, it attempts to maintain balance across\n\t\t\tthe Availability Zones in your cluster using the following logic:
\n\t\tSort the container instances by the largest number of running tasks for this\n\t\t\t\t\tservice in the same Availability Zone as the instance. For example, if zone A\n\t\t\t\t\thas one running service task and zones B and C each have two, container\n\t\t\t\t\tinstances in either zone B or C are considered optimal for termination.
\n\t\t\tStop the task on a container instance in an optimal Availability Zone (based\n\t\t\t\t\ton the previous steps), favoring container instances with the largest number of\n\t\t\t\t\trunning tasks for this service.
\n\t\t\tModifies which task set in a service is the primary task set. Any parameters that are\n updated on the primary task set in a service will transition to the service. This is\n used when a service uses the EXTERNAL
deployment controller type. For more\n information, see Amazon ECS Deployment\n Types in the Amazon Elastic Container Service Developer Guide.
Modifies which task set in a service is the primary task set. Any parameters that are\n\t\t\tupdated on the primary task set in a service will transition to the service. This is\n\t\t\tused when a service uses the EXTERNAL
deployment controller type. For more\n\t\t\tinformation, see Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the\n deployment.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset exists in.
", "smithy.api#required": {} } }, - "cluster": { + "primaryTaskSet": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n set exists in.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the task set to set as the primary task set in the\n\t\t\tdeployment.
", "smithy.api#required": {} } } @@ -8187,37 +8238,31 @@ "com.amazonaws.ecs#UpdateServiceRequest": { "type": "structure", "members": { - "deploymentConfiguration": { - "target": "com.amazonaws.ecs#DeploymentConfiguration", + "capacityProviderStrategy": { + "target": "com.amazonaws.ecs#CapacityProviderStrategy", "traits": { - "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment\n and the ordering of stopping and starting tasks.
" + "smithy.api#documentation": "The capacity provider strategy to update the service to use.
\n\t\tIf the service is using the default capacity provider strategy for the cluster, the\n\t\t\tservice can be updated to use one or more capacity providers as opposed to the default\n\t\t\tcapacity provider strategy. However, when a service is using a capacity provider\n\t\t\tstrategy that is not the default capacity provider strategy, the service cannot be\n\t\t\tupdated to use the cluster's default capacity provider strategy.
\n\t\tA capacity provider strategy consists of one or more capacity providers along with the\n\t\t\t\tbase
and weight
to assign to them. A capacity provider\n\t\t\tmust be associated with the cluster to be used in a capacity provider strategy. The\n\t\t\t\tPutClusterCapacityProviders API is used to associate a capacity\n\t\t\tprovider with a cluster. Only capacity providers with an ACTIVE
or\n\t\t\t\tUPDATING
status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n\t\t\tprovider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\n\t\tTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n\t\t\t\tFARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n\t\t\tavailable to all accounts and only need to be associated with a cluster to be\n\t\t\tused.
The PutClusterCapacityProviders API operation is used to update the\n\t\t\tlist of available capacity providers for a cluster after the cluster is created.
\n\t\t " } }, + "networkConfiguration": { + "target": "com.amazonaws.ecs#NetworkConfiguration" + }, "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on.\n If you do not specify a cluster, the default cluster is assumed.
" + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that your service is running on.\n\t\t\tIf you do not specify a cluster, the default cluster is assumed.
" } }, - "platformVersion": { - "target": "com.amazonaws.ecs#String", + "placementStrategy": { + "target": "com.amazonaws.ecs#PlacementStrategies", "traits": { - "smithy.api#documentation": "The platform version on which your tasks in the service are running. A platform\n version is only specified for tasks using the Fargate launch type. If a\n platform version is not specified, the LATEST
platform version is used by\n default. For more information, see AWS Fargate Platform\n Versions in the Amazon Elastic Container Service Developer Guide.
The task placement strategy objects to update the service to use. If no value is\n\t\t\tspecified, the existing placement strategy for the service will remain unchanged. If\n\t\t\tthis value is specified, it will override the existing placement strategy defined for\n\t\t\tthe service. To remove an existing placement strategy, specify an empty object.
\n\t\tYou can specify a maximum of five strategy rules per service.
" } }, - "networkConfiguration": { - "target": "com.amazonaws.ecs#NetworkConfiguration" - }, "desiredCount": { "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "The number of instantiations of the task to place and keep running in your\n service.
" - } - }, - "placementStrategy": { - "target": "com.amazonaws.ecs#PlacementStrategies", - "traits": { - "smithy.api#documentation": "The task placement strategy objects to update the service to use. If no value is\n specified, the existing placement strategy for the service will remain unchanged. If\n this value is specified, it will override the existing placement strategy defined for\n the service. To remove an existing placement strategy, specify an empty object.
\nYou can specify a maximum of five strategy rules per service.
" + "smithy.api#documentation": "The number of instantiations of the task to place and keep running in your\n\t\t\tservice.
" } }, "service": { @@ -8227,34 +8272,40 @@ "smithy.api#required": {} } }, - "forceNewDeployment": { - "target": "com.amazonaws.ecs#Boolean", + "healthCheckGracePeriodSeconds": { + "target": "com.amazonaws.ecs#BoxedInteger", "traits": { - "smithy.api#documentation": "Whether to force a new deployment of the service. Deployments are not forced by\n default. You can use this option to trigger a new deployment with no service definition\n changes. For example, you can update a service's tasks to use a newer Docker image with\n the same image/tag combination (my_image:latest
) or to roll Fargate tasks\n onto a newer platform version.
The period of time, in seconds, that the Amazon ECS service scheduler should ignore\n\t\t\tunhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid\n\t\t\tif your service is configured to use a load balancer. If your service's tasks take a\n\t\t\twhile to start and respond to Elastic Load Balancing health checks, you can specify a health check grace\n\t\t\tperiod of up to 2,147,483,647 seconds. During that time, the Amazon ECS service\n\t\t\tscheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS\n\t\t\tservice scheduler from marking tasks as unhealthy and stopping them before they have\n\t\t\ttime to come up.
" } }, "taskDefinition": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The family
and revision
(family:revision
) or\n full ARN of the task definition to run in your service. If a revision
is\n not specified, the latest ACTIVE
revision is used. If you modify the task\n definition with UpdateService
, Amazon ECS spawns a task with the new version of\n the task definition and then stops an old task after the new version is running.
The family
and revision
(family:revision
) or\n\t\t\tfull ARN of the task definition to run in your service. If a revision
is\n\t\t\tnot specified, the latest ACTIVE
revision is used. If you modify the task\n\t\t\tdefinition with UpdateService
, Amazon ECS spawns a task with the new version of\n\t\t\tthe task definition and then stops an old task after the new version is running.
The period of time, in seconds, that the Amazon ECS service scheduler should ignore\n unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid\n if your service is configured to use a load balancer. If your service's tasks take a\n while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace\n period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service\n scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS\n service scheduler from marking tasks as unhealthy and stopping them before they have\n time to come up.
" + "smithy.api#documentation": "The platform version on which your tasks in the service are running. A platform\n\t\t\tversion is only specified for tasks using the Fargate launch type. If a\n\t\t\tplatform version is not specified, the LATEST
platform version is used by\n\t\t\tdefault. For more information, see AWS Fargate Platform\n\t\t\t\tVersions in the Amazon Elastic Container Service Developer Guide.
Whether to force a new deployment of the service. Deployments are not forced by\n\t\t\tdefault. You can use this option to trigger a new deployment with no service definition\n\t\t\tchanges. For example, you can update a service's tasks to use a newer Docker image with\n\t\t\tthe same image/tag combination (my_image:latest
) or to roll Fargate tasks\n\t\t\tonto a newer platform version.
An array of task placement constraint objects to update the service to use. If no\n value is specified, the existing placement constraints for the service will remain\n unchanged. If this value is specified, it will override any existing placement\n constraints defined for the service. To remove all existing placement constraints,\n specify an empty array.
\nYou can specify a maximum of 10 constraints per task (this limit includes constraints\n in the task definition and those specified at runtime).
" + "smithy.api#documentation": "An array of task placement constraint objects to update the service to use. If no\n\t\t\tvalue is specified, the existing placement constraints for the service will remain\n\t\t\tunchanged. If this value is specified, it will override any existing placement\n\t\t\tconstraints defined for the service. To remove all existing placement constraints,\n\t\t\tspecify an empty array.
\n\t\tYou can specify a maximum of 10 constraints per task (this limit includes constraints\n\t\t\tin the task definition and those specified at runtime).
" } }, - "capacityProviderStrategy": { - "target": "com.amazonaws.ecs#CapacityProviderStrategy", + "deploymentConfiguration": { + "target": "com.amazonaws.ecs#DeploymentConfiguration", "traits": { - "smithy.api#documentation": "The capacity provider strategy to update the service to use.
\nIf the service is using the default capacity provider strategy for the cluster, the\n service can be updated to use one or more capacity providers as opposed to the default\n capacity provider strategy. However, when a service is using a capacity provider\n strategy that is not the default capacity provider strategy, the service cannot be\n updated to use the cluster's default capacity provider strategy.
\nA capacity provider strategy consists of one or more capacity providers along with the\n base
and weight
to assign to them. A capacity provider\n must be associated with the cluster to be used in a capacity provider strategy. The\n PutClusterCapacityProviders API is used to associate a capacity\n provider with a cluster. Only capacity providers with an ACTIVE
or\n UPDATING
status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity\n provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
\nTo use a AWS Fargate capacity provider, specify either the FARGATE
or\n FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are\n available to all accounts and only need to be associated with a cluster to be\n used.
The PutClusterCapacityProviders API operation is used to update the\n list of available capacity providers for a cluster after the cluster is created.
\n " + "smithy.api#documentation": "Optional deployment parameters that control how many tasks run during the deployment\n\t\t\tand the ordering of stopping and starting tasks.
" } } } @@ -8308,7 +8359,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies a task set. This is used when a service uses the EXTERNAL
\n deployment controller type. For more information, see Amazon ECS Deployment\n Types in the Amazon Elastic Container Service Developer Guide.
Modifies a task set. This is used when a service uses the EXTERNAL
\n\t\t\tdeployment controller type. For more information, see Amazon ECS Deployment\n\t\t\t\tTypes in the Amazon Elastic Container Service Developer Guide.
The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the task set to update.
", "smithy.api#required": {} } }, "cluster": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n set exists in.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service that the task\n\t\t\tset exists in.
", "smithy.api#required": {} } }, - "taskSet": { + "service": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the task set to update.
", + "smithy.api#documentation": "The short name or full Amazon Resource Name (ARN) of the service that the task set exists in.
", "smithy.api#required": {} } } @@ -8363,7 +8414,7 @@ "agentHash": { "target": "com.amazonaws.ecs#String", "traits": { - "smithy.api#documentation": "The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent\n GitHub repository.
" + "smithy.api#documentation": "The Git commit hash for the Amazon ECS container agent build on the amazon-ecs-agent\n\t\t\t GitHub repository.
" } }, "dockerVersion": { @@ -8374,54 +8425,60 @@ } }, "traits": { - "smithy.api#documentation": "The Docker and Amazon ECS container agent version information about a container\n instance.
" + "smithy.api#documentation": "The Docker and Amazon ECS container agent version information about a container\n\t\t\tinstance.
" } }, "com.amazonaws.ecs#Volume": { "type": "structure", "members": { - "efsVolumeConfiguration": { - "target": "com.amazonaws.ecs#EFSVolumeConfiguration", + "host": { + "target": "com.amazonaws.ecs#HostVolumeProperties", + "traits": { + "smithy.api#documentation": "This parameter is specified when you are using bind mount host volumes. The contents\n\t\t\tof the host
parameter determine whether your bind mount host volume\n\t\t\tpersists on the host container instance and where it is stored. If the host
\n\t\t\tparameter is empty, then the Docker daemon assigns a host path for your data volume.\n\t\t\tHowever, the data is not guaranteed to persist after the containers associated with it\n\t\t\tstop running.
Windows containers can mount whole directories on the same drive as\n\t\t\t\t$env:ProgramData
. Windows containers cannot mount directories on a\n\t\t\tdifferent drive, and mount point cannot be across drives. For example, you can mount\n\t\t\t\tC:\\my\\path:C:\\my\\path
and D:\\:D:\\
, but not\n\t\t\t\tD:\\my\\path:C:\\my\\path
or D:\\:C:\\my\\path
.
This parameter is specified when you are using an Amazon Elastic File System file system for task\n storage.
" + "smithy.api#documentation": "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This name is referenced in the\n\t\t\t\tsourceVolume
parameter of container definition\n\t\t\tmountPoints
.
This parameter is specified when you are using Docker volumes. Docker volumes are only\n supported when you are using the EC2 launch type. Windows containers only\n support the use of the local
driver. To use bind mounts, specify the\n host
parameter instead.
This parameter is specified when you are using Docker volumes. Docker volumes are only\n\t\t\tsupported when you are using the EC2 launch type. Windows containers only\n\t\t\tsupport the use of the local
driver. To use bind mounts, specify the\n\t\t\t\thost
parameter instead.
This parameter is specified when you are using bind mount host volumes. The contents\n of the host
parameter determine whether your bind mount host volume\n persists on the host container instance and where it is stored. If the host
\n parameter is empty, then the Docker daemon assigns a host path for your data volume.\n However, the data is not guaranteed to persist after the containers associated with it\n stop running.
Windows containers can mount whole directories on the same drive as\n $env:ProgramData
. Windows containers cannot mount directories on a\n different drive, and mount point cannot be across drives. For example, you can mount\n C:\\my\\path:C:\\my\\path
and D:\\:D:\\
, but not\n D:\\my\\path:C:\\my\\path
or D:\\:C:\\my\\path
.
This parameter is specified when you are using an Amazon Elastic File System file system for task\n\t\t\tstorage.
" } }, - "name": { - "target": "com.amazonaws.ecs#String", + "fsxWindowsFileServerVolumeConfiguration": { + "target": "com.amazonaws.ecs#FSxWindowsFileServerVolumeConfiguration", "traits": { - "smithy.api#documentation": "The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, and hyphens are allowed. This name is referenced in the\n sourceVolume
parameter of container definition\n mountPoints
.
This parameter is specified when you are using Amazon FSx for Windows File Server file system for task\n\t\t\tstorage.
" } } }, "traits": { - "smithy.api#documentation": "A data volume used in a task definition. For tasks that use Amazon Elastic File System\n (Amazon EFS) file storage, specify an efsVolumeConfiguration
. For tasks\n that use a Docker volume, specify a DockerVolumeConfiguration
. For tasks\n that use a bind mount host volume, specify a host
and optional\n sourcePath
. For more information, see Using Data Volumes in\n Tasks.
A data volume used in a task definition. For tasks that use the Amazon Elastic File\n\t\t\tSystem (Amazon EFS), specify an efsVolumeConfiguration
. For Windows tasks\n\t\t\tthat use Amazon FSx for Windows File Server file system, specify a\n\t\t\t\tfsxWindowsFileServerVolumeConfiguration
. For tasks that use a Docker\n\t\t\tvolume, specify a DockerVolumeConfiguration
. For tasks that use a bind\n\t\t\tmount host volume, specify a host
and optional sourcePath
. For\n\t\t\tmore information, see Using Data Volumes in\n\t\t\t\tTasks.
The name of another container within the same task definition from which to mount\n volumes.
" + "smithy.api#documentation": "If this value is true
, the container has read-only access to the volume.\n\t\t\tIf this value is false
, then the container can write to the volume. The\n\t\t\tdefault value is false
.
If this value is true
, the container has read-only access to the volume.\n If this value is false
, then the container can write to the volume. The\n default value is false
.
The name of another container within the same task definition from which to mount\n\t\t\tvolumes.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json b/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json index 93ad171e5148..1e20f2b1525c 100644 --- a/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json +++ b/codegen/sdk-codegen/aws-models/elastic-load-balancing-v2.2015-12-01.json @@ -52,22 +52,22 @@ "smithy.api#required": {} } }, - "AuthenticateCognitoConfig": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionConfig", + "TargetGroupArn": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { - "smithy.api#documentation": "[HTTPS listeners] Information for using Amazon Cognito to authenticate users. \n Specify only when Type
is authenticate-cognito
.
The Amazon Resource Name (ARN) of the target group. \n Specify only when Type
is forward
and you want to route to a single target group.\n To route to one or more target groups, use ForwardConfig
instead.
[Application Load Balancer] Information for creating a redirect action. \n Specify only when Type
is redirect
.
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). \n Specify only when Type
is authenticate-oidc
.
The Amazon Resource Name (ARN) of the target group. \n Specify only when Type
is forward
and you want to route to a single target group.\n To route to one or more target groups, use ForwardConfig
instead.
[HTTPS listeners] Information for using Amazon Cognito to authenticate users. \n Specify only when Type
is authenticate-cognito
.
The order for the action. This value is required for rules with multiple actions. \n The action with the lowest value for order is performed first.
" } }, - "FixedResponseConfig": { - "target": "com.amazonaws.elasticloadbalancingv2#FixedResponseActionConfig", + "RedirectConfig": { + "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionConfig", "traits": { - "smithy.api#documentation": "[Application Load Balancer] Information for creating an action that returns a custom HTTP response. \n Specify only when Type
is fixed-response
.
[Application Load Balancer] Information for creating a redirect action. \n Specify only when Type
is redirect
.
[HTTPS listeners] Information about an identity provider that is compliant with OpenID Connect (OIDC). \n Specify only when Type
is authenticate-oidc
.
[Application Load Balancer] Information for creating an action that returns a custom HTTP response. \n Specify only when Type
is fixed-response
.
Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.
\nIf the certificate in already in the certificate list, the call is successful but the certificate \n is not added again.
\nTo get the certificate list for a listener, use DescribeListenerCertificates. \n To remove certificates from the certificate list for a listener, use RemoveListenerCertificates.\n To replace the default certificate for a listener, use ModifyListener.
\nFor more information, see SSL Certificates\n in the Application Load Balancers Guide.
" + "smithy.api#documentation": "Adds the specified SSL server certificate to the certificate list for the specified HTTPS or TLS listener.
\nIf the certificate in already in the certificate list, the call is successful but the certificate \n is not added again.
\n \nFor more information, see HTTPS listeners in the Application Load Balancers Guide or TLS listeners in the\n Network Load Balancers Guide.
" } }, "com.amazonaws.elasticloadbalancingv2#AddListenerCertificatesInput": { "type": "structure", "members": { - "Certificates": { - "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", + "ListenerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { - "smithy.api#documentation": "The certificate to add. You can specify one certificate per call.\n Set CertificateArn
to the certificate ARN but do not set IsDefault
.
The Amazon Resource Name (ARN) of the listener.
", "smithy.api#required": {} } }, - "ListenerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", + "Certificates": { + "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener.
", + "smithy.api#documentation": "The certificate to add. You can specify one certificate per call.\n Set CertificateArn
to the certificate ARN but do not set IsDefault
.
Adds the specified tags to the specified Elastic Load Balancing resource. You can tag\n your Application Load Balancers, Network Load Balancers, target groups, listeners, and\n rules.
\nEach tag consists of a key and an optional value. If a resource already has a tag with\n the same key, AddTags
updates its value.
To list the current tags for your resources, use DescribeTags. To\n remove tags from your resources, use RemoveTags.
" + "smithy.api#documentation": "Adds the specified tags to the specified Elastic Load Balancing resource. You can tag your\n Application Load Balancers, Network Load Balancers, Gateway Load Balancers, target groups,\n listeners, and rules.
\nEach tag consists of a key and an optional value. If a resource already has a tag with\n the same key, AddTags
updates its value.
The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
", + "smithy.api#required": {} } }, - "Scope": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionScope", + "UserPoolClientId": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionUserPoolClientId", "traits": { - "smithy.api#documentation": "The set of user claims to be requested from the IdP. The default is openid
.
To verify which scope values your IdP supports and how to separate multiple values,\n see the documentation for your IdP.
" + "smithy.api#documentation": "The ID of the Amazon Cognito user pool client.
", + "smithy.api#required": {} } }, "UserPoolDomain": { @@ -325,17 +327,16 @@ "smithy.api#required": {} } }, - "UserPoolArn": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionUserPoolArn", + "SessionCookieName": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionSessionCookieName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon Cognito user pool.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
" } }, - "AuthenticationRequestExtraParams": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionAuthenticationRequestExtraParams", + "Scope": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionScope", "traits": { - "smithy.api#documentation": "The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
" + "smithy.api#documentation": "The set of user claims to be requested from the IdP. The default is openid
.
To verify which scope values your IdP supports and how to separate multiple values,\n see the documentation for your IdP.
" } }, "SessionTimeout": { @@ -344,17 +345,16 @@ "smithy.api#documentation": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
" } }, - "OnUnauthenticatedRequest": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionConditionalBehaviorEnum", + "AuthenticationRequestExtraParams": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionAuthenticationRequestExtraParams", "traits": { - "smithy.api#documentation": "The behavior if the user is not authenticated. The following are possible values:
\ndeny - Return an HTTP 401 Unauthorized error.
allow - Allow the request to be forwarded to the target.
authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
" } }, - "UserPoolClientId": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionUserPoolClientId", + "OnUnauthenticatedRequest": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateCognitoActionConditionalBehaviorEnum", "traits": { - "smithy.api#documentation": "The ID of the Amazon Cognito user pool client.
", - "smithy.api#required": {} + "smithy.api#documentation": "The behavior if the user is not authenticated. The following are possible values:
\ndeny - Return an HTTP 401 Unauthorized error.
allow - Allow the request to be forwarded to the target.
authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.
The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
", + "smithy.api#required": {} + } + }, "AuthorizationEndpoint": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionAuthorizationEndpoint", "traits": { @@ -436,6 +443,13 @@ "smithy.api#required": {} } }, + "TokenEndpoint": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionTokenEndpoint", + "traits": { + "smithy.api#documentation": "The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
", + "smithy.api#required": {} + } + }, "UserInfoEndpoint": { "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionUserInfoEndpoint", "traits": { @@ -456,24 +470,10 @@ "smithy.api#documentation": "The OAuth 2.0 client secret. This parameter is required if you are creating a rule. If you are modifying a rule,\n you can omit this parameter if you set UseExistingClientSecret
to true.
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule,\n you can omit this parameter or set it to false.
" - } - }, - "TokenEndpoint": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionTokenEndpoint", - "traits": { - "smithy.api#documentation": "The token endpoint of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
", - "smithy.api#required": {} - } - }, - "Issuer": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionIssuer", + "SessionCookieName": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionSessionCookieName", "traits": { - "smithy.api#documentation": "The OIDC issuer identifier of the IdP. This must be a full URL, including the HTTPS protocol, the domain, and the path.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
" } }, "Scope": { @@ -488,22 +488,22 @@ "smithy.api#documentation": "The maximum duration of the authentication session, in seconds. The default is 604800 seconds (7 days).
" } }, - "OnUnauthenticatedRequest": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionConditionalBehaviorEnum", - "traits": { - "smithy.api#documentation": "The behavior if the user is not authenticated. The following are possible values:
\ndeny - Return an HTTP 401 Unauthorized error.
allow - Allow the request to be forwarded to the target.
authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.
The query parameters (up to 10) to include in the redirect request to the authorization endpoint.
" } }, - "SessionCookieName": { - "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionSessionCookieName", + "OnUnauthenticatedRequest": { + "target": "com.amazonaws.elasticloadbalancingv2#AuthenticateOidcActionConditionalBehaviorEnum", "traits": { - "smithy.api#documentation": "The name of the cookie used to maintain session information. The default is AWSELBAuthSessionCookie.
" + "smithy.api#documentation": "The behavior if the user is not authenticated. The following are possible values:
\ndeny - Return an HTTP 401 Unauthorized error.
allow - Allow the request to be forwarded to the target.
authenticate - Redirect the request to the IdP authorization endpoint. This is the default value.
Indicates whether to use the existing client secret when modifying a rule. If you are creating a rule,\n you can omit this parameter or set it to false.
" } } }, @@ -541,22 +541,16 @@ "com.amazonaws.elasticloadbalancingv2#AvailabilityZone": { "type": "structure", "members": { - "SubnetId": { - "target": "com.amazonaws.elasticloadbalancingv2#SubnetId", - "traits": { - "smithy.api#documentation": "The ID of the subnet. You can specify one subnet per Availability Zone.
" - } - }, "ZoneName": { "target": "com.amazonaws.elasticloadbalancingv2#ZoneName", "traits": { "smithy.api#documentation": "The name of the Availability Zone.
" } }, - "LoadBalancerAddresses": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAddresses", + "SubnetId": { + "target": "com.amazonaws.elasticloadbalancingv2#SubnetId", "traits": { - "smithy.api#documentation": "[Network Load Balancers] If you need static IP addresses for your load balancer, \n you can specify one Elastic IP address per Availability Zone when you create an \n internal-facing load balancer. For internal load balancers, you can specify a private \n IP address from the IPv4 range of the subnet.
" + "smithy.api#documentation": "The ID of the subnet. You can specify one subnet per Availability Zone.
" } }, "OutpostId": { @@ -564,6 +558,12 @@ "traits": { "smithy.api#documentation": "[Application Load Balancers on Outposts] The ID of the Outpost.
" } + }, + "LoadBalancerAddresses": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAddresses", + "traits": { + "smithy.api#documentation": "[Network Load Balancers] If you need static IP addresses for your load balancer, \n you can specify one Elastic IP address per Availability Zone when you create an \n internal-facing load balancer. For internal load balancers, you can specify a private \n IP address from the IPv4 range of the subnet.
" + } } }, "traits": { @@ -637,17 +637,17 @@ "com.amazonaws.elasticloadbalancingv2#Cipher": { "type": "structure", "members": { - "Priority": { - "target": "com.amazonaws.elasticloadbalancingv2#CipherPriority", - "traits": { - "smithy.api#documentation": "The priority of the cipher.
" - } - }, "Name": { "target": "com.amazonaws.elasticloadbalancingv2#CipherName", "traits": { "smithy.api#documentation": "The name of the cipher.
" } + }, + "Priority": { + "target": "com.amazonaws.elasticloadbalancingv2#CipherPriority", + "traits": { + "smithy.api#documentation": "The priority of the cipher.
" + } } }, "traits": { @@ -740,19 +740,12 @@ } ], "traits": { - "smithy.api#documentation": "Creates a listener for the specified Application Load Balancer or Network Load\n Balancer.
\nTo update a listener, use ModifyListener. When you are finished with\n a listener, you can delete it using DeleteListener. If you are finished with\n both the listener and the load balancer, you can delete them both using DeleteLoadBalancer.
\nThis operation is idempotent, which means that it completes at most one time. If you\n attempt to create multiple listeners with the same settings, each call succeeds.
\nFor more information, see Listeners for\n Your Application Load Balancers in the Application Load Balancers\n Guide and Listeners for Your\n Network Load Balancers in the Network Load Balancers\n Guide.
" + "smithy.api#documentation": "Creates a listener for the specified Application Load Balancer, Network Load Balancer. or\n Gateway Load Balancer.
\n \n\nFor more information, see the following:
\nThis operation is idempotent, which means that it completes at most one time. If you\n attempt to create multiple listeners with the same settings, each call succeeds.
" } }, "com.amazonaws.elasticloadbalancingv2#CreateListenerInput": { "type": "structure", "members": { - "Port": { - "target": "com.amazonaws.elasticloadbalancingv2#Port", - "traits": { - "smithy.api#documentation": "The port on which the load balancer is listening.
", - "smithy.api#required": {} - } - }, "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { @@ -760,29 +753,28 @@ "smithy.api#required": {} } }, - "Certificates": { - "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", + "Protocol": { + "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { - "smithy.api#documentation": "[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. \n Set CertificateArn
to the certificate ARN but do not set IsDefault
.
To create a certificate list for the listener, use AddListenerCertificates.
" + "smithy.api#documentation": "The protocol for connections from clients to the load balancer. For Application Load\n Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the\n supported protocols are TCP, TLS, UDP, and TCP_UDP. You cannot specify a protocol for a\n Gateway Load Balancer.
" } }, - "Tags": { - "target": "com.amazonaws.elasticloadbalancingv2#TagList", + "Port": { + "target": "com.amazonaws.elasticloadbalancingv2#Port", "traits": { - "smithy.api#documentation": "The tags to assign to the listener.
" + "smithy.api#documentation": "The port on which the load balancer is listening. You cannot specify a port for a\n Gateway Load Balancer.
" } }, - "Protocol": { - "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", + "SslPolicy": { + "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", "traits": { - "smithy.api#documentation": "The protocol for connections from clients to the load balancer. For Application Load\n Balancers, the supported protocols are HTTP and HTTPS. For Network Load Balancers, the\n supported protocols are TCP, TLS, UDP, and TCP_UDP.
", - "smithy.api#required": {} + "smithy.api#documentation": "[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are\n supported.
\nFor more information, see Security policies in the Application Load Balancers Guide and\n Security policies in the Network Load Balancers Guide.
" } }, - "AlpnPolicy": { - "target": "com.amazonaws.elasticloadbalancingv2#AlpnPolicyName", + "Certificates": { + "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", "traits": { - "smithy.api#documentation": "[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy.\n You can specify one policy name. The following are the possible values:
\n\n HTTP1Only
\n
\n HTTP2Only
\n
\n HTTP2Optional
\n
\n HTTP2Preferred
\n
\n None
\n
For more information, see ALPN Policies in the Network Load Balancers Guide.
" + "smithy.api#documentation": "[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. \n Set CertificateArn
to the certificate ARN but do not set IsDefault
.
[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy.\n You can specify one policy name. The following are the possible values:
\n\n HTTP1Only
\n
\n HTTP2Only
\n
\n HTTP2Optional
\n
\n HTTP2Preferred
\n
\n None
\n
For more information, see ALPN policies in the Network Load Balancers Guide.
" + } + }, + "Tags": { + "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { - "smithy.api#documentation": "[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers are\n supported. The following are the possible values:
\n\n ELBSecurityPolicy-2016-08
\n
\n ELBSecurityPolicy-TLS-1-0-2015-04
\n
\n ELBSecurityPolicy-TLS-1-1-2017-01
\n
\n ELBSecurityPolicy-TLS-1-2-2017-01
\n
\n ELBSecurityPolicy-TLS-1-2-Ext-2018-06
\n
\n ELBSecurityPolicy-FS-2018-06
\n
\n ELBSecurityPolicy-FS-1-1-2019-08
\n
\n ELBSecurityPolicy-FS-1-2-2019-08
\n
\n ELBSecurityPolicy-FS-1-2-Res-2019-08
\n
For more information, see Security Policies in the Application Load Balancers Guide and\n Security Policies in the Network Load Balancers Guide.
" + "smithy.api#documentation": "The tags to assign to the listener.
" } } } @@ -861,53 +859,47 @@ } ], "traits": { - "smithy.api#documentation": "Creates an Application Load Balancer or a Network Load Balancer.
\nWhen you create a load balancer, you can specify security groups, public subnets, IP address\n type, and tags. Otherwise, you could do so later using SetSecurityGroups,\n SetSubnets, SetIpAddressType, and AddTags.
\nTo create listeners for your load balancer, use CreateListener. To\n describe your current load balancers, see DescribeLoadBalancers. When you\n are finished with a load balancer, you can delete it using DeleteLoadBalancer.
\nFor limit information, see Limits for Your\n Application Load Balancer in the Application Load Balancers\n Guide and Limits for Your Network\n Load Balancer in the Network Load Balancers Guide.
\nThis operation is idempotent, which means that it completes at most one time. If you\n attempt to create multiple load balancers with the same settings, each call\n succeeds.
\nFor more information, see Application\n Load Balancers in the Application Load Balancers Guide and\n Network Load\n Balancers in the Network Load Balancers Guide.
" + "smithy.api#documentation": "Creates an Application Load Balancer, Network Load Balancer, or Gateway Load Balancer.
\n\n \n\nFor more information, see the following:
\nThis operation is idempotent, which means that it completes at most one time. If you\n attempt to create multiple load balancers with the same settings, each call\n succeeds.
" } }, "com.amazonaws.elasticloadbalancingv2#CreateLoadBalancerInput": { "type": "structure", "members": { - "Scheme": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerSchemeEnum", - "traits": { - "smithy.api#documentation": "The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of\n an Internet-facing load balancer is publicly resolvable to the public IP addresses of the\n nodes. Therefore, Internet-facing load balancers can route requests from clients over the\n internet.
\nThe nodes of an internal load balancer have only private IP addresses. The DNS name of\n an internal load balancer is publicly resolvable to the private IP addresses of the nodes.\n Therefore, internal load balancers can route requests only from clients with access to the VPC\n for the load balancer.
\nThe default is an Internet-facing load balancer.
" - } - }, - "IpAddressType": { - "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", + "Name": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerName", "traits": { - "smithy.api#documentation": "[Application Load Balancers] The type of IP addresses used by the subnets for your load\n balancer. The possible values are ipv4
(for IPv4 addresses) and\n dualstack
(for IPv4 and IPv6 addresses). Internal load balancers must use\n ipv4
.
The name of the load balancer.
\nThis name must be unique per region per account, can have a maximum of 32 characters,\n must contain only alphanumeric characters or hyphens, must not begin or end with a\n hyphen, and must not begin with \"internal-\".
", + "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.elasticloadbalancingv2#TagList", + "Subnets": { + "target": "com.amazonaws.elasticloadbalancingv2#Subnets", "traits": { - "smithy.api#documentation": "The tags to assign to the load balancer.
" + "smithy.api#documentation": "The IDs of the public subnets. You can specify only one subnet per Availability Zone. \n You must specify either subnets or subnet mappings.
\n[Application Load Balancers] You must specify subnets from at least two Availability\n Zones.
\n[Application Load Balancers on Outposts] You must specify one Outpost subnet.
\n[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.
\n[Network Load Balancers] You can specify subnets from one or more Availability\n Zones.
\n[Gateway Load Balancers] You can specify subnets from one or more Availability\n Zones.
" } }, - "CustomerOwnedIpv4Pool": { - "target": "com.amazonaws.elasticloadbalancingv2#CustomerOwnedIpv4Pool", + "SubnetMappings": { + "target": "com.amazonaws.elasticloadbalancingv2#SubnetMappings", "traits": { - "smithy.api#documentation": "[Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP \n pool).
" + "smithy.api#documentation": "The IDs of the public subnets. You can specify only one subnet per Availability Zone. \n You must specify either subnets or subnet mappings.
\n[Application Load Balancers] You must specify subnets from at least two Availability\n Zones. You cannot specify Elastic IP addresses for your subnets.
\n[Application Load Balancers on Outposts] You must specify one Outpost subnet.
\n[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.
\n[Network Load Balancers] You can specify subnets from one or more Availability Zones.\n You can specify one Elastic IP address per subnet if you need static IP addresses for\n your internet-facing load balancer. For internal load balancers, you can specify one \n private IP address per subnet from the IPv4 range of the subnet.
\n[Gateway Load Balancers] You can specify subnets from one or more Availability\n Zones. You cannot specify Elastic IP addresses for your subnets.
" } }, - "Name": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerName", + "SecurityGroups": { + "target": "com.amazonaws.elasticloadbalancingv2#SecurityGroups", "traits": { - "smithy.api#documentation": "The name of the load balancer.
\nThis name must be unique per region per account, can have a maximum of 32 characters,\n must contain only alphanumeric characters or hyphens, must not begin or end with a\n hyphen, and must not begin with \"internal-\".
", - "smithy.api#required": {} + "smithy.api#documentation": "[Application Load Balancers] The IDs of the security groups for the load balancer.
" } }, - "SubnetMappings": { - "target": "com.amazonaws.elasticloadbalancingv2#SubnetMappings", + "Scheme": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerSchemeEnum", "traits": { - "smithy.api#documentation": "The IDs of the public subnets. You can specify only one subnet per Availability Zone. \n You must specify either subnets or subnet mappings.
\n[Application Load Balancers] You must specify subnets from at least two Availability\n Zones. You cannot specify Elastic IP addresses for your subnets.
\n[Application Load Balancers on Outposts] You must specify one Outpost subnet.
\n[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.
\n[Network Load Balancers] You can specify subnets from one or more Availability Zones.\n You can specify one Elastic IP address per subnet if you need static IP addresses for\n your internet-facing load balancer. For internal load balancers, you can specify one \n private IP address per subnet from the IPv4 range of the subnet.
" + "smithy.api#documentation": "The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of\n an Internet-facing load balancer is publicly resolvable to the public IP addresses of the\n nodes. Therefore, Internet-facing load balancers can route requests from clients over the\n internet.
\nThe nodes of an internal load balancer have only private IP addresses. The DNS name of\n an internal load balancer is publicly resolvable to the private IP addresses of the nodes.\n Therefore, internal load balancers can route requests only from clients with access to the VPC\n for the load balancer.
\nThe default is an Internet-facing load balancer.
\nYou cannot specify a scheme for a Gateway Load Balancer.
" } }, - "Subnets": { - "target": "com.amazonaws.elasticloadbalancingv2#Subnets", + "Tags": { + "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { - "smithy.api#documentation": "The IDs of the public subnets. You can specify only one subnet per Availability Zone. \n You must specify either subnets or subnet mappings.
\n[Application Load Balancers] You must specify subnets from at least two Availability\n Zones.
\n[Application Load Balancers on Outposts] You must specify one Outpost subnet.
\n[Application Load Balancers on Local Zones] You can specify subnets from one or more Local\n Zones.
\n[Network Load Balancers] You can specify subnets from one or more Availability\n Zones.
" + "smithy.api#documentation": "The tags to assign to the load balancer.
" } }, "Type": { @@ -916,10 +908,16 @@ "smithy.api#documentation": "The type of load balancer. The default is application
.
[Application Load Balancers] The IDs of the security groups for the load balancer.
" + "smithy.api#documentation": "[Application Load Balancers] The type of IP addresses used by the subnets for your load\n balancer. The possible values are ipv4
(for IPv4 addresses) and\n dualstack
(for IPv4 and IPv6 addresses). Internal load balancers must use\n ipv4
.
[Application Load Balancers on Outposts] The ID of the customer-owned address pool (CoIP \n pool).
" } } } @@ -991,12 +989,26 @@ } ], "traits": { - "smithy.api#documentation": "Creates a rule for the specified listener. The listener must be associated with an\n Application Load Balancer.
\nEach rule consists of a priority, one or more actions, and one or more conditions.\n Rules are evaluated in priority order, from the lowest value to the highest value. \n When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, \n the actions for the default rule are performed. For more information, see Listener Rules in the Application Load Balancers Guide.
\nTo view your current rules, use DescribeRules. To update a rule, use\n ModifyRule. To set the priorities of your rules, use SetRulePriorities. To delete a rule, use DeleteRule.
" + "smithy.api#documentation": "Creates a rule for the specified listener. The listener must be associated with an\n Application Load Balancer.
\nEach rule consists of a priority, one or more actions, and one or more conditions.\n Rules are evaluated in priority order, from the lowest value to the highest value. \n When the conditions for a rule are met, its actions are performed. If the conditions for no rules are met, \n the actions for the default rule are performed. For more information, see Listener rules in the Application Load Balancers Guide.
" } }, "com.amazonaws.elasticloadbalancingv2#CreateRuleInput": { "type": "structure", "members": { + "ListenerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener.
", + "smithy.api#required": {} + } + }, + "Conditions": { + "target": "com.amazonaws.elasticloadbalancingv2#RuleConditionList", + "traits": { + "smithy.api#documentation": "The conditions.
", + "smithy.api#required": {} + } + }, "Priority": { "target": "com.amazonaws.elasticloadbalancingv2#RulePriority", "traits": { @@ -1011,25 +1023,11 @@ "smithy.api#required": {} } }, - "ListenerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener.
", - "smithy.api#required": {} - } - }, "Tags": { "target": "com.amazonaws.elasticloadbalancingv2#TagList", "traits": { "smithy.api#documentation": "The tags to assign to the rule.
" } - }, - "Conditions": { - "target": "com.amazonaws.elasticloadbalancingv2#RuleConditionList", - "traits": { - "smithy.api#documentation": "The conditions.
", - "smithy.api#required": {} - } } } }, @@ -1067,41 +1065,53 @@ } ], "traits": { - "smithy.api#documentation": "Creates a target group.
\nTo register targets with the target group, use RegisterTargets. \n To update the health check settings for the target group, use ModifyTargetGroup. \n To monitor the health of targets in the target group, use DescribeTargetHealth.
\nTo route traffic to the targets in a target group, specify the target group in an\n action using CreateListener or CreateRule.
\nTo delete a target group, use DeleteTargetGroup.
\nThis operation is idempotent, which means that it completes at most one time. If you\n attempt to create multiple target groups with the same settings, each call succeeds.
\nFor more information, see Target Groups\n for Your Application Load Balancers in the Application Load Balancers\n Guide or Target Groups for\n Your Network Load Balancers in the Network Load Balancers\n Guide.
" + "smithy.api#documentation": "Creates a target group.
\n \n \n \nFor more information, see the following:
\nThis operation is idempotent, which means that it completes at most one time. If you\n attempt to create multiple target groups with the same settings, each call succeeds.
" } }, "com.amazonaws.elasticloadbalancingv2#CreateTargetGroupInput": { "type": "structure", "members": { - "HealthyThresholdCount": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", + "Name": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupName", "traits": { - "smithy.api#documentation": "The number of consecutive health checks successes required before considering an unhealthy target healthy. \n For target groups with a protocol of HTTP or HTTPS, the default is 5. \n For target groups with a protocol of TCP or TLS, the default is 3.\n If the target type is lambda
, the default is 5.
The name of the target group.
\nThis name must be unique per region per account, can have a maximum of 32 characters,\n must contain only alphanumeric characters or hyphens, and must not begin or end with a\n hyphen.
", + "smithy.api#required": {} } }, - "HealthCheckProtocol": { + "Protocol": { "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { - "smithy.api#documentation": "The protocol the load balancer uses when performing health checks on targets.\n For Application Load Balancers, the default is HTTP. For Network Load Balancers, the default is TCP.\n The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP.\n The TLS, UDP, and TCP_UDP protocols are not supported for health checks.
" + "smithy.api#documentation": "The protocol to use for routing traffic to the targets. \n For Application Load Balancers, the supported protocols are HTTP and HTTPS. \n For Network Load Balancers, the supported protocols are TCP, TLS, UDP, or TCP_UDP. \n For Gateway Load Balancers, the supported protocol is GENEVE. \n A TCP_UDP listener must be associated with a TCP_UDP target group. \n If the target is a Lambda function, this parameter does not apply.
" } }, - "Name": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupName", + "ProtocolVersion": { + "target": "com.amazonaws.elasticloadbalancingv2#ProtocolVersion", "traits": { - "smithy.api#documentation": "The name of the target group.
\nThis name must be unique per region per account, can have a maximum of 32 characters,\n must contain only alphanumeric characters or hyphens, and must not begin or end with a\n hyphen.
", - "smithy.api#required": {} + "smithy.api#documentation": "[HTTP/HTTPS protocol] The protocol version. \n Specify GRPC
to send requests to targets using gRPC.\n Specify HTTP2
to send requests to targets using HTTP/2.\n The default is HTTP1
, which sends requests to targets using HTTP/1.1.
The port on which the targets receive traffic. This port is used unless you specify a port\n override when registering the target. \n If the target is a Lambda function, this parameter does not apply. \n If the protocol is GENEVE, the supported port is 6081.
" + } + }, + "VpcId": { + "target": "com.amazonaws.elasticloadbalancingv2#VpcId", + "traits": { + "smithy.api#documentation": "The identifier of the virtual private cloud (VPC). If the target is a Lambda function, \n this parameter does not apply. Otherwise, this parameter is required.
" } }, - "UnhealthyThresholdCount": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", + "HealthCheckProtocol": { + "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { - "smithy.api#documentation": "The number of consecutive health check failures required before considering a target unhealthy. \n For target groups with a protocol of HTTP or HTTPS, the default is 2. \n For target groups with a protocol of TCP or TLS, this value must be the same as the healthy threshold count.\n If the target type is lambda
, the default is 2.
The protocol the load balancer uses when performing health checks on targets. For\n Application Load Balancers, the default is HTTP. For Network Load Balancers and Gateway Load\n Balancers, the default is TCP. The TCP protocol is not supported for health checks if the\n protocol of the target group is HTTP or HTTPS. The GENEVE, TLS, UDP, and TCP_UDP protocols are\n not supported for health checks.
" } }, - "ProtocolVersion": { - "target": "com.amazonaws.elasticloadbalancingv2#ProtocolVersion", + "HealthCheckPort": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckPort", "traits": { - "smithy.api#documentation": "[HTTP/HTTPS protocol] The protocol version. \n Specify GRPC
to send requests to targets using gRPC.\n Specify HTTP2
to send requests to targets using HTTP/2.\n The default is HTTP1
, which sends requests to targets using HTTP/1.1.
The port the load balancer uses when performing health checks on targets. If the protocol\n is HTTP, HTTPS, TCP, TLS, UDP, or TCP_UDP, the default is traffic-port
, which is\n the port on which each target receives traffic from the load balancer. If the protocol is\n GENEVE, the default is port 80.
Indicates whether health checks are enabled. If the target type is lambda
,\n health checks are disabled by default but can be enabled. If the target type is instance
\n or ip
, health checks are always enabled and cannot be disabled.
The amount of time, in seconds, during which no response from a target means a failed health check. \n For target groups with a protocol of HTTP or HTTPS, the default is 5 seconds. \n For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks \n and 10 seconds for TCP and HTTPS health checks.\n If the target type is lambda
, the default is 30 seconds.
[HTTP/HTTPS health checks] The destination for health checks on the targets.
\n[HTTP1 or HTTP2 protocol version] The ping path. The default is /.
\n[GRPC protocol version] The path of a custom health check method with the format /package.service/method. \n The default is /AWS.ALB/healthcheck.
" } }, - "Matcher": { - "target": "com.amazonaws.elasticloadbalancingv2#Matcher", - "traits": { - "smithy.api#documentation": "[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful \n response from a target.
" - } - }, - "VpcId": { - "target": "com.amazonaws.elasticloadbalancingv2#VpcId", + "HealthCheckIntervalSeconds": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckIntervalSeconds", "traits": { - "smithy.api#documentation": "The identifier of the virtual private cloud (VPC). If the target is a Lambda function, \n this parameter does not apply. Otherwise, this parameter is required.
" + "smithy.api#documentation": "The approximate amount of time, in seconds, between health checks of an individual target.\n For TCP health checks, the supported values are 10 and 30 seconds. \n If the target type is instance
or ip
, the default is 30 seconds. \n If the target group protocol is GENEVE, the default is 10 seconds. \n If the target type is lambda
, the default is 35 seconds.
The port the load balancer uses when performing health checks on targets. The default\n is traffic-port
, which is the port on which each target receives traffic from the\n load balancer.
The amount of time, in seconds, during which no response from a target means a failed health check. \n For target groups with a protocol of HTTP, HTTPS, or GENEVE, the default is 5 seconds. \n For target groups with a protocol of TCP or TLS, this value must be 6 seconds for HTTP health checks \n and 10 seconds for TCP and HTTPS health checks.\n If the target type is lambda
, the default is 30 seconds.
The port on which the targets receive traffic. This port is used unless you specify a\n port override when registering the target. If the target is a Lambda function, this \n parameter does not apply.
" + "smithy.api#documentation": "The number of consecutive health checks successes required before considering an unhealthy\n target healthy. For target groups with a protocol of HTTP or HTTPS, the default is 5. For\n target groups with a protocol of TCP, TLS, or GENEVE, the default is 3. If the target type is\n lambda
, the default is 5.
The tags to assign to the target group.
" + "smithy.api#documentation": "The number of consecutive health check failures required before considering a target\n unhealthy. If the target group protocol is HTTP or HTTPS, the default is 2. If the target\n group protocol is TCP or TLS, this value must be the same as the healthy threshold count. If\n the target group protocol is GENEVE, the default is 3. If the target type is\n lambda
, the default is 2.
The approximate amount of time, in seconds, between health checks of an individual target. \n For HTTP and HTTPS health checks, the range is 5–300 seconds. \n For TCP health checks, the supported values are 10 and 30 seconds. \n If the target type is instance
or ip
, the default is 30 seconds. \n If the target type is lambda
, the default is 35 seconds.
[HTTP/HTTPS health checks] The HTTP or gRPC codes to use when checking for a successful \n response from a target.
" } }, - "Protocol": { - "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", + "TargetType": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetTypeEnum", "traits": { - "smithy.api#documentation": "The protocol to use for routing traffic to the targets. For Application Load Balancers,\n the supported protocols are HTTP and HTTPS. For Network Load Balancers, the supported protocols\n are TCP, TLS, UDP, or TCP_UDP. A TCP_UDP listener must be associated with a TCP_UDP target group.\n If the target is a Lambda function, this parameter does not apply.
" + "smithy.api#documentation": "The type of target that you must specify when registering targets with this target group.\n You can't specify targets for a target group using more than one target type.
\n\n instance
- Register targets by instance ID. This is the default value.
\n ip
- Register targets by IP address. You can specify IP addresses \n from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 \n range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range \n (100.64.0.0/10). You can't specify publicly routable IP addresses.
\n lambda
- Register a single Lambda function as a target.
The type of target that you must specify when registering targets with this target group.\n You can't specify targets for a target group using more than one target type.
\n\n instance
- Targets are specified by instance ID. This is the default value.
\n ip
- Targets are specified by IP address. You can specify IP addresses \n from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 \n range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range \n (100.64.0.0/10). You can't specify publicly routable IP addresses.
\n lambda
- The target groups contains a single Lambda function.
The tags to assign to the target group.
" } } } @@ -1219,7 +1217,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified listener.
\nAlternatively, your listener is deleted when you delete the load balancer to which it\n is attached, using DeleteLoadBalancer.
" + "smithy.api#documentation": "Deletes the specified listener.
\nAlternatively, your listener is deleted when you delete the load balancer to which it\n is attached.
" } }, "com.amazonaws.elasticloadbalancingv2#DeleteListenerInput": { @@ -1258,7 +1256,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified Application Load Balancer or Network Load Balancer and its\n attached listeners.
\nYou can't delete a load balancer if deletion protection is enabled. If the load\n balancer does not exist or has already been deleted, the call succeeds.
\nDeleting a load balancer does not affect its registered targets. For example, your EC2\n instances continue to run and are still registered to their target groups. If you no longer\n need these EC2 instances, you can stop or terminate them.
" + "smithy.api#documentation": "Deletes the specified Application Load Balancer, Network Load Balancer, or Gateway Load\n Balancer. Deleting a load balancer also deletes its listeners.
\nYou can't delete a load balancer if deletion protection is enabled. If the load\n balancer does not exist or has already been deleted, the call succeeds.
\nDeleting a load balancer does not affect its registered targets. For example, your EC2\n instances continue to run and are still registered to their target groups. If you no longer\n need these EC2 instances, you can stop or terminate them.
" } }, "com.amazonaws.elasticloadbalancingv2#DeleteLoadBalancerInput": { @@ -1327,7 +1325,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified target group.
\nYou can delete a target group if it is not referenced by any actions. Deleting a target\n group also deletes any associated health checks.
" + "smithy.api#documentation": "Deletes the specified target group.
\nYou can delete a target group if it is not referenced by any actions. Deleting a target\n group also deletes any associated health checks. Deleting a target group does not affect its \n registered targets. For example, any EC2 instances continue to run until you stop or terminate\n them.
" } }, "com.amazonaws.elasticloadbalancingv2#DeleteTargetGroupInput": { @@ -1398,23 +1396,23 @@ "target": "com.amazonaws.elasticloadbalancingv2#DescribeAccountLimitsOutput" }, "traits": { - "smithy.api#documentation": "Describes the current Elastic Load Balancing resource limits for your AWS\n account.
\nFor more information, see Limits for Your\n Application Load Balancers in the Application Load Balancer\n Guide or Limits for Your Network\n Load Balancers in the Network Load Balancers Guide.
" + "smithy.api#documentation": "Describes the current Elastic Load Balancing resource limits for your AWS account.
\nFor more information, see the following:
\nThe maximum number of results to return with this call.
" - } - }, "Marker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "The marker for the next set of results. (You received this marker from a previous\n call.)
" } + }, + "PageSize": { + "target": "com.amazonaws.elasticloadbalancingv2#PageSize", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with this call.
" + } } } }, @@ -1449,7 +1447,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.
\nIf the default certificate is also in the certificate list, it appears twice in the results\n (once with IsDefault
set to true and once with IsDefault
set to false).
For more information, see SSL Certificates\n in the Application Load Balancers Guide.
" + "smithy.api#documentation": "Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.
\nIf the default certificate is also in the certificate list, it appears twice in the results\n (once with IsDefault
set to true and once with IsDefault
set to false).
For more information, see SSL certificates in the Application Load Balancers Guide or\n Server certificates in the Network Load Balancers Guide.
" } }, "com.amazonaws.elasticloadbalancingv2#DescribeListenerCertificatesInput": { @@ -1462,17 +1460,17 @@ "smithy.api#required": {} } }, - "PageSize": { - "target": "com.amazonaws.elasticloadbalancingv2#PageSize", - "traits": { - "smithy.api#documentation": "The maximum number of results to return with this call.
" - } - }, "Marker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "The marker for the next set of results. (You received this marker from a previous\n call.)
" } + }, + "PageSize": { + "target": "com.amazonaws.elasticloadbalancingv2#PageSize", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with this call.
" + } } } }, @@ -1513,7 +1511,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified listeners or the listeners for the specified Application Load\n Balancer or Network Load Balancer. You must specify either a load balancer or one or more\n listeners.
\nFor an HTTPS or TLS listener, the output includes the default certificate for the listener.\n To describe the certificate list for the listener, use DescribeListenerCertificates.
", + "smithy.api#documentation": "Describes the specified listeners or the listeners for the specified Application Load\n Balancer, Network Load Balancer, or Gateway Load Balancer. You must specify either a load\n balancer or one or more listeners.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -1524,18 +1522,6 @@ "com.amazonaws.elasticloadbalancingv2#DescribeListenersInput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.elasticloadbalancingv2#Marker", - "traits": { - "smithy.api#documentation": "The marker for the next set of results. (You received this marker from a previous\n call.)
" - } - }, - "PageSize": { - "target": "com.amazonaws.elasticloadbalancingv2#PageSize", - "traits": { - "smithy.api#documentation": "The maximum number of results to return with this call.
" - } - }, "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { @@ -1547,6 +1533,18 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Names (ARN) of the listeners.
" } + }, + "Marker": { + "target": "com.amazonaws.elasticloadbalancingv2#Marker", + "traits": { + "smithy.api#documentation": "The marker for the next set of results. (You received this marker from a previous\n call.)
" + } + }, + "PageSize": { + "target": "com.amazonaws.elasticloadbalancingv2#PageSize", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with this call.
" + } } } }, @@ -1581,7 +1579,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the attributes for the specified Application Load Balancer or Network Load\n Balancer.
\nFor more information, see Load Balancer Attributes \n in the Application Load Balancers Guide or Load Balancer Attributes \n in the Network Load Balancers Guide.
" + "smithy.api#documentation": "Describes the attributes for the specified Application Load Balancer, Network Load Balancer,\n or Gateway Load Balancer.
\n\nFor more information, see the following:
\n\n Load balancer attributes in the Application Load Balancers Guide\n
\n\n Load balancer attributes in the Network Load Balancers Guide\n
\n\n Load balancer attributes in the Gateway Load Balancers Guide\n
\nDescribes the specified load balancers or all of your load balancers.
\nTo describe the listeners for a load balancer, use DescribeListeners.\n To describe the attributes for a load balancer, use DescribeLoadBalancerAttributes.
", + "smithy.api#documentation": "Describes the specified load balancers or all of your load balancers.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -1632,46 +1630,46 @@ "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancersInput": { "type": "structure", "members": { - "Names": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNames", - "traits": { - "smithy.api#documentation": "The names of the load balancers.
" - } - }, - "PageSize": { - "target": "com.amazonaws.elasticloadbalancingv2#PageSize", - "traits": { - "smithy.api#documentation": "The maximum number of results to return with this call.
" - } - }, "LoadBalancerArns": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArns", "traits": { "smithy.api#documentation": "The Amazon Resource Names (ARN) of the load balancers. You can specify up to 20 load\n balancers in a single call.
" } }, + "Names": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerNames", + "traits": { + "smithy.api#documentation": "The names of the load balancers.
" + } + }, "Marker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { "smithy.api#documentation": "The marker for the next set of results. (You received this marker from a previous\n call.)
" } + }, + "PageSize": { + "target": "com.amazonaws.elasticloadbalancingv2#PageSize", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with this call.
" + } } } }, "com.amazonaws.elasticloadbalancingv2#DescribeLoadBalancersOutput": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.elasticloadbalancingv2#Marker", - "traits": { - "smithy.api#documentation": "If there are additional results, this is the marker for the next set of results. \n Otherwise, this is null.
" - } - }, "LoadBalancers": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancers", "traits": { "smithy.api#documentation": "Information about the load balancers.
" } + }, + "NextMarker": { + "target": "com.amazonaws.elasticloadbalancingv2#Marker", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the marker for the next set of results. \n Otherwise, this is null.
" + } } } }, @@ -1701,18 +1699,6 @@ "com.amazonaws.elasticloadbalancingv2#DescribeRulesInput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.elasticloadbalancingv2#Marker", - "traits": { - "smithy.api#documentation": "The marker for the next set of results. (You received this marker from a previous\n call.)
" - } - }, - "PageSize": { - "target": "com.amazonaws.elasticloadbalancingv2#PageSize", - "traits": { - "smithy.api#documentation": "The maximum number of results to return with this call.
" - } - }, "ListenerArn": { "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { @@ -1724,23 +1710,35 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Names (ARN) of the rules.
" } + }, + "Marker": { + "target": "com.amazonaws.elasticloadbalancingv2#Marker", + "traits": { + "smithy.api#documentation": "The marker for the next set of results. (You received this marker from a previous\n call.)
" + } + }, + "PageSize": { + "target": "com.amazonaws.elasticloadbalancingv2#PageSize", + "traits": { + "smithy.api#documentation": "The maximum number of results to return with this call.
" + } } } }, "com.amazonaws.elasticloadbalancingv2#DescribeRulesOutput": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.elasticloadbalancingv2#Marker", - "traits": { - "smithy.api#documentation": "If there are additional results, this is the marker for the next set of results. \n Otherwise, this is null.
" - } - }, "Rules": { "target": "com.amazonaws.elasticloadbalancingv2#Rules", "traits": { "smithy.api#documentation": "Information about the rules.
" } + }, + "NextMarker": { + "target": "com.amazonaws.elasticloadbalancingv2#Marker", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the marker for the next set of results. \n Otherwise, this is null.
" + } } } }, @@ -1758,12 +1756,18 @@ } ], "traits": { - "smithy.api#documentation": "Describes the specified policies or all policies used for SSL negotiation.
\nFor more information, see Security Policies in the Application Load Balancers\n Guide.
" + "smithy.api#documentation": "Describes the specified policies or all policies used for SSL negotiation.
\nFor more information, see Security policies in the Application Load Balancers Guide or\n Security policies in the Network Load Balancers Guide.
" } }, "com.amazonaws.elasticloadbalancingv2#DescribeSSLPoliciesInput": { "type": "structure", "members": { + "Names": { + "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyNames", + "traits": { + "smithy.api#documentation": "The names of the policies.
" + } + }, "Marker": { "target": "com.amazonaws.elasticloadbalancingv2#Marker", "traits": { @@ -1775,29 +1779,23 @@ "traits": { "smithy.api#documentation": "The maximum number of results to return with this call.
" } - }, - "Names": { - "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyNames", - "traits": { - "smithy.api#documentation": "The names of the policies.
" - } } } }, "com.amazonaws.elasticloadbalancingv2#DescribeSSLPoliciesOutput": { "type": "structure", "members": { - "NextMarker": { - "target": "com.amazonaws.elasticloadbalancingv2#Marker", - "traits": { - "smithy.api#documentation": "If there are additional results, this is the marker for the next set of results. \n Otherwise, this is null.
" - } - }, "SslPolicies": { "target": "com.amazonaws.elasticloadbalancingv2#SslPolicies", "traits": { "smithy.api#documentation": "Information about the security policies.
" } + }, + "NextMarker": { + "target": "com.amazonaws.elasticloadbalancingv2#Marker", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the marker for the next set of results. \n Otherwise, this is null.
" + } } } }, @@ -1824,7 +1822,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the tags for the specified Elastic Load Balancing resources. You can describe the tags for \n one or more Application Load Balancers, Network Load Balancers, target groups, listeners, or rules.
" + "smithy.api#documentation": "Describes the tags for the specified Elastic Load Balancing resources. You can describe\n the tags for one or more Application Load Balancers, Network Load Balancers, Gateway Load\n Balancers, target groups, listeners, or rules.
" } }, "com.amazonaws.elasticloadbalancingv2#DescribeTagsInput": { @@ -1864,7 +1862,7 @@ } ], "traits": { - "smithy.api#documentation": "Describes the attributes for the specified target group.
\nFor more information, see Target Group Attributes \n in the Application Load Balancers Guide or Target Group Attributes \n in the Network Load Balancers Guide.
" + "smithy.api#documentation": "Describes the attributes for the specified target group.
\nFor more information, see the following:
\n\n Target group attributes in the Application Load Balancers Guide\n
\n\n Target group attributes in the Network Load Balancers Guide\n
\n\n Target group attributes in the Gateway Load Balancers Guide\n
\nDescribes the specified target groups or all of your target groups. By default, all\n target groups are described. Alternatively, you can specify one of the following to filter the\n results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of\n one or more target groups.
\nTo describe the targets for a target group, use DescribeTargetHealth.\n To describe the attributes of a target group, use DescribeTargetGroupAttributes.
", + "smithy.api#documentation": "Describes the specified target groups or all of your target groups. By default, all\n target groups are described. Alternatively, you can specify one of the following to filter the\n results: the ARN of the load balancer, the names of one or more target groups, or the ARNs of\n one or more target groups.
", "smithy.api#paginated": { "inputToken": "Marker", "outputToken": "NextMarker", @@ -1918,16 +1916,22 @@ "com.amazonaws.elasticloadbalancingv2#DescribeTargetGroupsInput": { "type": "structure", "members": { + "LoadBalancerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the load balancer.
" + } + }, "TargetGroupArns": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArns", "traits": { "smithy.api#documentation": "The Amazon Resource Names (ARN) of the target groups.
" } }, - "LoadBalancerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", + "Names": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNames", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the load balancer.
" + "smithy.api#documentation": "The names of the target groups.
" } }, "Marker": { @@ -1941,12 +1945,6 @@ "traits": { "smithy.api#documentation": "The maximum number of results to return with this call.
" } - }, - "Names": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupNames", - "traits": { - "smithy.api#documentation": "The names of the target groups.
" - } } } }, @@ -2192,7 +2190,7 @@ "name": "elasticloadbalancing" }, "aws.protocols#awsQuery": {}, - "smithy.api#documentation": "A load balancer distributes incoming traffic across targets, such as your EC2\n instances. This enables you to increase the availability of your application. The load\n balancer also monitors the health of its registered targets and ensures that it routes traffic\n only to healthy targets. You configure your load balancer to accept incoming traffic by\n specifying one or more listeners, which are configured with a protocol and port number for\n connections from clients to the load balancer. You configure a target group with a protocol\n and port number for connections from the load balancer to the targets, and with health check\n settings to be used when checking the health status of the targets.
\n\nElastic Load Balancing supports the following types of load balancers: Application Load\n Balancers, Network Load Balancers, and Classic Load Balancers. This reference covers \n Application Load Balancers and Network Load Balancers.
\nAn Application Load Balancer makes routing and load balancing decisions at the\n application layer (HTTP/HTTPS). A Network Load Balancer makes routing and load balancing\n decisions at the transport layer (TCP/TLS). Both Application Load Balancers and Network Load\n Balancers can route requests to one or more ports on each EC2 instance or container instance\n in your virtual private cloud (VPC). For more information, see the Elastic Load Balancing User\n Guide.
\n \n \n \n\n \n \n\nAll Elastic Load Balancing operations are idempotent, which means that they complete at\n most one time. If you repeat an operation, it succeeds.
", + "smithy.api#documentation": "A load balancer distributes incoming traffic across targets, such as your EC2\n instances. This enables you to increase the availability of your application. The load\n balancer also monitors the health of its registered targets and ensures that it routes traffic\n only to healthy targets. You configure your load balancer to accept incoming traffic by\n specifying one or more listeners, which are configured with a protocol and port number for\n connections from clients to the load balancer. You configure a target group with a protocol\n and port number for connections from the load balancer to the targets, and with health check\n settings to be used when checking the health status of the targets.
\n\nElastic Load Balancing supports the following types of load balancers: Application Load\n Balancers, Network Load Balancers, Gateway Load Balancers, and Classic Load Balancers. \n This reference covers the following load balancer types:
\nApplication Load Balancer - Operates at the application layer (layer 7) and supports HTTP and HTTPS.
\nNetwork Load Balancer - Operates at the transport layer (layer 4) and supports TCP, TLS, and UDP.
\nGateway Load Balancer - Operates at the network layer (layer 3).
\nFor more information, see the Elastic Load Balancing User Guide.
\n \n \n \n\n \n \n\nAll Elastic Load Balancing operations are idempotent, which means that they complete at\n most one time. If you repeat an operation, it succeeds.
", "smithy.api#title": "Elastic Load Balancing", "smithy.api#xmlNamespace": { "uri": "http://elasticloadbalancing.amazonaws.com/doc/2015-12-01/" @@ -2205,12 +2203,6 @@ "com.amazonaws.elasticloadbalancingv2#FixedResponseActionConfig": { "type": "structure", "members": { - "ContentType": { - "target": "com.amazonaws.elasticloadbalancingv2#FixedResponseActionContentType", - "traits": { - "smithy.api#documentation": "The content type.
\nValid Values: text/plain | text/css | text/html | application/javascript | application/json
" - } - }, "MessageBody": { "target": "com.amazonaws.elasticloadbalancingv2#FixedResponseActionMessage", "traits": { @@ -2223,6 +2215,12 @@ "smithy.api#documentation": "The HTTP response code (2XX, 4XX, or 5XX).
", "smithy.api#required": {} } + }, + "ContentType": { + "target": "com.amazonaws.elasticloadbalancingv2#FixedResponseActionContentType", + "traits": { + "smithy.api#documentation": "The content type.
\nValid Values: text/plain | text/css | text/html | application/javascript | application/json
" + } } }, "traits": { @@ -2500,7 +2498,7 @@ "Name": { "target": "com.amazonaws.elasticloadbalancingv2#Name", "traits": { - "smithy.api#documentation": "The name of the limit. The possible values are:
\napplication-load-balancers
\nlisteners-per-application-load-balancer
\nlisteners-per-network-load-balancer
\nnetwork-load-balancers
\nrules-per-application-load-balancer
\ntarget-groups
\ntarget-groups-per-action-on-application-load-balancer
\ntarget-groups-per-action-on-network-load-balancer
\ntarget-groups-per-application-load-balancer
\ntargets-per-application-load-balancer
\ntargets-per-availability-zone-per-network-load-balancer
\ntargets-per-network-load-balancer
\nThe name of the limit. The possible values are:
\napplication-load-balancers
\ncondition-values-per-alb-rule
\ncondition-wildcards-per-alb-rule
\ngateway-load-balancers
\ngateway-load-balancers-per-vpc
\ngeneve-target-groups
\nlisteners-per-application-load-balancer
\nlisteners-per-network-load-balancer
\nnetwork-load-balancers
\nrules-per-application-load-balancer
\ntarget-groups
\ntarget-groups-per-action-on-application-load-balancer
\ntarget-groups-per-action-on-network-load-balancer
\ntarget-groups-per-application-load-balancer
\ntargets-per-application-load-balancer
\ntargets-per-availability-zone-per-gateway-load-balancer
\ntargets-per-availability-zone-per-network-load-balancer
\ntargets-per-network-load-balancer
\n[HTTPS or TLS listener] The security policy that defines which protocols and ciphers \n are supported.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener.
" } }, - "Protocol": { - "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", + "LoadBalancerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { - "smithy.api#documentation": "The protocol for connections from clients to the load balancer.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the load balancer.
" } }, - "DefaultActions": { - "target": "com.amazonaws.elasticloadbalancingv2#Actions", + "Port": { + "target": "com.amazonaws.elasticloadbalancingv2#Port", "traits": { - "smithy.api#documentation": "The default actions for the listener.
" + "smithy.api#documentation": "The port on which the load balancer is listening.
" } }, - "ListenerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", + "Protocol": { + "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener.
" + "smithy.api#documentation": "The protocol for connections from clients to the load balancer.
" } }, "Certificates": { @@ -2559,22 +2557,22 @@ "smithy.api#documentation": "[HTTPS or TLS listener] The default certificate for the listener.
" } }, - "AlpnPolicy": { - "target": "com.amazonaws.elasticloadbalancingv2#AlpnPolicyName", + "SslPolicy": { + "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", "traits": { - "smithy.api#documentation": "[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
" + "smithy.api#documentation": "[HTTPS or TLS listener] The security policy that defines which protocols and ciphers \n are supported.
" } }, - "LoadBalancerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", + "DefaultActions": { + "target": "com.amazonaws.elasticloadbalancingv2#Actions", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the load balancer.
" + "smithy.api#documentation": "The default actions for the listener.
" } }, - "Port": { - "target": "com.amazonaws.elasticloadbalancingv2#Port", + "AlpnPolicy": { + "target": "com.amazonaws.elasticloadbalancingv2#AlpnPolicyName", "traits": { - "smithy.api#documentation": "The port on which the load balancer is listening.
" + "smithy.api#documentation": "[TLS listener] The name of the Application-Layer Protocol Negotiation (ALPN) policy.
" } } }, @@ -2613,28 +2611,16 @@ "com.amazonaws.elasticloadbalancingv2#LoadBalancer": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerTypeEnum", - "traits": { - "smithy.api#documentation": "The type of load balancer.
" - } - }, - "VpcId": { - "target": "com.amazonaws.elasticloadbalancingv2#VpcId", - "traits": { - "smithy.api#documentation": "The ID of the VPC for the load balancer.
" - } - }, "LoadBalancerArn": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the load balancer.
" } }, - "State": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerState", + "DNSName": { + "target": "com.amazonaws.elasticloadbalancingv2#DNSName", "traits": { - "smithy.api#documentation": "The state of the load balancer.
" + "smithy.api#documentation": "The public DNS name of the load balancer.
" } }, "CanonicalHostedZoneId": { @@ -2643,40 +2629,52 @@ "smithy.api#documentation": "The ID of the Amazon Route 53 hosted zone associated with the load balancer.
" } }, + "CreatedTime": { + "target": "com.amazonaws.elasticloadbalancingv2#CreatedTime", + "traits": { + "smithy.api#documentation": "The date and time the load balancer was created.
" + } + }, "LoadBalancerName": { "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerName", "traits": { "smithy.api#documentation": "The name of the load balancer.
" } }, - "CustomerOwnedIpv4Pool": { - "target": "com.amazonaws.elasticloadbalancingv2#CustomerOwnedIpv4Pool", + "Scheme": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerSchemeEnum", "traits": { - "smithy.api#documentation": "[Application Load Balancers on Outposts] The ID of the customer-owned address pool.
" + "smithy.api#documentation": "The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of\n an Internet-facing load balancer is publicly resolvable to the public IP addresses of the\n nodes. Therefore, Internet-facing load balancers can route requests from clients over the\n internet.
\nThe nodes of an internal load balancer have only private IP addresses. The DNS name of\n an internal load balancer is publicly resolvable to the private IP addresses of the nodes.\n Therefore, internal load balancers can route requests only from clients with access to the VPC\n for the load balancer.
" } }, - "AvailabilityZones": { - "target": "com.amazonaws.elasticloadbalancingv2#AvailabilityZones", + "VpcId": { + "target": "com.amazonaws.elasticloadbalancingv2#VpcId", "traits": { - "smithy.api#documentation": "The subnets for the load balancer.
" + "smithy.api#documentation": "The ID of the VPC for the load balancer.
" } }, - "SecurityGroups": { - "target": "com.amazonaws.elasticloadbalancingv2#SecurityGroups", + "State": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerState", "traits": { - "smithy.api#documentation": "The IDs of the security groups for the load balancer.
" + "smithy.api#documentation": "The state of the load balancer.
" } }, - "CreatedTime": { - "target": "com.amazonaws.elasticloadbalancingv2#CreatedTime", + "Type": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerTypeEnum", "traits": { - "smithy.api#documentation": "The date and time the load balancer was created.
" + "smithy.api#documentation": "The type of load balancer.
" } }, - "Scheme": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerSchemeEnum", + "AvailabilityZones": { + "target": "com.amazonaws.elasticloadbalancingv2#AvailabilityZones", "traits": { - "smithy.api#documentation": "The nodes of an Internet-facing load balancer have public IP addresses. The DNS name of\n an Internet-facing load balancer is publicly resolvable to the public IP addresses of the\n nodes. Therefore, Internet-facing load balancers can route requests from clients over the\n internet.
\nThe nodes of an internal load balancer have only private IP addresses. The DNS name of\n an internal load balancer is publicly resolvable to the private IP addresses of the nodes.\n Therefore, internal load balancers can route requests only from clients with access to the VPC\n for the load balancer.
" + "smithy.api#documentation": "The subnets for the load balancer.
" + } + }, + "SecurityGroups": { + "target": "com.amazonaws.elasticloadbalancingv2#SecurityGroups", + "traits": { + "smithy.api#documentation": "The IDs of the security groups for the load balancer.
" } }, "IpAddressType": { @@ -2685,10 +2683,10 @@ "smithy.api#documentation": "The type of IP addresses used by the subnets for your load balancer. The possible\n values are ipv4
(for IPv4 addresses) and dualstack
(for IPv4 and\n IPv6 addresses).
The public DNS name of the load balancer.
" + "smithy.api#documentation": "[Application Load Balancers on Outposts] The ID of the customer-owned address pool.
" } } }, @@ -2699,12 +2697,6 @@ "com.amazonaws.elasticloadbalancingv2#LoadBalancerAddress": { "type": "structure", "members": { - "PrivateIPv4Address": { - "target": "com.amazonaws.elasticloadbalancingv2#PrivateIPv4Address", - "traits": { - "smithy.api#documentation": "[Network Load Balancers] The private IPv4 address for an internal load balancer.
" - } - }, "IpAddress": { "target": "com.amazonaws.elasticloadbalancingv2#IpAddress", "traits": { @@ -2716,6 +2708,12 @@ "traits": { "smithy.api#documentation": "[Network Load Balancers] The allocation ID of the Elastic IP address for an internal-facing load balancer.
" } + }, + "PrivateIPv4Address": { + "target": "com.amazonaws.elasticloadbalancingv2#PrivateIPv4Address", + "traits": { + "smithy.api#documentation": "[Network Load Balancers] The private IPv4 address for an internal load balancer.
" + } } }, "traits": { @@ -2740,16 +2738,16 @@ "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttribute": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributeValue", + "Key": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerAttributeKey", "traits": { - "smithy.api#documentation": "The value of the attribute.
" + "smithy.api#documentation": "The name of the attribute.
\n\nThe following attribute is supported by all load balancers:
\n\n deletion_protection.enabled
- Indicates whether deletion protection is enabled.\n The value is true
or false
. The default is false
.
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
\n\n access_logs.s3.enabled
- Indicates whether access logs are enabled. \n The value is true
or false
. The default is false
.
\n access_logs.s3.bucket
- The name of the S3 bucket for the access logs. This\n attribute is required if access logs are enabled. The bucket must exist in the same region\n as the load balancer and have a bucket policy that grants Elastic Load Balancing\n permissions to write to the bucket.
\n access_logs.s3.prefix
- The prefix for the location in the S3 bucket for the access logs.
The following attributes are supported by only Application Load Balancers:
\n\n idle_timeout.timeout_seconds
- The idle timeout value, in seconds. The valid range \n is 1-4000 seconds. The default is 60 seconds.
\n routing.http.desync_mitigation_mode
- Determines how the load balancer handles requests that \n might pose a security risk to your application. The possible values are monitor
, \n defensive
, and strictest
. The default is defensive
.
\n routing.http.drop_invalid_header_fields.enabled
- Indicates whether HTTP headers \n with invalid header fields are removed by the load balancer (true
) or routed to targets \n (false
). The default is false
.
\n routing.http2.enabled
- Indicates whether HTTP/2 is enabled. The value is\n true
or false
. The default is true
. Elastic Load Balancing \n requires that message header names contain only alphanumeric characters and hyphens.
The following attribute is supported by Network Load Balancers and Gateway Load Balancers:
\n\n load_balancing.cross_zone.enabled
- Indicates whether cross-zone load balancing is enabled. \n The value is true
or false
. The default is false
.
The name of the attribute.
\nThe following attributes are supported by both Application Load Balancers and Network Load Balancers:
\n\n access_logs.s3.enabled
- Indicates whether access logs are enabled. \n The value is true
or false
. The default is false
.
\n access_logs.s3.bucket
- The name of the S3 bucket for the access logs. This\n attribute is required if access logs are enabled. The bucket must exist in the same region\n as the load balancer and have a bucket policy that grants Elastic Load Balancing\n permissions to write to the bucket.
\n access_logs.s3.prefix
- The prefix for the location in the S3 bucket for the access logs.
\n deletion_protection.enabled
- Indicates whether deletion protection is enabled.\n The value is true
or false
. The default is false
.
The following attributes are supported by only Application Load Balancers:
\n\n idle_timeout.timeout_seconds
- The idle timeout value, in seconds. The valid range \n is 1-4000 seconds. The default is 60 seconds.
\n routing.http.desync_mitigation_mode
- Determines how the load balancer handles requests that \n might pose a security risk to your application. The possible values are monitor
, \n defensive
, and strictest
. The default is defensive
.
\n routing.http.drop_invalid_header_fields.enabled
- Indicates whether HTTP headers \n with invalid header fields are removed by the load balancer (true
) or routed to targets \n (false
). The default is false
.
\n routing.http2.enabled
- Indicates whether HTTP/2 is enabled. The value is\n true
or false
. The default is true
. Elastic Load Balancing \n requires that message header names contain only alphanumeric characters and hyphens.
The following attributes are supported by only Network Load Balancers:
\n\n load_balancing.cross_zone.enabled
- Indicates whether cross-zone load balancing is enabled. \n The value is true
or false
. The default is false
.
The value of the attribute.
" } } }, @@ -2879,6 +2877,10 @@ { "value": "network", "name": "NETWORK" + }, + { + "value": "gateway", + "name": "GATEWAY" } ] } @@ -2898,7 +2900,7 @@ "HttpCode": { "target": "com.amazonaws.elasticloadbalancingv2#HttpCode", "traits": { - "smithy.api#documentation": "For Application Load Balancers, you can specify values between 200 and 499, and the\n default value is 200. You can specify multiple values (for example, \"200,202\") or a range of\n values (for example, \"200-299\").
\nFor Network Load Balancers, this is \"200–399\".
" + "smithy.api#documentation": "For Application Load Balancers, you can specify values between 200 and 499, and the\n default value is 200. You can specify multiple values (for example, \"200,202\") or a range of\n values (for example, \"200-299\").
\nFor Network Load Balancers and Gateway Load Balancers, this must be \"200–399\".
" } }, "GrpcCode": { @@ -2983,35 +2985,35 @@ "com.amazonaws.elasticloadbalancingv2#ModifyListenerInput": { "type": "structure", "members": { - "AlpnPolicy": { - "target": "com.amazonaws.elasticloadbalancingv2#AlpnPolicyName", + "ListenerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", "traits": { - "smithy.api#documentation": "[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy.\n You can specify one policy name. The following are the possible values:
\n\n HTTP1Only
\n
\n HTTP2Only
\n
\n HTTP2Optional
\n
\n HTTP2Preferred
\n
\n None
\n
For more information, see ALPN Policies in the Network Load Balancers Guide.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener.
", + "smithy.api#required": {} } }, - "Protocol": { - "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", + "Port": { + "target": "com.amazonaws.elasticloadbalancingv2#Port", "traits": { - "smithy.api#documentation": "The protocol for connections from clients to the load balancer. Application Load\n Balancers support the HTTP and HTTPS protocols. Network Load Balancers support the\n TCP, TLS, UDP, and TCP_UDP protocols.
" + "smithy.api#documentation": "The port for connections from clients to the load balancer.\n You cannot specify a port for a Gateway Load Balancer.
" } }, - "Certificates": { - "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", + "Protocol": { + "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { - "smithy.api#documentation": "[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. \n Set CertificateArn
to the certificate ARN but do not set IsDefault
.
To create a certificate list, use AddListenerCertificates.
" + "smithy.api#documentation": "The protocol for connections from clients to the load balancer. \n Application Load Balancers support the HTTP and HTTPS protocols. \n Network Load Balancers support the TCP, TLS, UDP, and TCP_UDP protocols. \n You cannot specify a protocol for a Gateway Load Balancer.
" } }, - "ListenerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#ListenerArn", + "SslPolicy": { + "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the listener.
", - "smithy.api#required": {} + "smithy.api#documentation": "[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers \n are supported.
\nFor more information, see Security policies in the Application Load Balancers Guide or\n Security policies in the Network Load Balancers Guide.
" } }, - "Port": { - "target": "com.amazonaws.elasticloadbalancingv2#Port", + "Certificates": { + "target": "com.amazonaws.elasticloadbalancingv2#CertificateList", "traits": { - "smithy.api#documentation": "The port for connections from clients to the load balancer.
" + "smithy.api#documentation": "[HTTPS and TLS listeners] The default certificate for the listener. You must provide exactly one certificate. \n Set CertificateArn
to the certificate ARN but do not set IsDefault
.
The actions for the default rule.
" } }, - "SslPolicy": { - "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", + "AlpnPolicy": { + "target": "com.amazonaws.elasticloadbalancingv2#AlpnPolicyName", "traits": { - "smithy.api#documentation": "[HTTPS and TLS listeners] The security policy that defines which protocols and ciphers \n are supported. The following are the possible values:
\n\n ELBSecurityPolicy-2016-08
\n
\n ELBSecurityPolicy-TLS-1-0-2015-04
\n
\n ELBSecurityPolicy-TLS-1-1-2017-01
\n
\n ELBSecurityPolicy-TLS-1-2-2017-01
\n
\n ELBSecurityPolicy-TLS-1-2-Ext-2018-06
\n
\n ELBSecurityPolicy-FS-2018-06
\n
\n ELBSecurityPolicy-FS-1-1-2019-08
\n
\n ELBSecurityPolicy-FS-1-2-2019-08
\n
\n ELBSecurityPolicy-FS-1-2-Res-2019-08
\n
For more information, see Security Policies in the Application Load Balancers Guide and\n Security Policies in the Network Load Balancers Guide.
" + "smithy.api#documentation": "[TLS listeners] The name of the Application-Layer Protocol Negotiation (ALPN) policy.\n You can specify one policy name. The following are the possible values:
\n\n HTTP1Only
\n
\n HTTP2Only
\n
\n HTTP2Optional
\n
\n HTTP2Preferred
\n
\n None
\n
For more information, see ALPN policies in the Network Load Balancers Guide.
" } } } @@ -3056,7 +3058,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the specified attributes of the specified Application Load Balancer or Network\n Load Balancer.
\nIf any of the specified attributes can't be modified as requested, the call fails. Any\n existing attributes that you do not modify retain their current values.
" + "smithy.api#documentation": "Modifies the specified attributes of the specified Application Load Balancer, Network Load\n Balancer, or Gateway Load Balancer.
\nIf any of the specified attributes can't be modified as requested, the call fails. Any\n existing attributes that you do not modify retain their current values.
" } }, "com.amazonaws.elasticloadbalancingv2#ModifyLoadBalancerAttributesInput": { @@ -3133,12 +3135,19 @@ } ], "traits": { - "smithy.api#documentation": "Replaces the specified properties of the specified rule. Any properties that you do not\n specify are unchanged.
\nTo add an item to a list, remove an item from a list, or update an item in a list, \n you must provide the entire list. For example, to add an action, specify a list with the\n current actions plus the new action.
\nTo modify the actions for the default rule, use ModifyListener.
" + "smithy.api#documentation": "Replaces the specified properties of the specified rule. Any properties that you do not\n specify are unchanged.
\nTo add an item to a list, remove an item from a list, or update an item in a list, \n you must provide the entire list. For example, to add an action, specify a list with the\n current actions plus the new action.
" } }, "com.amazonaws.elasticloadbalancingv2#ModifyRuleInput": { "type": "structure", "members": { + "RuleArn": { + "target": "com.amazonaws.elasticloadbalancingv2#RuleArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule.
", + "smithy.api#required": {} + } + }, "Conditions": { "target": "com.amazonaws.elasticloadbalancingv2#RuleConditionList", "traits": { @@ -3150,13 +3159,6 @@ "traits": { "smithy.api#documentation": "The actions.
" } - }, - "RuleArn": { - "target": "com.amazonaws.elasticloadbalancingv2#RuleArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule.
", - "smithy.api#required": {} - } } } }, @@ -3188,7 +3190,7 @@ } ], "traits": { - "smithy.api#documentation": "Modifies the health checks used when evaluating the health state of the targets in the\n specified target group.
\nTo monitor the health of the targets, use DescribeTargetHealth.
" + "smithy.api#documentation": "Modifies the health checks used when evaluating the health state of the targets in the\n specified target group.
" } }, "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroupAttributes": { @@ -3214,17 +3216,17 @@ "com.amazonaws.elasticloadbalancingv2#ModifyTargetGroupAttributesInput": { "type": "structure", "members": { - "Attributes": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributes", + "TargetGroupArn": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { - "smithy.api#documentation": "The attributes.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target group.
", "smithy.api#required": {} } }, - "TargetGroupArn": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", + "Attributes": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupAttributes", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target group.
", + "smithy.api#documentation": "The attributes.
", "smithy.api#required": {} } } @@ -3251,10 +3253,10 @@ "smithy.api#required": {} } }, - "HealthCheckIntervalSeconds": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckIntervalSeconds", + "HealthCheckProtocol": { + "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { - "smithy.api#documentation": "The approximate amount of time, in seconds, between health checks of an individual\n target. For HTTP and HTTPS health checks, the range is 5 to 300 seconds. For TPC\n health checks, the supported values are 10 or 30 seconds.
\nWith Network Load Balancers, you can't modify this setting.
" + "smithy.api#documentation": "The protocol the load balancer uses when performing health checks on targets. The TCP\n protocol is supported for health checks only if the protocol of the target group is TCP, TLS,\n UDP, or TCP_UDP. The GENEVE, TLS, UDP, and TCP_UDP protocols are not supported for health\n checks.
\nWith Network Load Balancers, you can't modify this setting.
" } }, "HealthCheckPort": { @@ -3263,34 +3265,34 @@ "smithy.api#documentation": "The port the load balancer uses when performing health checks on targets.
" } }, - "HealthCheckProtocol": { - "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", + "HealthCheckPath": { + "target": "com.amazonaws.elasticloadbalancingv2#Path", "traits": { - "smithy.api#documentation": "The protocol the load balancer uses when performing health checks on targets. \n The TCP protocol is supported for health checks only if the protocol of the target group is TCP, TLS, UDP, or TCP_UDP.\n The TLS, UDP, and TCP_UDP protocols are not supported for health checks.
\nWith Network Load Balancers, you can't modify this setting.
" + "smithy.api#documentation": "[HTTP/HTTPS health checks] The destination for health checks on the targets.
\n[HTTP1 or HTTP2 protocol version] The ping path. The default is /.
\n[GRPC protocol version] The path of a custom health check method with the format /package.service/method. \n The default is /AWS.ALB/healthcheck.
" } }, - "HealthCheckTimeoutSeconds": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckTimeoutSeconds", + "HealthCheckEnabled": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckEnabled", "traits": { - "smithy.api#documentation": "[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response\n means a failed health check.
\nWith Network Load Balancers, you can't modify this setting.
" + "smithy.api#documentation": "Indicates whether health checks are enabled.
" } }, - "HealthyThresholdCount": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", + "HealthCheckIntervalSeconds": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckIntervalSeconds", "traits": { - "smithy.api#documentation": "The number of consecutive health checks successes required before considering an\n unhealthy target healthy.
" + "smithy.api#documentation": "The approximate amount of time, in seconds, between health checks of an individual target. \n For TCP health checks, the supported values are 10 or 30 seconds.
\nWith Network Load Balancers, you can't modify this setting.
" } }, - "HealthCheckPath": { - "target": "com.amazonaws.elasticloadbalancingv2#Path", + "HealthCheckTimeoutSeconds": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckTimeoutSeconds", "traits": { - "smithy.api#documentation": "[HTTP/HTTPS health checks] The destination for health checks on the targets.
\n[HTTP1 or HTTP2 protocol version] The ping path. The default is /.
\n[GRPC protocol version] The path of a custom health check method with the format /package.service/method. \n The default is /AWS.ALB/healthcheck.
" + "smithy.api#documentation": "[HTTP/HTTPS health checks] The amount of time, in seconds, during which no response\n means a failed health check.
\nWith Network Load Balancers, you can't modify this setting.
" } }, - "HealthCheckEnabled": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckEnabled", + "HealthyThresholdCount": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", "traits": { - "smithy.api#documentation": "Indicates whether health checks are enabled.
" + "smithy.api#documentation": "The number of consecutive health checks successes required before considering an\n unhealthy target healthy.
" } }, "UnhealthyThresholdCount": { @@ -3417,6 +3419,9 @@ }, { "value": "TCP_UDP" + }, + { + "value": "GENEVE" } ] } @@ -3441,16 +3446,16 @@ "com.amazonaws.elasticloadbalancingv2#QueryStringKeyValuePair": { "type": "structure", "members": { - "Value": { + "Key": { "target": "com.amazonaws.elasticloadbalancingv2#StringValue", "traits": { - "smithy.api#documentation": "The value.
" + "smithy.api#documentation": "The key. You can omit the key.
" } }, - "Key": { + "Value": { "target": "com.amazonaws.elasticloadbalancingv2#StringValue", "traits": { - "smithy.api#documentation": "The key. You can omit the key.
" + "smithy.api#documentation": "The value.
" } } }, @@ -3467,17 +3472,10 @@ "com.amazonaws.elasticloadbalancingv2#RedirectActionConfig": { "type": "structure", "members": { - "StatusCode": { - "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionStatusCodeEnum", - "traits": { - "smithy.api#documentation": "The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
", - "smithy.api#required": {} - } - }, - "Query": { - "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionQuery", + "Protocol": { + "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionProtocol", "traits": { - "smithy.api#documentation": "The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include\n the leading \"?\", as it is automatically added. You can specify any of the reserved\n keywords.
" + "smithy.api#documentation": "The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP,\n HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
" } }, "Port": { @@ -3486,22 +3484,29 @@ "smithy.api#documentation": "The port. You can specify a value from 1 to 65535 or #{port}.
" } }, + "Host": { + "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionHost", + "traits": { + "smithy.api#documentation": "The hostname. This component is not percent-encoded. The hostname can contain #{host}.
" + } + }, "Path": { "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionPath", "traits": { "smithy.api#documentation": "The absolute path, starting with the leading \"/\". This component is not percent-encoded.\n The path can contain #{host}, #{path}, and #{port}.
" } }, - "Host": { - "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionHost", + "Query": { + "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionQuery", "traits": { - "smithy.api#documentation": "The hostname. This component is not percent-encoded. The hostname can contain #{host}.
" + "smithy.api#documentation": "The query parameters, URL-encoded when necessary, but not percent-encoded. Do not include\n the leading \"?\", as it is automatically added. You can specify any of the reserved\n keywords.
" } }, - "Protocol": { - "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionProtocol", + "StatusCode": { + "target": "com.amazonaws.elasticloadbalancingv2#RedirectActionStatusCodeEnum", "traits": { - "smithy.api#documentation": "The protocol. You can specify HTTP, HTTPS, or #{protocol}. You can redirect HTTP to HTTP,\n HTTP to HTTPS, and HTTPS to HTTPS. You cannot redirect HTTPS to HTTP.
" + "smithy.api#documentation": "The HTTP redirect code. The redirect is either permanent (HTTP 301) or temporary (HTTP 302).
", + "smithy.api#required": {} } } }, @@ -3583,23 +3588,23 @@ } ], "traits": { - "smithy.api#documentation": "Registers the specified targets with the specified target group.
\n\nIf the target is an EC2 instance, it must be in the running
state when you register it.
By default, the load balancer routes requests to registered targets using the protocol\n and port for the target group. Alternatively, you can override the port for a target when you\n register it. You can register each EC2 instance or IP address with the same target group\n multiple times using different ports.
\n\nWith a Network Load Balancer, you cannot register instances by instance ID if they have\n the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3,\n and T1. You can register instances of these types by IP address.
\n\nTo remove a target from a target group, use DeregisterTargets.
" + "smithy.api#documentation": "Registers the specified targets with the specified target group.
\n\nIf the target is an EC2 instance, it must be in the running
state when you register it.
By default, the load balancer routes requests to registered targets using the protocol\n and port for the target group. Alternatively, you can override the port for a target when you\n register it. You can register each EC2 instance or IP address with the same target group\n multiple times using different ports.
\n\nWith a Network Load Balancer, you cannot register instances by instance ID if they have\n the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3,\n and T1. You can register instances of these types by IP address.
" } }, "com.amazonaws.elasticloadbalancingv2#RegisterTargetsInput": { "type": "structure", "members": { - "Targets": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetDescriptions", + "TargetGroupArn": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", "traits": { - "smithy.api#documentation": "The targets.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target group.
", "smithy.api#required": {} } }, - "TargetGroupArn": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", + "Targets": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetDescriptions", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target group.
", + "smithy.api#documentation": "The targets.
", "smithy.api#required": {} } } @@ -3626,7 +3631,7 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.
\nYou can't remove the default certificate for a listener. To replace the default\n certificate, call ModifyListener.
\nTo list the certificates for your listener, use DescribeListenerCertificates.
" + "smithy.api#documentation": "Removes the specified certificate from the certificate list for the specified HTTPS or TLS listener.
" } }, "com.amazonaws.elasticloadbalancingv2#RemoveListenerCertificatesInput": { @@ -3678,23 +3683,23 @@ } ], "traits": { - "smithy.api#documentation": "Removes the specified tags from the specified Elastic Load Balancing resources. You can remove the tags \n for one or more Application Load Balancers, Network Load Balancers, target groups, listeners, or rules.
\nTo list the current tags for your resources, use DescribeTags.
" + "smithy.api#documentation": "Removes the specified tags from the specified Elastic Load Balancing resources. You can\n remove the tags for one or more Application Load Balancers, Network Load Balancers, Gateway\n Load Balancers, target groups, listeners, or rules.
" } }, "com.amazonaws.elasticloadbalancingv2#RemoveTagsInput": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.elasticloadbalancingv2#TagKeys", + "ResourceArns": { + "target": "com.amazonaws.elasticloadbalancingv2#ResourceArns", "traits": { - "smithy.api#documentation": "The tag keys for the tags to remove.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", "smithy.api#required": {} } }, - "ResourceArns": { - "target": "com.amazonaws.elasticloadbalancingv2#ResourceArns", + "TagKeys": { + "target": "com.amazonaws.elasticloadbalancingv2#TagKeys", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
", + "smithy.api#documentation": "The tag keys for the tags to remove.
", "smithy.api#required": {} } } @@ -3735,10 +3740,10 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule.
" } }, - "IsDefault": { - "target": "com.amazonaws.elasticloadbalancingv2#IsDefault", + "Priority": { + "target": "com.amazonaws.elasticloadbalancingv2#String", "traits": { - "smithy.api#documentation": "Indicates whether this is the default rule.
" + "smithy.api#documentation": "The priority.
" } }, "Conditions": { @@ -3747,17 +3752,17 @@ "smithy.api#documentation": "The conditions. Each rule can include zero or one of the following conditions:\n http-request-method
, host-header
, path-pattern
,\n and source-ip
, and zero or more of the following conditions:\n http-header
and query-string
.
The priority.
" - } - }, "Actions": { "target": "com.amazonaws.elasticloadbalancingv2#Actions", "traits": { "smithy.api#documentation": "The actions. Each rule must include exactly one of the following types of actions: forward
, \n redirect
, or fixed-response
, and it must be the last action to be performed.
Indicates whether this is the default rule.
" + } } }, "traits": { @@ -3776,34 +3781,28 @@ "com.amazonaws.elasticloadbalancingv2#RuleCondition": { "type": "structure", "members": { - "HostHeaderConfig": { - "target": "com.amazonaws.elasticloadbalancingv2#HostHeaderConditionConfig", - "traits": { - "smithy.api#documentation": "Information for a host header condition.\n Specify only when Field
is host-header
.
Information for a path pattern condition.\n Specify only when Field
is path-pattern
.
The field in the HTTP request. The following are the possible values:
\n\n http-header
\n
\n http-request-method
\n
\n host-header
\n
\n path-pattern
\n
\n query-string
\n
\n source-ip
\n
Information for an HTTP method condition.\n Specify only when Field
is http-request-method
.
The condition value. \n Specify only when Field
is host-header
or path-pattern
. \n Alternatively, to specify multiple host names or multiple path patterns, \n use HostHeaderConfig
or PathPatternConfig
.
If Field
is host-header
and you are not using HostHeaderConfig
, \n you can specify a single host name (for example, my.example.com) in Values
. A host name is case insensitive, can be \n up to 128 characters in length, and can contain any of the following characters.
A-Z, a-z, 0-9
\n- .
\n* (matches 0 or more characters)
\n? (matches exactly 1 character)
\nIf Field
is path-pattern
and you are not using PathPatternConfig
, \n you can specify a single path pattern (for example, /img/*) in Values
. A path pattern is \n case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
A-Z, a-z, 0-9
\n_ - . $ / ~ \" ' @ : +
\n& (using &)
\n* (matches 0 or more characters)
\n? (matches exactly 1 character)
\nInformation for a source IP condition.\n Specify only when Field
is source-ip
.
Information for a host header condition.\n Specify only when Field
is host-header
.
Information for a path pattern condition.\n Specify only when Field
is path-pattern
.
Information for a query string condition.\n Specify only when Field
is query-string
.
The condition value. \n Specify only when Field
is host-header
or path-pattern
. \n Alternatively, to specify multiple host names or multiple path patterns, \n use HostHeaderConfig
or PathPatternConfig
.
If Field
is host-header
and you are not using HostHeaderConfig
, \n you can specify a single host name (for example, my.example.com) in Values
. A host name is case insensitive, can be \n up to 128 characters in length, and can contain any of the following characters.
A-Z, a-z, 0-9
\n- .
\n* (matches 0 or more characters)
\n? (matches exactly 1 character)
\nIf Field
is path-pattern
and you are not using PathPatternConfig
, \n you can specify a single path pattern (for example, /img/*) in Values
. A path pattern is \n case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.
A-Z, a-z, 0-9
\n_ - . $ / ~ \" ' @ : +
\n& (using &)
\n* (matches 0 or more characters)
\n? (matches exactly 1 character)
\nInformation for an HTTP method condition.\n Specify only when Field
is http-request-method
.
Information for a source IP condition.\n Specify only when Field
is source-ip
.
The rule priority.
" - } - }, "RuleArn": { "target": "com.amazonaws.elasticloadbalancingv2#RuleArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the rule.
" } + }, + "Priority": { + "target": "com.amazonaws.elasticloadbalancingv2#RulePriority", + "traits": { + "smithy.api#documentation": "The rule priority.
" + } } }, "traits": { @@ -3938,17 +3943,17 @@ "com.amazonaws.elasticloadbalancingv2#SetIpAddressTypeInput": { "type": "structure", "members": { - "IpAddressType": { - "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", + "LoadBalancerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { - "smithy.api#documentation": "The IP address type. The possible values are ipv4
(for IPv4 addresses) and\n dualstack
(for IPv4 and IPv6 addresses). Internal load balancers must use\n ipv4
. Network Load Balancers must use ipv4
.
The Amazon Resource Name (ARN) of the load balancer.
", "smithy.api#required": {} } }, - "LoadBalancerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", + "IpAddressType": { + "target": "com.amazonaws.elasticloadbalancingv2#IpAddressType", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the load balancer.
", + "smithy.api#documentation": "The IP address type. The possible values are ipv4
(for IPv4 addresses) and\n dualstack
(for IPv4 and IPv6 addresses). Internal load balancers must use\n ipv4
.
Associates the specified security groups with the specified Application Load Balancer.\n The specified security groups override the previously associated security groups.
\nYou can't specify a security group for a Network Load Balancer.
" + "smithy.api#documentation": "Associates the specified security groups with the specified Application Load Balancer.\n The specified security groups override the previously associated security groups.
\nYou can't specify a security group for a Network Load Balancer or Gateway Load\n Balancer.
" } }, "com.amazonaws.elasticloadbalancingv2#SetSecurityGroupsInput": { @@ -4093,16 +4098,17 @@ } ], "traits": { - "smithy.api#documentation": "Enables the Availability Zones for the specified public subnets for the specified \n load balancer. The specified subnets replace the previously enabled subnets.
\nWhen you specify subnets for a Network Load Balancer, you must include all\n subnets that were enabled previously, with their existing configurations, plus any \n additional subnets.
" + "smithy.api#documentation": "Enables the Availability Zones for the specified public subnets for the specified \n Application Load Balancer or Network Load Balancer. The specified subnets replace the \n previously enabled subnets.
\nWhen you specify subnets for a Network Load Balancer, you must include all\n subnets that were enabled previously, with their existing configurations, plus any \n additional subnets.
" } }, "com.amazonaws.elasticloadbalancingv2#SetSubnetsInput": { "type": "structure", "members": { - "SubnetMappings": { - "target": "com.amazonaws.elasticloadbalancingv2#SubnetMappings", + "LoadBalancerArn": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", "traits": { - "smithy.api#documentation": "The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must \n specify either subnets or subnet mappings.
\n[Application Load Balancers] You must specify subnets from at least two Availability Zones.\n You cannot specify Elastic IP addresses for your subnets.
\n[Network Load Balancers] You can specify subnets from one or more Availability Zones. If you \n need static IP addresses for your internet-facing load balancer, you can specify one Elastic IP \n address per subnet. For internal load balancers, you can specify one private IP address per \n subnet from the IPv4 range of the subnet.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the load balancer.
", + "smithy.api#required": {} } }, "Subnets": { @@ -4111,11 +4117,10 @@ "smithy.api#documentation": "The IDs of the public subnets. You must specify subnets from at least two Availability Zones.\n You can specify only one subnet per Availability Zone. You must specify either subnets or\n subnet mappings.
" } }, - "LoadBalancerArn": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArn", + "SubnetMappings": { + "target": "com.amazonaws.elasticloadbalancingv2#SubnetMappings", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the load balancer.
", - "smithy.api#required": {} + "smithy.api#documentation": "The IDs of the public subnets. You can specify only one subnet per Availability Zone. You must \n specify either subnets or subnet mappings.
\n[Application Load Balancers] You must specify subnets from at least two Availability Zones.\n You cannot specify Elastic IP addresses for your subnets.
\n[Network Load Balancers] You can specify subnets from one or more Availability Zones. If you \n need static IP addresses for your internet-facing load balancer, you can specify one Elastic IP \n address per subnet. For internal load balancers, you can specify one private IP address per \n subnet from the IPv4 range of the subnet.
" } } } @@ -4154,12 +4159,6 @@ "com.amazonaws.elasticloadbalancingv2#SslPolicy": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", - "traits": { - "smithy.api#documentation": "The name of the policy.
" - } - }, "SslProtocols": { "target": "com.amazonaws.elasticloadbalancingv2#SslProtocols", "traits": { @@ -4171,6 +4170,12 @@ "traits": { "smithy.api#documentation": "The ciphers.
" } + }, + "Name": { + "target": "com.amazonaws.elasticloadbalancingv2#SslPolicyName", + "traits": { + "smithy.api#documentation": "The name of the policy.
" + } } }, "traits": { @@ -4210,10 +4215,10 @@ "com.amazonaws.elasticloadbalancingv2#SubnetMapping": { "type": "structure", "members": { - "PrivateIPv4Address": { - "target": "com.amazonaws.elasticloadbalancingv2#PrivateIPv4Address", + "SubnetId": { + "target": "com.amazonaws.elasticloadbalancingv2#SubnetId", "traits": { - "smithy.api#documentation": "[Network Load Balancers] The private IPv4 address for an internal load balancer.
" + "smithy.api#documentation": "The ID of the subnet.
" } }, "AllocationId": { @@ -4222,10 +4227,10 @@ "smithy.api#documentation": "[Network Load Balancers] The allocation ID of the Elastic IP address for an internet-facing load balancer.
" } }, - "SubnetId": { - "target": "com.amazonaws.elasticloadbalancingv2#SubnetId", + "PrivateIPv4Address": { + "target": "com.amazonaws.elasticloadbalancingv2#PrivateIPv4Address", "traits": { - "smithy.api#documentation": "The ID of the subnet.
" + "smithy.api#documentation": "[Network Load Balancers] The private IPv4 address for an internal load balancer.
" } } }, @@ -4282,17 +4287,17 @@ "com.amazonaws.elasticloadbalancingv2#TagDescription": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.elasticloadbalancingv2#TagList", - "traits": { - "smithy.api#documentation": "Information about the tags.
" - } - }, "ResourceArn": { "target": "com.amazonaws.elasticloadbalancingv2#ResourceArn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" } + }, + "Tags": { + "target": "com.amazonaws.elasticloadbalancingv2#TagList", + "traits": { + "smithy.api#documentation": "Information about the tags.
" + } } }, "traits": { @@ -4345,12 +4350,6 @@ "com.amazonaws.elasticloadbalancingv2#TargetDescription": { "type": "structure", "members": { - "AvailabilityZone": { - "target": "com.amazonaws.elasticloadbalancingv2#ZoneName", - "traits": { - "smithy.api#documentation": "An Availability Zone or all
. This determines whether the target receives\n traffic from the load balancer nodes in the specified Availability Zone or from all enabled\n Availability Zones for the load balancer.
This parameter is not supported if the target type of the target group is instance
.
If the target type is ip
and the IP address is in a subnet of the VPC for the \n target group, the Availability Zone is automatically detected and this parameter is optional. \n If the IP address is outside the VPC, this parameter is required.
With an Application Load Balancer, if the target type is ip
and the IP address \n is outside the VPC for the target group, the only supported value is all
.
If the target type is lambda
, this parameter is optional and the only supported value is all
.
The port on which the target is listening. Not used if the target is a Lambda function.
" + "smithy.api#documentation": "The port on which the target is listening.\n If the target group protocol is GENEVE, the supported port is 6081.\n Not used if the target is a Lambda function.
" + } + }, + "AvailabilityZone": { + "target": "com.amazonaws.elasticloadbalancingv2#ZoneName", + "traits": { + "smithy.api#documentation": "An Availability Zone or all
. This determines whether the target receives\n traffic from the load balancer nodes in the specified Availability Zone or from all enabled\n Availability Zones for the load balancer.
This parameter is not supported if the target type of the target group is instance
.
If the target type is ip
and the IP address is in a subnet of the VPC for the \n target group, the Availability Zone is automatically detected and this parameter is optional. \n If the IP address is outside the VPC, this parameter is required.
With an Application Load Balancer, if the target type is ip
and the IP address \n is outside the VPC for the target group, the only supported value is all
.
If the target type is lambda
, this parameter is optional and the only supported value is all
.
The Amazon Resource Name (ARN) of the target group.
" + } + }, "TargetGroupName": { "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupName", "traits": { "smithy.api#documentation": "The name of the target group.
" } }, - "VpcId": { - "target": "com.amazonaws.elasticloadbalancingv2#VpcId", + "Protocol": { + "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { - "smithy.api#documentation": "The ID of the VPC for the targets.
" + "smithy.api#documentation": "The protocol to use for routing traffic to the targets.
" } }, - "HealthCheckPort": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckPort", + "Port": { + "target": "com.amazonaws.elasticloadbalancingv2#Port", "traits": { - "smithy.api#documentation": "The port to use to connect with the target.
" + "smithy.api#documentation": "The port on which the targets are listening. Not used if the target is a Lambda function.
" } }, - "TargetType": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetTypeEnum", + "VpcId": { + "target": "com.amazonaws.elasticloadbalancingv2#VpcId", "traits": { - "smithy.api#documentation": "The type of target that you must specify when registering targets with this target\n group. The possible values are instance
(targets are specified by instance ID) or\n ip
(targets are specified by IP address).
The ID of the VPC for the targets.
" } }, "HealthCheckProtocol": { "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", "traits": { - "smithy.api#documentation": "The protocol to use to connect with the target.
" - } - }, - "HealthyThresholdCount": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", - "traits": { - "smithy.api#documentation": "The number of consecutive health checks successes required before considering an\n unhealthy target healthy.
" + "smithy.api#documentation": "The protocol to use to connect with the target. The GENEVE, TLS, UDP, and TCP_UDP protocols \n are not supported for health checks.
" } }, - "Protocol": { - "target": "com.amazonaws.elasticloadbalancingv2#ProtocolEnum", + "HealthCheckPort": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckPort", "traits": { - "smithy.api#documentation": "The protocol to use for routing traffic to the targets.
" + "smithy.api#documentation": "The port to use to connect with the target.
" } }, - "TargetGroupArn": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetGroupArn", + "HealthCheckEnabled": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckEnabled", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target group.
" + "smithy.api#documentation": "Indicates whether health checks are enabled.
" } }, "HealthCheckIntervalSeconds": { @@ -4432,34 +4437,16 @@ "smithy.api#documentation": "The approximate amount of time, in seconds, between health checks of an individual\n target.
" } }, - "LoadBalancerArns": { - "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArns", - "traits": { - "smithy.api#documentation": "The Amazon Resource Names (ARN) of the load balancers that route traffic to this target\n group.
" - } - }, "HealthCheckTimeoutSeconds": { "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckTimeoutSeconds", "traits": { "smithy.api#documentation": "The amount of time, in seconds, during which no response means a failed health\n check.
" } }, - "HealthCheckPath": { - "target": "com.amazonaws.elasticloadbalancingv2#Path", - "traits": { - "smithy.api#documentation": "The destination for health checks on the targets.
" - } - }, - "Port": { - "target": "com.amazonaws.elasticloadbalancingv2#Port", - "traits": { - "smithy.api#documentation": "The port on which the targets are listening. Not used if the target is a Lambda function.
" - } - }, - "ProtocolVersion": { - "target": "com.amazonaws.elasticloadbalancingv2#ProtocolVersion", + "HealthyThresholdCount": { + "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckThresholdCount", "traits": { - "smithy.api#documentation": "[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC
,\n HTTP1
, and HTTP2
.
The number of consecutive health checks successes required before considering an\n unhealthy target healthy.
" } }, "UnhealthyThresholdCount": { @@ -4468,10 +4455,10 @@ "smithy.api#documentation": "The number of consecutive health check failures required before considering the target\n unhealthy.
" } }, - "HealthCheckEnabled": { - "target": "com.amazonaws.elasticloadbalancingv2#HealthCheckEnabled", + "HealthCheckPath": { + "target": "com.amazonaws.elasticloadbalancingv2#Path", "traits": { - "smithy.api#documentation": "Indicates whether health checks are enabled.
" + "smithy.api#documentation": "The destination for health checks on the targets.
" } }, "Matcher": { @@ -4479,6 +4466,24 @@ "traits": { "smithy.api#documentation": "The HTTP or gRPC codes to use when checking for a successful response from a target.
" } + }, + "LoadBalancerArns": { + "target": "com.amazonaws.elasticloadbalancingv2#LoadBalancerArns", + "traits": { + "smithy.api#documentation": "The Amazon Resource Names (ARN) of the load balancers that route traffic to this target\n group.
" + } + }, + "TargetType": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetTypeEnum", + "traits": { + "smithy.api#documentation": "The type of target that you must specify when registering targets with this target\n group. The possible values are instance
(register targets by instance ID), \n ip
(register targets by IP address), or lambda
(register a \n single Lambda function as a target).
[HTTP/HTTPS protocol] The protocol version. The possible values are GRPC
,\n HTTP1
, and HTTP2
.
The name of the attribute.
\n\nThe following attributes are supported by both Application Load Balancers and Network Load Balancers:
\n\n deregistration_delay.timeout_seconds
- The amount of time, in seconds,\n for Elastic Load Balancing to wait before changing the state of a deregistering target from\n draining
to unused
. The range is 0-3600 seconds. The default\n value is 300 seconds. If the target is a Lambda function, this attribute is not supported.
\n stickiness.enabled
- Indicates whether sticky sessions are enabled. \n The value is true
or false
. The default is false
.
\n stickiness.type
- The type of sticky sessions. The possible values are \n lb_cookie
for Application Load Balancers or source_ip
for\n Network Load Balancers.
The following attributes are supported only if the load balancer is an Application Load Balancer\n and the target is an instance or an IP address:
\n\n load_balancing.algorithm.type
- The load balancing algorithm determines\n how the load balancer selects targets when routing requests. The value is round_robin
\n or least_outstanding_requests
. The default is round_robin
.
\n slow_start.duration_seconds
- The time period, in seconds, during which a \n newly registered target receives an increasing share of the traffic to the target group. \n After this time period ends, the target receives its full share of traffic. \n The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled).
\n stickiness.lb_cookie.duration_seconds
- The time period, in seconds, during which \n requests from a client should be routed to the same target. After this time period expires, the load \n balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The \n default value is 1 day (86400 seconds).
The following attribute is supported only if the load balancer is an Application Load Balancer \n and the target is a Lambda function:
\n\n lambda.multi_value_headers.enabled
- Indicates whether the request and\n response headers that are exchanged between the load balancer and the Lambda function include\n arrays of values or strings. The value is true
or false
. The\n default is false
. If the value is false
and the request contains\n a duplicate header field name or query parameter key, the load balancer uses the last\n value sent by the client.
The following attribute is supported only by Network Load Balancers:
\n\n proxy_protocol_v2.enabled
- Indicates whether Proxy Protocol version 2 is enabled.\n The value is true
or false
. The default is false
.
The name of the attribute.
\n\nThe following attribute is supported by all load balancers:
\n\n deregistration_delay.timeout_seconds
- The amount of time, in seconds,\n for Elastic Load Balancing to wait before changing the state of a deregistering target from\n draining
to unused
. The range is 0-3600 seconds. The default\n value is 300 seconds. If the target is a Lambda function, this attribute is not supported.
The following attributes are supported by both Application Load Balancers and Network Load Balancers:
\n\n stickiness.enabled
- Indicates whether sticky sessions are enabled. \n The value is true
or false
. The default is false
.
\n stickiness.type
- The type of sticky sessions. The possible values are \n lb_cookie
for Application Load Balancers or source_ip
for\n Network Load Balancers.
The following attributes are supported only if the load balancer is an Application Load Balancer\n and the target is an instance or an IP address:
\n\n load_balancing.algorithm.type
- The load balancing algorithm determines\n how the load balancer selects targets when routing requests. The value is round_robin
\n or least_outstanding_requests
. The default is round_robin
.
\n slow_start.duration_seconds
- The time period, in seconds, during which a \n newly registered target receives an increasing share of the traffic to the target group. \n After this time period ends, the target receives its full share of traffic. \n The range is 30-900 seconds (15 minutes). The default is 0 seconds (disabled).
\n stickiness.lb_cookie.duration_seconds
- The time period, in seconds, during which \n requests from a client should be routed to the same target. After this time period expires, the load \n balancer-generated cookie is considered stale. The range is 1 second to 1 week (604800 seconds). The \n default value is 1 day (86400 seconds).
The following attribute is supported only if the load balancer is an Application Load Balancer \n and the target is a Lambda function:
\n\n lambda.multi_value_headers.enabled
- Indicates whether the request and\n response headers that are exchanged between the load balancer and the Lambda function include\n arrays of values or strings. The value is true
or false
. The\n default is false
. If the value is false
and the request contains\n a duplicate header field name or query parameter key, the load balancer uses the last\n value sent by the client.
The following attribute is supported only by Network Load Balancers:
\n\n proxy_protocol_v2.enabled
- Indicates whether Proxy Protocol version 2 is enabled.\n The value is true
or false
. The default is false
.
A description of the target health that provides additional details. If the state is\n healthy
, a description is not provided.
The state of the target.
" } }, "Reason": { "target": "com.amazonaws.elasticloadbalancingv2#TargetHealthReasonEnum", "traits": { - "smithy.api#documentation": "The reason code.
\n\nIf the target state is healthy
, a reason code is not provided.
If the target state is initial
, the reason code can be one of the\n following values:
\n Elb.RegistrationInProgress
- The target is in the process of being registered\n with the load balancer.
\n Elb.InitialHealthChecking
- The load balancer is still sending the target the\n minimum number of health checks required to determine its health status.
If the target state is unhealthy
, the reason code can be one of the\n following values:
\n Target.ResponseCodeMismatch
- The health checks did not return an expected\n HTTP code. Applies only to Application Load Balancers.
\n Target.Timeout
- The health check requests timed out.\n Applies only to Application Load Balancers.
\n Target.FailedHealthChecks
- The load balancer received an error while\n establishing a connection to the target or the target response was malformed.
\n Elb.InternalError
- The health checks failed due to an internal error.\n Applies only to Application Load Balancers.
If the target state is unused
, the reason code can be one of the following values:
\n Target.NotRegistered
- The target is not registered with the target group.
\n Target.NotInUse
- The target group is not used by any load balancer or the\n target is in an Availability Zone that is not enabled for its load balancer.
\n Target.InvalidState
- The target is in the stopped or terminated state.
\n Target.IpUnusable
- The target IP address is reserved for use by a load balancer.
If the target state is draining
, the reason code can be the following value:
\n Target.DeregistrationInProgress
- The target is in the process of being\n deregistered and the deregistration delay period has not expired.
If the target state is unavailable
, the reason code can be the following value:
\n Target.HealthCheckDisabled
- Health checks are disabled for the target group.\n Applies only to Application Load Balancers.
\n Elb.InternalError
- Target health is unavailable due to an internal error.\n Applies only to Network Load Balancers.
The reason code.
\n\nIf the target state is healthy
, a reason code is not provided.
If the target state is initial
, the reason code can be one of the\n following values:
\n Elb.RegistrationInProgress
- The target is in the process of being registered\n with the load balancer.
\n Elb.InitialHealthChecking
- The load balancer is still sending the target the\n minimum number of health checks required to determine its health status.
If the target state is unhealthy
, the reason code can be one of the\n following values:
\n Target.ResponseCodeMismatch
- The health checks did not return an expected\n HTTP code. Applies only to Application Load Balancers and Gateway Load Balancers.
\n Target.Timeout
- The health check requests timed out.\n Applies only to Application Load Balancers and Gateway Load Balancers.
\n Target.FailedHealthChecks
- The load balancer received an error while\n establishing a connection to the target or the target response was malformed.
\n Elb.InternalError
- The health checks failed due to an internal error.\n Applies only to Application Load Balancers.
If the target state is unused
, the reason code can be one of the following values:
\n Target.NotRegistered
- The target is not registered with the target group.
\n Target.NotInUse
- The target group is not used by any load balancer or the\n target is in an Availability Zone that is not enabled for its load balancer.
\n Target.InvalidState
- The target is in the stopped or terminated state.
\n Target.IpUnusable
- The target IP address is reserved for use by a load balancer.
If the target state is draining
, the reason code can be the following value:
\n Target.DeregistrationInProgress
- The target is in the process of being\n deregistered and the deregistration delay period has not expired.
If the target state is unavailable
, the reason code can be the following value:
\n Target.HealthCheckDisabled
- Health checks are disabled for the target group.\n Applies only to Application Load Balancers.
\n Elb.InternalError
- Target health is unavailable due to an internal error.\n Applies only to Network Load Balancers.
The state of the target.
" + "smithy.api#documentation": "A description of the target health that provides additional details. If the state is\n healthy
, a description is not provided.
The health information for the target.
" + "smithy.api#documentation": "The description of the target.
" } }, "HealthCheckPort": { @@ -4679,10 +4684,10 @@ "smithy.api#documentation": "The port to use to connect with the target.
" } }, - "Target": { - "target": "com.amazonaws.elasticloadbalancingv2#TargetDescription", + "TargetHealth": { + "target": "com.amazonaws.elasticloadbalancingv2#TargetHealth", "traits": { - "smithy.api#documentation": "The description of the target.
" + "smithy.api#documentation": "The health information for the target.
" } } }, diff --git a/codegen/sdk-codegen/aws-models/elasticsearch-service.2015-01-01.json b/codegen/sdk-codegen/aws-models/elasticsearch-service.2015-01-01.json index 38c8ffc293e8..ca23dc64c822 100644 --- a/codegen/sdk-codegen/aws-models/elasticsearch-service.2015-01-01.json +++ b/codegen/sdk-codegen/aws-models/elasticsearch-service.2015-01-01.json @@ -394,6 +394,9 @@ { "target": "com.amazonaws.elasticsearchservice#GetCompatibleElasticsearchVersions" }, + { + "target": "com.amazonaws.elasticsearchservice#GetPackageVersionHistory" + }, { "target": "com.amazonaws.elasticsearchservice#GetUpgradeHistory" }, @@ -433,6 +436,9 @@ { "target": "com.amazonaws.elasticsearchservice#UpdateElasticsearchDomainConfig" }, + { + "target": "com.amazonaws.elasticsearchservice#UpdatePackage" + }, { "target": "com.amazonaws.elasticsearchservice#UpgradeElasticsearchDomain" } @@ -680,6 +686,15 @@ "smithy.api#documentation": "Status of the Cognito options for the specified Elasticsearch domain.
" } }, + "com.amazonaws.elasticsearchservice#CommitMessage": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 0, + "max": 160 + } + } + }, "com.amazonaws.elasticsearchservice#CompatibleElasticsearchVersionsList": { "type": "list", "member": { @@ -2345,6 +2360,9 @@ "smithy.api#documentation": "State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.
" } }, + "PackageVersion": { + "target": "com.amazonaws.elasticsearchservice#PackageVersion" + }, "ReferencePath": { "target": "com.amazonaws.elasticsearchservice#ReferencePath", "traits": { @@ -3181,6 +3199,95 @@ "smithy.api#documentation": "\n Container for response returned by\n \n GetCompatibleElasticsearchVersions\n
\n operation.\n
Returns a list of versions of the package, along with their creation time and commit message.
", + "smithy.api#http": { + "method": "GET", + "uri": "/2015-01-01/packages/{PackageID}/history", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.elasticsearchservice#GetPackageVersionHistoryRequest": { + "type": "structure", + "members": { + "PackageID": { + "target": "com.amazonaws.elasticsearchservice#PackageID", + "traits": { + "smithy.api#documentation": "Returns an audit history of versions of the package.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.elasticsearchservice#MaxResults", + "traits": { + "smithy.api#documentation": "Limits results to a maximum number of versions.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.elasticsearchservice#NextToken", + "traits": { + "smithy.api#documentation": "Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Container for request parameters to\n \n GetPackageVersionHistory\n
\n operation.\n
List of PackageVersionHistory
objects.
\n Container for response returned by\n \n GetPackageVersionHistory\n
\n operation.\n
Timestamp which tells creation date of the package.
" } }, + "LastUpdatedAt": { + "target": "com.amazonaws.elasticsearchservice#LastUpdated" + }, + "AvailablePackageVersion": { + "target": "com.amazonaws.elasticsearchservice#PackageVersion" + }, "ErrorDetails": { "target": "com.amazonaws.elasticsearchservice#ErrorDetails", "traits": { @@ -4527,6 +4640,41 @@ ] } }, + "com.amazonaws.elasticsearchservice#PackageVersion": { + "type": "string" + }, + "com.amazonaws.elasticsearchservice#PackageVersionHistory": { + "type": "structure", + "members": { + "PackageVersion": { + "target": "com.amazonaws.elasticsearchservice#PackageVersion", + "traits": { + "smithy.api#documentation": "Version of the package.
" + } + }, + "CommitMessage": { + "target": "com.amazonaws.elasticsearchservice#CommitMessage", + "traits": { + "smithy.api#documentation": "A message associated with the version.
" + } + }, + "CreatedAt": { + "target": "com.amazonaws.elasticsearchservice#CreatedAt", + "traits": { + "smithy.api#documentation": "Timestamp which tells creation time of the package version.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Details of a package version.
" + } + }, + "com.amazonaws.elasticsearchservice#PackageVersionHistoryList": { + "type": "list", + "member": { + "target": "com.amazonaws.elasticsearchservice#PackageVersionHistory" + } + }, "com.amazonaws.elasticsearchservice#Password": { "type": "string", "traits": { @@ -5563,6 +5711,90 @@ "smithy.api#documentation": "The result of an UpdateElasticsearchDomain
request. Contains the status of the Elasticsearch domain being updated.
Updates a package for use with Amazon ES domains.
", + "smithy.api#http": { + "method": "POST", + "uri": "/2015-01-01/packages/update", + "code": 200 + } + } + }, + "com.amazonaws.elasticsearchservice#UpdatePackageRequest": { + "type": "structure", + "members": { + "PackageID": { + "target": "com.amazonaws.elasticsearchservice#PackageID", + "traits": { + "smithy.api#documentation": "Unique identifier for the package.
", + "smithy.api#required": {} + } + }, + "PackageSource": { + "target": "com.amazonaws.elasticsearchservice#PackageSource", + "traits": { + "smithy.api#required": {} + } + }, + "PackageDescription": { + "target": "com.amazonaws.elasticsearchservice#PackageDescription", + "traits": { + "smithy.api#documentation": "New description of the package.
" + } + }, + "CommitMessage": { + "target": "com.amazonaws.elasticsearchservice#CommitMessage", + "traits": { + "smithy.api#documentation": "An info message for the new version which will be shown as part of GetPackageVersionHistoryResponse
.
\n Container for request parameters to\n \n UpdatePackage\n
\n operation.\n
Information about the package PackageDetails
.
\n Container for response returned by\n \n UpdatePackage\n
\n operation.\n
The scale that hyperparameter tuning uses to search the hyperparameter range.\n Valid values:
\nAmazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
\nHyperparameter tuning searches the values in the hyperparameter range by using a\n linear scale.
\nHyperparameter tuning searches the values in the hyperparameter range by using a\n logarithmic scale.
\nLogarithmic scaling works only for ranges that have values greater than 0.
\nhyperparameter tuning searches the values in the hyperparameter range by using a\n reverse logarithmic scale.
\nReverse logarithmic scaling works only for ranges that are entirely within the\n range 0 <= x < 1.0.
\nFor information about choosing a hyperparameter scale, see\n Hyperparameter Scaling.\n One of the following values:
" - } - }, "Name": { "target": "com.amazonaws.forecast#Name", "traits": { @@ -231,19 +225,25 @@ "smithy.api#required": {} } }, - "MinValue": { + "MaxValue": { "target": "com.amazonaws.forecast#Double", "traits": { - "smithy.api#documentation": "The minimum tunable value of the hyperparameter.
", + "smithy.api#documentation": "The maximum tunable value of the hyperparameter.
", "smithy.api#required": {} } }, - "MaxValue": { + "MinValue": { "target": "com.amazonaws.forecast#Double", "traits": { - "smithy.api#documentation": "The maximum tunable value of the hyperparameter.
", + "smithy.api#documentation": "The minimum tunable value of the hyperparameter.
", "smithy.api#required": {} } + }, + "ScalingType": { + "target": "com.amazonaws.forecast#ScalingType", + "traits": { + "smithy.api#documentation": "The scale that hyperparameter tuning uses to search the hyperparameter range.\n Valid values:
\nAmazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
\nHyperparameter tuning searches the values in the hyperparameter range by using a\n linear scale.
\nHyperparameter tuning searches the values in the hyperparameter range by using a\n logarithmic scale.
\nLogarithmic scaling works only for ranges that have values greater than 0.
\nhyperparameter tuning searches the values in the hyperparameter range by using a\n reverse logarithmic scale.
\nReverse logarithmic scaling works only for ranges that are entirely within the\n range 0 <= x < 1.0.
\nFor information about choosing a hyperparameter scale, see\n Hyperparameter Scaling.\n One of the following values:
" + } } }, "traits": { @@ -311,18 +311,12 @@ } ], "traits": { - "smithy.api#documentation": "Creates a dataset group, which holds a collection of related datasets. You can add\n datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.
\nAfter creating a dataset group and adding datasets, you use the dataset group when you\n create a predictor. For more information, see howitworks-datasets-groups.
\nTo get a list of all your datasets groups, use the ListDatasetGroups\n operation.
\nThe Status
of a dataset group must be ACTIVE
before you can\n create use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.
Creates a dataset group, which holds a collection of related datasets. You can add\n datasets to the dataset group when you create the dataset group, or later by using the UpdateDatasetGroup operation.
\nAfter creating a dataset group and adding datasets, you use the dataset group when you\n create a predictor. For more information, see howitworks-datasets-groups.
\nTo get a list of all your datasets groups, use the ListDatasetGroups\n operation.
\nThe Status
of a dataset group must be ACTIVE
before you can\n use the dataset group to create a predictor. To get the status, use the DescribeDatasetGroup operation.
An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the\n dataset group.
" - } - }, "DatasetGroupName": { "target": "com.amazonaws.forecast#Name", "traits": { @@ -330,18 +324,24 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.forecast#Tags", - "traits": { - "smithy.api#documentation": "The optional metadata that you apply to the dataset group to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The domain associated with the dataset group. When you add a dataset to a dataset group,\n this value and the value specified for the Domain
parameter of the CreateDataset operation must match.
The Domain
and DatasetType
that you choose determine the fields\n that must be present in training data that you import to a dataset. For example, if you choose\n the RETAIL
domain and TARGET_TIME_SERIES
as the\n DatasetType
, Amazon Forecast requires that item_id
,\n timestamp
, and demand
fields are present in your data. For more\n information, see howitworks-datasets-groups.
An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the\n dataset group.
" + } + }, + "Tags": { + "target": "com.amazonaws.forecast#Tags", + "traits": { + "smithy.api#documentation": "The optional metadata that you apply to the dataset group to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The format of timestamps in the dataset. The format that you specify depends on the\n DataFrequency
specified when the dataset was created. The following formats are\n supported
\"yyyy-MM-dd\"
\nFor the following data frequencies: Y, M, W, and D
\n\"yyyy-MM-dd HH:mm:ss\"
\nFor the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y,\n M, W, and D
\nIf the format isn't specified, Amazon Forecast expects the format to be \"yyyy-MM-dd\n HH:mm:ss\".
" - } - }, "DatasetArn": { "target": "com.amazonaws.forecast#Arn", "traits": { @@ -408,18 +402,24 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.forecast#Tags", - "traits": { - "smithy.api#documentation": "The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast\n can assume to access the data. The training data must be stored in an Amazon S3 bucket.
\nIf encryption is used, DataSource
must include an AWS Key Management Service (KMS) key and the\n IAM role must allow Amazon Forecast permission to access the key. The KMS key and IAM role must\n match those specified in the EncryptionConfig
parameter of the CreateDataset operation.
The format of timestamps in the dataset. The format that you specify depends on the\n DataFrequency
specified when the dataset was created. The following formats are\n supported
\"yyyy-MM-dd\"
\nFor the following data frequencies: Y, M, W, and D
\n\"yyyy-MM-dd HH:mm:ss\"
\nFor the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y,\n M, W, and D
\nIf the format isn't specified, Amazon Forecast expects the format to be \"yyyy-MM-dd\n HH:mm:ss\".
" + } + }, + "Tags": { + "target": "com.amazonaws.forecast#Tags", + "traits": { + "smithy.api#documentation": "The optional metadata that you apply to the dataset import job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The domain associated with the dataset. When you add a dataset to a dataset group, this\n value and the value specified for the Domain
parameter of the CreateDatasetGroup operation must match.
The Domain
and DatasetType
that you choose determine the fields\n that must be present in the training data that you import to the dataset. For example, if you\n choose the RETAIL
domain and TARGET_TIME_SERIES
as the\n DatasetType
, Amazon Forecast requires item_id
, timestamp
,\n and demand
fields to be present in your data. For more information, see howitworks-datasets-groups.
A name for the dataset.
", "smithy.api#required": {} } }, - "EncryptionConfig": { - "target": "com.amazonaws.forecast#EncryptionConfig", - "traits": { - "smithy.api#documentation": "An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access\n the key.
" - } - }, - "Tags": { - "target": "com.amazonaws.forecast#Tags", + "Domain": { + "target": "com.amazonaws.forecast#Domain", "traits": { - "smithy.api#documentation": "The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The domain associated with the dataset. When you add a dataset to a dataset group, this\n value and the value specified for the Domain
parameter of the CreateDatasetGroup operation must match.
The Domain
and DatasetType
that you choose determine the fields\n that must be present in the training data that you import to the dataset. For example, if you\n choose the RETAIL
domain and TARGET_TIME_SERIES
as the\n DatasetType
, Amazon Forecast requires item_id
, timestamp
,\n and demand
fields to be present in your data. For more information, see howitworks-datasets-groups.
The frequency of data collection. This parameter is required for RELATED_TIME_SERIES\n datasets.
\nValid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes),\n 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example,\n \"D\" indicates every day and \"15min\" indicates every 15 minutes.
" + } + }, "Schema": { "target": "com.amazonaws.forecast#Schema", "traits": { @@ -470,17 +471,16 @@ "smithy.api#required": {} } }, - "DataFrequency": { - "target": "com.amazonaws.forecast#Frequency", + "EncryptionConfig": { + "target": "com.amazonaws.forecast#EncryptionConfig", "traits": { - "smithy.api#documentation": "The frequency of data collection. This parameter is required for RELATED_TIME_SERIES\n datasets.
\nValid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes),\n 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example,\n \"D\" indicates every day and \"15min\" indicates every 15 minutes.
" + "smithy.api#documentation": "An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access\n the key.
" } }, - "DatasetName": { - "target": "com.amazonaws.forecast#Name", + "Tags": { + "target": "com.amazonaws.forecast#Tags", "traits": { - "smithy.api#documentation": "A name for the dataset.
", - "smithy.api#required": {} + "smithy.api#documentation": "The optional metadata that you apply to the dataset to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The Amazon Resource Name (ARN) of the forecast that you want to export.
", + "smithy.api#required": {} + } + }, "Destination": { "target": "com.amazonaws.forecast#DataDestination", "traits": { @@ -576,13 +583,6 @@ "traits": { "smithy.api#documentation": "The optional metadata that you apply to the forecast export job to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The Amazon Resource Name (ARN) of the forecast that you want to export.
", - "smithy.api#required": {} - } } } }, @@ -607,12 +607,6 @@ "smithy.api#required": {} } }, - "ForecastTypes": { - "target": "com.amazonaws.forecast#ForecastTypes", - "traits": { - "smithy.api#documentation": "The quantiles at which probabilistic forecasts are generated. You\n can currently specify up to 5 quantiles per forecast. Accepted values include\n 0.01 to 0.99
(increments of .01 only) and mean
. The mean forecast\n is different from the median (0.50) when the distribution is not symmetric (for example, Beta\n and Negative Binomial). The default value is [\"0.1\", \"0.5\", \"0.9\"]
.
The quantiles at which probabilistic forecasts are generated. You\n can currently specify up to 5 quantiles per forecast. Accepted values include\n 0.01 to 0.99
(increments of .01 only) and mean
. The mean forecast\n is different from the median (0.50) when the distribution is not symmetric (for example, Beta\n and Negative Binomial). The default value is [\"0.1\", \"0.5\", \"0.9\"]
.
Creates an Amazon Forecast predictor.
\nIn the request, you provide a dataset group and either specify an algorithm or let\n Amazon Forecast choose the algorithm for you using AutoML. If you specify an algorithm, you also can\n override algorithm-specific hyperparameters.
\nAmazon Forecast uses the chosen algorithm to train a model using the latest version of the\n datasets in the specified dataset group. The result is called a predictor. You then generate a\n forecast using the CreateForecast operation.
\nAfter training a model, the CreatePredictor
operation also evaluates it. To\n see the evaluation metrics, use the GetAccuracyMetrics operation. Always\n review the evaluation metrics before deciding to use the predictor to generate a\n forecast.
Optionally, you can specify a featurization configuration to fill and aggregate the data\n fields in the TARGET_TIME_SERIES
dataset to improve model training. For more\n information, see FeaturizationConfig.
For RELATED_TIME_SERIES datasets, CreatePredictor
verifies that the\n DataFrequency
specified when the dataset was created matches the\n ForecastFrequency
. TARGET_TIME_SERIES datasets don't have this restriction.\n Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.
\n AutoML\n
\nIf you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the\n objective function
, set PerformAutoML
to true
. The\n objective function
is defined as the mean of the weighted p10, p50, and p90\n quantile losses. For more information, see EvaluationResult.
When AutoML is enabled, the following properties are disallowed:
\n\n AlgorithmArn
\n
\n HPOConfig
\n
\n PerformHPO
\n
\n TrainingParameters
\n
To get a list of all of your predictors, use the ListPredictors\n operation.
\nBefore you can use the predictor to create a forecast, the Status
of the\n predictor must be ACTIVE
, signifying that training has completed. To get the\n status, use the DescribePredictor operation.
Creates an Amazon Forecast predictor.
\nIn the request, provide a dataset group and either specify an algorithm or let\n Amazon Forecast choose an algorithm for you using AutoML. If you specify an algorithm, you also can\n override algorithm-specific hyperparameters.
\nAmazon Forecast uses the algorithm to train a predictor using the latest version of the\n datasets in the specified dataset group. You can then generate a\n forecast using the CreateForecast operation.
\n\n To see the evaluation metrics, use the GetAccuracyMetrics operation.\n
\nYou can specify a featurization configuration to fill and aggregate the data\n fields in the TARGET_TIME_SERIES
dataset to improve model training. For more\n information, see FeaturizationConfig.
For RELATED_TIME_SERIES datasets, CreatePredictor
verifies that the\n DataFrequency
specified when the dataset was created matches the\n ForecastFrequency
. TARGET_TIME_SERIES datasets don't have this restriction.\n Amazon Forecast also verifies the delimiter and timestamp format. For more information, see howitworks-datasets-groups.
By default, predictors are trained and evaluated at the 0.1 (P10), 0.5 (P50), and 0.9\n (P90) quantiles. You can choose custom forecast types to train and evaluate your predictor\n by setting the ForecastTypes
.\n
\n AutoML\n
\nIf you want Amazon Forecast to evaluate each algorithm and choose the one that minimizes the\n objective function
, set PerformAutoML
to true
. The\n objective function
is defined as the mean of the weighted losses over the\n forecast types. By default, these are the p10, p50, and p90\n quantile losses. For more information, see EvaluationResult.
When AutoML is enabled, the following properties are disallowed:
\n\n AlgorithmArn
\n
\n HPOConfig
\n
\n PerformHPO
\n
\n TrainingParameters
\n
To get a list of all of your predictors, use the ListPredictors\n operation.
\nBefore you can use the predictor to create a forecast, the Status
of the\n predictor must be ACTIVE
, signifying that training has completed. To get the\n status, use the DescribePredictor operation.
Describes the dataset group that contains the data to use to train the predictor.
", + "smithy.api#documentation": "A name for the predictor.
", "smithy.api#required": {} } }, - "EncryptionConfig": { - "target": "com.amazonaws.forecast#EncryptionConfig", + "AlgorithmArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access\n the key.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the algorithm to use for model training. Required if\n PerformAutoML
is not set to true
.
\n Supported algorithms:\n
\n\n arn:aws:forecast:::algorithm/ARIMA
\n
\n arn:aws:forecast:::algorithm/CNN-QR
\n
\n arn:aws:forecast:::algorithm/Deep_AR_Plus
\n
\n arn:aws:forecast:::algorithm/ETS
\n
\n arn:aws:forecast:::algorithm/NPTS
\n
\n arn:aws:forecast:::algorithm/Prophet
\n
Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast\n evaluates a predictor by splitting a dataset into training data and testing data. The\n evaluation parameters define how to perform the split and the number of iterations.
" + "smithy.api#documentation": "Specifies the forecast types used to train a predictor. You can specify up to five forecast types.\n Forecast types can be quantiles from 0.01 to 0.99, by increments of 0.01 or higher. You can also specify \n the mean forecast with mean
.\n
The default value is [\"0.10\", \"0.50\", \"0.9\"]
.
The Amazon Resource Name (ARN) of the algorithm to use for model training. Required if\n PerformAutoML
is not set to true
.
\n Supported algorithms:\n
\n\n arn:aws:forecast:::algorithm/ARIMA
\n
\n arn:aws:forecast:::algorithm/Deep_AR_Plus
\n
Supports hyperparameter optimization (HPO)
\n\n arn:aws:forecast:::algorithm/ETS
\n
\n arn:aws:forecast:::algorithm/NPTS
\n
\n arn:aws:forecast:::algorithm/Prophet
\n
Whether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates the algorithms it\n provides and chooses the best algorithm and configuration for your training dataset.
\nThe default value is false
. In this case, you are required to specify an\n algorithm.
Set PerformAutoML
to true
to have Amazon Forecast perform AutoML. This\n is a good option if you aren't sure which algorithm is suitable for your training data. In\n this case, PerformHPO
must be false.
Provides hyperparameter override values for the algorithm. If you don't provide this\n parameter, Amazon Forecast uses default values. The individual algorithms specify which\n hyperparameters support hyperparameter optimization (HPO). For more information, see aws-forecast-choosing-recipes.
\nIf you included the HPOConfig
object, you must set PerformHPO
to\n true.
Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter\n values for your training data. The process of performing HPO is known as running a\n hyperparameter tuning job.
\nThe default value is false
. In this case, Amazon Forecast uses default\n hyperparameter values from the chosen algorithm.
To override the default values, set PerformHPO
to true
and,\n optionally, supply the HyperParameterTuningJobConfig object. The tuning job\n specifies a metric to optimize, which hyperparameters participate in tuning, and the valid\n range for each tunable hyperparameter. In this case, you are required to specify an algorithm\n and PerformAutoML
must be false.
The following algorithms support HPO:
\nDeepAR+
\nCNN-QR
\nWhether to perform AutoML. When Amazon Forecast performs AutoML, it evaluates the algorithms it\n provides and chooses the best algorithm and configuration for your training dataset.
\nThe default value is false
. In this case, you are required to specify an\n algorithm.
Set PerformAutoML
to true
to have Amazon Forecast perform AutoML. This\n is a good option if you aren't sure which algorithm is suitable for your training data. In\n this case, PerformHPO
must be false.
The hyperparameters to override for model training. The hyperparameters that you can\n override are listed in the individual algorithms. For the list of supported algorithms, see\n aws-forecast-choosing-recipes.
" } }, - "PerformHPO": { - "target": "com.amazonaws.forecast#Boolean", + "EvaluationParameters": { + "target": "com.amazonaws.forecast#EvaluationParameters", "traits": { - "smithy.api#documentation": "Whether to perform hyperparameter optimization (HPO). HPO finds optimal hyperparameter\n values for your training data. The process of performing HPO is known as running a\n hyperparameter tuning job.
\nThe default value is false
. In this case, Amazon Forecast uses default\n hyperparameter values from the chosen algorithm.
To override the default values, set PerformHPO
to true
and,\n optionally, supply the HyperParameterTuningJobConfig object. The tuning job\n specifies a metric to optimize, which hyperparameters participate in tuning, and the valid\n range for each tunable hyperparameter. In this case, you are required to specify an algorithm\n and PerformAutoML
must be false.
The following algorithm supports HPO:
\nDeepAR+
\nUsed to override the default evaluation parameters of the specified algorithm. Amazon Forecast\n evaluates a predictor by splitting a dataset into training data and testing data. The\n evaluation parameters define how to perform the split and the number of iterations.
" } }, - "PredictorName": { - "target": "com.amazonaws.forecast#Name", + "HPOConfig": { + "target": "com.amazonaws.forecast#HyperParameterTuningJobConfig", "traits": { - "smithy.api#documentation": "A name for the predictor.
", - "smithy.api#required": {} + "smithy.api#documentation": "Provides hyperparameter override values for the algorithm. If you don't provide this\n parameter, Amazon Forecast uses default values. The individual algorithms specify which\n hyperparameters support hyperparameter optimization (HPO). For more information, see aws-forecast-choosing-recipes.
\nIf you included the HPOConfig
object, you must set PerformHPO
to\n true.
The optional metadata that you apply to the predictor to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
Describes the dataset group that contains the data to use to train the predictor.
", + "smithy.api#required": {} } }, "FeaturizationConfig": { @@ -741,10 +741,16 @@ "smithy.api#required": {} } }, - "TrainingParameters": { - "target": "com.amazonaws.forecast#TrainingParameters", + "EncryptionConfig": { + "target": "com.amazonaws.forecast#EncryptionConfig", "traits": { - "smithy.api#documentation": "The hyperparameters to override for model training. The hyperparameters that you can\n override are listed in the individual algorithms. For the list of supported algorithms, see\n aws-forecast-choosing-recipes.
" + "smithy.api#documentation": "An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access\n the key.
" + } + }, + "Tags": { + "target": "com.amazonaws.forecast#Tags", + "traits": { + "smithy.api#documentation": "The optional metadata that you apply to the predictor to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The status of the dataset import job. The status is reflected in the status of the\n dataset. For example, when the import job status is CREATE_IN_PROGRESS
, the\n status of the dataset is UPDATE_IN_PROGRESS
. States include:
\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The Amazon Resource Name (ARN) of the dataset import job.
" } }, - "LastModificationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "DatasetImportJobName": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "The last time that the dataset was modified. The time depends on the status of the job, as\n follows:
\n\n CREATE_PENDING
- The same time as CreationTime
.
\n CREATE_IN_PROGRESS
- The current timestamp.
\n ACTIVE
or CREATE_FAILED
- When the job finished or\n failed.
The name of the dataset import job.
" } }, "DataSource": { @@ -849,6 +855,12 @@ "smithy.api#documentation": "The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast\n can assume to access the data. The training data must be stored in an Amazon S3 bucket.
\nIf encryption is used, DataSource
includes an AWS Key Management Service (KMS) key.
The status of the dataset import job. The status is reflected in the status of the\n dataset. For example, when the import job status is CREATE_IN_PROGRESS
, the\n status of the dataset is UPDATE_IN_PROGRESS
. States include:
\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
When the dataset import job was created.
" } }, - "DatasetImportJobName": { - "target": "com.amazonaws.forecast#Name", - "traits": { - "smithy.api#documentation": "The name of the dataset import job.
" - } - }, - "DatasetImportJobArn": { - "target": "com.amazonaws.forecast#Arn", + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset import job.
" + "smithy.api#documentation": "The last time that the dataset was modified. The time depends on the status of the job, as\n follows:
\n\n CREATE_PENDING
- The same time as CreationTime
.
\n CREATE_IN_PROGRESS
- The current timestamp.
\n ACTIVE
or CREATE_FAILED
- When the job finished or\n failed.
The domain associated with the dataset.
" } }, - "LastModificationTime": { + "CreationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "When you create a dataset, LastModificationTime
is the same as\n CreationTime
. While data is being imported to the dataset,\n LastModificationTime
is the current time of the ListDatasets
call.\n After a CreateDatasetImportJob operation has finished,\n LastModificationTime
is when the import job completed or failed.
When the dataset was created.
" } }, - "CreationTime": { + "LastModificationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "When the dataset was created.
" + "smithy.api#documentation": "When you create a dataset, LastModificationTime
is the same as\n CreationTime
. While data is being imported to the dataset,\n LastModificationTime
is the current time of the ListDatasets
call.\n After a CreateDatasetImportJob operation has finished,\n LastModificationTime
is when the import job completed or failed.
When the dataset group was created.
" + "smithy.api#documentation": "The name of the dataset group.
" } }, "DatasetGroupArn": { @@ -1220,34 +1226,34 @@ "smithy.api#documentation": "The ARN of the dataset group.
" } }, - "Status": { - "target": "com.amazonaws.forecast#Status", - "traits": { - "smithy.api#documentation": "The status of the dataset group. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
\n UPDATE_PENDING
, UPDATE_IN_PROGRESS
,\n UPDATE_FAILED
\n
The UPDATE
states apply when you call the UpdateDatasetGroup operation.
The Status
of the dataset group must be ACTIVE
before you can\n use the dataset group to create a predictor.
The name of the dataset group.
" - } - }, "DatasetArns": { "target": "com.amazonaws.forecast#ArnList", "traits": { "smithy.api#documentation": "An array of Amazon Resource Names (ARNs) of the datasets contained in the dataset\n group.
" } }, - "LastModificationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "Domain": { + "target": "com.amazonaws.forecast#Domain", "traits": { - "smithy.api#documentation": "When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated,\n LastModificationTime
is the current time of the\n DescribeDatasetGroup
call.
The domain associated with the dataset group.
" } }, - "Domain": { - "target": "com.amazonaws.forecast#Domain", + "Status": { + "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "The domain associated with the dataset group.
" + "smithy.api#documentation": "The status of the dataset group. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
\n UPDATE_PENDING
, UPDATE_IN_PROGRESS
,\n UPDATE_FAILED
\n
The UPDATE
states apply when you call the UpdateDatasetGroup operation.
The Status
of the dataset group must be ACTIVE
before you can\n use the dataset group to create a predictor.
When the dataset group was created.
" + } + }, + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "When the dataset group was created or last updated from a call to the UpdateDatasetGroup operation. While the dataset group is being updated,\n LastModificationTime
is the current time of the\n DescribeDatasetGroup
call.
When the dataset import job was created.
" + "smithy.api#documentation": "The name of the dataset import job.
" } }, - "DataSource": { - "target": "com.amazonaws.forecast#DataSource", + "DatasetImportJobArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast\n can assume to access the data.
\nIf encryption is used, DataSource
includes an AWS Key Management Service (KMS) key.
The ARN of the dataset import job.
" } }, - "DatasetImportJobName": { - "target": "com.amazonaws.forecast#Name", + "DatasetArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "The name of the dataset import job.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset that the training data was imported\n to.
" } }, "TimestampFormat": { @@ -1312,22 +1318,16 @@ "smithy.api#documentation": "The format of timestamps in the dataset. The format that you specify depends on the\n DataFrequency
specified when the dataset was created. The following formats are\n supported
\"yyyy-MM-dd\"
\nFor the following data frequencies: Y, M, W, and D
\n\"yyyy-MM-dd HH:mm:ss\"
\nFor the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y,\n M, W, and D
\nThe status of the dataset import job. The status is reflected in the status of the\n dataset. For example, when the import job status is CREATE_IN_PROGRESS
, the\n status of the dataset is UPDATE_IN_PROGRESS
. States include:
\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The ARN of the dataset import job.
" + "smithy.api#documentation": "The location of the training data to import and an AWS Identity and Access Management (IAM) role that Amazon Forecast\n can assume to access the data.
\nIf encryption is used, DataSource
includes an AWS Key Management Service (KMS) key.
The last time that the dataset was modified. The time depends on the status of the job, as\n follows:
\n\n CREATE_PENDING
- The same time as CreationTime
.
\n CREATE_IN_PROGRESS
- The current timestamp.
\n ACTIVE
or CREATE_FAILED
- When the job finished or\n failed.
Statistical information about each field in the input data.
" } }, "DataSize": { @@ -1336,10 +1336,10 @@ "smithy.api#documentation": "The size of the dataset in gigabytes (GB) after the import job has finished.
" } }, - "DatasetArn": { - "target": "com.amazonaws.forecast#Arn", + "Status": { + "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset that the training data was imported\n to.
" + "smithy.api#documentation": "The status of the dataset import job. The status is reflected in the status of the\n dataset. For example, when the import job status is CREATE_IN_PROGRESS
, the\n status of the dataset is UPDATE_IN_PROGRESS
. States include:
\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
If an error occurred, an informational message about the error.
" } }, - "FieldStatistics": { - "target": "com.amazonaws.forecast#FieldStatistics", + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "Statistical information about each field in the input data.
" + "smithy.api#documentation": "When the dataset import job was created.
" + } + }, + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that the dataset was modified. The time depends on the status of the job, as\n follows:
\n\n CREATE_PENDING
- The same time as CreationTime
.
\n CREATE_IN_PROGRESS
- The current timestamp.
\n ACTIVE
or CREATE_FAILED
- When the job finished or\n failed.
The frequency of data collection.
\nValid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes),\n 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example,\n \"M\" indicates every month and \"30min\" indicates every 30 minutes.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" + } + }, + "DatasetName": { + "target": "com.amazonaws.forecast#Name", + "traits": { + "smithy.api#documentation": "The name of the dataset.
" } }, "Domain": { @@ -1389,28 +1401,22 @@ "smithy.api#documentation": "The dataset type.
" } }, - "DatasetArn": { - "target": "com.amazonaws.forecast#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" - } - }, - "EncryptionConfig": { - "target": "com.amazonaws.forecast#EncryptionConfig", + "DataFrequency": { + "target": "com.amazonaws.forecast#Frequency", "traits": { - "smithy.api#documentation": "The AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access\n the key.
" + "smithy.api#documentation": "The frequency of data collection.
\nValid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes),\n 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example,\n \"M\" indicates every month and \"30min\" indicates every 30 minutes.
" } }, - "CreationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "Schema": { + "target": "com.amazonaws.forecast#Schema", "traits": { - "smithy.api#documentation": "When the dataset was created.
" + "smithy.api#documentation": "An array of SchemaAttribute
objects that specify the dataset fields. Each\n SchemaAttribute
specifies the name and data type of a field.
When you create a dataset, LastModificationTime
is the same as\n CreationTime
. While data is being imported to the dataset,\n LastModificationTime
is the current time of the DescribeDataset
\n call. After a CreateDatasetImportJob operation has finished,\n LastModificationTime
is when the import job completed or failed.
The AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access\n the key.
" } }, "Status": { @@ -1419,16 +1425,16 @@ "smithy.api#documentation": "The status of the dataset. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
\n UPDATE_PENDING
, UPDATE_IN_PROGRESS
,\n UPDATE_FAILED
\n
The UPDATE
states apply while data is imported to the dataset from a call to\n the CreateDatasetImportJob operation and reflect the status of the dataset\n import job. For example, when the import job status is CREATE_IN_PROGRESS
, the\n status of the dataset is UPDATE_IN_PROGRESS
.
The Status
of the dataset must be ACTIVE
before you can import\n training data.
The name of the dataset.
" + "smithy.api#documentation": "When the dataset was created.
" } }, - "Schema": { - "target": "com.amazonaws.forecast#Schema", + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "An array of SchemaAttribute
objects that specify the dataset fields. Each\n SchemaAttribute
specifies the name and data type of a field.
When you create a dataset, LastModificationTime
is the same as\n CreationTime
. While data is being imported to the dataset,\n LastModificationTime
is the current time of the DescribeDataset
\n call. After a CreateDatasetImportJob operation has finished,\n LastModificationTime
is when the import job completed or failed.
If an error occurred, an informational message about the error.
" - } - }, - "ForecastArn": { + "ForecastExportJobArn": { "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the exported forecast.
" + "smithy.api#documentation": "The ARN of the forecast export job.
" } }, "ForecastExportJobName": { @@ -1508,10 +1508,10 @@ "smithy.api#documentation": "The name of the forecast export job.
" } }, - "ForecastExportJobArn": { + "ForecastArn": { "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "The ARN of the forecast export job.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the exported forecast.
" } }, "Destination": { @@ -1520,22 +1520,28 @@ "smithy.api#documentation": "The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
" } }, + "Message": { + "target": "com.amazonaws.forecast#Message", + "traits": { + "smithy.api#documentation": "If an error occurred, an informational message about the error.
" + } + }, "Status": { "target": "com.amazonaws.forecast#Status", "traits": { "smithy.api#documentation": "The status of the forecast export job. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The Status
of the forecast export job must be ACTIVE
before\n you can access the forecast in your S3 bucket.
When the last successful export job finished.
" + "smithy.api#documentation": "When the forecast export job was created.
" } }, - "CreationTime": { + "LastModificationTime": { "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "When the forecast export job was created.
" + "smithy.api#documentation": "When the last successful export job finished.
" } } } @@ -1555,10 +1561,10 @@ "com.amazonaws.forecast#DescribeForecastResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.forecast#String", + "ForecastArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "The status of the forecast. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The Status
of the forecast must be ACTIVE
before you can query\n or export the forecast.
The forecast ARN as specified in the request.
" } }, "ForecastName": { @@ -1573,10 +1579,10 @@ "smithy.api#documentation": "The quantiles at which probabilistic forecasts were generated.
" } }, - "Message": { - "target": "com.amazonaws.forecast#ErrorMessage", + "PredictorArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "If an error occurred, an informational message about the error.
" + "smithy.api#documentation": "The ARN of the predictor used to generate the forecast.
" } }, "DatasetGroupArn": { @@ -1585,22 +1591,22 @@ "smithy.api#documentation": "The ARN of the dataset group that provided the data used to train the predictor.
" } }, - "CreationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "Status": { + "target": "com.amazonaws.forecast#String", "traits": { - "smithy.api#documentation": "When the forecast creation task was created.
" + "smithy.api#documentation": "The status of the forecast. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The Status
of the forecast must be ACTIVE
before you can query\n or export the forecast.
The ARN of the predictor used to generate the forecast.
" + "smithy.api#documentation": "If an error occurred, an informational message about the error.
" } }, - "ForecastArn": { - "target": "com.amazonaws.forecast#Arn", + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "The forecast ARN as specified in the request.
" + "smithy.api#documentation": "When the forecast creation task was created.
" } }, "LastModificationTime": { @@ -1647,58 +1653,58 @@ "com.amazonaws.forecast#DescribePredictorResponse": { "type": "structure", "members": { - "LastModificationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "PredictorArn": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "Initially, the same as CreationTime
(when the status is\n CREATE_PENDING
). This value is updated when training starts (when the status\n changes to CREATE_IN_PROGRESS
), and when training has completed (when the status\n changes to ACTIVE
) or fails (when the status changes to\n CREATE_FAILED
).
The ARN of the predictor.
" } }, - "Status": { - "target": "com.amazonaws.forecast#Status", + "PredictorName": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "The status of the predictor. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
\n UPDATE_PENDING
, UPDATE_IN_PROGRESS
,\n UPDATE_FAILED
\n
The Status
of the predictor must be ACTIVE
before you can use\n the predictor to create a forecast.
The name of the predictor.
" } }, - "PerformAutoML": { - "target": "com.amazonaws.forecast#Boolean", + "AlgorithmArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "Whether the predictor is set to perform AutoML.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the algorithm used for model training.
" } }, - "EncryptionConfig": { - "target": "com.amazonaws.forecast#EncryptionConfig", + "ForecastHorizon": { + "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access\n the key.
" + "smithy.api#documentation": "The number of time-steps of the forecast. The forecast horizon is also called the\n prediction length.
" } }, - "PredictorName": { - "target": "com.amazonaws.forecast#Name", + "ForecastTypes": { + "target": "com.amazonaws.forecast#ForecastTypes", "traits": { - "smithy.api#documentation": "The name of the predictor.
" + "smithy.api#documentation": "The forecast types used during predictor training. Default value is [\"0.1\",\"0.5\",\"0.9\"]
\n
Describes the dataset group that contains the data to use to train the predictor.
" + "smithy.api#documentation": "Whether the predictor is set to perform AutoML.
" } }, - "PredictorExecutionDetails": { - "target": "com.amazonaws.forecast#PredictorExecutionDetails", + "PerformHPO": { + "target": "com.amazonaws.forecast#Boolean", "traits": { - "smithy.api#documentation": "Details on the the status and results of the backtests performed to evaluate the accuracy\n of the predictor. You specify the number of backtests to perform when you call the operation.
" + "smithy.api#documentation": "Whether the predictor is set to perform hyperparameter optimization (HPO).
" } }, - "CreationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "TrainingParameters": { + "target": "com.amazonaws.forecast#TrainingParameters", "traits": { - "smithy.api#documentation": "When the model training task was created.
" + "smithy.api#documentation": "The default training parameters or overrides selected during model training. When running\n AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen\n hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.
" } }, - "DatasetImportJobArns": { - "target": "com.amazonaws.forecast#ArnList", + "EvaluationParameters": { + "target": "com.amazonaws.forecast#EvaluationParameters", "traits": { - "smithy.api#documentation": "An array of the ARNs of the dataset import jobs used to import training data for the\n predictor.
" + "smithy.api#documentation": "Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast\n evaluates a predictor by splitting a dataset into training data and testing data. The\n evaluation parameters define how to perform the split and the number of iterations.
" } }, "HPOConfig": { @@ -1707,40 +1713,34 @@ "smithy.api#documentation": "The hyperparameter override values for the algorithm.
" } }, - "FeaturizationConfig": { - "target": "com.amazonaws.forecast#FeaturizationConfig", - "traits": { - "smithy.api#documentation": "The featurization configuration.
" - } - }, - "PredictorArn": { - "target": "com.amazonaws.forecast#Name", + "InputDataConfig": { + "target": "com.amazonaws.forecast#InputDataConfig", "traits": { - "smithy.api#documentation": "The ARN of the predictor.
" + "smithy.api#documentation": "Describes the dataset group that contains the data to use to train the predictor.
" } }, - "TrainingParameters": { - "target": "com.amazonaws.forecast#TrainingParameters", + "FeaturizationConfig": { + "target": "com.amazonaws.forecast#FeaturizationConfig", "traits": { - "smithy.api#documentation": "The default training parameters or overrides selected during model training. If using the\n AutoML algorithm or if HPO is turned on while using the DeepAR+ algorithms, the optimized\n values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.
" + "smithy.api#documentation": "The featurization configuration.
" } }, - "EvaluationParameters": { - "target": "com.amazonaws.forecast#EvaluationParameters", + "EncryptionConfig": { + "target": "com.amazonaws.forecast#EncryptionConfig", "traits": { - "smithy.api#documentation": "Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast\n evaluates a predictor by splitting a dataset into training data and testing data. The\n evaluation parameters define how to perform the split and the number of iterations.
" + "smithy.api#documentation": "An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access\n the key.
" } }, - "PerformHPO": { - "target": "com.amazonaws.forecast#Boolean", + "PredictorExecutionDetails": { + "target": "com.amazonaws.forecast#PredictorExecutionDetails", "traits": { - "smithy.api#documentation": "Whether the predictor is set to perform hyperparameter optimization (HPO).
" + "smithy.api#documentation": "Details on the the status and results of the backtests performed to evaluate the accuracy\n of the predictor. You specify the number of backtests to perform when you call the operation.
" } }, - "AlgorithmArn": { - "target": "com.amazonaws.forecast#Arn", + "DatasetImportJobArns": { + "target": "com.amazonaws.forecast#ArnList", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the algorithm used for model training.
" + "smithy.api#documentation": "An array of the ARNs of the dataset import jobs used to import training data for the\n predictor.
" } }, "AutoMLAlgorithmArns": { @@ -1749,10 +1749,10 @@ "smithy.api#documentation": "When PerformAutoML
is specified, the ARN of the chosen algorithm.
The number of time-steps of the forecast. The forecast horizon is also called the\n prediction length.
" + "smithy.api#documentation": "The status of the predictor. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
\n UPDATE_PENDING
, UPDATE_IN_PROGRESS
,\n UPDATE_FAILED
\n
The Status
of the predictor must be ACTIVE
before you can use\n the predictor to create a forecast.
If an error occurred, an informational message about the error.
" } + }, + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "When the model training task was created.
" + } + }, + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "Initially, the same as CreationTime
(when the status is\n CREATE_PENDING
). This value is updated when training starts (when the status\n changes to CREATE_IN_PROGRESS
), and when training has completed (when the status\n changes to ACTIVE
) or fails (when the status changes to\n CREATE_FAILED
).
The Amazon Resource Name (ARN) of the KMS key.
", + "smithy.api#documentation": "The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.
\nPassing a role across AWS accounts is not allowed. If you pass a role that isn't in your\n account, you get an InvalidInputException
error.
The ARN of the IAM role that Amazon Forecast can assume to access the AWS KMS key.
\nPassing a role across AWS accounts is not allowed. If you pass a role that isn't in your\n account, you get an InvalidInputException
error.
The Amazon Resource Name (ARN) of the KMS key.
", "smithy.api#required": {} } } @@ -1829,6 +1841,38 @@ "com.amazonaws.forecast#ErrorMessage": { "type": "string" }, + "com.amazonaws.forecast#ErrorMetric": { + "type": "structure", + "members": { + "ForecastType": { + "target": "com.amazonaws.forecast#ForecastType", + "traits": { + "smithy.api#documentation": "\n Forecast types can be quantiles from 0.01 to 0.99 (by increments of 0.01), and the mean.\n
" + } + }, + "WAPE": { + "target": "com.amazonaws.forecast#Double", + "traits": { + "smithy.api#documentation": "\n The weighted absolute percentage error (WAPE).\n
" + } + }, + "RMSE": { + "target": "com.amazonaws.forecast#Double", + "traits": { + "smithy.api#documentation": "\n The root-mean-square error (RMSE).\n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Provides detailed error metrics to evaluate the performance of a predictor. This object is\n part of the Metrics object.\n
" + } + }, + "com.amazonaws.forecast#ErrorMetrics": { + "type": "list", + "member": { + "target": "com.amazonaws.forecast#ErrorMetric" + } + }, "com.amazonaws.forecast#EvaluationParameters": { "type": "structure", "members": { @@ -1915,17 +1959,17 @@ "smithy.api#required": {} } }, - "Featurizations": { - "target": "com.amazonaws.forecast#Featurizations", - "traits": { - "smithy.api#documentation": "An array of featurization (transformation) information for the fields of a dataset.
" - } - }, "ForecastDimensions": { "target": "com.amazonaws.forecast#ForecastDimensions", "traits": { "smithy.api#documentation": "An array of dimension (field) names that specify how to group the generated forecast.
\nFor example, suppose that you are generating a forecast for item sales across all of\n your stores, and your dataset contains a store_id
field. If you want the sales\n forecast for each item by store, you would specify store_id
as the dimension.
All forecast dimensions specified in the TARGET_TIME_SERIES
dataset don't\n need to be specified in the CreatePredictor
request.\n All forecast dimensions specified in the RELATED_TIME_SERIES
dataset must\n be specified in the CreatePredictor
request.
An array of featurization (transformation) information for the fields of a dataset.
" + } } }, "traits": { @@ -1945,7 +1989,7 @@ "FeaturizationMethodParameters": { "target": "com.amazonaws.forecast#FeaturizationMethodParameters", "traits": { - "smithy.api#documentation": "The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. \n Related Time Series attributes do not accept aggregation parameters.
\nThe following list shows the parameters and their valid values for the \"filling\" featurization method for a Target Time Series dataset. Bold signifies the default\n value.
\n\n aggregation
: sum, avg
, first
, min
, max
\n
\n frontfill
: none\n
\n middlefill
: zero, nan
(not a number), value
, median
, mean
, min
, max
\n
\n backfill
: zero, nan
, value
, median
, mean
, min
, max
\n
The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):
\n\n middlefill
: zero
, value
, median
, mean
, min
, max
\n
\n backfill
: zero
, value
, median
, mean
, min
, max
\n
\n futurefill
: zero
, value
, median
, mean
, min
, max
\n
The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. \n Related Time Series attributes do not accept aggregation parameters.
\nThe following list shows the parameters and their valid values for the \"filling\" featurization method for a Target Time Series dataset. Bold signifies the default\n value.
\n\n aggregation
: sum, avg
, first
, min
, max
\n
\n frontfill
: none\n
\n middlefill
: zero, nan
(not a number), value
, median
, mean
, min
, max
\n
\n backfill
: zero, nan
, value
, median
, mean
, min
, max
\n
The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):
\n\n middlefill
: zero
, value
, median
, mean
, min
, max
\n
\n backfill
: zero
, value
, median
, mean
, min
, max
\n
\n futurefill
: zero
, value
, median
, mean
, min
, max
\n
To set a filling method to a specific value, set the fill parameter to value
\n and define the value in a corresponding _value
parameter. For example, to set\n backfilling to a value of 2, include the following: \"backfill\": \"value\"
and\n \"backfill_value\":\"2\"
.
The name of the parameter to filter on.
", + "smithy.api#required": {} + } + }, "Value": { "target": "com.amazonaws.forecast#Arn", "traits": { @@ -2028,13 +2079,6 @@ "smithy.api#documentation": "The condition to apply. To include the objects that match the statement, specify\n IS
. To exclude matching objects, specify IS_NOT
.
The name of the parameter to filter on.
", - "smithy.api#required": {} - } } }, "traits": { @@ -2077,46 +2121,46 @@ "com.amazonaws.forecast#ForecastExportJobSummary": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.forecast#ErrorMessage", + "ForecastExportJobArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "If an error occurred, an informational message about the error.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the forecast export job.
" } }, - "LastModificationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "ForecastExportJobName": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "When the last successful export job finished.
" + "smithy.api#documentation": "The name of the forecast export job.
" } }, - "Status": { - "target": "com.amazonaws.forecast#Status", + "Destination": { + "target": "com.amazonaws.forecast#DataDestination", "traits": { - "smithy.api#documentation": "The status of the forecast export job. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The Status
of the forecast export job must be ACTIVE
before\n you can access the forecast in your S3 bucket.
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
" } }, - "CreationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "Status": { + "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "When the forecast export job was created.
" + "smithy.api#documentation": "The status of the forecast export job. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The Status
of the forecast export job must be ACTIVE
before\n you can access the forecast in your S3 bucket.
The Amazon Resource Name (ARN) of the forecast export job.
" + "smithy.api#documentation": "If an error occurred, an informational message about the error.
" } }, - "Destination": { - "target": "com.amazonaws.forecast#DataDestination", + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
" + "smithy.api#documentation": "When the forecast export job was created.
" } }, - "ForecastExportJobName": { - "target": "com.amazonaws.forecast#Name", + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "The name of the forecast export job.
" + "smithy.api#documentation": "When the last successful export job finished.
" } } }, @@ -2133,10 +2177,10 @@ "com.amazonaws.forecast#ForecastSummary": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.forecast#Status", + "ForecastArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "The status of the forecast. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The Status
of the forecast must be ACTIVE
before you can query\n or export the forecast.
The ARN of the forecast.
" } }, "ForecastName": { @@ -2145,22 +2189,22 @@ "smithy.api#documentation": "The name of the forecast.
" } }, - "LastModificationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "PredictorArn": { + "target": "com.amazonaws.forecast#String", "traits": { - "smithy.api#documentation": "Initially, the same as CreationTime
(status is CREATE_PENDING
).\n Updated when inference (creating the forecast) starts (status changed to\n CREATE_IN_PROGRESS
), and when inference is complete (status changed to\n ACTIVE
) or fails (status changed to CREATE_FAILED
).
The ARN of the predictor used to generate the forecast.
" } }, - "CreationTime": { - "target": "com.amazonaws.forecast#Timestamp", + "DatasetGroupArn": { + "target": "com.amazonaws.forecast#String", "traits": { - "smithy.api#documentation": "When the forecast creation task was created.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset group that provided the data used to train\n the predictor.
" } }, - "ForecastArn": { - "target": "com.amazonaws.forecast#Arn", + "Status": { + "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "The ARN of the forecast.
" + "smithy.api#documentation": "The status of the forecast. States include:
\n\n ACTIVE
\n
\n CREATE_PENDING
, CREATE_IN_PROGRESS
,\n CREATE_FAILED
\n
\n DELETE_PENDING
, DELETE_IN_PROGRESS
,\n DELETE_FAILED
\n
The Status
of the forecast must be ACTIVE
before you can query\n or export the forecast.
If an error occurred, an informational message about the error.
" } }, - "DatasetGroupArn": { - "target": "com.amazonaws.forecast#String", + "CreationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset group that provided the data used to train\n the predictor.
" + "smithy.api#documentation": "When the forecast creation task was created.
" } }, - "PredictorArn": { - "target": "com.amazonaws.forecast#String", + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "The ARN of the predictor used to generate the forecast.
" + "smithy.api#documentation": "Initially, the same as CreationTime
(status is CREATE_PENDING
).\n Updated when inference (creating the forecast) starts (status changed to\n CREATE_IN_PROGRESS
), and when inference is complete (status changed to\n ACTIVE
) or fails (status changed to CREATE_FAILED
).
Provides metrics on the accuracy of the models that were trained by the\n CreatePredictor operation. Use metrics to see how well the model performed\n and to decide whether to use the predictor to generate a forecast. For more information, see\n metrics.
\nThis operation generates metrics for each backtest window that was evaluated. The number of backtest windows\n (NumberOfBacktestWindows
) is specified using the\n EvaluationParameters object, which is optionally\n included in the CreatePredictor
request. If\n NumberOfBacktestWindows
isn't specified, the number defaults to one.
The parameters of the filling
method determine which items contribute to\n the metrics. If you want all items to contribute, specify zero
.\n If you want only those items that have complete data in the range being evaluated to\n contribute, specify nan
.\n For more information, see FeaturizationMethod.
Before you can get accuracy metrics, the Status
of the predictor must be\n ACTIVE
, signifying that training has completed.\n To get the status, use the DescribePredictor operation.
Provides metrics on the accuracy of the models that were trained by the CreatePredictor operation. Use metrics to see how well the model performed and\n to decide whether to use the predictor to generate a forecast. For more information, see\n Predictor\n Metrics.
\nThis operation generates metrics for each backtest window that was evaluated. The number of backtest windows\n (NumberOfBacktestWindows
) is specified using the\n EvaluationParameters object, which is optionally\n included in the CreatePredictor
request. If\n NumberOfBacktestWindows
isn't specified, the number defaults to one.
The parameters of the filling
method determine which items contribute to\n the metrics. If you want all items to contribute, specify zero
.\n If you want only those items that have complete data in the range being evaluated to\n contribute, specify nan
.\n For more information, see FeaturizationMethod.
Before you can get accuracy metrics, the Status
of the predictor must be\n ACTIVE
, signifying that training has completed.\n To get the status, use the DescribePredictor operation.
The scale that hyperparameter tuning uses to search the hyperparameter range.\n Valid values:
\nAmazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
\nHyperparameter tuning searches the values in the hyperparameter range by using a\n linear scale.
\nHyperparameter tuning searches the values in the hyperparameter range by using a\n logarithmic scale.
\nLogarithmic scaling works only for ranges that have values greater than 0.
\nNot supported for IntegerParameterRange
.
Reverse logarithmic scaling works only for ranges that are entirely within the\n range 0 <= x < 1.0.
\nFor information about choosing a hyperparameter scale, see\n Hyperparameter Scaling.\n One of the following values:
" + "smithy.api#documentation": "The name of the hyperparameter to tune.
", + "smithy.api#required": {} } }, "MaxValue": { @@ -2320,19 +2365,18 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.forecast#Name", - "traits": { - "smithy.api#documentation": "The name of the hyperparameter to tune.
", - "smithy.api#required": {} - } - }, "MinValue": { "target": "com.amazonaws.forecast#Integer", "traits": { "smithy.api#documentation": "The minimum tunable value of the hyperparameter.
", "smithy.api#required": {} } + }, + "ScalingType": { + "target": "com.amazonaws.forecast#ScalingType", + "traits": { + "smithy.api#documentation": "The scale that hyperparameter tuning uses to search the hyperparameter range.\n Valid values:
\nAmazon Forecast hyperparameter tuning chooses the best scale for the hyperparameter.
\nHyperparameter tuning searches the values in the hyperparameter range by using a\n linear scale.
\nHyperparameter tuning searches the values in the hyperparameter range by using a\n logarithmic scale.
\nLogarithmic scaling works only for ranges that have values greater than 0.
\nNot supported for IntegerParameterRange
.
Reverse logarithmic scaling works only for ranges that are entirely within the\n range 0 <= x < 1.0.
\nFor information about choosing a hyperparameter scale, see\n Hyperparameter Scaling.\n One of the following values:
" + } } }, "traits": { @@ -2427,17 +2471,17 @@ "com.amazonaws.forecast#ListDatasetGroupsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.forecast#MaxResults", - "traits": { - "smithy.api#documentation": "The number of items to return in the response.
" - } - }, "NextToken": { "target": "com.amazonaws.forecast#NextToken", "traits": { "smithy.api#documentation": "If the result of the previous request was truncated, the response includes a\n NextToken
. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.
The number of items to return in the response.
" + } } } }, @@ -2488,10 +2532,10 @@ "com.amazonaws.forecast#ListDatasetImportJobsRequest": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.forecast#Filters", + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", "traits": { - "smithy.api#documentation": "An array of filters. For each filter, you provide a condition and a match statement. The\n condition is either IS
or IS_NOT
, which specifies whether to include\n or exclude the datasets that match the statement from the list, respectively. The match\n statement consists of a key and a value.
\n Filter properties\n
\n\n Condition
- The condition to apply. Valid values are IS
and\n IS_NOT
. To include the datasets that match the statement, specify\n IS
. To exclude matching datasets, specify IS_NOT
.
\n Key
- The name of the parameter to filter on. Valid values are\n DatasetArn
and Status
.
\n Value
- The value to match.
For example, to list all dataset import jobs whose status is ACTIVE, you specify the\n following filter:
\n\n \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" }\n ]
\n
If the result of the previous request was truncated, the response includes a\n NextToken
. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.
The number of items to return in the response.
" } }, - "NextToken": { - "target": "com.amazonaws.forecast#NextToken", + "Filters": { + "target": "com.amazonaws.forecast#Filters", "traits": { - "smithy.api#documentation": "If the result of the previous request was truncated, the response includes a\n NextToken
. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.
An array of filters. For each filter, you provide a condition and a match statement. The\n condition is either IS
or IS_NOT
, which specifies whether to include\n or exclude the datasets that match the statement from the list, respectively. The match\n statement consists of a key and a value.
\n Filter properties\n
\n\n Condition
- The condition to apply. Valid values are IS
and\n IS_NOT
. To include the datasets that match the statement, specify\n IS
. To exclude matching datasets, specify IS_NOT
.
\n Key
- The name of the parameter to filter on. Valid values are\n DatasetArn
and Status
.
\n Value
- The value to match.
For example, to list all dataset import jobs whose status is ACTIVE, you specify the\n following filter:
\n\n \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"Status\", \"Value\": \"ACTIVE\" }\n ]
\n
The number of items to return in the response.
" - } - }, "NextToken": { "target": "com.amazonaws.forecast#NextToken", "traits": { "smithy.api#documentation": "If the result of the previous request was truncated, the response includes a\n NextToken
. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.
The number of items to return in the response.
" + } } } }, "com.amazonaws.forecast#ListDatasetsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.forecast#NextToken", - "traits": { - "smithy.api#documentation": "If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of\n results, use the token in the next request.
" - } - }, "Datasets": { "target": "com.amazonaws.forecast#Datasets", "traits": { "smithy.api#documentation": "An array of objects that summarize each dataset's properties.
" } + }, + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of\n results, use the token in the next request.
" + } } } }, @@ -2613,6 +2657,12 @@ "com.amazonaws.forecast#ListForecastExportJobsRequest": { "type": "structure", "members": { + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "If the result of the previous request was truncated, the response includes a\n NextToken
. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.
An array of filters. For each filter, you provide a condition and a match statement. The\n condition is either IS
or IS_NOT
, which specifies whether to include\n or exclude the forecast export jobs that match the statement from the list, respectively. The\n match statement consists of a key and a value.
\n Filter properties\n
\n\n Condition
- The condition to apply. Valid values are IS
and\n IS_NOT
. To include the forecast export jobs that match the statement,\n specify IS
. To exclude matching forecast export jobs, specify\n IS_NOT
.
\n Key
- The name of the parameter to filter on. Valid values are\n ForecastArn
and Status
.
\n Value
- The value to match.
For example, to list all jobs that export a forecast named\n electricityforecast, specify the following filter:
\n\n \"Filters\": [ { \"Condition\": \"IS\", \"Key\": \"ForecastArn\", \"Value\":\n \"arn:aws:forecast:us-west-2:
\n
If the result of the previous request was truncated, the response includes a\n NextToken
. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.
If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of\n results, use the token in the next request.
" - } - }, "ForecastExportJobs": { "target": "com.amazonaws.forecast#ForecastExportJobs", "traits": { "smithy.api#documentation": "An array of objects that summarize each export job's properties.
" } + }, + "NextToken": { + "target": "com.amazonaws.forecast#NextToken", + "traits": { + "smithy.api#documentation": "If the response is truncated, Amazon Forecast returns this token. To retrieve the next set of\n results, use the token in the next request.
" + } } } }, @@ -2680,18 +2724,18 @@ "com.amazonaws.forecast#ListForecastsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.forecast#MaxResults", - "traits": { - "smithy.api#documentation": "The number of items to return in the response.
" - } - }, "NextToken": { "target": "com.amazonaws.forecast#NextToken", "traits": { "smithy.api#documentation": "If the result of the previous request was truncated, the response includes a\n NextToken
. To retrieve the next set of results, use the token in the next\n request. Tokens expire after 24 hours.
The number of items to return in the response.
" + } + }, "Filters": { "target": "com.amazonaws.forecast#Filters", "traits": { @@ -2843,16 +2887,25 @@ "com.amazonaws.forecast#Metrics": { "type": "structure", "members": { + "RMSE": { + "target": "com.amazonaws.forecast#Double", + "traits": { + "smithy.api#deprecated": { + "message": "This property is deprecated, please refer to ErrorMetrics for both RMSE and WAPE" + }, + "smithy.api#documentation": "The root-mean-square error (RMSE).
" + } + }, "WeightedQuantileLosses": { "target": "com.amazonaws.forecast#WeightedQuantileLosses", "traits": { "smithy.api#documentation": "An array of weighted quantile losses. Quantiles divide a probability distribution into\n regions of equal probability. The distribution in this case is the loss function.
" } }, - "RMSE": { - "target": "com.amazonaws.forecast#Double", + "ErrorMetrics": { + "target": "com.amazonaws.forecast#ErrorMetrics", "traits": { - "smithy.api#documentation": "The root mean square error (RMSE).
" + "smithy.api#documentation": "\n Provides detailed error metrics on forecast type, root-mean square-error (RMSE), and weighted\n average percentage error (WAPE).\n
" } } }, @@ -2898,17 +2951,17 @@ "smithy.api#documentation": "Specifies the tunable range for each categorical hyperparameter.
" } }, - "IntegerParameterRanges": { - "target": "com.amazonaws.forecast#IntegerParameterRanges", - "traits": { - "smithy.api#documentation": "Specifies the tunable range for each integer hyperparameter.
" - } - }, "ContinuousParameterRanges": { "target": "com.amazonaws.forecast#ContinuousParameterRanges", "traits": { "smithy.api#documentation": "Specifies the tunable range for each continuous hyperparameter.
" } + }, + "IntegerParameterRanges": { + "target": "com.amazonaws.forecast#IntegerParameterRanges", + "traits": { + "smithy.api#documentation": "Specifies the tunable range for each integer hyperparameter.
" + } } }, "traits": { @@ -2934,17 +2987,17 @@ "com.amazonaws.forecast#PredictorExecution": { "type": "structure", "members": { - "TestWindows": { - "target": "com.amazonaws.forecast#TestWindowDetails", - "traits": { - "smithy.api#documentation": "An array of test windows used to evaluate the algorithm. The\n NumberOfBacktestWindows
from the \n object determines the number of windows in the array.
The ARN of the algorithm used to test the predictor.
" } + }, + "TestWindows": { + "target": "com.amazonaws.forecast#TestWindowDetails", + "traits": { + "smithy.api#documentation": "An array of test windows used to evaluate the algorithm. The\n NumberOfBacktestWindows
from the \n object determines the number of windows in the array.
The ARN of the predictor.
" + } + }, "PredictorName": { "target": "com.amazonaws.forecast#Name", "traits": { "smithy.api#documentation": "The name of the predictor.
" } }, + "DatasetGroupArn": { + "target": "com.amazonaws.forecast#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset group that contains the data used to train\n the predictor.
" + } + }, "Status": { "target": "com.amazonaws.forecast#Status", "traits": { @@ -2998,28 +3063,16 @@ "smithy.api#documentation": "If an error occurred, an informational message about the error.
" } }, - "LastModificationTime": { - "target": "com.amazonaws.forecast#Timestamp", - "traits": { - "smithy.api#documentation": "Initially, the same as CreationTime
(status is CREATE_PENDING
).\n Updated when training starts (status changed to CREATE_IN_PROGRESS
), and when\n training is complete (status changed to ACTIVE
) or fails (status changed to\n CREATE_FAILED
).
When the model training task was created.
" } }, - "PredictorArn": { - "target": "com.amazonaws.forecast#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the predictor.
" - } - }, - "DatasetGroupArn": { - "target": "com.amazonaws.forecast#Arn", + "LastModificationTime": { + "target": "com.amazonaws.forecast#Timestamp", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset group that contains the data used to train\n the predictor.
" + "smithy.api#documentation": "Initially, the same as CreationTime
(status is CREATE_PENDING
).\n Updated when training starts (status changed to CREATE_IN_PROGRESS
), and when\n training is complete (status changed to ACTIVE
) or fails (status changed to\n CREATE_FAILED
).
The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.
" - } - }, "RoleArn": { "target": "com.amazonaws.forecast#Arn", "traits": { "smithy.api#documentation": "The ARN of the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3\n bucket or files. If you provide a value for the KMSKeyArn
key, the role must\n allow access to the key.
Passing a role across AWS accounts is not allowed. If you pass a role that isn't in your\n account, you get an InvalidInputException
error.
The Amazon Resource Name (ARN) of an AWS Key Management Service (KMS) key.
" + } } }, "traits": { @@ -3146,17 +3199,17 @@ "com.amazonaws.forecast#SchemaAttribute": { "type": "structure", "members": { - "AttributeType": { - "target": "com.amazonaws.forecast#AttributeType", - "traits": { - "smithy.api#documentation": "The data type of the field.
" - } - }, "AttributeName": { "target": "com.amazonaws.forecast#Name", "traits": { "smithy.api#documentation": "The name of the dataset field.
" } + }, + "AttributeType": { + "target": "com.amazonaws.forecast#AttributeType", + "traits": { + "smithy.api#documentation": "The data type of the field.
" + } } }, "traits": { @@ -3184,46 +3237,46 @@ "smithy.api#documentation": "The number of values in the field.
" } }, - "Stddev": { - "target": "com.amazonaws.forecast#Double", + "CountDistinct": { + "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "For a numeric field, the standard deviation.
" + "smithy.api#documentation": "The number of distinct values in the field.
" } }, - "Min": { - "target": "com.amazonaws.forecast#String", + "CountNull": { + "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "For a numeric field, the minimum value in the field.
" + "smithy.api#documentation": "The number of null values in the field.
" } }, - "Avg": { - "target": "com.amazonaws.forecast#Double", + "CountNan": { + "target": "com.amazonaws.forecast#Integer", "traits": { - "smithy.api#documentation": "For a numeric field, the average value in the field.
" + "smithy.api#documentation": "The number of NAN (not a number) values in the field.
" } }, - "Max": { + "Min": { "target": "com.amazonaws.forecast#String", "traits": { - "smithy.api#documentation": "For a numeric field, the maximum value in the field.
" + "smithy.api#documentation": "For a numeric field, the minimum value in the field.
" } }, - "CountDistinct": { - "target": "com.amazonaws.forecast#Integer", + "Max": { + "target": "com.amazonaws.forecast#String", "traits": { - "smithy.api#documentation": "The number of distinct values in the field.
" + "smithy.api#documentation": "For a numeric field, the maximum value in the field.
" } }, - "CountNull": { - "target": "com.amazonaws.forecast#Integer", + "Avg": { + "target": "com.amazonaws.forecast#Double", "traits": { - "smithy.api#documentation": "The number of null values in the field.
" + "smithy.api#documentation": "For a numeric field, the average value in the field.
" } }, - "CountNan": { - "target": "com.amazonaws.forecast#Integer", + "Stddev": { + "target": "com.amazonaws.forecast#Double", "traits": { - "smithy.api#documentation": "The number of NAN (not a number) values in the field.
" + "smithy.api#documentation": "For a numeric field, the standard deviation.
" } } }, @@ -3253,23 +3306,23 @@ "com.amazonaws.forecast#SupplementaryFeature": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.forecast#Value", + "Name": { + "target": "com.amazonaws.forecast#Name", "traits": { - "smithy.api#documentation": "One of the following 2 letter country codes:
\n\"AR\" - ARGENTINA
\n\"AT\" - AUSTRIA
\n\"AU\" - AUSTRALIA
\n\"BE\" - BELGIUM
\n\"BR\" - BRAZIL
\n\"CA\" - CANADA
\n\"CN\" - CHINA
\n\"CZ\" - CZECH REPUBLIC
\n\"DK\" - DENMARK
\n\"EC\" - ECUADOR
\n\"FI\" - FINLAND
\n\"FR\" - FRANCE
\n\"DE\" - GERMANY
\n\"HU\" - HUNGARY
\n\"IE\" - IRELAND
\n\"IN\" - INDIA
\n\"IT\" - ITALY
\n\"JP\" - JAPAN
\n\"KR\" - KOREA
\n\"LU\" - LUXEMBOURG
\n\"MX\" - MEXICO
\n\"NL\" - NETHERLANDS
\n\"NO\" - NORWAY
\n\"PL\" - POLAND
\n\"PT\" - PORTUGAL
\n\"RU\" - RUSSIA
\n\"ZA\" - SOUTH AFRICA
\n\"ES\" - SPAIN
\n\"SE\" - SWEDEN
\n\"CH\" - SWITZERLAND
\n\"US\" - UNITED STATES
\n\"UK\" - UNITED KINGDOM
\nThe name of the feature. This must be \"holiday\".
", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.forecast#Name", + "Value": { + "target": "com.amazonaws.forecast#Value", "traits": { - "smithy.api#documentation": "The name of the feature. This must be \"holiday\".
", + "smithy.api#documentation": "One of the following 2 letter country codes:
\n\"AL\" - ALBANIA
\n\"AR\" - ARGENTINA
\n\"AT\" - AUSTRIA
\n\"AU\" - AUSTRALIA
\n\"BA\" - BOSNIA HERZEGOVINA
\n\"BE\" - BELGIUM
\n\"BG\" - BULGARIA
\n\"BO\" - BOLIVIA
\n\"BR\" - BRAZIL
\n\"BY\" - BELARUS
\n\"CA\" - CANADA
\n\"CL\" - CHILE
\n\"CO\" - COLOMBIA
\n\"CR\" - COSTA RICA
\n\"HR\" - CROATIA
\n\"CZ\" - CZECH REPUBLIC
\n\"DK\" - DENMARK
\n\"EC\" - ECUADOR
\n\"EE\" - ESTONIA
\n\"ET\" - ETHIOPIA
\n\"FI\" - FINLAND
\n\"FR\" - FRANCE
\n\"DE\" - GERMANY
\n\"GR\" - GREECE
\n\"HU\" - HUNGARY
\n\"IS\" - ICELAND
\n\"IN\" - INDIA
\n\"IE\" - IRELAND
\n\"IT\" - ITALY
\n\"JP\" - JAPAN
\n\"KZ\" - KAZAKHSTAN
\n\"KR\" - KOREA
\n\"LV\" - LATVIA
\n\"LI\" - LIECHTENSTEIN
\n\"LT\" - LITHUANIA
\n\"LU\" - LUXEMBOURG
\n\"MK\" - MACEDONIA
\n\"MT\" - MALTA
\n\"MX\" - MEXICO
\n\"MD\" - MOLDOVA
\n\"ME\" - MONTENEGRO
\n\"NL\" - NETHERLANDS
\n\"NZ\" - NEW ZEALAND
\n\"NI\" - NICARAGUA
\n\"NG\" - NIGERIA
\n\"NO\" - NORWAY
\n\"PA\" - PANAMA
\n\"PY\" - PARAGUAY
\n\"PE\" - PERU
\n\"PL\" - POLAND
\n\"PT\" - PORTUGAL
\n\"RO\" - ROMANIA
\n\"RU\" - RUSSIA
\n\"RS\" - SERBIA
\n\"SK\" - SLOVAKIA
\n\"SI\" - SLOVENIA
\n\"ZA\" - SOUTH AFRICA
\n\"ES\" - SPAIN
\n\"SE\" - SWEDEN
\n\"CH\" - SWITZERLAND
\n\"UA\" - UKRAINE
\n\"AE\" - UNITED ARAB EMIRATES
\n\"US\" - UNITED STATES
\n\"UK\" - UNITED KINGDOM
\n\"UY\" - URUGUAY
\n\"VE\" - VENEZUELA
\nDescribes a supplementary feature of a dataset group. This object is part of the InputDataConfig object.
\nThe only supported feature is a holiday calendar. If you use the calendar, all data in the\n datasets should belong to the same country as the calendar. For the holiday calendar data, see\n the Jollyday web site.
\nIndia and Korea's holidays are not included in the Jollyday library, but both are\n supported by Amazon Forecast. Their holidays are:
\n\n \"IN\" - INDIA\n
\n\n JANUARY 26 - REPUBLIC DAY
\n
\n AUGUST 15 - INDEPENDENCE DAY
\n
\n OCTOBER 2 GANDHI'S BIRTHDAY
\n
\n \"KR\" - KOREA\n
\n\n JANUARY 1 - NEW YEAR
\n
\n MARCH 1 - INDEPENDENCE MOVEMENT DAY
\n
\n MAY 5 - CHILDREN'S DAY
\n
\n JUNE 6 - MEMORIAL DAY
\n
\n AUGUST 15 - LIBERATION DAY
\n
\n OCTOBER 3 - NATIONAL FOUNDATION DAY
\n
\n OCTOBER 9 - HANGEUL DAY
\n
\n DECEMBER 25 - CHRISTMAS DAY
\n
Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object.
\nThe only supported feature is Holidays. If you use the calendar, all data in the\n datasets should belong to the same country as the calendar. For the holiday calendar data, see\n the Jollyday website.
" } }, "com.amazonaws.forecast#SupplementaryFeatures": { @@ -3354,17 +3407,17 @@ "com.amazonaws.forecast#TagResourceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.forecast#Tags", + "ResourceArn": { + "target": "com.amazonaws.forecast#Arn", "traits": { - "smithy.api#documentation": "The tags to add to the resource. A tag is an array of key-value pairs.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast export jobs.
", "smithy.api#required": {} } }, - "ResourceArn": { - "target": "com.amazonaws.forecast#Arn", + "Tags": { + "target": "com.amazonaws.forecast#Tags", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are Forecast dataset groups, datasets, dataset import jobs, predictors, forecasts, and forecast export jobs.
", + "smithy.api#documentation": "The tags to add to the resource. A tag is an array of key-value pairs.
\nThe following basic restrictions apply to tags:
\nMaximum number of tags per resource - 50.
\nFor each resource, each tag key must be unique, and each tag key can have only one value.
\nMaximum key length - 128 Unicode characters in UTF-8.
\nMaximum value length - 256 Unicode characters in UTF-8.
\nIf your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
\nTag keys and values are case sensitive.
\nDo not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws
as its prefix but the key does not, then Forecast considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws
do not count against your tags per resource limit.
The status of the test. Possible status values are:
\n\n ACTIVE
\n
\n CREATE_IN_PROGRESS
\n
\n CREATE_FAILED
\n
The time at which the test began.
" } }, "TestWindowEnd": { @@ -3417,10 +3470,10 @@ "smithy.api#documentation": "The time at which the test ended.
" } }, - "TestWindowStart": { - "target": "com.amazonaws.forecast#Timestamp", + "Status": { + "target": "com.amazonaws.forecast#Status", "traits": { - "smithy.api#documentation": "The time at which the test began.
" + "smithy.api#documentation": "The status of the test. Possible status values are:
\n\n ACTIVE
\n
\n CREATE_IN_PROGRESS
\n
\n CREATE_FAILED
\n
An array of the Amazon Resource Names (ARNs) of the datasets to add to the dataset\n group.
", + "smithy.api#documentation": "The ARN of the dataset group.
", "smithy.api#required": {} } }, - "DatasetGroupArn": { - "target": "com.amazonaws.forecast#Arn", + "DatasetArns": { + "target": "com.amazonaws.forecast#ArnList", "traits": { - "smithy.api#documentation": "The ARN of the dataset group.
", + "smithy.api#documentation": "An array of the Amazon Resource Names (ARNs) of the datasets to add to the dataset\n group.
", "smithy.api#required": {} } } @@ -3609,6 +3662,18 @@ "com.amazonaws.forecast#WindowSummary": { "type": "structure", "members": { + "TestWindowStart": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp that defines the start of the window.
" + } + }, + "TestWindowEnd": { + "target": "com.amazonaws.forecast#Timestamp", + "traits": { + "smithy.api#documentation": "The timestamp that defines the end of the window.
" + } + }, "ItemCount": { "target": "com.amazonaws.forecast#Integer", "traits": { @@ -3621,23 +3686,11 @@ "smithy.api#documentation": "The type of evaluation.
\n\n SUMMARY
- The average metrics across all windows.
\n COMPUTED
- The metrics for the specified window.
The timestamp that defines the end of the window.
" - } - }, "Metrics": { "target": "com.amazonaws.forecast#Metrics", "traits": { "smithy.api#documentation": "Provides metrics used to evaluate the performance of a predictor.
" } - }, - "TestWindowStart": { - "target": "com.amazonaws.forecast#Timestamp", - "traits": { - "smithy.api#documentation": "The timestamp that defines the start of the window.
" - } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json b/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json index cbaa4aaee4e6..e78ece36740f 100644 --- a/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json +++ b/codegen/sdk-codegen/aws-models/fsx.2018-03-01.json @@ -44,6 +44,9 @@ "type": "service", "version": "2018-03-01", "operations": [ + { + "target": "com.amazonaws.fsx#AssociateFileSystemAliases" + }, { "target": "com.amazonaws.fsx#CancelDataRepositoryTask" }, @@ -71,9 +74,15 @@ { "target": "com.amazonaws.fsx#DescribeDataRepositoryTasks" }, + { + "target": "com.amazonaws.fsx#DescribeFileSystemAliases" + }, { "target": "com.amazonaws.fsx#DescribeFileSystems" }, + { + "target": "com.amazonaws.fsx#DisassociateFileSystemAliases" + }, { "target": "com.amazonaws.fsx#ListTagsForResource" }, @@ -105,17 +114,17 @@ "com.amazonaws.fsx#ActiveDirectoryBackupAttributes": { "type": "structure", "members": { - "ActiveDirectoryId": { - "target": "com.amazonaws.fsx#DirectoryId", - "traits": { - "smithy.api#documentation": "The ID of the AWS Managed Microsoft Active Directory instance to which the file system is joined.
" - } - }, "DomainName": { "target": "com.amazonaws.fsx#ActiveDirectoryFullyQualifiedName", "traits": { "smithy.api#documentation": "The fully qualified domain name of the self-managed AD directory.
" } + }, + "ActiveDirectoryId": { + "target": "com.amazonaws.fsx#DirectoryId", + "traits": { + "smithy.api#documentation": "The ID of the AWS Managed Microsoft Active Directory instance to which the file system is joined.
" + } } }, "traits": { @@ -125,12 +134,6 @@ "com.amazonaws.fsx#ActiveDirectoryError": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.fsx#ActiveDirectoryErrorType", - "traits": { - "smithy.api#documentation": "The type of Active Directory error.
" - } - }, "ActiveDirectoryId": { "target": "com.amazonaws.fsx#DirectoryId", "traits": { @@ -138,6 +141,12 @@ "smithy.api#required": {} } }, + "Type": { + "target": "com.amazonaws.fsx#ActiveDirectoryErrorType", + "traits": { + "smithy.api#documentation": "The type of Active Directory error.
" + } + }, "Message": { "target": "com.amazonaws.fsx#ErrorMessage" } @@ -187,10 +196,10 @@ "AdministrativeActionType": { "target": "com.amazonaws.fsx#AdministrativeActionType" }, - "Status": { - "target": "com.amazonaws.fsx#Status", + "ProgressPercent": { + "target": "com.amazonaws.fsx#ProgressPercent", "traits": { - "smithy.api#documentation": "Describes the status of the administrative action, as follows:
\n\n FAILED
- Amazon FSx failed to process the administrative action successfully.
\n IN_PROGRESS
- Amazon FSx is processing the administrative action.
\n PENDING
- Amazon FSx is waiting to process the administrative action.
\n COMPLETED
- Amazon FSx has finished processing the administrative task.
\n UPDATED_OPTIMIZING
- For a storage capacity increase update, Amazon FSx has updated the file system \n with the new storage capacity, and is now performing the storage optimization process.\n For more information, see Managing Storage Capacity.
Provides the percent complete of a STORAGE_OPTIMIZATION
administrative action. \n Does not apply to any other administrative action type.
Time that the administrative action request was received.
" } }, - "TargetFileSystemValues": { - "target": "com.amazonaws.fsx#FileSystem", + "Status": { + "target": "com.amazonaws.fsx#Status", "traits": { - "smithy.api#documentation": "Describes the target StorageCapacity
or ThroughputCapacity
value \n provided in the UpdateFileSystem
operation. \n Returned for FILE_SYSTEM_UPDATE
administrative actions. \n
Describes the status of the administrative action, as follows:
\n\n FAILED
- Amazon FSx failed to process the administrative action successfully.
\n IN_PROGRESS
- Amazon FSx is processing the administrative action.
\n PENDING
- Amazon FSx is waiting to process the administrative action.
\n COMPLETED
- Amazon FSx has finished processing the administrative task.
\n UPDATED_OPTIMIZING
- For a storage capacity increase update, Amazon FSx has updated the file system \n with the new storage capacity, and is now performing the storage optimization process.\n For more information, see Managing Storage Capacity.
Provides the percent complete of a STORAGE_OPTIMIZATION
administrative action.
Describes the target value for the administration action, \n provided in the UpdateFileSystem
operation. \n Returned for FILE_SYSTEM_UPDATE
administrative actions. \n
Error message providing details about the failure.
" + "smithy.api#documentation": "Error message providing details about the failed administrative action.
" } } }, @@ -236,7 +245,7 @@ "com.amazonaws.fsx#AdministrativeActionType": { "type": "string", "traits": { - "smithy.api#documentation": "Describes the type of administrative action, as follows:
\n\n FILE_SYSTEM_UPDATE
- A file system update administrative action initiated by the user from the \n Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system). A
\n STORAGE_OPTIMIZATION
- Once the FILE_SYSTEM_UPDATE
\n task to increase a file system's storage capacity completes successfully, a \n STORAGE_OPTIMIZATION
task starts. Storage optimization is the process \n of migrating the file system data to the new, larger disks. You can track the \n storage migration progress using the ProgressPercent
property. When \n STORAGE_OPTIMIZATION
completes successfully, the parent FILE_SYSTEM_UPDATE
\n action status changes to COMPLETED
. For more information, see \n Managing Storage Capacity.\n
Describes the type of administrative action, as follows:
\n\n FILE_SYSTEM_UPDATE
- A file system update administrative action initiated by the user from the \n Amazon FSx console, API (UpdateFileSystem), or CLI (update-file-system).
\n STORAGE_OPTIMIZATION
- Once the FILE_SYSTEM_UPDATE
\n task to increase a file system's storage capacity completes successfully, a \n STORAGE_OPTIMIZATION
task starts. Storage optimization is the process \n of migrating the file system data to the new, larger disks. You can track the \n storage migration progress using the ProgressPercent
property. When \n STORAGE_OPTIMIZATION
completes successfully, the parent FILE_SYSTEM_UPDATE
\n action status changes to COMPLETED
. For more information, see \n Managing Storage Capacity.\n
\n FILE_SYSTEM_ALIAS_ASSOCIATION
- A file system update to associate a new DNS alias with the file system. \n For more information, see\n .
\n FILE_SYSTEM_ALIAS_DISASSOCIATION
- A file system update to disassociate a DNS alias from the file system.\n For more information, see .
The name of the DNS alias. The alias name has to meet the following requirements:
\nFormatted as a fully-qualified domain name (FQDN), hostname.domain
, for example, accounting.example.com
.
Can contain alphanumeric characters and the hyphen (-).
\nCannot start or end with a hyphen.
\nCan start with a numeric.
\nFor DNS names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: \n as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
" + } + }, + "Lifecycle": { + "target": "com.amazonaws.fsx#AliasLifecycle", + "traits": { + "smithy.api#documentation": "Describes the state of the DNS alias.
\nAVAILABLE - The DNS alias is associated with an Amazon FSx file system.
\nCREATING - Amazon FSx is creating the DNS alias and associating it with the file system.
\nCREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system.
\nDELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it.
\nDELETE_FAILED - Amazon FSx was unable to disassocate the DNS alias from the file system.
\nA DNS alias that is associated with the file system. You can use a DNS alias to access a file system using \n user-defined DNS names, in addition to the default DNS name\n that Amazon FSx assigns to the file system. For more information, see \n DNS aliases in the FSx for Windows File Server User Guide.
" + } + }, + "com.amazonaws.fsx#AliasLifecycle": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "AVAILABLE", + "name": "AVAILABLE" + }, + { + "value": "CREATING", + "name": "CREATING" + }, + { + "value": "DELETING", + "name": "DELETING" + }, + { + "value": "CREATE_FAILED", + "name": "CREATE_FAILED" + }, + { + "value": "DELETE_FAILED", + "name": "DELETE_FAILED" + } + ] + } + }, + "com.amazonaws.fsx#Aliases": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#Alias" + }, + "traits": { + "smithy.api#documentation": "An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. \n Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. \n You can associate up to 50 aliases with a file system at any time. \n You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. \n You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation.\n You only need to specify the alias name in the request payload. For more information, see \n DNS aliases.
", + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, + "com.amazonaws.fsx#AlternateDNSName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 4, + "max": 253 + }, + "smithy.api#pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{4,253}$" + } + }, + "com.amazonaws.fsx#AlternateDNSNames": { + "type": "list", + "member": { + "target": "com.amazonaws.fsx#AlternateDNSName" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 50 + } + } + }, "com.amazonaws.fsx#ArchivePath": { "type": "string", "traits": { "smithy.api#length": { "min": 3, - "max": 900 + "max": 4357 }, "smithy.api#pattern": "^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$" } }, + "com.amazonaws.fsx#AssociateFileSystemAliases": { + "type": "operation", + "input": { + "target": "com.amazonaws.fsx#AssociateFileSystemAliasesRequest" + }, + "output": { + "target": "com.amazonaws.fsx#AssociateFileSystemAliasesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.fsx#BadRequest" + }, + { + "target": "com.amazonaws.fsx#FileSystemNotFound" + }, + { + "target": "com.amazonaws.fsx#InternalServerError" + } + ], + "traits": { + "smithy.api#documentation": "Use this action to associate one or more Domain Name Server (DNS) aliases with an existing Amazon FSx for Windows File Server file system. \n A file systen can have a maximum of 50 DNS aliases associated with it at any one time. If you try to \n associate a DNS alias that is already associated with the file system, FSx takes no action on that alias in the request. \n For more information, see Working with DNS Aliases and \n Walkthrough 5: Using DNS aliases to access your file system, including\n additional steps you must take to be able to access your file system using a DNS alias.
\nThe system response shows the DNS aliases that \n Amazon FSx is attempting to associate with the file system. \n Use the API \n operation to monitor the status of the aliases Amazon FSx is \n associating with the file system.
" + } + }, + "com.amazonaws.fsx#AssociateFileSystemAliasesRequest": { + "type": "structure", + "members": { + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "FileSystemId": { + "target": "com.amazonaws.fsx#FileSystemId", + "traits": { + "smithy.api#documentation": "Specifies the file system with which you want to associate one or more DNS aliases.
", + "smithy.api#required": {} + } + }, + "Aliases": { + "target": "com.amazonaws.fsx#AlternateDNSNames", + "traits": { + "smithy.api#documentation": "An array of one or more DNS alias names to associate with the file system. \n The alias name has to comply with the following formatting requirements:
\nFormatted as a fully-qualified domain name (FQDN), \n hostname.domain
\n , \n for example, accounting.corp.example.com
.
Can contain alphanumeric characters and the hyphen (-).
\nCannot start or end with a hyphen.
\nCan start with a numeric.
\nFor DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: \n as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request object specifying one or more DNS alias names to associate with an Amazon FSx for Windows File Server file system.
" + } + }, + "com.amazonaws.fsx#AssociateFileSystemAliasesResponse": { + "type": "structure", + "members": { + "Aliases": { + "target": "com.amazonaws.fsx#Aliases", + "traits": { + "smithy.api#documentation": "An array of the DNS aliases that Amazon FSx is associating with the file system.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The system generated response showing the DNS aliases that \n Amazon FSx is attempting to associate with the file system. \n Use the API \n operation to monitor the status of the aliases Amazon FSx is \n associating with the file system. It can take up to 2.5 minutes for \n the alias status to change from CREATING
to AVAILABLE
.
Metadata of the file system associated with the backup. This metadata is persisted\n even if the file system is deleted.
", + "smithy.api#documentation": "The ID of the backup.
", "smithy.api#required": {} } }, @@ -318,27 +482,6 @@ "smithy.api#required": {} } }, - "ResourceARN": { - "target": "com.amazonaws.fsx#ResourceARN", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the backup resource.
" - } - }, - "KmsKeyId": { - "target": "com.amazonaws.fsx#KmsKeyId", - "traits": { - "smithy.api#documentation": "The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the \n backup of the Amazon FSx file system's data at rest. \n
" - } - }, - "DirectoryInformation": { - "target": "com.amazonaws.fsx#ActiveDirectoryBackupAttributes", - "traits": { - "smithy.api#documentation": "The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.
" - } - }, - "ProgressPercent": { - "target": "com.amazonaws.fsx#ProgressPercent" - }, "FailureDetails": { "target": "com.amazonaws.fsx#BackupFailureDetails", "traits": { @@ -352,6 +495,9 @@ "smithy.api#required": {} } }, + "ProgressPercent": { + "target": "com.amazonaws.fsx#ProgressPercent" + }, "CreationTime": { "target": "com.amazonaws.fsx#CreationTime", "traits": { @@ -359,11 +505,16 @@ "smithy.api#required": {} } }, - "BackupId": { - "target": "com.amazonaws.fsx#BackupId", + "KmsKeyId": { + "target": "com.amazonaws.fsx#KmsKeyId", "traits": { - "smithy.api#documentation": "The ID of the backup.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the \n backup of the Amazon FSx file system's data at rest. \n
" + } + }, + "ResourceARN": { + "target": "com.amazonaws.fsx#ResourceARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the backup resource.
" } }, "Tags": { @@ -371,6 +522,19 @@ "traits": { "smithy.api#documentation": "Tags associated with a particular file system.
" } + }, + "FileSystem": { + "target": "com.amazonaws.fsx#FileSystem", + "traits": { + "smithy.api#documentation": "Metadata of the file system associated with the backup. This metadata is persisted\n even if the file system is deleted.
", + "smithy.api#required": {} + } + }, + "DirectoryInformation": { + "target": "com.amazonaws.fsx#ActiveDirectoryBackupAttributes", + "traits": { + "smithy.api#documentation": "The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.
" + } } }, "traits": { @@ -497,6 +661,10 @@ { "value": "USER_INITIATED", "name": "USER_INITIATED" + }, + { + "value": "AWS_BACKUP", + "name": "AWS_BACKUP" } ] } @@ -602,6 +770,13 @@ "com.amazonaws.fsx#CompletionReport": { "type": "structure", "members": { + "Enabled": { + "target": "com.amazonaws.fsx#Flag", + "traits": { + "smithy.api#documentation": "Set Enabled
to True
to generate a CompletionReport
when the task completes. \n If set to true
, then you need to provide a report Scope
, Path
, and Format
. \n Set Enabled
to False
if you do not want a CompletionReport
generated when the task completes.
Required if Enabled
is set to true
. Specifies the format of the CompletionReport
. REPORT_CSV_20191124
is the only format currently supported.\n When Format
is set to REPORT_CSV_20191124
, the CompletionReport
is provided in CSV format, and is delivered to\n {path}/task-{id}/failures.csv
. \n
Set Enabled
to True
to generate a CompletionReport
when the task completes. \n If set to true
, then you need to provide a report Scope
, Path
, and Format
. \n Set Enabled
to False
if you do not want a CompletionReport
generated when the task completes.
(Optional) The tags to apply to the backup at backup creation. The key value of the\n Name
tag appears in the console as the backup name. If you have set CopyTagsToBackups
to true, and \n you specify one or more tags using the CreateBackup
action, no existing file system tags are copied from the file system to the backup.
The ID of the file system to back up.
", + "smithy.api#required": {} } }, "ClientRequestToken": { @@ -684,11 +853,10 @@ "smithy.api#idempotencyToken": {} } }, - "FileSystemId": { - "target": "com.amazonaws.fsx#FileSystemId", + "Tags": { + "target": "com.amazonaws.fsx#Tags", "traits": { - "smithy.api#documentation": "The ID of the file system to back up.
", - "smithy.api#required": {} + "smithy.api#documentation": "(Optional) The tags to apply to the backup at backup creation. The key value of the\n Name
tag appears in the console as the backup name. If you have set CopyTagsToBackups
to true, and \n you specify one or more tags using the CreateBackup
action, no existing file system tags are copied from the file system to the backup.
Specifies the type of data repository task to create.
", + "smithy.api#required": {} } }, - "FileSystemId": { - "target": "com.amazonaws.fsx#FileSystemId", - "traits": { + "Paths": { + "target": "com.amazonaws.fsx#DataRepositoryTaskPaths", + "traits": { + "smithy.api#documentation": "(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. \n The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. \n If the mount point is /mnt/fsx
and /mnt/fsx/path1
is a directory or \n file on the file system you want to export, then the path to provide is path1
.\n If a path that you provide isn't valid, the task fails.
(Optional) The path or paths on the Amazon FSx file system to use when the data repository task is processed. \n The default path is the file system root directory. The paths you provide need to be relative to the mount point of the file system. \n If the mount point is /mnt/fsx
and /mnt/fsx/path1
is a directory or \n file on the file system you want to export, then the path to provide is path1
.\n If a path that you provide isn't valid, the task fails.
Specifies the type of data repository task to create.
", - "smithy.api#required": {} - } + "Tags": { + "target": "com.amazonaws.fsx#Tags" } } }, @@ -885,26 +1053,24 @@ "com.amazonaws.fsx#CreateFileSystemFromBackupRequest": { "type": "structure", "members": { - "SubnetIds": { - "target": "com.amazonaws.fsx#SubnetIds", - "traits": { - "smithy.api#documentation": "Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1
\n file system deployment types, provide exactly two subnet IDs, one for the preferred file server \n and one for the standby file server. You specify one of these subnets as the preferred subnet \n using the WindowsConfiguration > PreferredSubnetID
property.
For Windows SINGLE_AZ_1
and SINGLE_AZ_2
deployment \n types and Lustre file systems, provide exactly one subnet ID.\n The file server is launched in that subnet's Availability Zone.
A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n AWS Command Line Interface (AWS CLI) or an AWS SDK.
", + "smithy.api#idempotencyToken": {} + } }, - "WindowsConfiguration": { - "target": "com.amazonaws.fsx#CreateFileSystemWindowsConfiguration", + "SubnetIds": { + "target": "com.amazonaws.fsx#SubnetIds", "traits": { - "smithy.api#documentation": "The configuration for this Microsoft Windows file system.
" + "smithy.api#documentation": "Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1
\n file system deployment types, provide exactly two subnet IDs, one for the preferred file server \n and one for the standby file server. You specify one of these subnets as the preferred subnet \n using the WindowsConfiguration > PreferredSubnetID
property.
For Windows SINGLE_AZ_1
and SINGLE_AZ_2
deployment \n types and Lustre file systems, provide exactly one subnet ID.\n The file server is launched in that subnet's Availability Zone.
A list of IDs for the security groups that apply to the specified network\n interfaces created for file system access. These security groups apply to all network\n interfaces. This value isn't returned in later DescribeFileSystem requests.
" } }, - "StorageType": { - "target": "com.amazonaws.fsx#StorageType", + "Tags": { + "target": "com.amazonaws.fsx#Tags", "traits": { - "smithy.api#documentation": "Sets the storage type for the Windows file system you're creating from a backup. \n Valid values are SSD
and HDD
.
Set to SSD
to use solid state drive storage. \n Supported on all Windows deployment types.
Set to HDD
to use hard disk drive storage. \n Supported on SINGLE_AZ_2
and MULTI_AZ_1
Windows file system deployment types. \n
\n Default value is SSD
. \n
HDD and SSD storage types have different minimum storage capacity requirements. \n A restored file system's storage capacity is tied to the file system that was backed up. \n You can create a file system that uses HDD storage from a backup of a file system that \n used SSD storage only if the original SSD file system had a storage capacity of at least 2000 GiB. \n
\nThe tags to be applied to the file system at file system creation. The key value of\n the Name
tag appears in the console as the file system\n name.
A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n AWS Command Line Interface (AWS CLI) or an AWS SDK.
", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "The configuration for this Microsoft Windows file system.
" } }, - "Tags": { - "target": "com.amazonaws.fsx#Tags", + "LustreConfiguration": { + "target": "com.amazonaws.fsx#CreateFileSystemLustreConfiguration" + }, + "StorageType": { + "target": "com.amazonaws.fsx#StorageType", "traits": { - "smithy.api#documentation": "The tags to be applied to the file system at file system creation. The key value of\n the Name
tag appears in the console as the file system\n name.
Sets the storage type for the Windows file system you're creating from a backup. \n Valid values are SSD
and HDD
.
Set to SSD
to use solid state drive storage. \n Supported on all Windows deployment types.
Set to HDD
to use hard disk drive storage. \n Supported on SINGLE_AZ_2
and MULTI_AZ_1
Windows file system deployment types. \n
\n Default value is SSD
. \n
HDD and SSD storage types have different minimum storage capacity requirements. \n A restored file system's storage capacity is tied to the file system that was backed up. \n You can create a file system that uses HDD storage from a backup of a file system that \n used SSD storage only if the original SSD file system had a storage capacity of at least 2000 GiB. \n
\n(Optional) The path to the Amazon S3 bucket (including the optional prefix) that\n you're using as the data repository for your Amazon FSx for Lustre file system.\n The root of your FSx for Lustre file system will\n be mapped to the root of the Amazon S3 bucket you select. An\n example is s3://import-bucket/optional-prefix
. If you specify a prefix\n after the Amazon S3 bucket name, only object keys with that prefix are loaded into the\n file system.
(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
" } }, - "DriveCacheType": { - "target": "com.amazonaws.fsx#DriveCacheType", + "ImportPath": { + "target": "com.amazonaws.fsx#ArchivePath", "traits": { - "smithy.api#documentation": "The type of drive cache used by PERSISTENT_1 file systems that are provisioned with\n HDD storage devices. This parameter is required when storage type is HDD. Set to\n READ
, improve the performance for frequently accessed files and allows 20%\n of the total storage capacity of the file system to be cached.
This parameter is required when StorageType
is set to HDD.
(Optional) The path to the Amazon S3 bucket (including the optional prefix) that\n you're using as the data repository for your Amazon FSx for Lustre file system.\n The root of your FSx for Lustre file system will\n be mapped to the root of the Amazon S3 bucket you select. An\n example is s3://import-bucket/optional-prefix
. If you specify a prefix\n after the Amazon S3 bucket name, only object keys with that prefix are loaded into the\n file system.
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. \n Use this property to choose how Amazon FSx keeps your file and directory listings up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy
can\n have the following values:
\n NONE
- (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update file and directory \n listings for any new or changed objects after choosing this option.
\n NEW
- AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.
\n NEW_CHANGED
- AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option. \n
For more information, see Automatically import updates from your S3 bucket.
" + "smithy.api#documentation": "(Optional) The path in Amazon S3 where the root of your Amazon FSx file system is exported. \n The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which\n new and changed data is to be exported from your Amazon FSx for Lustre file system. If\n an ExportPath
value is not provided, Amazon FSx sets a default export path,\n s3://import-bucket/FSxLustre[creation-timestamp]
. The timestamp is in\n UTC format, for example\n s3://import-bucket/FSxLustre20181105T222312Z
.
The Amazon S3 export bucket must be the same as the import bucket specified by\n ImportPath
. If you only specify a bucket name, such as\n s3://import-bucket
, you get a 1:1 mapping of file system objects to S3\n bucket objects. This mapping means that the input data in S3 is overwritten on export.\n If you provide a custom prefix in the export path, such as\n s3://import-bucket/[custom-optional-prefix]
, Amazon FSx exports the contents of your file \n system to that export prefix in the Amazon S3 bucket.
(Optional) Not available to use with file systems that are linked to a data repository. \n A boolean flag indicating whether tags for the file system should be copied to\n backups. The default value is false. If it's set to true, all file system\n tags are copied to all automatic and user-initiated backups when the user\n doesn't specify any backup-specific tags. If this value is true, and you specify one or more backup tags, only\n the specified tags are copied to backups. If you specify one or more tags when creating a\n user-initiated backup, no tags are copied from the file system, regardless of this value.
\nFor more information, see Working with backups.
" + "smithy.api#documentation": "(Optional) For files imported from a data repository, this value determines the stripe\n count and maximum amount of data per file (in MiB) stored on a single physical disk. The\n maximum number of disks that a single file can be striped across is limited by the total\n number of disks that make up the file system.
\n \nThe default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.
" } }, "DeploymentType": { @@ -990,10 +1152,10 @@ "smithy.api#documentation": " \n Choose SCRATCH_1
and SCRATCH_2
deployment \n types when you need temporary storage and shorter-term processing of data. \n The SCRATCH_2
deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1
.
Choose PERSISTENT_1
deployment type for longer-term storage \n and workloads and encryption of data in transit. To learn more about deployment types, see \n \n FSx for Lustre Deployment Options.
Encryption of data in-transit is automatically \n enabled when you access a SCRATCH_2
or PERSISTENT_1
\n file system from Amazon EC2 instances that support this feature.\n (Default = SCRATCH_1
)\n
Encryption of data in-transit for SCRATCH_2
and PERSISTENT_1
\n deployment types is supported when accessed from supported instance types in supported AWS Regions. To learn more, \n Encrypting Data in Transit.
(Optional) For files imported from a data repository, this value determines the stripe\n count and maximum amount of data per file (in MiB) stored on a single physical disk. The\n maximum number of disks that a single file can be striped across is limited by the total\n number of disks that make up the file system.
\n \nThe default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.
" + "smithy.api#documentation": " (Optional) When you create your file system, your existing S3 objects appear as file and directory listings. \n Use this property to choose how Amazon FSx keeps your file and directory listings up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy
can\n have the following values:
\n NONE
- (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update file and directory \n listings for any new or changed objects after choosing this option.
\n NEW
- AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.
\n NEW_CHANGED
- AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option. \n
For more information, see Automatically import updates from your S3 bucket.
" } }, "PerUnitStorageThroughput": { @@ -1002,16 +1164,22 @@ "smithy.api#documentation": "\n Required for the PERSISTENT_1
deployment type, describes the amount of read and write \n throughput for each 1 tebibyte of storage, in MB/s/TiB. \n File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput\n (MB/s/TiB). For a 2.4 TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput\n yields 120 MB/s of file system throughput. You pay for the amount of throughput that you\n provision.\n
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
" } }, + "DailyAutomaticBackupStartTime": { + "target": "com.amazonaws.fsx#DailyTime" + }, "AutomaticBackupRetentionDays": { "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays" }, - "DailyAutomaticBackupStartTime": { - "target": "com.amazonaws.fsx#DailyTime" + "CopyTagsToBackups": { + "target": "com.amazonaws.fsx#Flag", + "traits": { + "smithy.api#documentation": "(Optional) Not available to use with file systems that are linked to a data repository. \n A boolean flag indicating whether tags for the file system should be copied to\n backups. The default value is false. If it's set to true, all file system\n tags are copied to all automatic and user-initiated backups when the user\n doesn't specify any backup-specific tags. If this value is true, and you specify one or more backup tags, only\n the specified tags are copied to backups. If you specify one or more tags when creating a\n user-initiated backup, no tags are copied from the file system, regardless of this value.
\nFor more information, see Working with backups.
" + } }, - "ExportPath": { - "target": "com.amazonaws.fsx#ArchivePath", + "DriveCacheType": { + "target": "com.amazonaws.fsx#DriveCacheType", "traits": { - "smithy.api#documentation": "(Optional) The path in Amazon S3 where the root of your Amazon FSx file system is exported. \n The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which\n new and changed data is to be exported from your Amazon FSx for Lustre file system. If\n an ExportPath
value is not provided, Amazon FSx sets a default export path,\n s3://import-bucket/FSxLustre[creation-timestamp]
. The timestamp is in\n UTC format, for example\n s3://import-bucket/FSxLustre20181105T222312Z
.
The Amazon S3 export bucket must be the same as the import bucket specified by\n ImportPath
. If you only specify a bucket name, such as\n s3://import-bucket
, you get a 1:1 mapping of file system objects to S3\n bucket objects. This mapping means that the input data in S3 is overwritten on export.\n If you provide a custom prefix in the export path, such as\n s3://import-bucket/[custom-optional-prefix]
, Amazon FSx exports the contents of your file \n system to that export prefix in the Amazon S3 bucket.
The type of drive cache used by PERSISTENT_1 file systems that are provisioned with\n HDD storage devices. This parameter is required when storage type is HDD. Set to\n READ
, improve the performance for frequently accessed files and allows 20%\n of the total storage capacity of the file system to be cached.
This parameter is required when StorageType
is set to HDD.
Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1
\n file system deployment types, provide exactly two subnet IDs, one for the preferred file server \n and one for the standby file server. You specify one of these subnets as the preferred subnet \n using the WindowsConfiguration > PreferredSubnetID
property.
For Windows SINGLE_AZ_1
and SINGLE_AZ_2
file system deployment types and Lustre file systems, provide exactly one subnet ID.\n The file server is launched in that subnet's Availability Zone.
The tags to apply to the file system being created. The key value of\n the Name
tag appears in the console as the file system name.
The Microsoft Windows configuration for the file system being created. \n
" + "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n AWS Command Line Interface (AWS CLI) or an AWS SDK.
", + "smithy.api#idempotencyToken": {} } }, "FileSystemType": { @@ -1058,27 +1211,42 @@ "smithy.api#required": {} } }, + "StorageType": { + "target": "com.amazonaws.fsx#StorageType", + "traits": { + "smithy.api#documentation": "Sets the storage type for the file system you're creating. \n Valid values are SSD
and HDD
.
Set to SSD
to use solid state drive storage. \n SSD is supported on all Windows and Lustre deployment types.
Set to HDD
to use hard disk drive storage. \n HDD is supported on SINGLE_AZ_2
and MULTI_AZ_1
Windows file system deployment types,\n and on PERSISTENT
Lustre file system deployment types. \n
\n Default value is SSD
. For more information, see \n \n Storage Type Options in the Amazon FSx for Windows User Guide and \n Multiple Storage Options \n in the Amazon FSx for Lustre User Guide.\n
Specifies the IDs of the subnets that the file system will be accessible from. For Windows MULTI_AZ_1
\n file system deployment types, provide exactly two subnet IDs, one for the preferred file server \n and one for the standby file server. You specify one of these subnets as the preferred subnet \n using the WindowsConfiguration > PreferredSubnetID
property.
For Windows SINGLE_AZ_1
and SINGLE_AZ_2
file system deployment types and Lustre file systems, provide exactly one subnet ID.\n The file server is launched in that subnet's Availability Zone.
A list of IDs specifying the security groups to apply to all network interfaces\n created for file system access. This list isn't returned in later requests to\n describe the file system.
" } }, - "StorageType": { - "target": "com.amazonaws.fsx#StorageType", + "Tags": { + "target": "com.amazonaws.fsx#Tags", "traits": { - "smithy.api#documentation": "Sets the storage type for the file system you're creating. \n Valid values are SSD
and HDD
.
Set to SSD
to use solid state drive storage. \n SSD is supported on all Windows and Lustre deployment types.
Set to HDD
to use hard disk drive storage. \n HDD is supported on SINGLE_AZ_2
and MULTI_AZ_1
Windows file system deployment types,\n and on PERSISTENT
Lustre file system deployment types. \n
\n Default value is SSD
. For more information, see \n \n Storage Type Options in the Amazon FSx for Windows User Guide and \n Multiple Storage Options \n in the Amazon FSx for Lustre User Guide.\n
The tags to apply to the file system being created. The key value of\n the Name
tag appears in the console as the file system name.
A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent creation. This string is automatically filled on your behalf when you use the\n AWS Command Line Interface (AWS CLI) or an AWS SDK.
", - "smithy.api#idempotencyToken": {} + "smithy.api#documentation": "The Microsoft Windows configuration for the file system being created. \n
" } + }, + "LustreConfiguration": { + "target": "com.amazonaws.fsx#CreateFileSystemLustreConfiguration" } }, "traits": { @@ -1102,22 +1270,32 @@ "com.amazonaws.fsx#CreateFileSystemWindowsConfiguration": { "type": "structure", "members": { - "PreferredSubnetId": { - "target": "com.amazonaws.fsx#SubnetId", + "ActiveDirectoryId": { + "target": "com.amazonaws.fsx#DirectoryId", "traits": { - "smithy.api#documentation": "Required when DeploymentType
is set to MULTI_AZ_1
. This specifies the subnet \n in which you want the preferred file server to be located. For in-AWS applications, we recommend that you launch \n your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ \n data transfer costs and minimize latency.
The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the\n file system should join when it's created.
" } }, - "AutomaticBackupRetentionDays": { - "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays", + "SelfManagedActiveDirectoryConfiguration": { + "target": "com.amazonaws.fsx#SelfManagedActiveDirectoryConfiguration" + }, + "DeploymentType": { + "target": "com.amazonaws.fsx#WindowsDeploymentType", "traits": { - "smithy.api#documentation": "The number of days to retain automatic backups. The default is to retain backups for 7\n days. Setting this value to 0 disables the creation of automatic backups. The maximum\n retention period for backups is 90 days.
" + "smithy.api#documentation": "Specifies the file system deployment type, valid values are the following:
\n\n MULTI_AZ_1
- Deploys a high availability file system that is configured \n for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You \n can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones. Also \n supports HDD storage type
\n SINGLE_AZ_1
- (Default) Choose to deploy a file system that is configured for single AZ redundancy.
\n SINGLE_AZ_2
- The latest generation Single AZ file system. \n Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.
For more information, see \n \n Availability and Durability: Single-AZ and Multi-AZ File Systems.
" } }, - "DailyAutomaticBackupStartTime": { - "target": "com.amazonaws.fsx#DailyTime", + "PreferredSubnetId": { + "target": "com.amazonaws.fsx#SubnetId", "traits": { - "smithy.api#documentation": "The preferred time to take daily automatic backups, formatted HH:MM in the UTC time\n zone.
" + "smithy.api#documentation": "Required when DeploymentType
is set to MULTI_AZ_1
. This specifies the subnet \n in which you want the preferred file server to be located. For in-AWS applications, we recommend that you launch \n your clients in the same Availability Zone (AZ) as your preferred file server to reduce cross-AZ \n data transfer costs and minimize latency.
The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to\n the nth increments, between 2^3 (8) and 2^11 (2048).
", + "smithy.api#required": {} } }, "WeeklyMaintenanceStartTime": { @@ -1126,19 +1304,16 @@ "smithy.api#documentation": "The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
" } }, - "ActiveDirectoryId": { - "target": "com.amazonaws.fsx#DirectoryId", + "DailyAutomaticBackupStartTime": { + "target": "com.amazonaws.fsx#DailyTime", "traits": { - "smithy.api#documentation": "The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the\n file system should join when it's created.
" + "smithy.api#documentation": "The preferred time to take daily automatic backups, formatted HH:MM in the UTC time\n zone.
" } }, - "SelfManagedActiveDirectoryConfiguration": { - "target": "com.amazonaws.fsx#SelfManagedActiveDirectoryConfiguration" - }, - "DeploymentType": { - "target": "com.amazonaws.fsx#WindowsDeploymentType", + "AutomaticBackupRetentionDays": { + "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays", "traits": { - "smithy.api#documentation": "Specifies the file system deployment type, valid values are the following:
\n\n MULTI_AZ_1
- Deploys a high availability file system that is configured \n for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You \n can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones. Also \n supports HDD storage type
\n SINGLE_AZ_1
- (Default) Choose to deploy a file system that is configured for single AZ redundancy.
\n SINGLE_AZ_2
- The latest generation Single AZ file system. \n Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.
For more information, see \n \n Availability and Durability: Single-AZ and Multi-AZ File Systems.
" + "smithy.api#documentation": "The number of days to retain automatic backups. The default is to retain backups for 7\n days. Setting this value to 0 disables the creation of automatic backups. The maximum\n retention period for backups is 90 days.
" } }, "CopyTagsToBackups": { @@ -1147,11 +1322,10 @@ "smithy.api#documentation": "A boolean flag indicating whether tags for the file system should be copied to\n backups. This value defaults to false. If it's set to true, all tags for the file\n system are copied to all automatic and user-initiated backups where the user\n doesn't specify tags. If this value is true, and you specify one or more tags, only\n the specified tags are copied to backups. If you specify one or more tags when creating a\n user-initiated backup, no tags are copied from the file system, regardless of this value.
" } }, - "ThroughputCapacity": { - "target": "com.amazonaws.fsx#MegabytesPerSecond", + "Aliases": { + "target": "com.amazonaws.fsx#AlternateDNSNames", "traits": { - "smithy.api#documentation": "The throughput of an Amazon FSx file system, measured in megabytes per second, in 2 to\n the nth increments, between 2^3 (8) and 2^11 (2048).
", - "smithy.api#required": {} + "smithy.api#documentation": "An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. \n Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. \n You can associate up to 50 aliases with a file system at any time. \n You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. \n You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation.\n You only need to specify the alias name in the request payload.
\nFor more information, see Working with DNS Aliases and \n Walkthrough 5: Using DNS aliases to access your file system, including\n additional steps you must take to be able to access your file system using a DNS alias.
\nAn alias name has to meet the following requirements:
\nFormatted as a fully-qualified domain name (FQDN), hostname.domain
, for example, accounting.example.com
.
Can contain alphanumeric characters and the hyphen (-).
\nCannot start or end with a hyphen.
\nCan start with a numeric.
\nFor DNS alias names, Amazon FSx stores alphabetic characters as lowercase letters (a-z), regardless of how you specify them: \n as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
" } } }, @@ -1202,26 +1376,26 @@ "smithy.api#documentation": "The import path to the Amazon S3 bucket (and optional prefix) that you're using\n as the data repository for your FSx for Lustre file system, for example\n s3://import-bucket/optional-prefix
. If a prefix is specified after the\n Amazon S3 bucket name, only object keys with that prefix are loaded into the file\n system.
The export path to the Amazon S3 bucket (and prefix) that you are using to store new and\n changed Lustre file system files in S3.
" } }, + "ImportedFileChunkSize": { + "target": "com.amazonaws.fsx#Megabytes", + "traits": { + "smithy.api#documentation": "For files imported from a data repository, this value determines the stripe count and\n maximum amount of data per file (in MiB) stored on a single physical disk. The maximum\n number of disks that a single file can be striped across is limited by the total number\n of disks that make up the file system.
\n\nThe default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.
" + } + }, "AutoImportPolicy": { "target": "com.amazonaws.fsx#AutoImportPolicyType", "traits": { "smithy.api#documentation": "Describes the file system's linked S3 data repository's AutoImportPolicy
. \n The AutoImportPolicy configures how Amazon FSx keeps your file and directory listings up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy
can have the following values:
\n NONE
- (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update file and directory \n listings for any new or changed objects after choosing this option.
\n NEW
- AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.
\n NEW_CHANGED
- AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option. \n
For more information, see Automatically import updates from your S3 bucket.
" } }, - "ImportedFileChunkSize": { - "target": "com.amazonaws.fsx#Megabytes", - "traits": { - "smithy.api#documentation": "For files imported from a data repository, this value determines the stripe count and\n maximum amount of data per file (in MiB) stored on a single physical disk. The maximum\n number of disks that a single file can be striped across is limited by the total number\n of disks that make up the file system.
\n\nThe default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500\n GiB). Amazon S3 objects have a maximum size of 5 TB.
" - } + "FailureDetails": { + "target": "com.amazonaws.fsx#DataRepositoryFailureDetails" } }, "traits": { @@ -1269,25 +1443,30 @@ "com.amazonaws.fsx#DataRepositoryTask": { "type": "structure", "members": { - "FailureDetails": { - "target": "com.amazonaws.fsx#DataRepositoryTaskFailureDetails", + "TaskId": { + "target": "com.amazonaws.fsx#TaskId", "traits": { - "smithy.api#documentation": "Failure message describing why the task failed, it is populated only when Lifecycle
is set to FAILED
.
The system-generated, unique 17-digit ID of the data repository task.
", + "smithy.api#required": {} } }, - "Report": { - "target": "com.amazonaws.fsx#CompletionReport" + "Lifecycle": { + "target": "com.amazonaws.fsx#DataRepositoryTaskLifecycle", + "traits": { + "smithy.api#documentation": "The lifecycle status of the data repository task, as follows:
\n\n PENDING
- Amazon FSx has not started the task.
\n EXECUTING
- Amazon FSx is processing the task.
\n FAILED
- Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. \n The DataRepositoryTaskFailureDetails property provides more information about task failures.
\n SUCCEEDED
- FSx completed the task successfully.
\n CANCELED
- Amazon FSx canceled the task and it did not complete.
\n CANCELING
- FSx is in process of canceling the task.
You cannot delete an FSx for Lustre file system if there are data \n repository tasks for the file system in the PENDING
or EXECUTING
states.\n Please retry when the data repository task is finished (with a status of CANCELED
, SUCCEEDED
, or FAILED
). \n You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.
Provides the status of the number of files that the task has processed successfully and failed to process.
" + "smithy.api#documentation": "The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
", + "smithy.api#required": {} } }, - "Lifecycle": { - "target": "com.amazonaws.fsx#DataRepositoryTaskLifecycle", + "CreationTime": { + "target": "com.amazonaws.fsx#CreationTime", "traits": { - "smithy.api#documentation": "The lifecycle status of the data repository task, as follows:
\n\n PENDING
- Amazon FSx has not started the task.
\n EXECUTING
- Amazon FSx is processing the task.
\n FAILED
- Amazon FSx was not able to complete the task. For example, there may be files the task failed to process. \n The DataRepositoryTaskFailureDetails property provides more information about task failures.
\n SUCCEEDED
- FSx completed the task successfully.
\n CANCELED
- Amazon FSx canceled the task and it did not complete.
\n CANCELING
- FSx is in process of canceling the task.
You cannot delete an FSx for Lustre file system if there are data \n repository tasks for the file system in the PENDING
or EXECUTING
states.\n Please retry when the data repository task is finished (with a status of CANCELED
, SUCCEEDED
, or FAILED
). \n You can use the DescribeDataRepositoryTask action to monitor the task status. Contact the FSx team if you need to delete your file system immediately.
The time that Amazon FSx completed processing the task, populated after the task is complete.
" } }, - "Tags": { - "target": "com.amazonaws.fsx#Tags" - }, "ResourceARN": { "target": "com.amazonaws.fsx#ResourceARN" }, - "Type": { - "target": "com.amazonaws.fsx#DataRepositoryTaskType", + "Tags": { + "target": "com.amazonaws.fsx#Tags" + }, + "FileSystemId": { + "target": "com.amazonaws.fsx#FileSystemId", "traits": { - "smithy.api#documentation": "The type of data repository task; EXPORT_TO_REPOSITORY is the only type currently supported.
", "smithy.api#required": {} } }, @@ -1322,24 +1500,20 @@ "smithy.api#documentation": "An array of paths on the Amazon FSx for Lustre file system that specify the data for the data repository task to process. \n For example, in an EXPORT_TO_REPOSITORY task, the paths specify which data to export to the linked data repository.
\n(Default) If Paths
is not specified, Amazon FSx uses the file system root directory.
Failure message describing why the task failed, it is populated only when Lifecycle
is set to FAILED
.
The system-generated, unique 17-digit ID of the data repository task.
", - "smithy.api#required": {} + "smithy.api#documentation": "Provides the status of the number of files that the task has processed successfully and failed to process.
" } }, - "CreationTime": { - "target": "com.amazonaws.fsx#CreationTime", - "traits": { - "smithy.api#required": {} - } + "Report": { + "target": "com.amazonaws.fsx#CompletionReport" } }, "traits": { @@ -1606,19 +1780,19 @@ "com.amazonaws.fsx#DeleteBackupRequest": { "type": "structure", "members": { - "ClientRequestToken": { - "target": "com.amazonaws.fsx#ClientRequestToken", - "traits": { - "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent deletion. This is automatically filled on your behalf when using the AWS CLI\n or SDK.
", - "smithy.api#idempotencyToken": {} - } - }, "BackupId": { "target": "com.amazonaws.fsx#BackupId", "traits": { "smithy.api#documentation": "The ID of the backup you want to delete.
", "smithy.api#required": {} } + }, + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", + "traits": { + "smithy.api#documentation": "A string of up to 64 ASCII characters that Amazon FSx uses to ensure\n idempotent deletion. This is automatically filled on your behalf when using the AWS CLI\n or SDK.
", + "smithy.api#idempotencyToken": {} + } } }, "traits": { @@ -1678,17 +1852,17 @@ "com.amazonaws.fsx#DeleteFileSystemLustreConfiguration": { "type": "structure", "members": { - "FinalBackupTags": { - "target": "com.amazonaws.fsx#Tags", - "traits": { - "smithy.api#documentation": "Use if SkipFinalBackup
is set to false
, \n and you want to apply an array of tags to the final backup. If you have set the file system property\n CopyTagsToBackups
to true, and \n you specify one or more FinalBackupTags
when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup.
Set SkipFinalBackup
to false if you want to take a final backup of the file \n system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the\n DeleteFileSystem
operation is invoked. (Default = true)
Use if SkipFinalBackup
is set to false
, \n and you want to apply an array of tags to the final backup. If you have set the file system property\n CopyTagsToBackups
to true, and \n you specify one or more FinalBackupTags
when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup.
The set of tags applied to the final backup.
" - } - }, "FinalBackupId": { "target": "com.amazonaws.fsx#BackupId", "traits": { "smithy.api#documentation": "The ID of the final backup for this file system.
" } + }, + "FinalBackupTags": { + "target": "com.amazonaws.fsx#Tags", + "traits": { + "smithy.api#documentation": "The set of tags applied to the final backup.
" + } } }, "traits": { @@ -1718,11 +1892,12 @@ "com.amazonaws.fsx#DeleteFileSystemRequest": { "type": "structure", "members": { - "LustreConfiguration": { - "target": "com.amazonaws.fsx#DeleteFileSystemLustreConfiguration" - }, - "WindowsConfiguration": { - "target": "com.amazonaws.fsx#DeleteFileSystemWindowsConfiguration" + "FileSystemId": { + "target": "com.amazonaws.fsx#FileSystemId", + "traits": { + "smithy.api#documentation": "The ID of the file system you want to delete.
", + "smithy.api#required": {} + } }, "ClientRequestToken": { "target": "com.amazonaws.fsx#ClientRequestToken", @@ -1731,12 +1906,11 @@ "smithy.api#idempotencyToken": {} } }, - "FileSystemId": { - "target": "com.amazonaws.fsx#FileSystemId", - "traits": { - "smithy.api#documentation": "The ID of the file system you want to delete.
", - "smithy.api#required": {} - } + "WindowsConfiguration": { + "target": "com.amazonaws.fsx#DeleteFileSystemWindowsConfiguration" + }, + "LustreConfiguration": { + "target": "com.amazonaws.fsx#DeleteFileSystemLustreConfiguration" } }, "traits": { @@ -1746,23 +1920,23 @@ "com.amazonaws.fsx#DeleteFileSystemResponse": { "type": "structure", "members": { - "Lifecycle": { - "target": "com.amazonaws.fsx#FileSystemLifecycle", - "traits": { - "smithy.api#documentation": "The file system lifecycle for the deletion request. Should be\n DELETING
.
The ID of the file system being deleted.
" } }, - "LustreResponse": { - "target": "com.amazonaws.fsx#DeleteFileSystemLustreResponse" + "Lifecycle": { + "target": "com.amazonaws.fsx#FileSystemLifecycle", + "traits": { + "smithy.api#documentation": "The file system lifecycle for the deletion request. Should be\n DELETING
.
IDs of the backups you want to retrieve (String). This overrides any\n filters. If any IDs are not found, BackupNotFound will be thrown.
" } }, + "Filters": { + "target": "com.amazonaws.fsx#Filters", + "traits": { + "smithy.api#documentation": "Filters structure. Supported names are file-system-id and\n backup-type.
" + } + }, "MaxResults": { "target": "com.amazonaws.fsx#MaxResults", "traits": { @@ -1860,53 +2040,112 @@ "traits": { "smithy.api#documentation": "Opaque pagination token returned from a previous\n DescribeBackups
operation (String). If a token present, the action\n continues the list from where the returning call left off.
The request object for DescribeBackups
operation.
Any array of backups.
" + } + }, + "NextToken": { + "target": "com.amazonaws.fsx#NextToken", + "traits": { + "smithy.api#documentation": "This is present if there are more backups than returned in the response (String).\n You can use the NextToken
value in the later request to fetch the backups.\n
Response object for DescribeBackups
operation.
Returns the description of specific Amazon FSx for Lustre data repository tasks, if\n one or more TaskIds
values are provided in the request, or if filters are used in the request. \n You can use filters to narrow the response to include just tasks for specific file systems, \n or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned \n by your AWS account in the AWS Region of the endpoint that you're calling.
When retrieving all tasks, you can paginate the response by using the optional MaxResults
\n parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon\n FSx returns a NextToken
value in the response. In this case, send a later\n request with the NextToken
request parameter set to the value of\n NextToken
from the last response.
(Optional) IDs of the tasks whose descriptions you want to retrieve\n (String).
" + } }, "Filters": { - "target": "com.amazonaws.fsx#Filters", + "target": "com.amazonaws.fsx#DataRepositoryTaskFilters", "traits": { - "smithy.api#documentation": "Filters structure. Supported names are file-system-id and\n backup-type.
" + "smithy.api#documentation": "(Optional) You can use filters to narrow the DescribeDataRepositoryTasks
response to \n include just tasks for specific file systems, or tasks in a specific lifecycle state.
The request object for DescribeBackups
operation.
This is present if there are more backups than returned in the response (String).\n You can use the NextToken
value in the later request to fetch the backups.\n
The collection of data repository task descriptions returned.
" } }, - "Backups": { - "target": "com.amazonaws.fsx#Backups", - "traits": { - "smithy.api#documentation": "Any array of backups.
" - } + "NextToken": { + "target": "com.amazonaws.fsx#NextToken" } - }, - "traits": { - "smithy.api#documentation": "Response object for DescribeBackups
operation.
Returns the description of specific Amazon FSx for Lustre data repository tasks, if\n one or more TaskIds
values are provided in the request, or if filters are used in the request. \n You can use filters to narrow the response to include just tasks for specific file systems, \n or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned \n by your AWS account in the AWS Region of the endpoint that you're calling.
When retrieving all tasks, you can paginate the response by using the optional MaxResults
\n parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon\n FSx returns a NextToken
value in the response. In this case, send a later\n request with the NextToken
request parameter set to the value of\n NextToken
from the last response.
Returns the DNS aliases that are associated with the specified Amazon FSx for Windows File Server file system. A history of \n all DNS aliases that have been associated with and disassociated from the file system is available in the list of AdministrativeAction \n provided in the DescribeFileSystems operation response.
", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1923,41 +2162,57 @@ } } }, - "com.amazonaws.fsx#DescribeDataRepositoryTasksRequest": { + "com.amazonaws.fsx#DescribeFileSystemAliasesRequest": { "type": "structure", "members": { - "TaskIds": { - "target": "com.amazonaws.fsx#TaskIds", + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { - "smithy.api#documentation": "(Optional) IDs of the tasks whose descriptions you want to retrieve\n (String).
" + "smithy.api#idempotencyToken": {} } }, - "Filters": { - "target": "com.amazonaws.fsx#DataRepositoryTaskFilters", + "FileSystemId": { + "target": "com.amazonaws.fsx#FileSystemId", "traits": { - "smithy.api#documentation": "(Optional) You can use filters to narrow the DescribeDataRepositoryTasks
response to \n include just tasks for specific file systems, or tasks in a specific lifecycle state.
The ID of the file system to return the associated DNS aliases for\n (String).
", + "smithy.api#required": {} } }, "MaxResults": { - "target": "com.amazonaws.fsx#MaxResults" + "target": "com.amazonaws.fsx#MaxResults", + "traits": { + "smithy.api#documentation": "Maximum number of DNS aliases to return in the response (integer). This\n parameter value must be greater than 0. The number of items that Amazon FSx returns is\n the minimum of the MaxResults
parameter specified in the request and the\n service's internal maximum number of items per page.
Opaque pagination token returned from a previous\n DescribeFileSystemAliases
operation (String). If a token is included in the request, the action\n continues the list from where the previous returning call left off.
The request object for DescribeFileSystemAliases
operation.
An array of one or more DNS aliases currently associated with the specified file system.
" + } }, - "DataRepositoryTasks": { - "target": "com.amazonaws.fsx#DataRepositoryTasks", + "NextToken": { + "target": "com.amazonaws.fsx#NextToken", "traits": { - "smithy.api#documentation": "The collection of data repository task descriptions returned.
" + "smithy.api#documentation": "Present if there are more DNS aliases than returned in the response (String). You\n can use the NextToken
value in a later request to fetch additional\n descriptions.
The response object for DescribeFileSystemAliases
operation.
Opaque pagination token returned from a previous\n DescribeFileSystems
operation (String). If a token present, the action\n continues the list from where the returning call left off.
IDs of the file systems whose descriptions you want to retrieve\n (String).
" } }, "MaxResults": { @@ -2003,10 +2258,10 @@ "smithy.api#documentation": "Maximum number of file systems to return in the response (integer). This\n parameter value must be greater than 0. The number of items that Amazon FSx returns is\n the minimum of the MaxResults
parameter specified in the request and the\n service's internal maximum number of items per page.
IDs of the file systems whose descriptions you want to retrieve\n (String).
" + "smithy.api#documentation": "Opaque pagination token returned from a previous\n DescribeFileSystems
operation (String). If a token present, the action\n continues the list from where the returning call left off.
Present if there are more file systems than returned in the response (String). You\n can use the NextToken
value in the later request to fetch the\n descriptions.
An array of file system descriptions.
" } + }, + "NextToken": { + "target": "com.amazonaws.fsx#NextToken", + "traits": { + "smithy.api#documentation": "Present if there are more file systems than returned in the response (String). You\n can use the NextToken
value in the later request to fetch the\n descriptions.
Use this action to disassociate, or remove, one or more Domain Name Service (DNS) aliases \n from an Amazon FSx for Windows File Server file system. If you attempt to disassociate a DNS alias that is not \n associated with the file system, Amazon FSx responds with a 400 Bad Request. For more information, see \n Working with DNS Aliases.
\nThe system generated response showing the DNS aliases that \n Amazon FSx is attempting to disassociate from the file system. \n Use the API \n operation to monitor the status of the aliases Amazon FSx is \n disassociating with the file system.
" + } + }, + "com.amazonaws.fsx#DisassociateFileSystemAliasesRequest": { + "type": "structure", + "members": { + "ClientRequestToken": { + "target": "com.amazonaws.fsx#ClientRequestToken", + "traits": { + "smithy.api#idempotencyToken": {} + } + }, + "FileSystemId": { + "target": "com.amazonaws.fsx#FileSystemId", + "traits": { + "smithy.api#documentation": "Specifies the file system from which to disassociate the DNS aliases.
", + "smithy.api#required": {} + } + }, + "Aliases": { + "target": "com.amazonaws.fsx#AlternateDNSNames", + "traits": { + "smithy.api#documentation": "An array of one or more DNS alias names to disassociate, or remove, from the file system.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The request object of DNS aliases to disassociate from an Amazon FSx for Windows File Server file system.
" + } + }, + "com.amazonaws.fsx#DisassociateFileSystemAliasesResponse": { + "type": "structure", + "members": { + "Aliases": { + "target": "com.amazonaws.fsx#Aliases", + "traits": { + "smithy.api#documentation": "An array of one or more DNS aliases that Amazon FSx is attempting to disassociate from the file system.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The system generated response showing the DNS aliases that Amazon FSx is attempting to disassociate from the file system. \n Use the API operation to monitor the status of the aliases Amazon FSx is removing from the file system.
" + } + }, "com.amazonaws.fsx#DnsIps": { "type": "list", "member": { @@ -2114,52 +2434,61 @@ "com.amazonaws.fsx#FileSystem": { "type": "structure", "members": { + "OwnerId": { + "target": "com.amazonaws.fsx#AWSAccountId", + "traits": { + "smithy.api#documentation": "The AWS account that created the file system. If the file system was created by an AWS\n Identity and Access Management (IAM) user, the AWS account to which the IAM user belongs\n is the owner.
" + } + }, "CreationTime": { "target": "com.amazonaws.fsx#CreationTime", "traits": { "smithy.api#documentation": "The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z),\n also known as Unix time.
" } }, - "WindowsConfiguration": { - "target": "com.amazonaws.fsx#WindowsFileSystemConfiguration", + "FileSystemId": { + "target": "com.amazonaws.fsx#FileSystemId", "traits": { - "smithy.api#documentation": "The configuration for this Microsoft Windows file system.
" + "smithy.api#documentation": "The system-generated, unique 17-digit ID of the file system.
" } }, - "DNSName": { - "target": "com.amazonaws.fsx#DNSName", + "FileSystemType": { + "target": "com.amazonaws.fsx#FileSystemType", "traits": { - "smithy.api#documentation": "The DNS name for the file system.
" + "smithy.api#documentation": "The type of Amazon FSx file system, either LUSTRE
or WINDOWS
.
The Amazon Resource Name (ARN) for the file system resource.
" + "smithy.api#documentation": "The lifecycle status of the file system, following are the possible values and what they mean:
\n\n AVAILABLE
- The file system is in a healthy state, and is reachable and available for use.
\n CREATING
- Amazon FSx is creating the new file system.
\n DELETING
- Amazon FSx is deleting an existing file system.
\n FAILED
- An existing file system has experienced an unrecoverable failure. \n When creating a new file system, Amazon FSx was unable to create the file system.
\n MISCONFIGURED
indicates that the file system is in a failed but recoverable state.
\n UPDATING
indicates that the file system is undergoing a customer initiated update.
The type of Amazon FSx file system, either LUSTRE
or WINDOWS
.
The storage capacity of the file system in gigabytes (GB).
" } }, - "SubnetIds": { - "target": "com.amazonaws.fsx#SubnetIds", + "StorageType": { + "target": "com.amazonaws.fsx#StorageType", "traits": { - "smithy.api#documentation": "Specifies the IDs of the subnets that the file system is accessible from. For Windows MULTI_AZ_1
\n file system deployment type, there are two subnet IDs, one for the preferred file server \n and one for the standby file server. The preferred file server subnet identified in the \n PreferredSubnetID
property. All other file systems have only one subnet ID.
For Lustre file systems, and Single-AZ Windows file systems, this is the ID of \n the subnet that contains the endpoint for the file system. For MULTI_AZ_1
Windows file systems,\n the endpoint for the file system is available in the PreferredSubnetID
.
The storage type of the file system. \n Valid values are SSD
and HDD
.\n If set to SSD
, the file system uses solid state drive storage. \n If set to HDD
, the file system uses hard disk drive storage.\n
The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data\n for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file\n systems at rest. In either case, if not specified, the Amazon FSx managed key\n is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using\n Amazon FSx managed keys. For more information, see Encrypt\n in the AWS Key Management Service API Reference.
" + "smithy.api#documentation": "The ID of the primary VPC for the file system.
" } }, - "Lifecycle": { - "target": "com.amazonaws.fsx#FileSystemLifecycle", + "SubnetIds": { + "target": "com.amazonaws.fsx#SubnetIds", "traits": { - "smithy.api#documentation": "The lifecycle status of the file system, following are the possible values and what they mean:
\n\n AVAILABLE
- The file system is in a healthy state, and is reachable and available for use.
\n CREATING
- Amazon FSx is creating the new file system.
\n DELETING
- Amazon FSx is deleting an existing file system.
\n FAILED
- An existing file system has experienced an unrecoverable failure. \n When creating a new file system, Amazon FSx was unable to create the file system.
\n MISCONFIGURED
indicates that the file system is in a failed but recoverable state.
\n UPDATING
indicates that the file system is undergoing a customer initiated update.
Specifies the IDs of the subnets that the file system is accessible from. For Windows MULTI_AZ_1
\n file system deployment type, there are two subnet IDs, one for the preferred file server \n and one for the standby file server. The preferred file server subnet identified in the \n PreferredSubnetID
property. All other file systems have only one subnet ID.
For Lustre file systems, and Single-AZ Windows file systems, this is the ID of \n the subnet that contains the endpoint for the file system. For MULTI_AZ_1
Windows file systems,\n the endpoint for the file system is available in the PreferredSubnetID
.
The IDs of the elastic network interface from which a specific file system is\n accessible. The elastic network interface is automatically created in the same VPC that\n the Amazon FSx file system was created in. For more information, see Elastic Network\n Interfaces in the Amazon EC2 User Guide.\n
\n\nFor an Amazon FSx for Windows File Server file system, you can have one network\n interface ID. For an Amazon FSx for Lustre file system, you can have more than\n one.
" } }, - "VpcId": { - "target": "com.amazonaws.fsx#VpcId", + "DNSName": { + "target": "com.amazonaws.fsx#DNSName", "traits": { - "smithy.api#documentation": "The ID of the primary VPC for the file system.
" + "smithy.api#documentation": "The DNS name for the file system.
" } }, - "LustreConfiguration": { - "target": "com.amazonaws.fsx#LustreFileSystemConfiguration" - }, - "FailureDetails": { - "target": "com.amazonaws.fsx#FileSystemFailureDetails" - }, - "StorageType": { - "target": "com.amazonaws.fsx#StorageType", + "KmsKeyId": { + "target": "com.amazonaws.fsx#KmsKeyId", "traits": { - "smithy.api#documentation": "The storage type of the file system. \n Valid values are SSD
and HDD
.\n If set to SSD
, the file system uses solid state drive storage. \n If set to HDD
, the file system uses hard disk drive storage.\n
The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the file system's data\n for Amazon FSx for Windows File Server file systems and persistent Amazon FSx for Lustre file\n systems at rest. In either case, if not specified, the Amazon FSx managed key\n is used. The scratch Amazon FSx for Lustre file systems are always encrypted at rest using\n Amazon FSx managed keys. For more information, see Encrypt\n in the AWS Key Management Service API Reference.
" } }, - "OwnerId": { - "target": "com.amazonaws.fsx#AWSAccountId", + "ResourceARN": { + "target": "com.amazonaws.fsx#ResourceARN", "traits": { - "smithy.api#documentation": "The AWS account that created the file system. If the file system was created by an AWS\n Identity and Access Management (IAM) user, the AWS account to which the IAM user belongs\n is the owner.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the file system resource.
" } }, "Tags": { @@ -2198,23 +2521,20 @@ "smithy.api#documentation": "The tags to associate with the file system. For more information, see Tagging Your\n Amazon EC2 Resources in the Amazon EC2 User\n Guide.
" } }, - "StorageCapacity": { - "target": "com.amazonaws.fsx#StorageCapacity", + "WindowsConfiguration": { + "target": "com.amazonaws.fsx#WindowsFileSystemConfiguration", "traits": { - "smithy.api#documentation": "The storage capacity of the file system in gigabytes (GB).
" + "smithy.api#documentation": "The configuration for this Microsoft Windows file system.
" } }, + "LustreConfiguration": { + "target": "com.amazonaws.fsx#LustreFileSystemConfiguration" + }, "AdministrativeActions": { "target": "com.amazonaws.fsx#AdministrativeActions", "traits": { "smithy.api#documentation": "A list of administrative actions for the file system that are in process or waiting to be processed. \n Administrative actions describe changes to the Windows file system that you have initiated using the UpdateFileSystem
action.\n
The system-generated, unique 17-digit ID of the file system.
" - } } }, "traits": { @@ -2457,15 +2777,15 @@ "com.amazonaws.fsx#IncompatibleParameterError": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.fsx#ErrorMessage" - }, "Parameter": { "target": "com.amazonaws.fsx#Parameter", "traits": { "smithy.api#documentation": "A parameter that is incompatible with the earlier request.
", "smithy.api#required": {} } + }, + "Message": { + "target": "com.amazonaws.fsx#ErrorMessage" } }, "traits": { @@ -2512,12 +2832,12 @@ "com.amazonaws.fsx#InvalidNetworkSettings": { "type": "structure", "members": { - "InvalidSubnetId": { - "target": "com.amazonaws.fsx#SubnetId" - }, "Message": { "target": "com.amazonaws.fsx#ErrorMessage" }, + "InvalidSubnetId": { + "target": "com.amazonaws.fsx#SubnetId" + }, "InvalidSecurityGroupId": { "target": "com.amazonaws.fsx#SecurityGroupId" } @@ -2595,17 +2915,17 @@ "com.amazonaws.fsx#ListTagsForResourceRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.fsx#MaxResults", + "ResourceARN": { + "target": "com.amazonaws.fsx#ResourceARN", "traits": { - "smithy.api#documentation": "Maximum number of tags to return in the response (integer). This\n parameter value must be greater than 0. The number of items that Amazon FSx returns is\n the minimum of the MaxResults
parameter specified in the request and the\n service's internal maximum number of items per page.
The ARN of the Amazon FSx resource that will have its tags listed.
", + "smithy.api#required": {} } }, - "ResourceARN": { - "target": "com.amazonaws.fsx#ResourceARN", + "MaxResults": { + "target": "com.amazonaws.fsx#MaxResults", "traits": { - "smithy.api#documentation": "The ARN of the Amazon FSx resource that will have its tags listed.
", - "smithy.api#required": {} + "smithy.api#documentation": "Maximum number of tags to return in the response (integer). This\n parameter value must be greater than 0. The number of items that Amazon FSx returns is\n the minimum of the MaxResults
parameter specified in the request and the\n service's internal maximum number of items per page.
This is present if there are more tags than returned in the response (String). You\n can use the NextToken
value in the later request to fetch the tags.\n
A list of tags on the resource.
" } + }, + "NextToken": { + "target": "com.amazonaws.fsx#NextToken", + "traits": { + "smithy.api#documentation": "This is present if there are more tags than returned in the response (String). You\n can use the NextToken
value in the later request to fetch the tags.\n
A boolean flag indicating whether tags on the file system should be copied to backups.\n If it's set to true, all tags on the file system are\n copied to all automatic backups and any user-initiated backups where the user\n doesn't specify any tags. If this value is true, and you specify one or more tags,\n only the specified tags are copied to backups. If you specify one or more tags when \n creating a user-initiated backup, no tags are copied from the file system, \n regardless of this value. (Default = false)
" + "smithy.api#documentation": "The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
" } }, - "DailyAutomaticBackupStartTime": { - "target": "com.amazonaws.fsx#DailyTime" + "DataRepositoryConfiguration": { + "target": "com.amazonaws.fsx#DataRepositoryConfiguration" + }, + "DeploymentType": { + "target": "com.amazonaws.fsx#LustreDeploymentType", + "traits": { + "smithy.api#documentation": "The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage\n and shorter-term processing of data.
\n\n SCRATCH_1
and SCRATCH_2
deployment \n types are best suited for when you need temporary storage and shorter-term processing of data. \n The SCRATCH_2
deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1
.
The PERSISTENT_1
deployment type is used for longer-term storage \n and workloads and encryption of data in transit. To learn more about deployment types, see \n \n FSx for Lustre Deployment Options. (Default = SCRATCH_1
)
Per unit storage throughput represents the megabytes per second of read or write\n throughput per 1 tebibyte of storage provisioned. File system throughput capacity is\n equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is\n only valid for PERSISTENT_1
deployment types.
Valid values for SSD storage: 50, 100, 200. Valid values for HDD storage: 12, 40.
" } }, - "AutomaticBackupRetentionDays": { - "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays" - }, - "DataRepositoryConfiguration": { - "target": "com.amazonaws.fsx#DataRepositoryConfiguration" - }, "MountName": { "target": "com.amazonaws.fsx#LustreFileSystemMountName", "traits": { "smithy.api#documentation": "You use the MountName
value when mounting the file system.
For the SCRATCH_1
deployment type, this value is always \"fsx
\". \n For SCRATCH_2
and PERSISTENT_1
deployment types, this \n value is a string that is unique within an AWS Region. \n \n
The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage\n and shorter-term processing of data.
\n\n SCRATCH_1
and SCRATCH_2
deployment \n types are best suited for when you need temporary storage and shorter-term processing of data. \n The SCRATCH_2
deployment type provides in-transit encryption of data and higher burst \n throughput capacity than SCRATCH_1
.
The PERSISTENT_1
deployment type is used for longer-term storage \n and workloads and encryption of data in transit. To learn more about deployment types, see \n \n FSx for Lustre Deployment Options. (Default = SCRATCH_1
)
A boolean flag indicating whether tags on the file system should be copied to backups.\n If it's set to true, all tags on the file system are\n copied to all automatic backups and any user-initiated backups where the user\n doesn't specify any tags. If this value is true, and you specify one or more tags,\n only the specified tags are copied to backups. If you specify one or more tags when \n creating a user-initiated backup, no tags are copied from the file system, \n regardless of this value. (Default = false)
" } }, "DriveCacheType": { @@ -2699,12 +3025,6 @@ "traits": { "smithy.api#documentation": "The type of drive cache used by PERSISTENT_1 file systems that are provisioned with\n HDD storage devices. This parameter is required when storage type is HDD. Set to\n READ
, improve the performance for frequently accessed files and allows 20%\n of the total storage capacity of the file system to be cached.
This parameter is required when StorageType
is set to HDD.
The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
" - } } }, "traits": { @@ -2917,15 +3237,15 @@ "com.amazonaws.fsx#ResourceNotFound": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.fsx#ErrorMessage" - }, "ResourceARN": { "target": "com.amazonaws.fsx#ResourceARN", "traits": { "smithy.api#documentation": "The resource ARN of the resource that can't be found.
", "smithy.api#required": {} } + }, + "Message": { + "target": "com.amazonaws.fsx#ErrorMessage" } }, "traits": { @@ -2960,16 +3280,10 @@ "com.amazonaws.fsx#SelfManagedActiveDirectoryAttributes": { "type": "structure", "members": { - "FileSystemAdministratorsGroup": { - "target": "com.amazonaws.fsx#FileSystemAdministratorsGroupName", - "traits": { - "smithy.api#documentation": "The name of the domain group whose members have administrative privileges for the FSx\n file system.
" - } - }, - "UserName": { - "target": "com.amazonaws.fsx#DirectoryUserName", + "DomainName": { + "target": "com.amazonaws.fsx#ActiveDirectoryFullyQualifiedName", "traits": { - "smithy.api#documentation": "The user name for the service account on your self-managed AD domain that FSx uses to\n join to your AD domain.
" + "smithy.api#documentation": "The fully qualified domain name of the self-managed AD directory.
" } }, "OrganizationalUnitDistinguishedName": { @@ -2978,10 +3292,16 @@ "smithy.api#documentation": "The fully qualified distinguished name of the organizational unit within the\n self-managed AD directory to which the Windows File Server instance is joined.
" } }, - "DomainName": { - "target": "com.amazonaws.fsx#ActiveDirectoryFullyQualifiedName", + "FileSystemAdministratorsGroup": { + "target": "com.amazonaws.fsx#FileSystemAdministratorsGroupName", "traits": { - "smithy.api#documentation": "The fully qualified domain name of the self-managed AD directory.
" + "smithy.api#documentation": "The name of the domain group whose members have administrative privileges for the FSx\n file system.
" + } + }, + "UserName": { + "target": "com.amazonaws.fsx#DirectoryUserName", + "traits": { + "smithy.api#documentation": "The user name for the service account on your self-managed AD domain that FSx uses to\n join to your AD domain.
" } }, "DnsIps": { @@ -2998,23 +3318,29 @@ "com.amazonaws.fsx#SelfManagedActiveDirectoryConfiguration": { "type": "structure", "members": { + "DomainName": { + "target": "com.amazonaws.fsx#ActiveDirectoryFullyQualifiedName", + "traits": { + "smithy.api#documentation": "The fully qualified domain name of the self-managed AD directory, such as\n corp.example.com
.
(Optional) The fully qualified distinguished name of the organizational unit within\n your self-managed AD directory that the Windows File Server instance will join. Amazon\n FSx only accepts OU as the direct parent of the file system. An example is\n OU=FSx,DC=yourdomain,DC=corp,DC=com
. To learn more, see RFC 2253. If none is provided, the\n FSx file system is created in the default location of your self-managed AD directory.
Only Organizational Unit (OU) objects can be the direct parent of the file system\n that you're creating.
\nThe fully qualified domain name of the self-managed AD directory, such as\n corp.example.com
.
(Optional) The name of the domain group whose members are granted administrative\n privileges for the file system. Administrative privileges include taking ownership of\n files and folders, setting audit controls (audit ACLs) on files and folders, and \n administering the file system remotely by using the FSx Remote PowerShell.\n The group that you specify must already exist in your domain. If you don't provide one,\n your AD domain's Domain Admins group is used.
" } }, - "DnsIps": { - "target": "com.amazonaws.fsx#DnsIps", + "UserName": { + "target": "com.amazonaws.fsx#DirectoryUserName", "traits": { - "smithy.api#documentation": "A list of up to two IP addresses of DNS servers or domain controllers in the\n self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range\n as the one in which your Amazon FSx file system is being created, or in the private IP version 4\n (IPv4) address ranges, as specified in RFC 1918:
\n10.0.0.0 - 10.255.255.255 (10/8 prefix)
\n172.16.0.0 - 172.31.255.255 (172.16/12 prefix)
\n192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
\nThe user name for the service account on your self-managed AD domain that Amazon FSx\n will use to join to your AD domain. This account must have the permission to join\n computers to the domain in the organizational unit provided in\n OrganizationalUnitDistinguishedName
, or in the default location of your\n AD domain.
(Optional) The name of the domain group whose members are granted administrative\n privileges for the file system. Administrative privileges include taking ownership of\n files and folders, setting audit controls (audit ACLs) on files and folders, and \n administering the file system remotely by using the FSx Remote PowerShell.\n The group that you specify must already exist in your domain. If you don't provide one,\n your AD domain's Domain Admins group is used.
" - } - }, - "UserName": { - "target": "com.amazonaws.fsx#DirectoryUserName", + "DnsIps": { + "target": "com.amazonaws.fsx#DnsIps", "traits": { - "smithy.api#documentation": "The user name for the service account on your self-managed AD domain that Amazon FSx\n will use to join to your AD domain. This account must have the permission to join\n computers to the domain in the organizational unit provided in\n OrganizationalUnitDistinguishedName
, or in the default location of your\n AD domain.
A list of up to two IP addresses of DNS servers or domain controllers in the\n self-managed AD directory. The IP addresses need to be either in the same VPC CIDR range\n as the one in which your Amazon FSx file system is being created, or in the private IP version 4\n (IPv4) address ranges, as specified in RFC 1918:
\n10.0.0.0 - 10.255.255.255 (10/8 prefix)
\n172.16.0.0 - 172.31.255.255 (172.16/12 prefix)
\n192.168.0.0 - 192.168.255.255 (192.168/16 prefix)
\nA list of up to two IP addresses of DNS servers or domain controllers in the\n self-managed AD directory.
" + "smithy.api#documentation": "The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to\n your AD domain. This account must have the permission to join\n computers to the domain in the organizational unit provided in\n OrganizationalUnitDistinguishedName
.
The password for the service account on your self-managed AD domain that Amazon FSx will use to join to\n your AD domain.
" } }, - "UserName": { - "target": "com.amazonaws.fsx#DirectoryUserName", + "DnsIps": { + "target": "com.amazonaws.fsx#DnsIps", "traits": { - "smithy.api#documentation": "The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to\n your AD domain. This account must have the permission to join\n computers to the domain in the organizational unit provided in\n OrganizationalUnitDistinguishedName
.
A list of up to two IP addresses of DNS servers or domain controllers in the\n self-managed AD directory.
" } } }, @@ -3202,17 +3522,17 @@ "com.amazonaws.fsx#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.fsx#TagValue", + "Key": { + "target": "com.amazonaws.fsx#TagKey", "traits": { - "smithy.api#documentation": "A value that specifies the TagValue
, the value assigned to the\n corresponding tag key. Tag values can be null and don't have to be unique in a tag set.\n For example, you can have a key-value pair in a tag set of finances : April
\n and also of payroll : April
.
A value that specifies the TagKey
, the name of the tag. Tag keys must\n be unique for the resource to which they are attached.
A value that specifies the TagKey
, the name of the tag. Tag keys must\n be unique for the resource to which they are attached.
A value that specifies the TagValue
, the value assigned to the\n corresponding tag key. Tag values can be null and don't have to be unique in a tag set.\n For example, you can have a key-value pair in a tag set of finances : April
\n and also of payroll : April
.
(Optional) When you create your file system, your existing S3 objects appear as file and directory listings. \n Use this property to choose how Amazon FSx keeps your file and directory listing up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy
can\n have the following values:
\n NONE
- (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update the file and directory \n listing for any new or changed objects after choosing this option.
\n NEW
- AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.
\n NEW_CHANGED
- AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option. \n
For more information, see Automatically import updates from your S3 bucket.
" - } - }, - "DailyAutomaticBackupStartTime": { - "target": "com.amazonaws.fsx#DailyTime" - }, "WeeklyMaintenanceStartTime": { "target": "com.amazonaws.fsx#WeeklyTime", "traits": { "smithy.api#documentation": "(Optional) The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
" } }, + "DailyAutomaticBackupStartTime": { + "target": "com.amazonaws.fsx#DailyTime" + }, "AutomaticBackupRetentionDays": { "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays" + }, + "AutoImportPolicy": { + "target": "com.amazonaws.fsx#AutoImportPolicyType", + "traits": { + "smithy.api#documentation": " (Optional) When you create your file system, your existing S3 objects appear as file and directory listings. \n Use this property to choose how Amazon FSx keeps your file and directory listing up to date \n as you add or modify objects in your linked S3 bucket. AutoImportPolicy
can\n have the following values:
\n NONE
- (Default) AutoImport is off. Amazon FSx only updates \n file and directory listings from the linked S3 bucket \n when the file system is created. FSx does not update the file and directory \n listing for any new or changed objects after choosing this option.
\n NEW
- AutoImport is on. Amazon FSx automatically imports\n directory listings of any new objects added to the linked S3 bucket that \n do not currently exist in the FSx file system.
\n NEW_CHANGED
- AutoImport is on. Amazon FSx automatically imports \n file and directory listings of any new objects added to the S3 bucket and any \n existing objects that are changed in the S3 bucket after you choose this option. \n
For more information, see Automatically import updates from your S3 bucket.
" + } } }, "traits": { @@ -3491,12 +3811,6 @@ "com.amazonaws.fsx#UpdateFileSystemRequest": { "type": "structure", "members": { - "WindowsConfiguration": { - "target": "com.amazonaws.fsx#UpdateFileSystemWindowsConfiguration", - "traits": { - "smithy.api#documentation": "The configuration updates for an Amazon FSx for Windows File Server file system.
" - } - }, "FileSystemId": { "target": "com.amazonaws.fsx#FileSystemId", "traits": { @@ -3504,9 +3818,6 @@ "smithy.api#required": {} } }, - "LustreConfiguration": { - "target": "com.amazonaws.fsx#UpdateFileSystemLustreConfiguration" - }, "ClientRequestToken": { "target": "com.amazonaws.fsx#ClientRequestToken", "traits": { @@ -3519,6 +3830,15 @@ "traits": { "smithy.api#documentation": "Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server file system. \n Specifies the storage capacity target value, GiB, for the file system you're updating. \n The storage capacity target value must be at least 10 percent (%) greater than the current storage capacity value.\n In order to increase storage capacity, the file system needs to have at least 16 MB/s of throughput capacity. You cannot \n make a storage capacity increase request if there is an existing storage capacity increase request in progress. \n For more information, see \n Managing Storage Capacity.
" } + }, + "WindowsConfiguration": { + "target": "com.amazonaws.fsx#UpdateFileSystemWindowsConfiguration", + "traits": { + "smithy.api#documentation": "The configuration updates for an Amazon FSx for Windows File Server file system.
" + } + }, + "LustreConfiguration": { + "target": "com.amazonaws.fsx#UpdateFileSystemLustreConfiguration" } }, "traits": { @@ -3542,30 +3862,30 @@ "com.amazonaws.fsx#UpdateFileSystemWindowsConfiguration": { "type": "structure", "members": { - "AutomaticBackupRetentionDays": { - "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays", - "traits": { - "smithy.api#documentation": "The number of days to retain automatic daily backups. Setting this to zero (0) disables automatic daily\n backups. You can retain automatic daily backups for a maximum of 90 days. For more information, see\n Working with Automatic Daily Backups.
" - } - }, "WeeklyMaintenanceStartTime": { "target": "com.amazonaws.fsx#WeeklyTime", "traits": { "smithy.api#documentation": "The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. Where d is the weekday number, from 1 through 7, with 1 = Monday and 7 = Sunday.
" } }, - "ThroughputCapacity": { - "target": "com.amazonaws.fsx#MegabytesPerSecond", - "traits": { - "smithy.api#documentation": "Sets the target value for a file system's throughput capacity, in MB/s, that you are updating the file system to. Valid values are \n 8, 16, 32, 64, 128, 256, 512, 1024, 2048. You cannot make a throughput capacity update request if there is an existing throughput capacity update request in progress. For more information, \n see Managing Throughput Capacity.
" - } - }, "DailyAutomaticBackupStartTime": { "target": "com.amazonaws.fsx#DailyTime", "traits": { "smithy.api#documentation": "The preferred time to start the daily automatic backup, in the UTC time zone, for example, 02:00
\n
The number of days to retain automatic daily backups. Setting this to zero (0) disables automatic daily\n backups. You can retain automatic daily backups for a maximum of 90 days. For more information, see\n Working with Automatic Daily Backups.
" + } + }, + "ThroughputCapacity": { + "target": "com.amazonaws.fsx#MegabytesPerSecond", + "traits": { + "smithy.api#documentation": "Sets the target value for a file system's throughput capacity, in MB/s, that you are updating the file system to. Valid values are \n 8, 16, 32, 64, 128, 256, 512, 1024, 2048. You cannot make a throughput capacity update request if there is an existing throughput capacity update request in progress. For more information, \n see Managing Throughput Capacity.
" + } + }, "SelfManagedActiveDirectoryConfiguration": { "target": "com.amazonaws.fsx#SelfManagedActiveDirectoryConfigurationUpdates", "traits": { @@ -3627,10 +3947,19 @@ "smithy.api#documentation": "The ID for an existing Microsoft Active Directory instance that the file system should join when\n it's created.
" } }, - "AutomaticBackupRetentionDays": { - "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays", + "SelfManagedActiveDirectoryConfiguration": { + "target": "com.amazonaws.fsx#SelfManagedActiveDirectoryAttributes" + }, + "DeploymentType": { + "target": "com.amazonaws.fsx#WindowsDeploymentType", "traits": { - "smithy.api#documentation": "The number of days to retain automatic backups. Setting this to 0 disables automatic\n backups. You can retain automatic backups for a maximum of 90 days.
" + "smithy.api#documentation": "Specifies the file system deployment type, valid values are the following:
\n\n MULTI_AZ_1
- Specifies a high availability file system that is configured for Multi-AZ \n redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.
\n SINGLE_AZ_1
- (Default) Specifies a file system that is configured for single AZ redundancy, \n only supports SSD storage.
\n SINGLE_AZ_2
- Latest generation Single AZ file system. \n Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.
For more information, see \n Single-AZ and Multi-AZ File Systems.
" + } + }, + "RemoteAdministrationEndpoint": { + "target": "com.amazonaws.fsx#DNSName", + "traits": { + "smithy.api#documentation": "For MULTI_AZ_1
deployment types, use this endpoint when performing administrative tasks on the file system using \n Amazon FSx Remote PowerShell.
For SINGLE_AZ_1
and SINGLE_AZ_2
deployment types, this is the DNS name of the file system.
This endpoint is temporarily unavailable when the file system is undergoing maintenance.
" } }, "PreferredSubnetId": { @@ -3639,10 +3968,10 @@ "smithy.api#documentation": "For MULTI_AZ_1
deployment types, it specifies the ID of the subnet where the preferred file server is located. \n Must be one of the two subnet IDs specified in SubnetIds
property.\n Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server.
For SINGLE_AZ_1
and SINGLE_AZ_2
deployment types, this value is the same as that for SubnetIDs
.\n For more information, see \n Availability and Durability: Single-AZ and Multi-AZ File Systems\n
A boolean flag indicating whether tags on the file system should be copied to backups.\n This value defaults to false. If it's set to true, all tags on the file system are\n copied to all automatic backups and any user-initiated backups where the user\n doesn't specify any tags. If this value is true, and you specify one or more tags,\n only the specified tags are copied to backups. If you specify one or more tags when \n creating a user-initiated backup, no tags are copied from the file system, \n regardless of this value.
" + "smithy.api#documentation": "For MULTI_AZ_1
deployment types, the IP address of the primary, or preferred, file server.
Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that \n are not joined to a Microsoft Active Directory. \n Applicable for all Windows file system deployment types. \n This IP address is temporarily unavailable \n when the file system is undergoing maintenance. For Linux and Windows \n SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information\n on mapping and mounting file shares, see \n Accessing File Shares.
" } }, "ThroughputCapacity": { @@ -3651,18 +3980,6 @@ "smithy.api#documentation": "The throughput of an Amazon FSx file system, measured in megabytes per\n second.
" } }, - "RemoteAdministrationEndpoint": { - "target": "com.amazonaws.fsx#DNSName", - "traits": { - "smithy.api#documentation": "For MULTI_AZ_1
deployment types, use this endpoint when performing administrative tasks on the file system using \n Amazon FSx Remote PowerShell.
For SINGLE_AZ_1
and SINGLE_AZ_2
deployment types, this is the DNS name of the file system.
This endpoint is temporarily unavailable when the file system is undergoing maintenance.
" - } - }, - "DailyAutomaticBackupStartTime": { - "target": "com.amazonaws.fsx#DailyTime", - "traits": { - "smithy.api#documentation": "The preferred time to take daily automatic backups, in the UTC time zone.
" - } - }, "MaintenanceOperationsInProgress": { "target": "com.amazonaws.fsx#FileSystemMaintenanceOperations", "traits": { @@ -3675,20 +3992,26 @@ "smithy.api#documentation": "The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC\n time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.
" } }, - "DeploymentType": { - "target": "com.amazonaws.fsx#WindowsDeploymentType", + "DailyAutomaticBackupStartTime": { + "target": "com.amazonaws.fsx#DailyTime", "traits": { - "smithy.api#documentation": "Specifies the file system deployment type, valid values are the following:
\n\n MULTI_AZ_1
- Specifies a high availability file system that is configured for Multi-AZ \n redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage.
\n SINGLE_AZ_1
- (Default) Specifies a file system that is configured for single AZ redundancy, \n only supports SSD storage.
\n SINGLE_AZ_2
- Latest generation Single AZ file system. \n Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage.
For more information, see \n Single-AZ and Multi-AZ File Systems.
" + "smithy.api#documentation": "The preferred time to take daily automatic backups, in the UTC time zone.
" } }, - "SelfManagedActiveDirectoryConfiguration": { - "target": "com.amazonaws.fsx#SelfManagedActiveDirectoryAttributes" + "AutomaticBackupRetentionDays": { + "target": "com.amazonaws.fsx#AutomaticBackupRetentionDays", + "traits": { + "smithy.api#documentation": "The number of days to retain automatic backups. Setting this to 0 disables automatic\n backups. You can retain automatic backups for a maximum of 90 days.
" + } }, - "PreferredFileServerIp": { - "target": "com.amazonaws.fsx#IpAddress", + "CopyTagsToBackups": { + "target": "com.amazonaws.fsx#Flag", "traits": { - "smithy.api#documentation": "For MULTI_AZ_1
deployment types, the IP address of the primary, or preferred, file server.
Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that \n are not joined to a Microsoft Active Directory. \n Applicable for all Windows file system deployment types. \n This IP address is temporarily unavailable \n when the file system is undergoing maintenance. For Linux and Windows \n SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information\n on mapping and mounting file shares, see \n Accessing File Shares.
" + "smithy.api#documentation": "A boolean flag indicating whether tags on the file system should be copied to backups.\n This value defaults to false. If it's set to true, all tags on the file system are\n copied to all automatic backups and any user-initiated backups where the user\n doesn't specify any tags. If this value is true, and you specify one or more tags,\n only the specified tags are copied to backups. If you specify one or more tags when \n creating a user-initiated backup, no tags are copied from the file system, \n regardless of this value.
" } + }, + "Aliases": { + "target": "com.amazonaws.fsx#Aliases" } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/iotanalytics.2017-11-27.json b/codegen/sdk-codegen/aws-models/iotanalytics.2017-11-27.json index ad347e6aa2b8..e3fe16b2de2d 100644 --- a/codegen/sdk-codegen/aws-models/iotanalytics.2017-11-27.json +++ b/codegen/sdk-codegen/aws-models/iotanalytics.2017-11-27.json @@ -173,10 +173,17 @@ "com.amazonaws.iotanalytics#AddAttributesActivity": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.iotanalytics#ActivityName", + "traits": { + "smithy.api#documentation": "The name of the addAttributes activity.
", + "smithy.api#required": {} + } + }, "attributes": { "target": "com.amazonaws.iotanalytics#AttributeNameMapping", "traits": { - "smithy.api#documentation": "A list of 1-50 \"AttributeNameMapping\"\n objects that map an existing attribute to a new attribute.
\nThe existing attributes remain in the message,\n so if you want to remove the originals,\n use \"RemoveAttributeActivity\".
\nA list of 1-50 AttributeNameMapping
objects that map an existing attribute\n to a new attribute.
The existing attributes remain in the message, so if you want to remove the originals, use\n RemoveAttributeActivity
.
The next activity in the pipeline.
" } - }, - "name": { - "target": "com.amazonaws.iotanalytics#ActivityName", - "traits": { - "smithy.api#documentation": "The name of the 'addAttributes' activity.
", - "smithy.api#required": {} - } } }, "traits": { @@ -277,16 +277,10 @@ "com.amazonaws.iotanalytics#BatchPutMessageErrorEntry": { "type": "structure", "members": { - "errorMessage": { - "target": "com.amazonaws.iotanalytics#ErrorMessage", - "traits": { - "smithy.api#documentation": "The message associated with the error.
" - } - }, "messageId": { "target": "com.amazonaws.iotanalytics#MessageId", "traits": { - "smithy.api#documentation": "The ID of the message that caused the error. (See the value corresponding to the \n \"messageId\" key in the message object.)
" + "smithy.api#documentation": "The ID of the message that caused the error. See the value corresponding to the\n messageId
key in the message object.
The code associated with the error.
" } + }, + "errorMessage": { + "target": "com.amazonaws.iotanalytics#ErrorMessage", + "traits": { + "smithy.api#documentation": "The message associated with the error.
" + } } }, "traits": { @@ -313,7 +313,7 @@ "messages": { "target": "com.amazonaws.iotanalytics#Messages", "traits": { - "smithy.api#documentation": "The list of messages to be sent. Each message has format:\n '{ \"messageId\": \"string\", \"payload\": \"string\"}'.
\nNote that the field names of message payloads (data) that you send to AWS IoT Analytics:
\nMust contain only alphanumeric characters and undescores (_); no other special \n characters are allowed.
\nMust begin with an alphabetic character or single underscore (_).
\nCannot contain hyphens (-).
\nIn regular expression terms: \"^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$\".\n
\nCannot be greater than 255 characters.
\nAre case-insensitive. (Fields named \"foo\" and \"FOO\" in the same payload are \n considered duplicates.)
\nFor example, {\"temp_01\": 29} or {\"_temp_01\": 29} are valid, but {\"temp-01\": 29},\n {\"01_temp\": 29} or {\"__temp_01\": 29} are invalid in message payloads.
", + "smithy.api#documentation": "The list of messages to be sent. Each message has the format: { \"messageId\": \"string\",\n \"payload\": \"string\"}.
\nThe field names of message payloads (data) that you send to AWS IoT Analytics:
\nMust contain only alphanumeric characters and undescores (_). No other special characters are\n allowed.
\nMust begin with an alphabetic character or single underscore (_).
\nCannot contain hyphens (-).
\nIn regular expression terms: \"^[A-Za-z_]([A-Za-z0-9]*|[A-Za-z0-9][A-Za-z0-9_]*)$\".\n
\nCannot be more than 255 characters.
\nAre case insensitive. (Fields named foo and FOO in the same payload are considered\n duplicates.)
\nFor example, {\"temp_01\": 29} or {\"_temp_01\": 29} are valid, but {\"temp-01\": 29},\n {\"01_temp\": 29} or {\"__temp_01\": 29} are invalid in message payloads.
", "smithy.api#required": {} } } @@ -398,7 +398,7 @@ "reprocessingId": { "target": "com.amazonaws.iotanalytics#ReprocessingId", "traits": { - "smithy.api#documentation": "The ID of the reprocessing task (returned by \"StartPipelineReprocessing\").
", + "smithy.api#documentation": "The ID of the reprocessing task (returned by\n StartPipelineReprocessing
).
The ARN of the channel.
" + "smithy.api#documentation": "The name of the channel.
" } }, "storage": { "target": "com.amazonaws.iotanalytics#ChannelStorage", "traits": { - "smithy.api#documentation": "Where channel data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" \n storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after creation\n of the channel.
" + "smithy.api#documentation": "Where channel data is stored. You can choose one of serviceManagedS3
or\n customerManagedS3
storage. If not specified, the default is\n serviceManagedS3
. You cannot change this storage option after the channel is\n created.
When the channel was last updated.
" + "smithy.api#documentation": "The ARN of the channel.
" } }, - "name": { - "target": "com.amazonaws.iotanalytics#ChannelName", + "status": { + "target": "com.amazonaws.iotanalytics#ChannelStatus", "traits": { - "smithy.api#documentation": "The name of the channel.
" + "smithy.api#documentation": "The status of the channel.
" } }, "retentionPeriod": { @@ -442,16 +442,22 @@ "smithy.api#documentation": "How long, in days, message data is kept for the channel.
" } }, - "status": { - "target": "com.amazonaws.iotanalytics#ChannelStatus", + "creationTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "The status of the channel.
" + "smithy.api#documentation": "When the channel was created.
" } }, - "creationTime": { + "lastUpdateTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "When the channel was created.
" + "smithy.api#documentation": "When the channel was last updated.
" + } + }, + "lastMessageArrivalTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", + "traits": { + "smithy.api#documentation": "The last time when a new message arrived in the channel.
\nAWS IoT Analytics updates this value at most once per minute for one channel. \n Hence, the lastMessageArrivalTime
value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
" } } }, @@ -462,6 +468,13 @@ "com.amazonaws.iotanalytics#ChannelActivity": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.iotanalytics#ActivityName", + "traits": { + "smithy.api#documentation": "The name of the channel activity.
", + "smithy.api#required": {} + } + }, "channelName": { "target": "com.amazonaws.iotanalytics#ChannelName", "traits": { @@ -474,13 +487,6 @@ "traits": { "smithy.api#documentation": "The next activity in the pipeline.
" } - }, - "name": { - "target": "com.amazonaws.iotanalytics#ActivityName", - "traits": { - "smithy.api#documentation": "The name of the 'channel' activity.
", - "smithy.api#required": {} - } } }, "traits": { @@ -539,18 +545,18 @@ "serviceManagedS3": { "target": "com.amazonaws.iotanalytics#ServiceManagedChannelS3Storage", "traits": { - "smithy.api#documentation": "Use this to store channel data in an S3 bucket managed by the AWS IoT Analytics service.\n The choice of service-managed or customer-managed S3 storage cannot be changed after creation\n of the channel.
" + "smithy.api#documentation": "Use this to store channel data in an S3 bucket managed by AWS IoT Analytics. You cannot\n change the choice of service-managed or customer-managed S3 storage after the channel is\n created.
" } }, "customerManagedS3": { "target": "com.amazonaws.iotanalytics#CustomerManagedChannelS3Storage", "traits": { - "smithy.api#documentation": "Use this to store channel data in an S3 bucket that you manage. If customer managed storage is \n selected, the \"retentionPeriod\" parameter is ignored. The choice of service-managed or customer-managed \n S3 storage cannot be changed after creation of the channel.
" + "smithy.api#documentation": "Use this to store channel data in an S3 bucket that you manage. If customer managed\n storage is selected, the retentionPeriod
parameter is ignored. You cannot change\n the choice of service-managed or customer-managed S3 storage after the channel is\n created.
Where channel data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" \n storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after creation\n of the channel.
" + "smithy.api#documentation": "Where channel data is stored. You may choose one of serviceManagedS3
or\n customerManagedS3
storage. If not specified, the default is\n serviceManagedS3
. This cannot be changed after creation of the channel.
Used to store channel data in an S3 bucket managed by the AWS IoT Analytics service.
" + "smithy.api#documentation": "Used to store channel data in an S3 bucket managed by AWS IoT Analytics.
" } }, "customerManagedS3": { @@ -582,10 +588,10 @@ "com.amazonaws.iotanalytics#ChannelSummary": { "type": "structure", "members": { - "creationTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", + "channelName": { + "target": "com.amazonaws.iotanalytics#ChannelName", "traits": { - "smithy.api#documentation": "When the channel was created.
" + "smithy.api#documentation": "The name of the channel.
" } }, "channelStorage": { @@ -594,23 +600,29 @@ "smithy.api#documentation": "Where channel data is stored.
" } }, - "channelName": { - "target": "com.amazonaws.iotanalytics#ChannelName", - "traits": { - "smithy.api#documentation": "The name of the channel.
" - } - }, "status": { "target": "com.amazonaws.iotanalytics#ChannelStatus", "traits": { "smithy.api#documentation": "The status of the channel.
" } }, + "creationTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", + "traits": { + "smithy.api#documentation": "When the channel was created.
" + } + }, "lastUpdateTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { "smithy.api#documentation": "The last time the channel was updated.
" } + }, + "lastMessageArrivalTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", + "traits": { + "smithy.api#documentation": "The last time when a new message arrived in the channel.
\nAWS IoT Analytics updates this value at most once per minute for one channel. \n Hence, the lastMessageArrivalTime
value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
" + } } }, "traits": { @@ -635,36 +647,36 @@ "com.amazonaws.iotanalytics#ContainerDatasetAction": { "type": "structure", "members": { - "variables": { - "target": "com.amazonaws.iotanalytics#Variables", + "image": { + "target": "com.amazonaws.iotanalytics#Image", "traits": { - "smithy.api#documentation": "The values of variables used within the context of the execution of the containerized\n application (basically, parameters passed to the application). Each variable must have a\n name and a value given by one of \"stringValue\", \"datasetContentVersionValue\",\n or \"outputFileUriValue\".
" + "smithy.api#documentation": "The ARN of the Docker container stored in your account. The Docker container contains an\n application and required support libraries and is used to generate dataset contents.
", + "smithy.api#required": {} } }, - "resourceConfiguration": { - "target": "com.amazonaws.iotanalytics#ResourceConfiguration", + "executionRoleArn": { + "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "Configuration of the resource which executes the \"containerAction\".
", + "smithy.api#documentation": "The ARN of the role that gives permission to the system to access required resources to\n run the containerAction
. This includes, at minimum, permission to retrieve the\n dataset contents that are the input to the containerized application.
The ARN of the Docker container stored in your account. The Docker container contains an\n application and needed support libraries and is used to generate data set contents.
", + "smithy.api#documentation": "Configuration of the resource that executes the containerAction
.
The ARN of the role which gives permission to the system to access needed resources in order\n to run the \"containerAction\". This includes, at minimum, permission to retrieve the data set\n contents which are the input to the containerized application.
", - "smithy.api#required": {} + "smithy.api#documentation": "The values of variables used in the context of the execution of the containerized\n application (basically, parameters passed to the application). Each variable must have a name\n and a value given by one of stringValue
, datasetContentVersionValue
,\n or outputFileUriValue
.
Information needed to run the \"containerAction\" to produce data set contents.
" + "smithy.api#documentation": "Information required to run the containerAction
to produce dataset\n contents.
How long, in days, message data is kept for the channel. When \"customerManagedS3\" storage is \n selected, this parameter is ignored.
" - } - }, - "tags": { - "target": "com.amazonaws.iotanalytics#TagList", - "traits": { - "smithy.api#documentation": "Metadata which can be used to manage the channel.
" - } - }, "channelName": { "target": "com.amazonaws.iotanalytics#ChannelName", "traits": { @@ -729,7 +729,19 @@ "channelStorage": { "target": "com.amazonaws.iotanalytics#ChannelStorage", "traits": { - "smithy.api#documentation": "Where channel data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" \n storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after creation\n of the channel.
" + "smithy.api#documentation": "Where channel data is stored. You can choose one of serviceManagedS3
or\n customerManagedS3
storage. If not specified, the default is\n serviceManagedS3
. You cannot change this storage option after the channel is\n created.
How long, in days, message data is kept for the channel. When\n customerManagedS3
storage is selected, this parameter is ignored.
Metadata which can be used to manage the channel.
" } } } @@ -737,6 +749,12 @@ "com.amazonaws.iotanalytics#CreateChannelResponse": { "type": "structure", "members": { + "channelName": { + "target": "com.amazonaws.iotanalytics#ChannelName", + "traits": { + "smithy.api#documentation": "The name of the channel.
" + } + }, "channelArn": { "target": "com.amazonaws.iotanalytics#ChannelArn", "traits": { @@ -748,12 +766,6 @@ "traits": { "smithy.api#documentation": "How long, in days, message data is kept for the channel.
" } - }, - "channelName": { - "target": "com.amazonaws.iotanalytics#ChannelName", - "traits": { - "smithy.api#documentation": "The name of the channel.
" - } } } }, @@ -786,7 +798,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a data set. A data set stores data retrieved from a data store by applying a\n \"queryAction\" (a SQL query) or a \"containerAction\" (executing a containerized application).\n This operation creates the skeleton of a data set. The data set can be populated manually\n by calling \"CreateDatasetContent\" or automatically according to a \"trigger\" you specify.
", + "smithy.api#documentation": "Creates a dataset. A dataset stores data retrieved from a data store by applying a\n queryAction
(a SQL query) or a containerAction
(executing a\n containerized application). This operation creates the skeleton of a dataset. The dataset can\n be populated manually by calling CreateDatasetContent
or automatically according\n to a trigger you specify.
Creates the content of a data set by applying a \"queryAction\" (a SQL query) or a \"containerAction\" \n (executing a containerized application).
", + "smithy.api#documentation": "Creates the content of a data set by applying a queryAction
(a SQL query)\n or a containerAction
(executing a containerized application).
The name of the data set.
", + "smithy.api#documentation": "The name of the dataset.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "versionId": { + "target": "com.amazonaws.iotanalytics#DatasetContentVersion", + "traits": { + "smithy.api#documentation": "The version ID of the dataset content. To specify versionId
for a dataset\n content, the dataset must use a DeltaTimer filter.
The version ID of the data set contents which are being created.
" + "smithy.api#documentation": "The version ID of the dataset contents that are being created.
" } } } @@ -855,48 +873,54 @@ "com.amazonaws.iotanalytics#CreateDatasetRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.iotanalytics#TagList", + "datasetName": { + "target": "com.amazonaws.iotanalytics#DatasetName", "traits": { - "smithy.api#documentation": "Metadata which can be used to manage the data set.
" + "smithy.api#documentation": "The name of the data set.
", + "smithy.api#required": {} } }, - "versioningConfiguration": { - "target": "com.amazonaws.iotanalytics#VersioningConfiguration", + "actions": { + "target": "com.amazonaws.iotanalytics#DatasetActions", "traits": { - "smithy.api#documentation": "[Optional] How many versions of data set contents are kept. If not specified or set to null, only the \n latest version plus the latest succeeded version (if they are different) are kept for \n the time period specified by the \"retentionPeriod\" parameter. (For more information, see\n https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
" + "smithy.api#documentation": "A list of actions that create the data set contents.
", + "smithy.api#required": {} + } + }, + "triggers": { + "target": "com.amazonaws.iotanalytics#DatasetTriggers", + "traits": { + "smithy.api#documentation": "A list of triggers. A trigger causes data set contents to be populated at a specified\n time interval or when another data set's contents are created. The list of triggers can be\n empty or contain up to five DataSetTrigger
objects.
When data set contents are created they are delivered to destinations specified here.
" + "smithy.api#documentation": "When dataset contents are created, they are delivered to destinations specified\n here.
" } }, - "actions": { - "target": "com.amazonaws.iotanalytics#DatasetActions", + "retentionPeriod": { + "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { - "smithy.api#documentation": "A list of actions that create the data set contents.
", - "smithy.api#required": {} + "smithy.api#documentation": "Optional. How long, in days, versions of dataset contents are kept for the dataset. If\n not specified or set to null
, versions of dataset contents are retained for at\n most 90 days. The number of versions of dataset contents retained is determined by the\n versioningConfiguration
parameter. For more information, see Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT\n Analytics User Guide.
The name of the data set.
", - "smithy.api#required": {} + "smithy.api#documentation": "Optional. How many versions of dataset contents are kept. If not specified or set to\n null, only the latest version plus the latest succeeded version (if they are different) are\n kept for the time period specified by the retentionPeriod
parameter. For more\n information, see\n Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT\n Analytics User Guide.
[Optional] How long, in days, versions of data set contents are kept for the data set. If \n not specified or set to null, versions of data set contents are retained for at most 90 days. \n The number of versions of data set contents retained is determined by the \n versioningConfiguration
parameter. (For more information, see \n https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
Metadata which can be used to manage the data set.
" } }, - "triggers": { - "target": "com.amazonaws.iotanalytics#DatasetTriggers", + "lateDataRules": { + "target": "com.amazonaws.iotanalytics#LateDataRules", "traits": { - "smithy.api#documentation": "A list of triggers. A trigger causes data set contents to be populated at a specified \n time interval or when another data set's contents are created. The list of triggers can \n be empty or contain up to five DataSetTrigger objects.
" + "smithy.api#documentation": "A list of data rules that send notifications to Amazon CloudWatch, when data arrives late. To\n specify lateDataRules
, the dataset must use a DeltaTimer\n filter.
The name of the data set.
" + "smithy.api#documentation": "The name of the dataset.
" } }, - "retentionPeriod": { - "target": "com.amazonaws.iotanalytics#RetentionPeriod", + "datasetArn": { + "target": "com.amazonaws.iotanalytics#DatasetArn", "traits": { - "smithy.api#documentation": "How long, in days, data set contents are kept for the data set.
" + "smithy.api#documentation": "The ARN of the dataset.
" } }, - "datasetArn": { - "target": "com.amazonaws.iotanalytics#DatasetArn", + "retentionPeriod": { + "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { - "smithy.api#documentation": "The ARN of the data set.
" + "smithy.api#documentation": "How long, in days, dataset contents are kept for the dataset.
" } } } @@ -964,12 +988,6 @@ "com.amazonaws.iotanalytics#CreateDatastoreRequest": { "type": "structure", "members": { - "retentionPeriod": { - "target": "com.amazonaws.iotanalytics#RetentionPeriod", - "traits": { - "smithy.api#documentation": "How long, in days, message data is kept for the data store. When \"customerManagedS3\" storage \n is selected, this parameter is ignored.
" - } - }, "datastoreName": { "target": "com.amazonaws.iotanalytics#DatastoreName", "traits": { @@ -977,16 +995,22 @@ "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.iotanalytics#TagList", + "datastoreStorage": { + "target": "com.amazonaws.iotanalytics#DatastoreStorage", "traits": { - "smithy.api#documentation": "Metadata which can be used to manage the data store.
" + "smithy.api#documentation": "Where data store data is stored. You can choose one of serviceManagedS3
or\n customerManagedS3
storage. If not specified, the default is\n serviceManagedS3
. You cannot change this storage option after the data store is\n created.
How long, in days, message data is kept for the data store. When\n customerManagedS3
storage is selected, this parameter is ignored.
Where data store data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" \n storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after the data\n store is created.
" + "smithy.api#documentation": "Metadata which can be used to manage the data store.
" } } } @@ -994,10 +1018,10 @@ "com.amazonaws.iotanalytics#CreateDatastoreResponse": { "type": "structure", "members": { - "retentionPeriod": { - "target": "com.amazonaws.iotanalytics#RetentionPeriod", + "datastoreName": { + "target": "com.amazonaws.iotanalytics#DatastoreName", "traits": { - "smithy.api#documentation": "How long, in days, message data is kept for the data store.
" + "smithy.api#documentation": "The name of the data store.
" } }, "datastoreArn": { @@ -1006,10 +1030,10 @@ "smithy.api#documentation": "The ARN of the data store.
" } }, - "datastoreName": { - "target": "com.amazonaws.iotanalytics#DatastoreName", + "retentionPeriod": { + "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { - "smithy.api#documentation": "The name of the data store.
" + "smithy.api#documentation": "How long, in days, message data is kept for the data store.
" } } } @@ -1054,17 +1078,17 @@ "com.amazonaws.iotanalytics#CreatePipelineRequest": { "type": "structure", "members": { - "pipelineActivities": { - "target": "com.amazonaws.iotanalytics#PipelineActivities", + "pipelineName": { + "target": "com.amazonaws.iotanalytics#PipelineName", "traits": { - "smithy.api#documentation": "A list of \"PipelineActivity\" objects. Activities perform transformations on your messages, \n such as removing, renaming or adding message attributes; filtering messages based on attribute \n values; invoking your Lambda functions on messages for advanced processing; or performing \n mathematical transformations to normalize device data.
\nThe list can be 2-25 PipelineActivity objects and must \n contain both a channel
and a datastore
activity. Each entry in the \n list must contain only one activity, for example:
\n pipelineActivities = [\n {\n \"channel\": { ... }\n },\n {\n \"lambda\": { ... }\n },\n ... \n]
\n
The name of the pipeline.
", "smithy.api#required": {} } }, - "pipelineName": { - "target": "com.amazonaws.iotanalytics#PipelineName", + "pipelineActivities": { + "target": "com.amazonaws.iotanalytics#PipelineActivities", "traits": { - "smithy.api#documentation": "The name of the pipeline.
", + "smithy.api#documentation": "A list of PipelineActivity
objects. Activities perform transformations on\n your messages, such as removing, renaming or adding message attributes; filtering messages\n based on attribute values; invoking your Lambda functions on messages for advanced processing;\n or performing mathematical transformations to normalize device data.
The list can be 2-25 PipelineActivity
objects and must contain both a\n channel
and a datastore
activity. Each entry in the list must\n contain only one activity. For example:
\n pipelineActivities = [\n {\n \"channel\": { ... }\n },\n {\n \"lambda\": { ... }\n },\n ... \n]
\n
The ARN of the pipeline.
" - } - }, "pipelineName": { "target": "com.amazonaws.iotanalytics#PipelineName", "traits": { "smithy.api#documentation": "The name of the pipeline.
" } + }, + "pipelineArn": { + "target": "com.amazonaws.iotanalytics#PipelineArn", + "traits": { + "smithy.api#documentation": "The ARN of the pipeline.
" + } } } }, @@ -1099,47 +1123,47 @@ "bucket": { "target": "com.amazonaws.iotanalytics#BucketName", "traits": { - "smithy.api#documentation": "The name of the Amazon S3 bucket in which channel data is stored.
", + "smithy.api#documentation": "The name of the S3 bucket in which channel data is stored.
", "smithy.api#required": {} } }, - "roleArn": { - "target": "com.amazonaws.iotanalytics#RoleArn", + "keyPrefix": { + "target": "com.amazonaws.iotanalytics#S3KeyPrefix", "traits": { - "smithy.api#documentation": "The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
", - "smithy.api#required": {} + "smithy.api#documentation": "Optional. The prefix used to create the keys of the channel data objects. Each object in\n an S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket\n has exactly one key. The prefix must end with a forward slash (/).
" } }, - "keyPrefix": { - "target": "com.amazonaws.iotanalytics#S3KeyPrefix", + "roleArn": { + "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "[Optional] The prefix used to create the keys of the channel data objects. Each object in \n an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in \n a bucket has exactly one key). The prefix must end with a '/'.
" + "smithy.api#documentation": "The ARN of the role that grants AWS IoT Analytics permission to interact with your\n Amazon S3 resources.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Use this to store channel data in an S3 bucket that you manage. If customer managed storage is\n selected, the \"retentionPeriod\" parameter is ignored. The choice of service-managed or customer-managed \n S3 storage cannot be changed after creation of the channel.
" + "smithy.api#documentation": "Use this to store channel data in an S3 bucket that you manage. If customer managed\n storage is selected, the retentionPeriod
parameter is ignored. You cannot change\n the choice of service-managed or customer-managed S3 storage after the channel is\n created.
[Optional] The prefix used to create the keys of the channel data objects. Each object in \n an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in \n a bucket has exactly one key). The prefix must end with a '/'.
" + "smithy.api#documentation": "The name of the S3 bucket in which channel data is stored.
" } }, - "bucket": { - "target": "com.amazonaws.iotanalytics#BucketName", + "keyPrefix": { + "target": "com.amazonaws.iotanalytics#S3KeyPrefix", "traits": { - "smithy.api#documentation": "The name of the Amazon S3 bucket in which channel data is stored.
" + "smithy.api#documentation": "Optional. The prefix used to create the keys of the channel data objects. Each object in\n an S3 bucket has a key that is its unique identifier within the bucket (each object in a\n bucket has exactly one key). The prefix must end with a forward slash (/).
" } }, "roleArn": { "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon \n S3 resources.
" + "smithy.api#documentation": "The ARN of the role that grants AWS IoT Analytics permission to interact with your\n Amazon S3 resources.
" } } }, @@ -1150,29 +1174,29 @@ "com.amazonaws.iotanalytics#CustomerManagedDatastoreS3Storage": { "type": "structure", "members": { + "bucket": { + "target": "com.amazonaws.iotanalytics#BucketName", + "traits": { + "smithy.api#documentation": "The name of the S3 bucket in which data store data is stored.
", + "smithy.api#required": {} + } + }, "keyPrefix": { "target": "com.amazonaws.iotanalytics#S3KeyPrefix", "traits": { - "smithy.api#documentation": "[Optional] The prefix used to create the keys of the data store data objects. Each object in \n an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a \n bucket has exactly one key). The prefix must end with a '/'.
" + "smithy.api#documentation": "Optional. The prefix used to create the keys of the data store data objects. Each object\n in an S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket\n has exactly one key. The prefix must end with a forward slash (/).
" } }, "roleArn": { "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
", - "smithy.api#required": {} - } - }, - "bucket": { - "target": "com.amazonaws.iotanalytics#BucketName", - "traits": { - "smithy.api#documentation": "The name of the Amazon S3 bucket in which data store data is stored.
", + "smithy.api#documentation": "The ARN of the role that grants AWS IoT Analytics permission to interact with your\n Amazon S3 resources.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Use this to store data store data in an S3 bucket that you manage. When customer managed storage is\n selected, the \"retentionPeriod\" parameter is ignored. The choice of service-managed or customer-managed \n S3 storage cannot be changed after creation of the data store.
" + "smithy.api#documentation": "Use this to store data store data in an S3 bucket that you manage. When customer-managed\n storage is selected, the retentionPeriod
parameter is ignored. You cannot change\n the choice of service-managed or customer-managed S3 storage after the data store is\n created.
The name of the Amazon S3 bucket in which data store data is stored.
" + "smithy.api#documentation": "The name of the S3 bucket in which data store data is stored.
" } }, - "roleArn": { - "target": "com.amazonaws.iotanalytics#RoleArn", + "keyPrefix": { + "target": "com.amazonaws.iotanalytics#S3KeyPrefix", "traits": { - "smithy.api#documentation": "The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3 resources.
" + "smithy.api#documentation": "Optional. The prefix used to create the keys of the data store data objects. Each object\n in an S3 bucket has a key that is its unique identifier in the bucket. Each object in a bucket\n has exactly one key. The prefix must end with a forward slash (/).
" } }, - "keyPrefix": { - "target": "com.amazonaws.iotanalytics#S3KeyPrefix", + "roleArn": { + "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "[Optional] The prefix used to create the keys of the data store data objects. Each object in \n an Amazon S3 bucket has a key that is its unique identifier within the bucket (each object in a \n bucket has exactly one key). The prefix must end with a '/'.
" + "smithy.api#documentation": "The ARN of the role that grants AWS IoT Analytics permission to interact with your\n Amazon S3 resources.
" } } }, @@ -1204,64 +1228,70 @@ "com.amazonaws.iotanalytics#Dataset": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.iotanalytics#DatasetStatus", + "name": { + "target": "com.amazonaws.iotanalytics#DatasetName", "traits": { - "smithy.api#documentation": "The status of the data set.
" + "smithy.api#documentation": "The name of the data set.
" } }, - "triggers": { - "target": "com.amazonaws.iotanalytics#DatasetTriggers", + "arn": { + "target": "com.amazonaws.iotanalytics#DatasetArn", "traits": { - "smithy.api#documentation": "The \"DatasetTrigger\" objects\n that specify when the data set is automatically updated.
" + "smithy.api#documentation": "The ARN of the data set.
" } }, - "lastUpdateTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", + "actions": { + "target": "com.amazonaws.iotanalytics#DatasetActions", "traits": { - "smithy.api#documentation": "The last time the data set was updated.
" + "smithy.api#documentation": "The DatasetAction
objects that automatically create the data set\n contents.
The ARN of the data set.
" + "smithy.api#documentation": "The DatasetTrigger
objects that specify when the data set is automatically\n updated.
The name of the data set.
" + "smithy.api#documentation": "When dataset contents are created they are delivered to destinations specified\n here.
" } }, - "actions": { - "target": "com.amazonaws.iotanalytics#DatasetActions", + "status": { + "target": "com.amazonaws.iotanalytics#DatasetStatus", "traits": { - "smithy.api#documentation": "The \"DatasetAction\" objects that automatically create the data set contents.
" + "smithy.api#documentation": "The status of the data set.
" } }, - "contentDeliveryRules": { - "target": "com.amazonaws.iotanalytics#DatasetContentDeliveryRules", + "creationTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "When data set contents are created they are delivered to destinations specified here.
" + "smithy.api#documentation": "When the data set was created.
" + } + }, + "lastUpdateTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", + "traits": { + "smithy.api#documentation": "The last time the data set was updated.
" } }, "retentionPeriod": { "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { - "smithy.api#documentation": "[Optional] How long, in days, message data is kept for the data set.
" + "smithy.api#documentation": "Optional. How long, in days, message data is kept for the data set.
" } }, "versioningConfiguration": { "target": "com.amazonaws.iotanalytics#VersioningConfiguration", "traits": { - "smithy.api#documentation": "[Optional] How many versions of data set contents are kept. If not specified or set to null, only the \n latest version plus the latest succeeded version (if they are different) are kept for \n the time period specified by the \"retentionPeriod\" parameter. (For more information, see\n https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
" + "smithy.api#documentation": "Optional. How many versions of dataset contents are kept. If not specified or set to\n null, only the latest version plus the latest succeeded version (if they are different) are\n kept for the time period specified by the retentionPeriod
parameter. For more\n information, see\n Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT\n Analytics User Guide.
When the data set was created.
" + "smithy.api#documentation": "A list of data rules that send notifications to Amazon CloudWatch, when data arrives late. To\n specify lateDataRules
, the dataset must use a DeltaTimer\n filter.
The name of the data set action by which data set contents are automatically created.
" + } + }, "queryAction": { "target": "com.amazonaws.iotanalytics#SqlQueryDatasetAction", "traits": { - "smithy.api#documentation": "An \"SqlQueryDatasetAction\" object that uses an SQL query to automatically create data set contents.
" + "smithy.api#documentation": "An SqlQueryDatasetAction
object that uses an SQL query to automatically\n create data set contents.
Information which allows the system to run a containerized application in order to create\n the data set contents. The application must be in a Docker container along with any needed\n support libraries.
" - } - }, - "actionName": { - "target": "com.amazonaws.iotanalytics#DatasetActionName", - "traits": { - "smithy.api#documentation": "The name of the data set action by which data set contents are automatically created.
" + "smithy.api#documentation": "Information that allows the system to run a containerized application to create the\n dataset contents. The application must be in a Docker container along with any required\n support libraries.
" } } }, "traits": { - "smithy.api#documentation": "A \"DatasetAction\" object that specifies how data set contents are automatically created.
" + "smithy.api#documentation": "A DatasetAction
object that specifies how data set contents are\n automatically created.
The type of action by which the data set's contents are automatically created.
" + "smithy.api#documentation": "The name of the action that automatically creates the dataset's contents.
" } }, - "actionName": { - "target": "com.amazonaws.iotanalytics#DatasetActionName", + "actionType": { + "target": "com.amazonaws.iotanalytics#DatasetActionType", "traits": { - "smithy.api#documentation": "The name of the action which automatically creates the data set's contents.
" + "smithy.api#documentation": "The type of action by which the dataset's contents are automatically created.
" } } }, "traits": { - "smithy.api#documentation": "Information about the action which automatically creates the data set's contents.
" + "smithy.api#documentation": "Information about the action that automatically creates the dataset's contents.
" } }, "com.amazonaws.iotanalytics#DatasetActionType": { @@ -1373,39 +1403,39 @@ "iotEventsDestinationConfiguration": { "target": "com.amazonaws.iotanalytics#IotEventsDestinationConfiguration", "traits": { - "smithy.api#documentation": "Configuration information for delivery of data set contents to AWS IoT Events.
" + "smithy.api#documentation": "Configuration information for delivery of dataset contents to AWS IoT Events.
" } }, "s3DestinationConfiguration": { "target": "com.amazonaws.iotanalytics#S3DestinationConfiguration", "traits": { - "smithy.api#documentation": "Configuration information for delivery of data set contents to Amazon S3.
" + "smithy.api#documentation": "Configuration information for delivery of dataset contents to Amazon S3.
" } } }, "traits": { - "smithy.api#documentation": "The destination to which data set contents are delivered.
" + "smithy.api#documentation": "The destination to which dataset contents are delivered.
" } }, "com.amazonaws.iotanalytics#DatasetContentDeliveryRule": { "type": "structure", "members": { - "destination": { - "target": "com.amazonaws.iotanalytics#DatasetContentDeliveryDestination", + "entryName": { + "target": "com.amazonaws.iotanalytics#EntryName", "traits": { - "smithy.api#documentation": "The destination to which data set contents are delivered.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the dataset content delivery rules entry.
" } }, - "entryName": { - "target": "com.amazonaws.iotanalytics#EntryName", + "destination": { + "target": "com.amazonaws.iotanalytics#DatasetContentDeliveryDestination", "traits": { - "smithy.api#documentation": "The name of the data set content delivery rules entry.
" + "smithy.api#documentation": "The destination to which dataset contents are delivered.
", + "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "When data set contents are created they are delivered to destination specified here.
" + "smithy.api#documentation": "When dataset contents are created, they are delivered to destination specified\n here.
" } }, "com.amazonaws.iotanalytics#DatasetContentDeliveryRules": { @@ -1442,16 +1472,16 @@ "com.amazonaws.iotanalytics#DatasetContentStatus": { "type": "structure", "members": { - "reason": { - "target": "com.amazonaws.iotanalytics#Reason", + "state": { + "target": "com.amazonaws.iotanalytics#DatasetContentState", "traits": { - "smithy.api#documentation": "The reason the data set contents are in this state.
" + "smithy.api#documentation": "The state of the data set contents. Can be one of READY, CREATING, SUCCEEDED, or\n FAILED.
" } }, - "state": { - "target": "com.amazonaws.iotanalytics#DatasetContentState", + "reason": { + "target": "com.amazonaws.iotanalytics#Reason", "traits": { - "smithy.api#documentation": "The state of the data set contents. Can be one of \"READY\", \"CREATING\", \"SUCCEEDED\" or\n \"FAILED\".
" + "smithy.api#documentation": "The reason the data set contents are in this state.
" } } }, @@ -1468,28 +1498,28 @@ "com.amazonaws.iotanalytics#DatasetContentSummary": { "type": "structure", "members": { - "scheduleTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", + "version": { + "target": "com.amazonaws.iotanalytics#DatasetContentVersion", "traits": { - "smithy.api#documentation": "The time the creation of the data set contents was scheduled to start.
" + "smithy.api#documentation": "The version of the dataset contents.
" } }, - "creationTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", + "status": { + "target": "com.amazonaws.iotanalytics#DatasetContentStatus", "traits": { - "smithy.api#documentation": "The actual time the creation of the data set contents was started.
" + "smithy.api#documentation": "The status of the data set contents.
" } }, - "version": { - "target": "com.amazonaws.iotanalytics#DatasetContentVersion", + "creationTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "The version of the data set contents.
" + "smithy.api#documentation": "The actual time the creation of the dataset contents was started.
" } }, - "status": { - "target": "com.amazonaws.iotanalytics#DatasetContentStatus", + "scheduleTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "The status of the data set contents.
" + "smithy.api#documentation": "The time the creation of the dataset contents was scheduled to start.
" } }, "completionTime": { @@ -1500,7 +1530,7 @@ } }, "traits": { - "smithy.api#documentation": "Summary information about data set contents.
" + "smithy.api#documentation": "Summary information about dataset contents.
" } }, "com.amazonaws.iotanalytics#DatasetContentVersion": { @@ -1518,13 +1548,13 @@ "datasetName": { "target": "com.amazonaws.iotanalytics#DatasetName", "traits": { - "smithy.api#documentation": "The name of the data set whose latest contents are used as input to the notebook or \n application.
", + "smithy.api#documentation": "The name of the dataset whose latest contents are used as input to the notebook or\n application.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "The data set whose latest contents are used as input to the notebook or \n application.
" + "smithy.api#documentation": "The dataset whose latest contents are used as input to the notebook or\n application.
" } }, "com.amazonaws.iotanalytics#DatasetEntries": { @@ -1536,17 +1566,17 @@ "com.amazonaws.iotanalytics#DatasetEntry": { "type": "structure", "members": { - "dataURI": { - "target": "com.amazonaws.iotanalytics#PresignedURI", - "traits": { - "smithy.api#documentation": "The pre-signed URI of the data set item.
" - } - }, "entryName": { "target": "com.amazonaws.iotanalytics#EntryName", "traits": { "smithy.api#documentation": "The name of the data set item.
" } + }, + "dataURI": { + "target": "com.amazonaws.iotanalytics#PresignedURI", + "traits": { + "smithy.api#documentation": "The presigned URI of the data set item.
" + } } }, "traits": { @@ -1591,6 +1621,12 @@ "com.amazonaws.iotanalytics#DatasetSummary": { "type": "structure", "members": { + "datasetName": { + "target": "com.amazonaws.iotanalytics#DatasetName", + "traits": { + "smithy.api#documentation": "The name of the data set.
" + } + }, "status": { "target": "com.amazonaws.iotanalytics#DatasetStatus", "traits": { @@ -1603,12 +1639,6 @@ "smithy.api#documentation": "The time the data set was created.
" } }, - "datasetName": { - "target": "com.amazonaws.iotanalytics#DatasetName", - "traits": { - "smithy.api#documentation": "The name of the data set.
" - } - }, "lastUpdateTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { @@ -1618,13 +1648,13 @@ "triggers": { "target": "com.amazonaws.iotanalytics#DatasetTriggers", "traits": { - "smithy.api#documentation": "A list of triggers. A trigger causes data set content to be populated at a specified time\n interval or when another data set is populated. The list of triggers can be empty or contain up\n to five DataSetTrigger objects
" + "smithy.api#documentation": "A list of triggers. A trigger causes data set content to be populated at a specified time\n interval or when another data set is populated. The list of triggers can be empty or contain up\n to five DataSetTrigger
objects
A list of \"DataActionSummary\" objects.
" + "smithy.api#documentation": "A list of DataActionSummary
objects.
The data set whose content creation triggers the creation of this data set's contents.
" + "smithy.api#documentation": "The Schedule when the trigger is initiated.
" } }, - "schedule": { - "target": "com.amazonaws.iotanalytics#Schedule", + "dataset": { + "target": "com.amazonaws.iotanalytics#TriggeringDataset", "traits": { - "smithy.api#documentation": "The \"Schedule\" when the trigger is initiated.
" + "smithy.api#documentation": "The data set whose content creation triggers the creation of this data set's contents.
" } } }, "traits": { - "smithy.api#documentation": "The \"DatasetTrigger\"\n that specifies when the data set is automatically updated.
" + "smithy.api#documentation": "The DatasetTrigger
that specifies when the data set is automatically\n updated.
The ARN of the data store.
" + "smithy.api#documentation": "The name of the data store.
" } }, "storage": { "target": "com.amazonaws.iotanalytics#DatastoreStorage", "traits": { - "smithy.api#documentation": "Where data store data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" \n storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after the data\n store is created.
" + "smithy.api#documentation": "Where data store data is stored. You can choose one of serviceManagedS3
or\n customerManagedS3
storage. If not specified, the default is\n serviceManagedS3
. You cannot change this storage option after the data store is\n created.
The ARN of the data store.
" } }, "status": { @@ -1685,6 +1721,12 @@ "smithy.api#documentation": "The status of a data store:
\nThe data store is being created.
\nThe data store has been created and can be used.
\nThe data store is being deleted.
\nHow long, in days, message data is kept for the data store. When\n customerManagedS3
storage is selected, this parameter is ignored.
The last time the data store was updated.
" } }, - "name": { - "target": "com.amazonaws.iotanalytics#DatastoreName", - "traits": { - "smithy.api#documentation": "The name of the data store.
" - } - }, - "retentionPeriod": { - "target": "com.amazonaws.iotanalytics#RetentionPeriod", + "lastMessageArrivalTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "How long, in days, message data is kept for the data store. When \"customerManagedS3\" storage \n is selected, this parameter is ignored.
" + "smithy.api#documentation": "The last time when a new message arrived in the data store.
\nAWS IoT Analytics updates this value at most once per minute for one data store. \n Hence, the lastMessageArrivalTime
value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
" } } }, @@ -1720,7 +1756,7 @@ "name": { "target": "com.amazonaws.iotanalytics#ActivityName", "traits": { - "smithy.api#documentation": "The name of the 'datastore' activity.
", + "smithy.api#documentation": "The name of the datastore activity.
", "smithy.api#required": {} } }, @@ -1733,7 +1769,7 @@ } }, "traits": { - "smithy.api#documentation": "The 'datastore' activity that specifies where to store the processed data.
" + "smithy.api#documentation": "The datastore activity that specifies where to store the processed data.
" } }, "com.amazonaws.iotanalytics#DatastoreArn": { @@ -1788,18 +1824,18 @@ "serviceManagedS3": { "target": "com.amazonaws.iotanalytics#ServiceManagedDatastoreS3Storage", "traits": { - "smithy.api#documentation": "Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service.\n The choice of service-managed or customer-managed S3 storage cannot be changed after creation\n of the data store.
" + "smithy.api#documentation": "Use this to store data store data in an S3 bucket managed by AWS IoT Analytics. You\n cannot change the choice of service-managed or customer-managed S3 storage after the data\n store is created.
" } }, "customerManagedS3": { "target": "com.amazonaws.iotanalytics#CustomerManagedDatastoreS3Storage", "traits": { - "smithy.api#documentation": "Use this to store data store data in an S3 bucket that you manage. When customer managed storage is \n selected, the \"retentionPeriod\" parameter is ignored. The choice of service-managed or customer-managed \n S3 storage cannot be changed after creation of the data store.
" + "smithy.api#documentation": "Use this to store data store data in an S3 bucket that you manage. When customer managed\n storage is selected, the retentionPeriod
parameter is ignored. The choice of\n service-managed or customer-managed S3 storage cannot be changed after creation of the data\n store.
Where data store data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" \n storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after the data\n store is created.
" + "smithy.api#documentation": "Where data store data is stored. You can choose one of serviceManagedS3
or\n customerManagedS3
storage. If not specified, the default is\n serviceManagedS3
. You cannot change this storage option after the data store is\n created.
Used to store data store data in an S3 bucket managed by the AWS IoT Analytics service.
" + "smithy.api#documentation": "Used to store data store data in an S3 bucket managed by AWS IoT Analytics.
" } }, "customerManagedS3": { @@ -1831,10 +1867,16 @@ "com.amazonaws.iotanalytics#DatastoreSummary": { "type": "structure", "members": { - "creationTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", + "datastoreName": { + "target": "com.amazonaws.iotanalytics#DatastoreName", "traits": { - "smithy.api#documentation": "When the data store was created.
" + "smithy.api#documentation": "The name of the data store.
" + } + }, + "datastoreStorage": { + "target": "com.amazonaws.iotanalytics#DatastoreStorageSummary", + "traits": { + "smithy.api#documentation": "Where data store data is stored.
" } }, "status": { @@ -1843,10 +1885,10 @@ "smithy.api#documentation": "The status of the data store.
" } }, - "datastoreStorage": { - "target": "com.amazonaws.iotanalytics#DatastoreStorageSummary", + "creationTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "Where data store data is stored.
" + "smithy.api#documentation": "When the data store was created.
" } }, "lastUpdateTime": { @@ -1855,10 +1897,10 @@ "smithy.api#documentation": "The last time the data store was updated.
" } }, - "datastoreName": { - "target": "com.amazonaws.iotanalytics#DatastoreName", + "lastMessageArrivalTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "The name of the data store.
" + "smithy.api#documentation": "The last time when a new message arrived in the data store.
\nAWS IoT Analytics updates this value at most once per minute for one data store. \n Hence, the lastMessageArrivalTime
value is an approximation.
This feature only applies to messages that arrived in the data store after October 23, 2020.
" } } }, @@ -1933,7 +1975,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the specified data set.
\nYou do not have to delete the content of the data set before you perform this operation.
", + "smithy.api#documentation": "Deletes the specified dataset.
\nYou do not have to delete the content of the dataset before you perform this\n operation.
", "smithy.api#http": { "method": "DELETE", "uri": "/datasets/{datasetName}", @@ -1964,7 +2006,7 @@ } ], "traits": { - "smithy.api#documentation": "Deletes the content of the specified data set.
", + "smithy.api#documentation": "Deletes the content of the specified dataset.
", "smithy.api#http": { "method": "DELETE", "uri": "/datasets/{datasetName}/content", @@ -1978,7 +2020,7 @@ "datasetName": { "target": "com.amazonaws.iotanalytics#DatasetName", "traits": { - "smithy.api#documentation": "The name of the data set whose content is deleted.
", + "smithy.api#documentation": "The name of the dataset whose content is deleted.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -1986,7 +2028,7 @@ "versionId": { "target": "com.amazonaws.iotanalytics#DatasetContentVersion", "traits": { - "smithy.api#documentation": "The version of the data set whose content is deleted. You can also use the strings\n \"$LATEST\" or \"$LATEST_SUCCEEDED\" to delete the latest or latest successfully \n completed data set. If not specified, \"$LATEST_SUCCEEDED\" is the default.
", + "smithy.api#documentation": "The version of the dataset whose content is deleted. You can also use the strings\n \"$LATEST\" or \"$LATEST_SUCCEEDED\" to delete the latest or latest successfully completed data\n set. If not specified, \"$LATEST_SUCCEEDED\" is the default.
", "smithy.api#httpQuery": "versionId" } } @@ -2099,20 +2141,35 @@ "offsetSeconds": { "target": "com.amazonaws.iotanalytics#OffsetSeconds", "traits": { - "smithy.api#documentation": "The number of seconds of estimated \"in flight\" lag time of message data. When you create \n data set contents using message data from a specified time frame, some message data may still be \n \"in flight\" when processing begins, and so will not arrive in time to be processed. Use this \n field to make allowances for the \"in flight\" time of your message data, so that data not processed \n from a previous time frame will be included with the next time frame. Without this, missed message \n data would be excluded from processing during the next time frame as well, because its timestamp \n places it within the previous time frame.
", + "smithy.api#documentation": "The number of seconds of estimated in-flight lag time of message data. When you create\n dataset contents using message data from a specified timeframe, some message data might still\n be in flight when processing begins, and so do not arrive in time to be processed. Use this\n field to make allowances for the in flight time of your message data, so that data not\n processed from a previous timeframe is included with the next timeframe. Otherwise, missed\n message data would be excluded from processing during the next timeframe too, because its\n timestamp places it within the previous timeframe.
", "smithy.api#required": {} } }, "timeExpression": { "target": "com.amazonaws.iotanalytics#TimeExpression", "traits": { - "smithy.api#documentation": "An expression by which the time of the message data may be determined. This may be the name\n of a timestamp field, or a SQL expression which is used to derive the time the message\n data was generated.
", + "smithy.api#documentation": "An expression by which the time of the message data might be determined. This can be the\n name of a timestamp field or a SQL expression that is used to derive the time the message data\n was generated.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "Used to limit data to that which has arrived since the last execution of the action.
" + } + }, + "com.amazonaws.iotanalytics#DeltaTimeSessionWindowConfiguration": { + "type": "structure", + "members": { + "timeoutInMinutes": { + "target": "com.amazonaws.iotanalytics#SessionTimeoutInMinutes", + "traits": { + "smithy.api#documentation": "A time interval. You can use timeoutInMinutes
so that AWS IoT Analytics can batch up late data notifications \n that have been generated since the last execution. AWS IoT Analytics sends one batch of notifications to Amazon CloudWatch Events at one time.
For more information about how to write a timestamp expression, \n see Date and Time Functions and Operators, \n in the Presto 0.172 Documentation.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Used to limit data to that which has arrived since the last execution of the action.
" + "smithy.api#documentation": "A structure that contains the configuration information of a delta time session\n window.
\n\n \n DeltaTime
\n specifies a time interval. \n You can use DeltaTime
to create dataset contents with data that has arrived in the data store since the last execution. \n For an example of DeltaTime
, see \n Creating a SQL dataset with a delta window (CLI) in the AWS IoT Analytics User Guide.
Statistics about the channel. Included if the 'includeStatistics' parameter is set\n to true in the request.
" - } - }, "channel": { "target": "com.amazonaws.iotanalytics#Channel", "traits": { "smithy.api#documentation": "An object that contains information about the channel.
" } + }, + "statistics": { + "target": "com.amazonaws.iotanalytics#ChannelStatistics", + "traits": { + "smithy.api#documentation": "Statistics about the channel. Included if the includeStatistics
parameter is\n set to true
in the request.
Retrieves information about a data set.
", + "smithy.api#documentation": "Retrieves information about a dataset.
", "smithy.api#http": { "method": "GET", "uri": "/datasets/{datasetName}", @@ -2310,7 +2367,7 @@ "statistics": { "target": "com.amazonaws.iotanalytics#DatastoreStatistics", "traits": { - "smithy.api#documentation": "Additional statistical information about the data store. Included if the 'includeStatistics' \n parameter is set to true in the request.
" + "smithy.api#documentation": "Additional statistical information about the data store. Included if the\n includeStatistics
parameter is set to true
in the request.
A \"Pipeline\" object\n that contains information about the pipeline.
" + "smithy.api#documentation": "A Pipeline
object that contains information about the pipeline.
The ARN of the role that allows access to the device's registry information.
", + "smithy.api#documentation": "The name of the deviceRegistryEnrich
activity.
The name of the 'deviceRegistryEnrich' activity.
", + "smithy.api#documentation": "The ARN of the role that allows access to the device's registry information.
", "smithy.api#required": {} } }, @@ -2467,43 +2524,43 @@ "com.amazonaws.iotanalytics#DeviceShadowEnrichActivity": { "type": "structure", "members": { - "thingName": { - "target": "com.amazonaws.iotanalytics#AttributeName", + "name": { + "target": "com.amazonaws.iotanalytics#ActivityName", "traits": { - "smithy.api#documentation": "The name of the IoT device whose shadow information is added to \n the message.
", + "smithy.api#documentation": "The name of the deviceShadowEnrich
activity.
The ARN of the role that allows access to the device's shadow.
", + "smithy.api#documentation": "The name of the attribute that is added to the message.
", "smithy.api#required": {} } }, - "attribute": { + "thingName": { "target": "com.amazonaws.iotanalytics#AttributeName", "traits": { - "smithy.api#documentation": "The name of the attribute that is added to the message.
", + "smithy.api#documentation": "The name of the IoT device whose shadow information is added to \n the message.
", "smithy.api#required": {} } }, - "next": { - "target": "com.amazonaws.iotanalytics#ActivityName", + "roleArn": { + "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "The next activity in the pipeline.
" + "smithy.api#documentation": "The ARN of the role that allows access to the device's shadow.
", + "smithy.api#required": {} } }, - "name": { + "next": { "target": "com.amazonaws.iotanalytics#ActivityName", "traits": { - "smithy.api#documentation": "The name of the 'deviceShadowEnrich' activity.
", - "smithy.api#required": {} + "smithy.api#documentation": "The next activity in the pipeline.
" } } }, "traits": { - "smithy.api#documentation": "An activity that adds information from the AWS IoT Device Shadows service to a message.
" + "smithy.api#documentation": "An activity that adds information from the AWS IoT Device Shadow service to a\n message.
" } }, "com.amazonaws.iotanalytics#DoubleValue": { @@ -2524,16 +2581,16 @@ "com.amazonaws.iotanalytics#EstimatedResourceSize": { "type": "structure", "members": { - "estimatedOn": { - "target": "com.amazonaws.iotanalytics#Timestamp", + "estimatedSizeInBytes": { + "target": "com.amazonaws.iotanalytics#SizeInBytes", "traits": { - "smithy.api#documentation": "The time when the estimate of the size of the resource was made.
" + "smithy.api#documentation": "The estimated size of the resource, in bytes.
" } }, - "estimatedSizeInBytes": { - "target": "com.amazonaws.iotanalytics#SizeInBytes", + "estimatedOn": { + "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "The estimated size of the resource in bytes.
" + "smithy.api#documentation": "The time when the estimate of the size of the resource was made.
" } } }, @@ -2544,10 +2601,17 @@ "com.amazonaws.iotanalytics#FilterActivity": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.iotanalytics#ActivityName", + "traits": { + "smithy.api#documentation": "The name of the filter activity.
", + "smithy.api#required": {} + } + }, "filter": { "target": "com.amazonaws.iotanalytics#FilterExpression", "traits": { - "smithy.api#documentation": "An expression that looks like a SQL WHERE clause that must return a Boolean value.
", + "smithy.api#documentation": "An expression that looks like a SQL WHERE clause that must return a Boolean value. \n Messages that satisfy the condition are passed to the next activity.
", "smithy.api#required": {} } }, @@ -2556,13 +2620,6 @@ "traits": { "smithy.api#documentation": "The next activity in the pipeline.
" } - }, - "name": { - "target": "com.amazonaws.iotanalytics#ActivityName", - "traits": { - "smithy.api#documentation": "The name of the 'filter' activity.
", - "smithy.api#required": {} - } } }, "traits": { @@ -2604,7 +2661,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves the contents of a data set as pre-signed URIs.
", + "smithy.api#documentation": "Retrieves the contents of a data set as presigned URIs.
", "smithy.api#http": { "method": "GET", "uri": "/datasets/{datasetName}/content", @@ -2638,7 +2695,7 @@ "entries": { "target": "com.amazonaws.iotanalytics#DatasetEntries", "traits": { - "smithy.api#documentation": "A list of \"DatasetEntry\" objects.
" + "smithy.api#documentation": "A list of DatasetEntry
objects.
The name of the database in your AWS Glue Data Catalog in which the table is located. (An AWS \n Glue Data Catalog database contains Glue Data tables.)
", + "smithy.api#documentation": "The name of the table in your AWS Glue Data Catalog that is used to perform the ETL\n operations. An AWS Glue Data Catalog table contains partitioned data and descriptions of data\n sources and targets.
", "smithy.api#required": {} } }, - "tableName": { - "target": "com.amazonaws.iotanalytics#GlueTableName", + "databaseName": { + "target": "com.amazonaws.iotanalytics#GlueDatabaseName", "traits": { - "smithy.api#documentation": "The name of the table in your AWS Glue Data Catalog which is used to perform the ETL (extract, \n transform and load) operations. (An AWS Glue Data Catalog table contains partitioned data and descriptions \n of data sources and targets.)
", + "smithy.api#documentation": "The name of the database in your AWS Glue Data Catalog in which the table is located. An\n AWS Glue Data Catalog database contains metadata tables.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Configuration information for coordination with the AWS Glue ETL (extract, transform and \n load) service.
" + "smithy.api#documentation": "Configuration information for coordination with AWS Glue, a fully managed extract,\n transform and load (ETL) service.
" } }, "com.amazonaws.iotanalytics#GlueDatabaseName": { @@ -2741,20 +2798,20 @@ "inputName": { "target": "com.amazonaws.iotanalytics#IotEventsInputName", "traits": { - "smithy.api#documentation": "The name of the AWS IoT Events input to which data set contents are delivered.
", + "smithy.api#documentation": "The name of the AWS IoT Events input to which dataset contents are delivered.
", "smithy.api#required": {} } }, "roleArn": { "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "The ARN of the role which grants AWS IoT Analytics permission to deliver data set contents\n to an AWS IoT Events input.
", + "smithy.api#documentation": "The ARN of the role that grants AWS IoT Analytics permission to deliver dataset contents\n to an AWS IoT Events input.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Configuration information for delivery of data set contents to AWS IoT Events.
" + "smithy.api#documentation": "Configuration information for delivery of dataset contents to AWS IoT Events.
" } }, "com.amazonaws.iotanalytics#IotEventsInputName": { @@ -2770,17 +2827,11 @@ "com.amazonaws.iotanalytics#LambdaActivity": { "type": "structure", "members": { - "batchSize": { - "target": "com.amazonaws.iotanalytics#ActivityBatchSize", - "traits": { - "smithy.api#documentation": "The number of messages passed to the Lambda function for processing.
\nThe AWS Lambda function must be able to process all of these messages within\n five minutes, which is the maximum timeout duration for Lambda functions.
", - "smithy.api#required": {} - } - }, - "next": { + "name": { "target": "com.amazonaws.iotanalytics#ActivityName", "traits": { - "smithy.api#documentation": "The next activity in the pipeline.
" + "smithy.api#documentation": "The name of the lambda activity.
", + "smithy.api#required": {} } }, "lambdaName": { @@ -2790,12 +2841,18 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.iotanalytics#ActivityName", + "batchSize": { + "target": "com.amazonaws.iotanalytics#ActivityBatchSize", "traits": { - "smithy.api#documentation": "The name of the 'lambda' activity.
", + "smithy.api#documentation": "The number of messages passed to the Lambda function for processing.
\nThe Lambda function must be able to process all of these messages within five minutes,\n which is the maximum timeout duration for Lambda functions.
", "smithy.api#required": {} } + }, + "next": { + "target": "com.amazonaws.iotanalytics#ActivityName", + "traits": { + "smithy.api#documentation": "The next activity in the pipeline.
" + } } }, "traits": { @@ -2812,6 +2869,63 @@ "smithy.api#pattern": "^[a-zA-Z0-9_-]+$" } }, + "com.amazonaws.iotanalytics#LateDataRule": { + "type": "structure", + "members": { + "ruleName": { + "target": "com.amazonaws.iotanalytics#LateDataRuleName", + "traits": { + "smithy.api#documentation": "The name of the late data rule.
" + } + }, + "ruleConfiguration": { + "target": "com.amazonaws.iotanalytics#LateDataRuleConfiguration", + "traits": { + "smithy.api#documentation": "The information needed to configure the late data rule.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "A structure that contains the name and configuration information of a late data\n rule.
" + } + }, + "com.amazonaws.iotanalytics#LateDataRuleConfiguration": { + "type": "structure", + "members": { + "deltaTimeSessionWindowConfiguration": { + "target": "com.amazonaws.iotanalytics#DeltaTimeSessionWindowConfiguration", + "traits": { + "smithy.api#documentation": "The information needed to configure a delta time session window.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The information needed to configure a delta time session window.
" + } + }, + "com.amazonaws.iotanalytics#LateDataRuleName": { + "type": "string", + "traits": { + "smithy.api#length": { + "min": 1, + "max": 128 + }, + "smithy.api#pattern": "^[a-zA-Z0-9_]+$" + } + }, + "com.amazonaws.iotanalytics#LateDataRules": { + "type": "list", + "member": { + "target": "com.amazonaws.iotanalytics#LateDataRule" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 1 + } + } + }, "com.amazonaws.iotanalytics#LimitExceededException": { "type": "structure", "members": { @@ -2886,7 +3000,7 @@ "channelSummaries": { "target": "com.amazonaws.iotanalytics#ChannelSummaries", "traits": { - "smithy.api#documentation": "A list of \"ChannelSummary\" objects.
" + "smithy.api#documentation": "A list of ChannelSummary
objects.
The maximum number of results to return in this request.
", - "smithy.api#httpQuery": "maxResults" - } - }, "nextToken": { "target": "com.amazonaws.iotanalytics#NextToken", "traits": { @@ -2961,17 +3068,24 @@ "smithy.api#httpQuery": "nextToken" } }, + "maxResults": { + "target": "com.amazonaws.iotanalytics#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in this request.
", + "smithy.api#httpQuery": "maxResults" + } + }, "scheduledOnOrAfter": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "A filter to limit results to those data set contents whose creation is scheduled on or \n after the given time. See the field triggers.schedule
in the CreateDataset \n request. (timestamp)
A filter to limit results to those data set contents whose creation is scheduled on or \n after the given time. See the field triggers.schedule
in the CreateDataset
\n request. (timestamp)
A filter to limit results to those data set contents whose creation is scheduled before the \n given time. See the field triggers.schedule
in the CreateDataset request. (timestamp)
A filter to limit results to those data set contents whose creation is scheduled before\n the given time. See the field triggers.schedule
in the CreateDataset
\n request. (timestamp)
The maximum number of results to return in this request.
\nThe default value is 100.
", - "smithy.api#httpQuery": "maxResults" - } - }, "nextToken": { "target": "com.amazonaws.iotanalytics#NextToken", "traits": { "smithy.api#documentation": "The token for the next set of results.
", "smithy.api#httpQuery": "nextToken" } + }, + "maxResults": { + "target": "com.amazonaws.iotanalytics#MaxResults", + "traits": { + "smithy.api#documentation": "The maximum number of results to return in this request.
\nThe default value is 100.
", + "smithy.api#httpQuery": "maxResults" + } } } }, "com.amazonaws.iotanalytics#ListDatasetsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.iotanalytics#NextToken", + "datasetSummaries": { + "target": "com.amazonaws.iotanalytics#DatasetSummaries", "traits": { - "smithy.api#documentation": "The token to retrieve the next set of results, or null
if there are no\n more results.
A list of DatasetSummary
objects.
A list of \"DatasetSummary\" objects.
" + "smithy.api#documentation": "The token to retrieve the next set of results, or null
if there are no\n more results.
A list of \"DatastoreSummary\" objects.
" + "smithy.api#documentation": "A list of DatastoreSummary
objects.
A list of \"PipelineSummary\" objects.
" + "smithy.api#documentation": "A list of PipelineSummary
objects.
Lists the tags (metadata) which you have assigned to the resource.
", + "smithy.api#documentation": "Lists the tags (metadata) that you have assigned to the resource.
", "smithy.api#http": { "method": "GET", "uri": "/tags", @@ -3266,7 +3380,7 @@ "tags": { "target": "com.amazonaws.iotanalytics#TagList", "traits": { - "smithy.api#documentation": "The tags (metadata) which you have assigned to the resource.
" + "smithy.api#documentation": "The tags (metadata) that you have assigned to the resource.
" } } } @@ -3298,17 +3412,17 @@ "smithy.api#required": {} } }, - "enabled": { - "target": "com.amazonaws.iotanalytics#LoggingEnabled", + "level": { + "target": "com.amazonaws.iotanalytics#LoggingLevel", "traits": { - "smithy.api#documentation": "If true, logging is enabled for AWS IoT Analytics.
", + "smithy.api#documentation": "The logging level. Currently, only ERROR is supported.
", "smithy.api#required": {} } }, - "level": { - "target": "com.amazonaws.iotanalytics#LoggingLevel", + "enabled": { + "target": "com.amazonaws.iotanalytics#LoggingEnabled", "traits": { - "smithy.api#documentation": "The logging level. Currently, only \"ERROR\" is supported.
", + "smithy.api#documentation": "If true, logging is enabled for AWS IoT Analytics.
", "smithy.api#required": {} } } @@ -3320,10 +3434,10 @@ "com.amazonaws.iotanalytics#MathActivity": { "type": "structure", "members": { - "math": { - "target": "com.amazonaws.iotanalytics#MathExpression", + "name": { + "target": "com.amazonaws.iotanalytics#ActivityName", "traits": { - "smithy.api#documentation": "An expression that uses one or more existing attributes and must return an integer value.
", + "smithy.api#documentation": "The name of the math activity.
", "smithy.api#required": {} } }, @@ -3334,10 +3448,10 @@ "smithy.api#required": {} } }, - "name": { - "target": "com.amazonaws.iotanalytics#ActivityName", + "math": { + "target": "com.amazonaws.iotanalytics#MathExpression", "traits": { - "smithy.api#documentation": "The name of the 'math' activity.
", + "smithy.api#documentation": "An expression that uses one or more existing attributes and must return an integer value.
", "smithy.api#required": {} } }, @@ -3394,17 +3508,17 @@ "com.amazonaws.iotanalytics#Message": { "type": "structure", "members": { - "payload": { - "target": "com.amazonaws.iotanalytics#MessagePayload", + "messageId": { + "target": "com.amazonaws.iotanalytics#MessageId", "traits": { - "smithy.api#documentation": "The payload of the message. This may be a JSON string or a Base64-encoded string \n representing binary data (in which case you must decode it by means of a pipeline activity).
", + "smithy.api#documentation": "The ID you want to assign to the message. Each messageId
must be unique\n within each batch sent.
The ID you wish to assign to the message. Each \"messageId\" must be unique \n within each batch sent.
", + "smithy.api#documentation": "The payload of the message. This can be a JSON string or a base64-encoded string\n representing binary data, in which case you must decode it by means of a pipeline\n activity.
", "smithy.api#required": {} } } @@ -3464,7 +3578,7 @@ "fileName": { "target": "com.amazonaws.iotanalytics#OutputFileName", "traits": { - "smithy.api#documentation": "The URI of the location where data set contents are stored, usually the URI of a file in an \n S3 bucket.
", + "smithy.api#documentation": "The URI of the location where dataset contents are stored, usually the URI of a file in\n an S3 bucket.
", "smithy.api#required": {} } } @@ -3482,10 +3596,10 @@ "smithy.api#documentation": "The name of the pipeline.
" } }, - "creationTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", + "arn": { + "target": "com.amazonaws.iotanalytics#PipelineArn", "traits": { - "smithy.api#documentation": "When the pipeline was created.
" + "smithy.api#documentation": "The ARN of the pipeline.
" } }, "activities": { @@ -3494,22 +3608,22 @@ "smithy.api#documentation": "The activities that perform transformations on the messages.
" } }, - "arn": { - "target": "com.amazonaws.iotanalytics#PipelineArn", + "reprocessingSummaries": { + "target": "com.amazonaws.iotanalytics#ReprocessingSummaries", "traits": { - "smithy.api#documentation": "The ARN of the pipeline.
" + "smithy.api#documentation": "A summary of information about the pipeline reprocessing.
" } }, - "lastUpdateTime": { + "creationTime": { "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "The last time the pipeline was updated.
" + "smithy.api#documentation": "When the pipeline was created.
" } }, - "reprocessingSummaries": { - "target": "com.amazonaws.iotanalytics#ReprocessingSummaries", + "lastUpdateTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "A summary of information about the pipeline reprocessing.
" + "smithy.api#documentation": "The last time the pipeline was updated.
" } } }, @@ -3532,22 +3646,34 @@ "com.amazonaws.iotanalytics#PipelineActivity": { "type": "structure", "members": { + "channel": { + "target": "com.amazonaws.iotanalytics#ChannelActivity", + "traits": { + "smithy.api#documentation": "Determines the source of the messages to be processed.
" + } + }, "lambda": { "target": "com.amazonaws.iotanalytics#LambdaActivity", "traits": { "smithy.api#documentation": "Runs a Lambda function to modify the message.
" } }, - "math": { - "target": "com.amazonaws.iotanalytics#MathActivity", + "datastore": { + "target": "com.amazonaws.iotanalytics#DatastoreActivity", "traits": { - "smithy.api#documentation": "Computes an arithmetic expression using the message's attributes and adds\n it to the message.
" + "smithy.api#documentation": "Specifies where to store the processed message data.
" } }, - "filter": { - "target": "com.amazonaws.iotanalytics#FilterActivity", + "addAttributes": { + "target": "com.amazonaws.iotanalytics#AddAttributesActivity", "traits": { - "smithy.api#documentation": "Filters a message based on its attributes.
" + "smithy.api#documentation": "Adds other attributes based on existing attributes in the message.
" + } + }, + "removeAttributes": { + "target": "com.amazonaws.iotanalytics#RemoveAttributesActivity", + "traits": { + "smithy.api#documentation": "Removes attributes from a message.
" } }, "selectAttributes": { @@ -3556,22 +3682,16 @@ "smithy.api#documentation": "Creates a new message using only the specified attributes from the original message.\n
" } }, - "channel": { - "target": "com.amazonaws.iotanalytics#ChannelActivity", - "traits": { - "smithy.api#documentation": "Determines the source of the messages to be processed.
" - } - }, - "removeAttributes": { - "target": "com.amazonaws.iotanalytics#RemoveAttributesActivity", + "filter": { + "target": "com.amazonaws.iotanalytics#FilterActivity", "traits": { - "smithy.api#documentation": "Removes attributes from a message.
" + "smithy.api#documentation": "Filters a message based on its attributes.
" } }, - "deviceShadowEnrich": { - "target": "com.amazonaws.iotanalytics#DeviceShadowEnrichActivity", + "math": { + "target": "com.amazonaws.iotanalytics#MathActivity", "traits": { - "smithy.api#documentation": "Adds information from the AWS IoT Device Shadows service to a message.
" + "smithy.api#documentation": "Computes an arithmetic expression using the message's attributes and adds\n it to the message.
" } }, "deviceRegistryEnrich": { @@ -3580,16 +3700,10 @@ "smithy.api#documentation": "Adds data from the AWS IoT device registry to your message.
" } }, - "datastore": { - "target": "com.amazonaws.iotanalytics#DatastoreActivity", - "traits": { - "smithy.api#documentation": "Specifies where to store the processed message data.
" - } - }, - "addAttributes": { - "target": "com.amazonaws.iotanalytics#AddAttributesActivity", + "deviceShadowEnrich": { + "target": "com.amazonaws.iotanalytics#DeviceShadowEnrichActivity", "traits": { - "smithy.api#documentation": "Adds other attributes based on existing attributes in the message.
" + "smithy.api#documentation": "Adds information from the AWS IoT Device Shadow service to a message.
" } } }, @@ -3619,16 +3733,10 @@ "com.amazonaws.iotanalytics#PipelineSummary": { "type": "structure", "members": { - "lastUpdateTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", - "traits": { - "smithy.api#documentation": "When the pipeline was last updated.
" - } - }, - "creationTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", + "pipelineName": { + "target": "com.amazonaws.iotanalytics#PipelineName", "traits": { - "smithy.api#documentation": "When the pipeline was created.
" + "smithy.api#documentation": "The name of the pipeline.
" } }, "reprocessingSummaries": { @@ -3637,10 +3745,16 @@ "smithy.api#documentation": "A summary of information about the pipeline reprocessing.
" } }, - "pipelineName": { - "target": "com.amazonaws.iotanalytics#PipelineName", + "creationTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "The name of the pipeline.
" + "smithy.api#documentation": "When the pipeline was created.
" + } + }, + "lastUpdateTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", + "traits": { + "smithy.api#documentation": "When the pipeline was last updated.
" } } }, @@ -3671,7 +3785,7 @@ } ], "traits": { - "smithy.api#documentation": "Sets or updates the AWS IoT Analytics logging options.
\nNote that if you update the value of any loggingOptions
field, it takes up to one \n minute for the change to take effect. Also, if you change the policy attached to the role \n you specified in the roleArn field (for example, to correct an invalid policy) it takes \n up to 5 minutes for that change to take effect.\n
Sets or updates the AWS IoT Analytics logging options.
\nIf you update the value of any loggingOptions
field, it takes up to one\n minute for the change to take effect. Also, if you change the policy attached to the role you\n specified in the roleArn
field (for example, to correct an invalid policy), it\n takes up to five minutes for that change to take effect.
Information which is used to filter message data, to segregate it according to the time\n frame in which it arrives.
" + "smithy.api#documentation": "Information that is used to filter message data, to segregate it according to the\n timeframe in which it arrives.
" } }, "com.amazonaws.iotanalytics#QueryFilters": { @@ -3726,22 +3840,22 @@ "name": { "target": "com.amazonaws.iotanalytics#ActivityName", "traits": { - "smithy.api#documentation": "The name of the 'removeAttributes' activity.
", + "smithy.api#documentation": "The name of the removeAttributes
activity.
The next activity in the pipeline.
" - } - }, "attributes": { "target": "com.amazonaws.iotanalytics#AttributeNames", "traits": { "smithy.api#documentation": "A list of 1-50 attributes to remove from the message.
", "smithy.api#required": {} } + }, + "next": { + "target": "com.amazonaws.iotanalytics#ActivityName", + "traits": { + "smithy.api#documentation": "The next activity in the pipeline.
" + } } }, "traits": { @@ -3783,10 +3897,10 @@ "com.amazonaws.iotanalytics#ReprocessingSummary": { "type": "structure", "members": { - "creationTime": { - "target": "com.amazonaws.iotanalytics#Timestamp", + "id": { + "target": "com.amazonaws.iotanalytics#ReprocessingId", "traits": { - "smithy.api#documentation": "The time the pipeline reprocessing was created.
" + "smithy.api#documentation": "The reprocessingId
returned by\n StartPipelineReprocessing
.
The status of the pipeline reprocessing.
" } }, - "id": { - "target": "com.amazonaws.iotanalytics#ReprocessingId", + "creationTime": { + "target": "com.amazonaws.iotanalytics#Timestamp", "traits": { - "smithy.api#documentation": "The 'reprocessingId' returned by \"StartPipelineReprocessing\".
" + "smithy.api#documentation": "The time the pipeline reprocessing was created.
" } } }, @@ -3809,15 +3923,15 @@ "com.amazonaws.iotanalytics#ResourceAlreadyExistsException": { "type": "structure", "members": { + "message": { + "target": "com.amazonaws.iotanalytics#ErrorMessage" + }, "resourceId": { "target": "com.amazonaws.iotanalytics#resourceId", "traits": { "smithy.api#documentation": "The ID of the resource.
" } }, - "message": { - "target": "com.amazonaws.iotanalytics#ErrorMessage" - }, "resourceArn": { "target": "com.amazonaws.iotanalytics#ResourceArn2", "traits": { @@ -3849,20 +3963,20 @@ "computeType": { "target": "com.amazonaws.iotanalytics#ComputeType", "traits": { - "smithy.api#documentation": "The type of the compute resource used to execute the \"containerAction\". Possible values \n are: ACU_1 (vCPU=4, memory=16GiB) or ACU_2 (vCPU=8, memory=32GiB).
", + "smithy.api#documentation": "The type of the compute resource used to execute the containerAction
.\n Possible values are: ACU_1
(vCPU=4, memory=16 GiB) or ACU_2
(vCPU=8,\n memory=32 GiB).
The size (in GB) of the persistent storage available to the resource instance used to\n execute the \"containerAction\" (min: 1, max: 50).
", + "smithy.api#documentation": "The size, in GB, of the persistent storage available to the resource instance used to\n execute the containerAction
(min: 1, max: 50).
The configuration of the resource used to execute the \"containerAction\".
" + "smithy.api#documentation": "The configuration of the resource used to execute the\n containerAction
.
The number of days that message data is kept. The \"unlimited\" parameter must be false.
" + "smithy.api#documentation": "The number of days that message data is kept. The unlimited
parameter must\n be false.
The pipeline activity that is run. This must not be a 'channel' activity or a \n 'datastore' activity because these activities are used in a pipeline only to load the \n original message and to store the (possibly) transformed message. If a 'lambda' activity is\n specified, only short-running Lambda functions (those with a timeout of less than 30 seconds\n or less) can be used.
", + "smithy.api#documentation": "The pipeline activity that is run. This must not be a channel activity or a datastore\n activity because these activities are used in a pipeline only to load the original message and\n to store the (possibly) transformed message. If a lambda activity is specified, only\n short-running Lambda functions (those with a timeout of less than 30 seconds or less) can be\n used.
", "smithy.api#required": {} } }, @@ -3986,36 +4100,36 @@ "com.amazonaws.iotanalytics#S3DestinationConfiguration": { "type": "structure", "members": { - "roleArn": { - "target": "com.amazonaws.iotanalytics#RoleArn", + "bucket": { + "target": "com.amazonaws.iotanalytics#BucketName", "traits": { - "smithy.api#documentation": "The ARN of the role which grants AWS IoT Analytics permission to interact with your Amazon S3\n and AWS Glue resources.
", + "smithy.api#documentation": "The name of the S3 bucket to which dataset contents are delivered.
", "smithy.api#required": {} } }, - "glueConfiguration": { - "target": "com.amazonaws.iotanalytics#GlueConfiguration", - "traits": { - "smithy.api#documentation": "Configuration information for coordination with the AWS Glue ETL (extract, transform and \n load) service.
" - } - }, "key": { "target": "com.amazonaws.iotanalytics#BucketKeyExpression", "traits": { - "smithy.api#documentation": "The key of the data set contents object. Each object in an Amazon S3 bucket has a key that is \n its unique identifier within the bucket (each object in a bucket has exactly one key). To produce\n a unique key, you can use \"!{iotanalytics:scheduledTime}\" to insert the time of the scheduled SQL \n query run, or \"!{iotanalytics:versioned} to insert a unique hash identifying the data set, for \n example: \"/DataSet/!{iotanalytics:scheduledTime}/!{iotanalytics:versioned}.csv\".
", + "smithy.api#documentation": "The key of the dataset contents object in an S3 bucket. Each object has a key that is a\n unique identifier. Each object has exactly one key.
\nYou can create a unique key with the following options:
\nUse !{iotanalytics:scheduleTime}
to insert the time of a scheduled SQL\n query run.
Use !{iotanalytics:versionId}
to insert a unique hash that identifies a\n dataset content.
Use !{iotanalytics:creationTime}
to insert the creation time of a dataset\n content.
The following example creates a unique key for a CSV file:\n dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv
\n
If you don't use !{iotanalytics:versionId}
to specify the key, you might\n get duplicate keys. For example, you might have two dataset contents with the same\n scheduleTime
but different versionId
s. \n This means that one dataset content overwrites the other.
Configuration information for coordination with AWS Glue, a fully managed extract,\n transform and load (ETL) service.
" + } + }, + "roleArn": { + "target": "com.amazonaws.iotanalytics#RoleArn", "traits": { - "smithy.api#documentation": "The name of the Amazon S3 bucket to which data set contents are delivered.
", + "smithy.api#documentation": "The ARN of the role that grants AWS IoT Analytics permission to interact with your\n Amazon S3 and AWS Glue resources.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Configuration information for delivery of data set contents to Amazon S3.
" + "smithy.api#documentation": "Configuration information for delivery of dataset contents to Amazon Simple Storage\n Service (Amazon S3).
" } }, "com.amazonaws.iotanalytics#S3KeyPrefix": { @@ -4073,6 +4187,13 @@ "smithy.api#required": {} } }, + "maxMessages": { + "target": "com.amazonaws.iotanalytics#MaxMessages", + "traits": { + "smithy.api#documentation": "The number of sample messages to be retrieved. The limit is 10. The default is also\n 10.
", + "smithy.api#httpQuery": "maxMessages" + } + }, "startTime": { "target": "com.amazonaws.iotanalytics#StartTime", "traits": { @@ -4080,13 +4201,6 @@ "smithy.api#httpQuery": "startTime" } }, - "maxMessages": { - "target": "com.amazonaws.iotanalytics#MaxMessages", - "traits": { - "smithy.api#documentation": "The number of sample messages to be retrieved. The limit is 10, the default\n is also 10.
", - "smithy.api#httpQuery": "maxMessages" - } - }, "endTime": { "target": "com.amazonaws.iotanalytics#EndTime", "traits": { @@ -4113,7 +4227,7 @@ "expression": { "target": "com.amazonaws.iotanalytics#ScheduleExpression", "traits": { - "smithy.api#documentation": "The expression that defines when to trigger an update. For more information, see \n \n Schedule Expressions for Rules in the Amazon CloudWatch Events User Guide.
" + "smithy.api#documentation": "The expression that defines when to trigger an update. \n For more information, see Schedule Expressions for\n Rules in the Amazon CloudWatch Events User\n Guide.
" } } }, @@ -4127,6 +4241,13 @@ "com.amazonaws.iotanalytics#SelectAttributesActivity": { "type": "structure", "members": { + "name": { + "target": "com.amazonaws.iotanalytics#ActivityName", + "traits": { + "smithy.api#documentation": "The name of the selectAttributes
activity.
The next activity in the pipeline.
" } - }, - "name": { - "target": "com.amazonaws.iotanalytics#ActivityName", - "traits": { - "smithy.api#documentation": "The name of the 'selectAttributes' activity.
", - "smithy.api#required": {} - } } }, "traits": { @@ -4156,28 +4270,28 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Use this to store channel data in an S3 bucket managed by the AWS IoT Analytics service.\n The choice of service-managed or customer-managed S3 storage cannot be changed after creation\n of the channel.
" + "smithy.api#documentation": "Use this to store channel data in an S3 bucket managed by AWS IoT Analytics. You cannot\n change the choice of service-managed or customer-managed S3 storage after the channel is\n created.
" } }, "com.amazonaws.iotanalytics#ServiceManagedChannelS3StorageSummary": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Used to store channel data in an S3 bucket managed by the AWS IoT Analytics service.
" + "smithy.api#documentation": "Used to store channel data in an S3 bucket managed by AWS IoT Analytics.
" } }, "com.amazonaws.iotanalytics#ServiceManagedDatastoreS3Storage": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Use this to store data store data in an S3 bucket managed by the AWS IoT Analytics service.\n The choice of service-managed or customer-managed S3 storage cannot be changed after creation\n of the data store.
" + "smithy.api#documentation": "Use this to store data store data in an S3 bucket managed by AWS IoT Analytics. You\n cannot change the choice of service-managed or customer-managed S3 storage after the data\n store is created.
" } }, "com.amazonaws.iotanalytics#ServiceManagedDatastoreS3StorageSummary": { "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "Used to store data store data in an S3 bucket managed by the AWS IoT Analytics service.
" + "smithy.api#documentation": "Used to store data store data in an S3 bucket managed by AWS IoT Analytics.
" } }, "com.amazonaws.iotanalytics#ServiceUnavailableException": { @@ -4193,6 +4307,16 @@ "smithy.api#httpError": 503 } }, + "com.amazonaws.iotanalytics#SessionTimeoutInMinutes": { + "type": "integer", + "traits": { + "smithy.api#box": {}, + "smithy.api#range": { + "min": 1, + "max": 60 + } + } + }, "com.amazonaws.iotanalytics#SizeInBytes": { "type": "double", "traits": { @@ -4205,18 +4329,18 @@ "com.amazonaws.iotanalytics#SqlQueryDatasetAction": { "type": "structure", "members": { - "filters": { - "target": "com.amazonaws.iotanalytics#QueryFilters", - "traits": { - "smithy.api#documentation": "Pre-filters applied to message data.
" - } - }, "sqlQuery": { "target": "com.amazonaws.iotanalytics#SqlQuery", "traits": { "smithy.api#documentation": "A SQL query string.
", "smithy.api#required": {} } + }, + "filters": { + "target": "com.amazonaws.iotanalytics#QueryFilters", + "traits": { + "smithy.api#documentation": "Prefilters applied to message data.
" + } } }, "traits": { @@ -4263,12 +4387,6 @@ "com.amazonaws.iotanalytics#StartPipelineReprocessingRequest": { "type": "structure", "members": { - "startTime": { - "target": "com.amazonaws.iotanalytics#StartTime", - "traits": { - "smithy.api#documentation": "The start time (inclusive) of raw message data that is reprocessed.
" - } - }, "pipelineName": { "target": "com.amazonaws.iotanalytics#PipelineName", "traits": { @@ -4277,6 +4395,12 @@ "smithy.api#required": {} } }, + "startTime": { + "target": "com.amazonaws.iotanalytics#StartTime", + "traits": { + "smithy.api#documentation": "The start time (inclusive) of raw message data that is reprocessed.
" + } + }, "endTime": { "target": "com.amazonaws.iotanalytics#EndTime", "traits": { @@ -4311,23 +4435,23 @@ "com.amazonaws.iotanalytics#Tag": { "type": "structure", "members": { - "value": { - "target": "com.amazonaws.iotanalytics#TagValue", + "key": { + "target": "com.amazonaws.iotanalytics#TagKey", "traits": { - "smithy.api#documentation": "The tag's value.
", + "smithy.api#documentation": "The tag's key.
", "smithy.api#required": {} } }, - "key": { - "target": "com.amazonaws.iotanalytics#TagKey", + "value": { + "target": "com.amazonaws.iotanalytics#TagValue", "traits": { - "smithy.api#documentation": "The tag's key.
", + "smithy.api#documentation": "The tag's value.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A set of key/value pairs which are used to manage the resource.
" + "smithy.api#documentation": "A set of key-value pairs that are used to manage the resource.
" } }, "com.amazonaws.iotanalytics#TagKey": { @@ -4392,7 +4516,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds to or modifies the tags of the given resource. Tags are metadata \n which can be used to manage a resource.
", + "smithy.api#documentation": "Adds to or modifies the tags of the given resource. Tags are metadata that can be used\n to manage a resource.
", "smithy.api#http": { "method": "POST", "uri": "/tags", @@ -4458,13 +4582,13 @@ "name": { "target": "com.amazonaws.iotanalytics#DatasetName", "traits": { - "smithy.api#documentation": "The name of the data set whose content generation triggers the new data set content \n generation.
", + "smithy.api#documentation": "The name of the dataset whose content generation triggers the new dataset content\n generation.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Information about the data set whose content generation triggers the new data set content \n generation.
" + "smithy.api#documentation": "Information about the dataset whose content generation triggers the new dataset content\n generation.
" } }, "com.amazonaws.iotanalytics#UnlimitedRetentionPeriod": { @@ -4513,14 +4637,6 @@ "com.amazonaws.iotanalytics#UntagResourceRequest": { "type": "structure", "members": { - "tagKeys": { - "target": "com.amazonaws.iotanalytics#TagKeyList", - "traits": { - "smithy.api#documentation": "The keys of those tags which you want to remove.
", - "smithy.api#httpQuery": "tagKeys", - "smithy.api#required": {} - } - }, "resourceArn": { "target": "com.amazonaws.iotanalytics#ResourceArn", "traits": { @@ -4528,6 +4644,14 @@ "smithy.api#httpQuery": "resourceArn", "smithy.api#required": {} } + }, + "tagKeys": { + "target": "com.amazonaws.iotanalytics#TagKeyList", + "traits": { + "smithy.api#documentation": "The keys of those tags which you want to remove.
", + "smithy.api#httpQuery": "tagKeys", + "smithy.api#required": {} + } } } }, @@ -4569,10 +4693,18 @@ "com.amazonaws.iotanalytics#UpdateChannelRequest": { "type": "structure", "members": { + "channelName": { + "target": "com.amazonaws.iotanalytics#ChannelName", + "traits": { + "smithy.api#documentation": "The name of the channel to be updated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "channelStorage": { "target": "com.amazonaws.iotanalytics#ChannelStorage", "traits": { - "smithy.api#documentation": "Where channel data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" \n storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after creation\n of the channel.
" + "smithy.api#documentation": "Where channel data is stored. You can choose one of serviceManagedS3
or\n customerManagedS3
storage. If not specified, the default is\n serviceManagedS3
. You cannot change this storage option after the channel is\n created.
How long, in days, message data is kept for the channel. The retention period cannot be updated\n if the channel's S3 storage is customer-managed.
" } - }, - "channelName": { - "target": "com.amazonaws.iotanalytics#ChannelName", - "traits": { - "smithy.api#documentation": "The name of the channel to be updated.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -4636,32 +4760,38 @@ "actions": { "target": "com.amazonaws.iotanalytics#DatasetActions", "traits": { - "smithy.api#documentation": "A list of \"DatasetAction\" objects.
", + "smithy.api#documentation": "A list of DatasetAction
objects.
[Optional] How many versions of data set contents are kept. If not specified or set to null, only the \n latest version plus the latest succeeded version (if they are different) are kept for \n the time period specified by the \"retentionPeriod\" parameter. (For more information, see\n https://docs.aws.amazon.com/iotanalytics/latest/userguide/getting-started.html#aws-iot-analytics-dataset-versions)
" + "smithy.api#documentation": "A list of DatasetTrigger
objects. The list can be empty or can contain up\n to five DatasetTrigger
objects.
When data set contents are created they are delivered to destinations specified here.
" + "smithy.api#documentation": "When dataset contents are created, they are delivered to destinations specified\n here.
" } }, "retentionPeriod": { "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { - "smithy.api#documentation": "How long, in days, data set contents are kept for the data set.
" + "smithy.api#documentation": "How long, in days, dataset contents are kept for the dataset.
" } }, - "triggers": { - "target": "com.amazonaws.iotanalytics#DatasetTriggers", + "versioningConfiguration": { + "target": "com.amazonaws.iotanalytics#VersioningConfiguration", + "traits": { + "smithy.api#documentation": "Optional. How many versions of dataset contents are kept. If not specified or set to\n null, only the latest version plus the latest succeeded version (if they are different) are\n kept for the time period specified by the retentionPeriod
parameter. For more\n information, see \n Keeping Multiple Versions of AWS IoT Analytics Data Sets in the AWS IoT\n Analytics User Guide.
A list of \"DatasetTrigger\" objects. The list can be empty or can contain up \n to five DataSetTrigger objects.
" + "smithy.api#documentation": "A list of data rules that send notifications to Amazon CloudWatch, when data arrives late. To\n specify lateDataRules
, the dataset must use a DeltaTimer\n filter.
Where data store data is stored. You may choose one of \"serviceManagedS3\" or \"customerManagedS3\" \n storage. If not specified, the default is \"serviceManagedS3\". This cannot be changed after the data\n store is created.
" - } - }, "retentionPeriod": { "target": "com.amazonaws.iotanalytics#RetentionPeriod", "traits": { "smithy.api#documentation": "How long, in days, message data is kept for the data store. The retention period cannot be updated\n if the data store's S3 storage is customer-managed.
" } + }, + "datastoreStorage": { + "target": "com.amazonaws.iotanalytics#DatastoreStorage", + "traits": { + "smithy.api#documentation": "Where data store data is stored. You can choose one of serviceManagedS3
or\n customerManagedS3
storage. If not specified, the default\n isserviceManagedS3
. You cannot change this storage option after the data store\n is created.
A list of \"PipelineActivity\" objects. Activities perform transformations on your messages, \n such as removing, renaming or adding message attributes; filtering messages based on attribute \n values; invoking your Lambda functions on messages for advanced processing; or performing \n mathematical transformations to normalize device data.
\nThe list can be 2-25 PipelineActivity objects and must \n contain both a channel
and a datastore
activity. Each entry in the \n list must contain only one activity, for example:
\n pipelineActivities = [\n {\n \"channel\": { ... }\n },\n {\n \"lambda\": { ... }\n },\n ... \n]
\n
A list of PipelineActivity
objects. Activities perform transformations on\n your messages, such as removing, renaming or adding message attributes; filtering messages\n based on attribute values; invoking your Lambda functions on messages for advanced processing;\n or performing mathematical transformations to normalize device data.
The list can be 2-25 PipelineActivity
objects and must contain both a\n channel
and a datastore
activity. Each entry in the list must\n contain only one activity. For example:
\n pipelineActivities = [\n {\n \"channel\": { ... }\n },\n {\n \"lambda\": { ... }\n },\n ... \n]
\n
The value of the variable as a structure that specifies an output file URI.
" + "smithy.api#documentation": "The name of the variable.
", + "smithy.api#required": {} + } + }, + "stringValue": { + "target": "com.amazonaws.iotanalytics#StringValue", + "traits": { + "smithy.api#documentation": "The value of the variable as a string.
" } }, "doubleValue": { @@ -4792,28 +4929,21 @@ "smithy.api#documentation": "The value of the variable as a double (numeric).
" } }, - "name": { - "target": "com.amazonaws.iotanalytics#VariableName", - "traits": { - "smithy.api#documentation": "The name of the variable.
", - "smithy.api#required": {} - } - }, "datasetContentVersionValue": { "target": "com.amazonaws.iotanalytics#DatasetContentVersionValue", "traits": { - "smithy.api#documentation": "The value of the variable as a structure that specifies a data set content version.
" + "smithy.api#documentation": "The value of the variable as a structure that specifies a dataset content\n version.
" } }, - "stringValue": { - "target": "com.amazonaws.iotanalytics#StringValue", + "outputFileUriValue": { + "target": "com.amazonaws.iotanalytics#OutputFileUriValue", "traits": { - "smithy.api#documentation": "The value of the variable as a string.
" + "smithy.api#documentation": "The value of the variable as a structure that specifies an output file URI.
" } } }, "traits": { - "smithy.api#documentation": "An instance of a variable to be passed to the \"containerAction\" execution. Each variable \n must have a name and a value given by one of \"stringValue\", \"datasetContentVersionValue\", or \n \"outputFileUriValue\".
" + "smithy.api#documentation": "An instance of a variable to be passed to the containerAction
execution.\n Each variable must have a name and a value given by one of stringValue
,\n datasetContentVersionValue
, or outputFileUriValue
.
If true, unlimited versions of data set contents will be kept.
" + "smithy.api#documentation": "If true, unlimited versions of dataset contents are kept.
" } }, "maxVersions": { "target": "com.amazonaws.iotanalytics#MaxVersions", "traits": { - "smithy.api#documentation": "How many versions of data set contents will be kept. The \"unlimited\" parameter must be false.
" + "smithy.api#documentation": "How many versions of dataset contents are kept. The unlimited
parameter\n must be false
.
Information about the versioning of data set contents.
" + "smithy.api#documentation": "Information about the versioning of dataset contents.
" } }, "com.amazonaws.iotanalytics#VolumeSizeInGB": { diff --git a/codegen/sdk-codegen/aws-models/macie2.2020-01-01.json b/codegen/sdk-codegen/aws-models/macie2.2020-01-01.json index 6d73b7d8b41f..b936a5cb83ed 100644 --- a/codegen/sdk-codegen/aws-models/macie2.2020-01-01.json +++ b/codegen/sdk-codegen/aws-models/macie2.2020-01-01.json @@ -72,19 +72,19 @@ "com.amazonaws.macie2#AcceptInvitationRequest": { "type": "structure", "members": { - "masterAccount": { + "invitationId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The AWS account ID for the account that sent the invitation.
", - "smithy.api#jsonName": "masterAccount", + "smithy.api#documentation": "The unique identifier for the invitation to accept.
", + "smithy.api#jsonName": "invitationId", "smithy.api#required": {} } }, - "invitationId": { + "masterAccount": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the invitation to accept.
", - "smithy.api#jsonName": "invitationId", + "smithy.api#documentation": "The AWS account ID for the account that sent the invitation.
", + "smithy.api#jsonName": "masterAccount", "smithy.api#required": {} } } @@ -97,18 +97,18 @@ "com.amazonaws.macie2#AccessControlList": { "type": "structure", "members": { - "allowsPublicWriteAccess": { + "allowsPublicReadAccess": { "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "Specifies whether the ACL grants the general public with write access permissions for the bucket.
", - "smithy.api#jsonName": "allowsPublicWriteAccess" + "smithy.api#documentation": "Specifies whether the ACL grants the general public with read access permissions for the bucket.
", + "smithy.api#jsonName": "allowsPublicReadAccess" } }, - "allowsPublicReadAccess": { + "allowsPublicWriteAccess": { "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "Specifies whether the ACL grants the general public with read access permissions for the bucket.
", - "smithy.api#jsonName": "allowsPublicReadAccess" + "smithy.api#documentation": "Specifies whether the ACL grants the general public with write access permissions for the bucket.
", + "smithy.api#jsonName": "allowsPublicWriteAccess" } } }, @@ -136,19 +136,19 @@ "com.amazonaws.macie2#AccountDetail": { "type": "structure", "members": { - "email": { + "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The email address for the account.
", - "smithy.api#jsonName": "email", + "smithy.api#documentation": "The AWS account ID for the account.
", + "smithy.api#jsonName": "accountId", "smithy.api#required": {} } }, - "accountId": { + "email": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The AWS account ID for the account.
", - "smithy.api#jsonName": "accountId", + "smithy.api#documentation": "The email address for the account.
", + "smithy.api#jsonName": "email", "smithy.api#required": {} } } @@ -175,19 +175,19 @@ "com.amazonaws.macie2#AdminAccount": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.macie2#AdminStatus", - "traits": { - "smithy.api#documentation": "The current status of the account as a delegated administrator of Amazon Macie for the organization.
", - "smithy.api#jsonName": "status" - } - }, "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#documentation": "The AWS account ID for the account.
", "smithy.api#jsonName": "accountId" } + }, + "status": { + "target": "com.amazonaws.macie2#AdminStatus", + "traits": { + "smithy.api#documentation": "The current status of the account as a delegated administrator of Amazon Macie for the organization.
", + "smithy.api#jsonName": "status" + } } }, "traits": { @@ -213,20 +213,6 @@ "com.amazonaws.macie2#ApiCallDetails": { "type": "structure", "members": { - "lastSeen": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "The most recent date and time, in UTC and extended ISO 8601 format, when the specified operation (api) was invoked and produced the finding.
", - "smithy.api#jsonName": "lastSeen" - } - }, - "firstSeen": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "The first date and time, in UTC and extended ISO 8601 format, when any operation was invoked and produced the finding.
", - "smithy.api#jsonName": "firstSeen" - } - }, "api": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -240,6 +226,20 @@ "smithy.api#documentation": "The URL of the AWS service that provides the operation, for example: s3.amazonaws.com.
", "smithy.api#jsonName": "apiServiceName" } + }, + "firstSeen": { + "target": "com.amazonaws.macie2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "The first date and time, in UTC and extended ISO 8601 format, when any operation was invoked and produced the finding.
", + "smithy.api#jsonName": "firstSeen" + } + }, + "lastSeen": { + "target": "com.amazonaws.macie2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "The most recent date and time, in UTC and extended ISO 8601 format, when the specified operation (api) was invoked and produced the finding.
", + "smithy.api#jsonName": "lastSeen" + } } }, "traits": { @@ -249,25 +249,18 @@ "com.amazonaws.macie2#AssumedRole": { "type": "structure", "members": { - "principalId": { + "accessKeyId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the entity that was used to get the credentials.
", - "smithy.api#jsonName": "principalId" - } - }, - "sessionContext": { - "target": "com.amazonaws.macie2#SessionContext", - "traits": { - "smithy.api#documentation": "The details of the session that was created for the credentials, including the entity that issued the session.
", - "smithy.api#jsonName": "sessionContext" + "smithy.api#documentation": "The AWS access key ID that identifies the credentials.
", + "smithy.api#jsonName": "accessKeyId" } }, - "accessKeyId": { + "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The AWS access key ID that identifies the credentials.
", - "smithy.api#jsonName": "accessKeyId" + "smithy.api#documentation": "The unique identifier for the AWS account that owns the entity that was used to get the credentials.
", + "smithy.api#jsonName": "accountId" } }, "arn": { @@ -277,11 +270,18 @@ "smithy.api#jsonName": "arn" } }, - "accountId": { + "principalId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the AWS account that owns the entity that was used to get the credentials.
", - "smithy.api#jsonName": "accountId" + "smithy.api#documentation": "The unique identifier for the entity that was used to get the credentials.
", + "smithy.api#jsonName": "principalId" + } + }, + "sessionContext": { + "target": "com.amazonaws.macie2#SessionContext", + "traits": { + "smithy.api#documentation": "The details of the session that was created for the credentials, including the entity that issued the session.
", + "smithy.api#jsonName": "sessionContext" } } }, @@ -292,18 +292,18 @@ "com.amazonaws.macie2#AwsAccount": { "type": "structure", "members": { - "principalId": { + "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the entity that performed the action.
", - "smithy.api#jsonName": "principalId" + "smithy.api#documentation": "The unique identifier for the AWS account.
", + "smithy.api#jsonName": "accountId" } }, - "accountId": { + "principalId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the AWS account.
", - "smithy.api#jsonName": "accountId" + "smithy.api#documentation": "The unique identifier for the entity that performed the action.
", + "smithy.api#jsonName": "principalId" } } }, @@ -336,11 +336,11 @@ "smithy.api#jsonName": "arn" } }, - "id": { - "target": "com.amazonaws.macie2#__string", + "createdAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "The unique identifier for the custom data identifier.
", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.
", + "smithy.api#jsonName": "createdAt" } }, "deleted": { @@ -350,13 +350,6 @@ "smithy.api#jsonName": "deleted" } }, - "createdAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.
", - "smithy.api#jsonName": "createdAt" - } - }, "description": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -364,6 +357,13 @@ "smithy.api#jsonName": "description" } }, + "id": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The unique identifier for the custom data identifier.
", + "smithy.api#jsonName": "id" + } + }, "name": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -450,11 +450,11 @@ "com.amazonaws.macie2#BlockPublicAccess": { "type": "structure", "members": { - "restrictPublicBuckets": { + "blockPublicAcls": { "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "Specifies whether Amazon S3 restricts public bucket policies for the bucket.
", - "smithy.api#jsonName": "restrictPublicBuckets" + "smithy.api#documentation": "Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.
", + "smithy.api#jsonName": "blockPublicAcls" } }, "blockPublicPolicy": { @@ -471,11 +471,11 @@ "smithy.api#jsonName": "ignorePublicAcls" } }, - "blockPublicAcls": { + "restrictPublicBuckets": { "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.
", - "smithy.api#jsonName": "blockPublicAcls" + "smithy.api#documentation": "Specifies whether Amazon S3 restricts public bucket policies for the bucket.
", + "smithy.api#jsonName": "restrictPublicBuckets" } } }, @@ -486,13 +486,6 @@ "com.amazonaws.macie2#BucketCountByEffectivePermission": { "type": "structure", "members": { - "unknown": { - "target": "com.amazonaws.macie2#__long", - "traits": { - "smithy.api#documentation": "The total number of buckets that Amazon Macie wasn't able to evaluate permissions settings for. Macie can't determine whether these buckets are publicly accessible.
", - "smithy.api#jsonName": "unknown" - } - }, "publiclyAccessible": { "target": "com.amazonaws.macie2#__long", "traits": { @@ -513,6 +506,13 @@ "smithy.api#documentation": "The total number of buckets that allow the general public to have write access to the bucket.
", "smithy.api#jsonName": "publiclyWritable" } + }, + "unknown": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "The total number of buckets that Amazon Macie wasn't able to evaluate permissions settings for. Macie can't determine whether these buckets are publicly accessible.
", + "smithy.api#jsonName": "unknown" + } } }, "traits": { @@ -522,11 +522,11 @@ "com.amazonaws.macie2#BucketCountByEncryptionType": { "type": "structure", "members": { - "unencrypted": { + "kmsManaged": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The total number of buckets that don't encrypt objects by default. Default encryption is disabled for these buckets.
", - "smithy.api#jsonName": "unencrypted" + "smithy.api#documentation": "The total number of buckets that use an AWS Key Management Service (AWS KMS) customer master key (CMK) to encrypt objects. These buckets use AWS KMS AWS-managed (AWS-KMS) encryption or AWS KMS customer-managed (SSE-KMS) encryption.
", + "smithy.api#jsonName": "kmsManaged" } }, "s3Managed": { @@ -536,11 +536,11 @@ "smithy.api#jsonName": "s3Managed" } }, - "kmsManaged": { + "unencrypted": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The total number of buckets that use an AWS Key Management Service (AWS KMS) customer master key (CMK) to encrypt objects. These buckets use AWS KMS AWS-managed (AWS-KMS) encryption or AWS KMS customer-managed (SSE-KMS) encryption.
", - "smithy.api#jsonName": "kmsManaged" + "smithy.api#documentation": "The total number of buckets that don't encrypt objects by default. Default encryption is disabled for these buckets.
", + "smithy.api#jsonName": "unencrypted" } } }, @@ -558,13 +558,6 @@ "smithy.api#jsonName": "external" } }, - "unknown": { - "target": "com.amazonaws.macie2#__long", - "traits": { - "smithy.api#documentation": "The total number of buckets that Amazon Macie wasn't able to evaluate shared access settings for. Macie can't determine whether these buckets are shared with other AWS accounts.
", - "smithy.api#jsonName": "unknown" - } - }, "internal": { "target": "com.amazonaws.macie2#__long", "traits": { @@ -578,6 +571,13 @@ "smithy.api#documentation": "The total number of buckets that aren't shared with other AWS accounts.
", "smithy.api#jsonName": "notShared" } + }, + "unknown": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "The total number of buckets that Amazon Macie wasn't able to evaluate shared access settings for. Macie can't determine whether these buckets are shared with other AWS accounts.
", + "smithy.api#jsonName": "unknown" + } } }, "traits": { @@ -599,13 +599,6 @@ "com.amazonaws.macie2#BucketCriteriaAdditionalProperties": { "type": "structure", "members": { - "lte": { - "target": "com.amazonaws.macie2#__long", - "traits": { - "smithy.api#documentation": "A less than or equal to condition to apply to a specified attribute value for buckets.
", - "smithy.api#jsonName": "lte" - } - }, "eq": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { @@ -620,11 +613,11 @@ "smithy.api#jsonName": "gt" } }, - "prefix": { - "target": "com.amazonaws.macie2#__string", + "gte": { + "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The prefix of the buckets to include in the results.
", - "smithy.api#jsonName": "prefix" + "smithy.api#documentation": "A greater than or equal to condition to apply to a specified attribute value for buckets.
", + "smithy.api#jsonName": "gte" } }, "lt": { @@ -634,11 +627,11 @@ "smithy.api#jsonName": "lt" } }, - "gte": { + "lte": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "A greater than or equal to condition to apply to a specified attribute value for buckets.
", - "smithy.api#jsonName": "gte" + "smithy.api#documentation": "A less than or equal to condition to apply to a specified attribute value for buckets.
", + "smithy.api#jsonName": "lte" } }, "neq": { @@ -647,6 +640,13 @@ "smithy.api#documentation": "A not equal to condition to apply to a specified attribute value for buckets.
", "smithy.api#jsonName": "neq" } + }, + "prefix": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The prefix of the buckets to include in the results.
", + "smithy.api#jsonName": "prefix" + } } }, "traits": { @@ -663,19 +663,19 @@ "smithy.api#jsonName": "accessControlList" } }, - "bucketPolicy": { - "target": "com.amazonaws.macie2#BucketPolicy", - "traits": { - "smithy.api#documentation": "The permissions settings of the bucket policy for the bucket. This value is null if a bucket policy hasn't been defined for the bucket.
", - "smithy.api#jsonName": "bucketPolicy" - } - }, "blockPublicAccess": { "target": "com.amazonaws.macie2#BlockPublicAccess", "traits": { "smithy.api#documentation": "The block public access settings for the bucket.
", "smithy.api#jsonName": "blockPublicAccess" } + }, + "bucketPolicy": { + "target": "com.amazonaws.macie2#BucketPolicy", + "traits": { + "smithy.api#documentation": "The permissions settings of the bucket policy for the bucket. This value is null if a bucket policy hasn't been defined for the bucket.
", + "smithy.api#jsonName": "bucketPolicy" + } } }, "traits": { @@ -685,67 +685,60 @@ "com.amazonaws.macie2#BucketMetadata": { "type": "structure", "members": { - "bucketCreatedAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
", - "smithy.api#jsonName": "bucketCreatedAt" - } - }, - "region": { + "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The AWS Region that hosts the bucket.
", - "smithy.api#jsonName": "region" + "smithy.api#documentation": "The unique identifier for the AWS account that owns the bucket.
", + "smithy.api#jsonName": "accountId" } }, - "accountId": { + "bucketArn": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the AWS account that owns the bucket.
", - "smithy.api#jsonName": "accountId" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bucket.
", + "smithy.api#jsonName": "bucketArn" } }, - "sizeInBytesCompressed": { - "target": "com.amazonaws.macie2#__long", + "bucketCreatedAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "The total compressed storage size, in bytes, of the bucket.
", - "smithy.api#jsonName": "sizeInBytesCompressed" + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
", + "smithy.api#jsonName": "bucketCreatedAt" } }, - "tags": { - "target": "com.amazonaws.macie2#__listOfKeyValuePair", + "bucketName": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "An array that specifies the tags (keys and values) that are associated with the bucket.
", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The name of the bucket.
", + "smithy.api#jsonName": "bucketName" } }, - "unclassifiableObjectCount": { - "target": "com.amazonaws.macie2#ObjectLevelStatistics", + "classifiableObjectCount": { + "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
", - "smithy.api#jsonName": "unclassifiableObjectCount" + "smithy.api#documentation": "The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.
", + "smithy.api#jsonName": "classifiableObjectCount" } }, - "sizeInBytes": { + "classifiableSizeInBytes": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The total storage size, in bytes, of the bucket.
", - "smithy.api#jsonName": "sizeInBytes" + "smithy.api#documentation": "The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.
", + "smithy.api#jsonName": "classifiableSizeInBytes" } }, - "replicationDetails": { - "target": "com.amazonaws.macie2#ReplicationDetails", + "lastUpdated": { + "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "Specifies whether the bucket is configured to replicate one or more objects to buckets for other AWS accounts and, if so, which accounts.
", - "smithy.api#jsonName": "replicationDetails" + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved data about the bucket from Amazon S3.
", + "smithy.api#jsonName": "lastUpdated" } }, - "bucketName": { - "target": "com.amazonaws.macie2#__string", + "objectCount": { + "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The name of the bucket.
", - "smithy.api#jsonName": "bucketName" + "smithy.api#documentation": "The total number of objects in the bucket.
", + "smithy.api#jsonName": "objectCount" } }, "objectCountByEncryptionType": { @@ -755,67 +748,74 @@ "smithy.api#jsonName": "objectCountByEncryptionType" } }, - "unclassifiableObjectSizeInBytes": { - "target": "com.amazonaws.macie2#ObjectLevelStatistics", + "publicAccess": { + "target": "com.amazonaws.macie2#BucketPublicAccess", "traits": { - "smithy.api#documentation": "The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
", - "smithy.api#jsonName": "unclassifiableObjectSizeInBytes" + "smithy.api#documentation": "Specifies whether the bucket is publicly accessible. If this value is true, an access control list (ACL), bucket policy, or block public access settings allow the bucket to be accessed by the general public.
", + "smithy.api#jsonName": "publicAccess" } }, - "classifiableSizeInBytes": { - "target": "com.amazonaws.macie2#__long", + "region": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.
", - "smithy.api#jsonName": "classifiableSizeInBytes" + "smithy.api#documentation": "The AWS Region that hosts the bucket.
", + "smithy.api#jsonName": "region" } }, - "classifiableObjectCount": { - "target": "com.amazonaws.macie2#__long", + "replicationDetails": { + "target": "com.amazonaws.macie2#ReplicationDetails", "traits": { - "smithy.api#documentation": "The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.
", - "smithy.api#jsonName": "classifiableObjectCount" + "smithy.api#documentation": "Specifies whether the bucket is configured to replicate one or more objects to buckets for other AWS accounts and, if so, which accounts.
", + "smithy.api#jsonName": "replicationDetails" } }, - "objectCount": { + "sharedAccess": { + "target": "com.amazonaws.macie2#SharedAccess", + "traits": { + "smithy.api#documentation": "Specifies whether the bucket is shared with another AWS account. Possible values are:
EXTERNAL - The bucket is shared with an AWS account that isn't part of the same Amazon Macie organization.
INTERNAL - The bucket is shared with an AWS account that's part of the same Amazon Macie organization.
NOT_SHARED - The bucket isn't shared with other AWS accounts.
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
The total number of objects in the bucket.
", - "smithy.api#jsonName": "objectCount" + "smithy.api#documentation": "The total storage size, in bytes, of the bucket.
", + "smithy.api#jsonName": "sizeInBytes" } }, - "sharedAccess": { - "target": "com.amazonaws.macie2#SharedAccess", + "sizeInBytesCompressed": { + "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "Specifies whether the bucket is shared with another AWS account. Possible values are:
EXTERNAL - The bucket is shared with an AWS account that isn't part of the same Amazon Macie organization.
INTERNAL - The bucket is shared with an AWS account that's part of the same Amazon Macie organization.
NOT_SHARED - The bucket isn't shared with other AWS accounts.
UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.
The total compressed storage size, in bytes, of the bucket.
", + "smithy.api#jsonName": "sizeInBytesCompressed" } }, - "versioning": { - "target": "com.amazonaws.macie2#__boolean", + "tags": { + "target": "com.amazonaws.macie2#__listOfKeyValuePair", "traits": { - "smithy.api#documentation": "Specifies whether versioning is enabled for the bucket.
", - "smithy.api#jsonName": "versioning" + "smithy.api#documentation": "An array that specifies the tags (keys and values) that are associated with the bucket.
", + "smithy.api#jsonName": "tags" } }, - "bucketArn": { - "target": "com.amazonaws.macie2#__string", + "unclassifiableObjectCount": { + "target": "com.amazonaws.macie2#ObjectLevelStatistics", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bucket.
", - "smithy.api#jsonName": "bucketArn" + "smithy.api#documentation": "The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
", + "smithy.api#jsonName": "unclassifiableObjectCount" } }, - "lastUpdated": { - "target": "com.amazonaws.macie2#__timestampIso8601", + "unclassifiableObjectSizeInBytes": { + "target": "com.amazonaws.macie2#ObjectLevelStatistics", "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved data about the bucket from Amazon S3.
", - "smithy.api#jsonName": "lastUpdated" + "smithy.api#documentation": "The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
", + "smithy.api#jsonName": "unclassifiableObjectSizeInBytes" } }, - "publicAccess": { - "target": "com.amazonaws.macie2#BucketPublicAccess", + "versioning": { + "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "Specifies whether the bucket is publicly accessible. If this value is true, an access control list (ACL), bucket policy, or block public access settings allow the bucket to be accessed by the general public.
", - "smithy.api#jsonName": "publicAccess" + "smithy.api#documentation": "Specifies whether versioning is enabled for the bucket.
", + "smithy.api#jsonName": "versioning" } } }, @@ -870,19 +870,19 @@ "com.amazonaws.macie2#BucketPublicAccess": { "type": "structure", "members": { - "permissionConfiguration": { - "target": "com.amazonaws.macie2#BucketPermissionConfiguration", - "traits": { - "smithy.api#documentation": "The account-level and bucket-level permissions for the bucket.
", - "smithy.api#jsonName": "permissionConfiguration" - } - }, "effectivePermission": { "target": "com.amazonaws.macie2#EffectivePermission", "traits": { "smithy.api#documentation": "Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket. Possible values are:
NOT_PUBLIC - The bucket isn't publicly accessible.
PUBLIC - The bucket is publicly accessible.
UNKNOWN - Amazon Macie can't determine whether the bucket is publicly accessible.
The account-level and bucket-level permissions for the bucket.
", + "smithy.api#jsonName": "permissionConfiguration" + } } }, "traits": { @@ -892,19 +892,19 @@ "com.amazonaws.macie2#BucketSortCriteria": { "type": "structure", "members": { - "orderBy": { - "target": "com.amazonaws.macie2#OrderBy", - "traits": { - "smithy.api#documentation": "The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.
", - "smithy.api#jsonName": "orderBy" - } - }, "attributeName": { "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#documentation": "The name of the attribute to sort the results by. This value can be the name of any property that Amazon Macie defines as bucket metadata, such as bucketName or accountId.
", "smithy.api#jsonName": "attributeName" } + }, + "orderBy": { + "target": "com.amazonaws.macie2#OrderBy", + "traits": { + "smithy.api#documentation": "The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.
", + "smithy.api#jsonName": "orderBy" + } } }, "traits": { @@ -914,11 +914,11 @@ "com.amazonaws.macie2#Cell": { "type": "structure", "members": { - "row": { - "target": "com.amazonaws.macie2#__long", + "cellReference": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The row number of the row that contains the data.
", - "smithy.api#jsonName": "row" + "smithy.api#documentation": "The location of the cell, as an absolute cell reference, that contains the data. For example, Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.
", + "smithy.api#jsonName": "cellReference" } }, "column": { @@ -935,11 +935,11 @@ "smithy.api#jsonName": "columnName" } }, - "cellReference": { - "target": "com.amazonaws.macie2#__string", + "row": { + "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The location of the cell, as an absolute cell reference, that contains the data. For example, Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.
", - "smithy.api#jsonName": "cellReference" + "smithy.api#documentation": "The row number of the row that contains the data.
", + "smithy.api#jsonName": "row" } } }, @@ -959,6 +959,13 @@ "com.amazonaws.macie2#ClassificationDetails": { "type": "structure", "members": { + "detailedResultsLocation": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The path to the folder or file (in Amazon S3) that contains the corresponding sensitive data discovery result for the finding. If a finding applies to a large archive or compressed file, this value is the path to a folder. Otherwise, this value is the path to a file.
", + "smithy.api#jsonName": "detailedResultsLocation" + } + }, "jobArn": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -979,13 +986,6 @@ "smithy.api#documentation": "The status and other details for the finding.
", "smithy.api#jsonName": "result" } - }, - "detailedResultsLocation": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The path to the folder or file (in Amazon S3) that contains the corresponding sensitive data discovery result for the finding. If a finding applies to a large archive or compressed file, this value is the path to a folder. Otherwise, this value is the path to a file.
", - "smithy.api#jsonName": "detailedResultsLocation" - } } }, "traits": { @@ -1010,11 +1010,18 @@ "com.amazonaws.macie2#ClassificationResult": { "type": "structure", "members": { - "sensitiveData": { - "target": "com.amazonaws.macie2#SensitiveData", + "additionalOccurrences": { + "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "The category, types, and number of occurrences of the sensitive data that produced the finding.
", - "smithy.api#jsonName": "sensitiveData" + "smithy.api#documentation": "Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.
This value can help you to determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (ClassificationDetails.detailedResultsLocation).
", + "smithy.api#jsonName": "additionalOccurrences" + } + }, + "customDataIdentifiers": { + "target": "com.amazonaws.macie2#CustomDataIdentifiers", + "traits": { + "smithy.api#documentation": "The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.
", + "smithy.api#jsonName": "customDataIdentifiers" } }, "mimeType": { @@ -1024,6 +1031,13 @@ "smithy.api#jsonName": "mimeType" } }, + "sensitiveData": { + "target": "com.amazonaws.macie2#SensitiveData", + "traits": { + "smithy.api#documentation": "The category, types, and number of occurrences of the sensitive data that produced the finding.
", + "smithy.api#jsonName": "sensitiveData" + } + }, "sizeClassified": { "target": "com.amazonaws.macie2#__long", "traits": { @@ -1031,26 +1045,12 @@ "smithy.api#jsonName": "sizeClassified" } }, - "additionalOccurrences": { - "target": "com.amazonaws.macie2#__boolean", - "traits": { - "smithy.api#documentation": "Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.
This value can help you to determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (ClassificationDetails.detailedResultsLocation).
", - "smithy.api#jsonName": "additionalOccurrences" - } - }, "status": { "target": "com.amazonaws.macie2#ClassificationResultStatus", "traits": { "smithy.api#documentation": "The status of the finding.
", "smithy.api#jsonName": "status" } - }, - "customDataIdentifiers": { - "target": "com.amazonaws.macie2#CustomDataIdentifiers", - "traits": { - "smithy.api#documentation": "The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.
", - "smithy.api#jsonName": "customDataIdentifiers" - } } }, "traits": { @@ -1139,21 +1139,6 @@ "com.amazonaws.macie2#CreateClassificationJobRequest": { "type": "structure", "members": { - "s3JobDefinition": { - "target": "com.amazonaws.macie2#S3JobDefinition", - "traits": { - "smithy.api#documentation": "The S3 buckets that contain the objects to analyze, and the scope of that analysis.
", - "smithy.api#jsonName": "s3JobDefinition", - "smithy.api#required": {} - } - }, - "customDataIdentifierIds": { - "target": "com.amazonaws.macie2#__listOf__string", - "traits": { - "smithy.api#documentation": "The custom data identifiers to use for data analysis and classification.
", - "smithy.api#jsonName": "customDataIdentifierIds" - } - }, "clientToken": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -1163,11 +1148,11 @@ "smithy.api#required": {} } }, - "tags": { - "target": "com.amazonaws.macie2#TagMap", + "customDataIdentifierIds": { + "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "A map of key-value pairs that specifies the tags to associate with the job.
A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The custom data identifiers to use for data analysis and classification.
", + "smithy.api#jsonName": "customDataIdentifierIds" } }, "description": { @@ -1192,13 +1177,6 @@ "smithy.api#required": {} } }, - "samplingPercentage": { - "target": "com.amazonaws.macie2#__integer", - "traits": { - "smithy.api#documentation": "The sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.
", - "smithy.api#jsonName": "samplingPercentage" - } - }, "name": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -1207,12 +1185,34 @@ "smithy.api#required": {} } }, + "s3JobDefinition": { + "target": "com.amazonaws.macie2#S3JobDefinition", + "traits": { + "smithy.api#documentation": "The S3 buckets that contain the objects to analyze, and the scope of that analysis.
", + "smithy.api#jsonName": "s3JobDefinition", + "smithy.api#required": {} + } + }, + "samplingPercentage": { + "target": "com.amazonaws.macie2#__integer", + "traits": { + "smithy.api#documentation": "The sampling depth, as a percentage, to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.
", + "smithy.api#jsonName": "samplingPercentage" + } + }, "scheduleFrequency": { "target": "com.amazonaws.macie2#JobScheduleFrequency", "traits": { "smithy.api#documentation": "The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.
", "smithy.api#jsonName": "scheduleFrequency" } + }, + "tags": { + "target": "com.amazonaws.macie2#TagMap", + "traits": { + "smithy.api#documentation": "A map of key-value pairs that specifies the tags to associate with the job.
A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
", + "smithy.api#jsonName": "tags" + } } } }, @@ -1278,11 +1278,12 @@ "com.amazonaws.macie2#CreateCustomDataIdentifierRequest": { "type": "structure", "members": { - "keywords": { - "target": "com.amazonaws.macie2#__listOf__string", + "clientToken": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 4 - 90 characters. Keywords aren't case sensitive.
", - "smithy.api#jsonName": "keywords" + "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure the idempotency of the request.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" } }, "description": { @@ -1299,19 +1300,18 @@ "smithy.api#jsonName": "ignoreWords" } }, - "clientToken": { - "target": "com.amazonaws.macie2#__string", + "keywords": { + "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "A unique, case-sensitive token that you provide to ensure the idempotency of the request.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "clientToken" + "smithy.api#documentation": "An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 4 - 90 characters. Keywords aren't case sensitive.
", + "smithy.api#jsonName": "keywords" } }, - "tags": { - "target": "com.amazonaws.macie2#TagMap", + "maximumMatchDistance": { + "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "A map of key-value pairs that specifies the tags to associate with the custom data identifier.
A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.
", + "smithy.api#jsonName": "maximumMatchDistance" } }, "name": { @@ -1328,11 +1328,11 @@ "smithy.api#jsonName": "regex" } }, - "maximumMatchDistance": { - "target": "com.amazonaws.macie2#__integer", + "tags": { + "target": "com.amazonaws.macie2#TagMap", "traits": { - "smithy.api#documentation": "The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.
", - "smithy.api#jsonName": "maximumMatchDistance" + "smithy.api#documentation": "A map of key-value pairs that specifies the tags to associate with the custom data identifier.
A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
", + "smithy.api#jsonName": "tags" } } } @@ -1392,13 +1392,6 @@ "com.amazonaws.macie2#CreateFindingsFilterRequest": { "type": "structure", "members": { - "position": { - "target": "com.amazonaws.macie2#__integer", - "traits": { - "smithy.api#documentation": "The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.
", - "smithy.api#jsonName": "position" - } - }, "action": { "target": "com.amazonaws.macie2#FindingsFilterAction", "traits": { @@ -1415,6 +1408,13 @@ "smithy.api#jsonName": "clientToken" } }, + "description": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "A custom description of the filter. The description can contain as many as 512 characters.
We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.
", + "smithy.api#jsonName": "description" + } + }, "findingCriteria": { "target": "com.amazonaws.macie2#FindingCriteria", "traits": { @@ -1431,11 +1431,11 @@ "smithy.api#required": {} } }, - "description": { - "target": "com.amazonaws.macie2#__string", + "position": { + "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "A custom description of the filter. The description can contain as many as 512 characters.
We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.
", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.
", + "smithy.api#jsonName": "position" } }, "tags": { @@ -1509,11 +1509,12 @@ "com.amazonaws.macie2#CreateInvitationsRequest": { "type": "structure", "members": { - "message": { - "target": "com.amazonaws.macie2#__string", + "accountIds": { + "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "A custom message to include in the invitation. Amazon Macie adds this message to the standard content that it sends for an invitation.
", - "smithy.api#jsonName": "message" + "smithy.api#documentation": "An array that lists AWS account IDs, one for each account to send the invitation to.
", + "smithy.api#jsonName": "accountIds", + "smithy.api#required": {} } }, "disableEmailNotification": { @@ -1522,13 +1523,12 @@ "smithy.api#documentation": "Specifies whether to send an email notification to the root user of each account that the invitation will be sent to. This notification is in addition to an alert that the root user receives in AWS Personal Health Dashboard. To send an email notification to the root user of each account, set this value to true.
", "smithy.api#jsonName": "disableEmailNotification" } - }, - "accountIds": { - "target": "com.amazonaws.macie2#__listOf__string", + }, + "message": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "An array that lists AWS account IDs, one for each account to send the invitation to.
", - "smithy.api#jsonName": "accountIds", - "smithy.api#required": {} + "smithy.api#documentation": "A custom message to include in the invitation. Amazon Macie adds this message to the standard content that it sends for an invitation.
", + "smithy.api#jsonName": "message" } } } @@ -1588,13 +1588,6 @@ "com.amazonaws.macie2#CreateMemberRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.macie2#TagMap", - "traits": { - "smithy.api#documentation": "A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie.
An account can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
", - "smithy.api#jsonName": "tags" - } - }, "account": { "target": "com.amazonaws.macie2#AccountDetail", "traits": { @@ -1602,6 +1595,13 @@ "smithy.api#jsonName": "account", "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.macie2#TagMap", + "traits": { + "smithy.api#documentation": "A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie.
An account can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
", + "smithy.api#jsonName": "tags" + } } } }, @@ -1695,6 +1695,13 @@ "smithy.api#jsonName": "eq" } }, + "eqExactMatch": { + "target": "com.amazonaws.macie2#__listOf__string", + "traits": { + "smithy.api#documentation": "A condition that requires an array field of a finding to exactly match the specified property values. You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.
", + "smithy.api#jsonName": "eqExactMatch" + } + }, "gt": { "target": "com.amazonaws.macie2#__long", "traits": { @@ -1702,11 +1709,11 @@ "smithy.api#jsonName": "gt" } }, - "lte": { + "gte": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "A less than or equal to condition to apply to a specified property value for findings.
", - "smithy.api#jsonName": "lte" + "smithy.api#documentation": "A greater than or equal to condition to apply to a specified property value for findings.
", + "smithy.api#jsonName": "gte" } }, "lt": { @@ -1716,25 +1723,18 @@ "smithy.api#jsonName": "lt" } }, - "neq": { - "target": "com.amazonaws.macie2#__listOf__string", - "traits": { - "smithy.api#documentation": "A not equal to condition to apply to a specified property value for findings.
", - "smithy.api#jsonName": "neq" - } - }, - "gte": { + "lte": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "A greater than or equal to condition to apply to a specified property value for findings.
", - "smithy.api#jsonName": "gte" + "smithy.api#documentation": "A less than or equal to condition to apply to a specified property value for findings.
", + "smithy.api#jsonName": "lte" } }, - "eqExactMatch": { + "neq": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "A condition that requires an array field on a finding to exactly match the specified property values. You can use this operator with the following properties:
customDataIdentifiers.detections.arn
customDataIdentifiers.detections.name
resourcesAffected.s3Bucket.tags.key
resourcesAffected.s3Bucket.tags.value
resourcesAffected.s3Object.tags.key
resourcesAffected.s3Object.tags.value
sensitiveData.category
sensitiveData.detections.type
A not equal to condition to apply to a specified property value for findings.
", + "smithy.api#jsonName": "neq" } } }, @@ -1757,13 +1757,6 @@ "com.amazonaws.macie2#CustomDataIdentifierSummary": { "type": "structure", "members": { - "name": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The custom name of the custom data identifier.
", - "smithy.api#jsonName": "name" - } - }, "arn": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -1771,13 +1764,6 @@ "smithy.api#jsonName": "arn" } }, - "description": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The custom description of the custom data identifier.
", - "smithy.api#jsonName": "description" - } - }, "createdAt": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { @@ -1785,12 +1771,26 @@ "smithy.api#jsonName": "createdAt" } }, + "description": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The custom description of the custom data identifier.
", + "smithy.api#jsonName": "description" + } + }, "id": { "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#documentation": "The unique identifier for the custom data identifier.
", "smithy.api#jsonName": "id" } + }, + "name": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The custom name of the custom data identifier.
", + "smithy.api#jsonName": "name" + } } }, "traits": { @@ -1800,19 +1800,19 @@ "com.amazonaws.macie2#CustomDataIdentifiers": { "type": "structure", "members": { - "totalCount": { - "target": "com.amazonaws.macie2#__long", - "traits": { - "smithy.api#documentation": "The total number of occurrences of the data that was detected by the custom data identifiers and produced the finding.
", - "smithy.api#jsonName": "totalCount" - } - }, "detections": { "target": "com.amazonaws.macie2#CustomDetections", "traits": { "smithy.api#documentation": "The custom data identifiers that detected the data, and the number of occurrences of the data that each identifier detected.
", "smithy.api#jsonName": "detections" } + }, + "totalCount": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "The total number of occurrences of the data that was detected by the custom data identifiers and produced the finding.
", + "smithy.api#jsonName": "totalCount" + } } }, "traits": { @@ -1822,11 +1822,11 @@ "com.amazonaws.macie2#CustomDetection": { "type": "structure", "members": { - "occurrences": { - "target": "com.amazonaws.macie2#Occurrences", + "arn": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The location of 1-15 occurrences of the sensitive data that the custom data identifier detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.
", - "smithy.api#jsonName": "occurrences" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom data identifier.
", + "smithy.api#jsonName": "arn" } }, "count": { @@ -1843,11 +1843,11 @@ "smithy.api#jsonName": "name" } }, - "arn": { - "target": "com.amazonaws.macie2#__string", + "occurrences": { + "target": "com.amazonaws.macie2#Occurrences", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom data identifier.
", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The location of 1-15 occurrences of the sensitive data that the custom data identifier detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.
", + "smithy.api#jsonName": "occurrences" } } }, @@ -1981,19 +1981,19 @@ "smithy.api#jsonName": "count" } }, - "type": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The type of sensitive data that was detected. For example, AWS_CREDENTIALS, PHONE_NUMBER, or ADDRESS.
", - "smithy.api#jsonName": "type" - } - }, "occurrences": { "target": "com.amazonaws.macie2#Occurrences", "traits": { "smithy.api#documentation": "The location of 1-15 occurrences of the sensitive data that was detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.
", "smithy.api#jsonName": "occurrences" } + }, + "type": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The type of sensitive data that was detected. For example, AWS_CREDENTIALS, PHONE_NUMBER, or ADDRESS.
", + "smithy.api#jsonName": "type" + } } }, "traits": { @@ -2294,18 +2294,11 @@ "com.amazonaws.macie2#DescribeBucketsRequest": { "type": "structure", "members": { - "sortCriteria": { - "target": "com.amazonaws.macie2#BucketSortCriteria", - "traits": { - "smithy.api#documentation": "The criteria to use to sort the query results.
", - "smithy.api#jsonName": "sortCriteria" - } - }, - "nextToken": { - "target": "com.amazonaws.macie2#__string", + "criteria": { + "target": "com.amazonaws.macie2#BucketCriteria", "traits": { - "smithy.api#documentation": "The nextToken string that specifies which page of results to return in a paginated response.
", - "smithy.api#jsonName": "nextToken" + "smithy.api#documentation": "The criteria to use to filter the query results.
", + "smithy.api#jsonName": "criteria" } }, "maxResults": { @@ -2315,11 +2308,18 @@ "smithy.api#jsonName": "maxResults" } }, - "criteria": { - "target": "com.amazonaws.macie2#BucketCriteria", + "nextToken": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The criteria to use to filter the query results.
", - "smithy.api#jsonName": "criteria" + "smithy.api#documentation": "The nextToken string that specifies which page of results to return in a paginated response.
", + "smithy.api#jsonName": "nextToken" + } + }, + "sortCriteria": { + "target": "com.amazonaws.macie2#BucketSortCriteria", + "traits": { + "smithy.api#documentation": "The criteria to use to sort the query results.
", + "smithy.api#jsonName": "sortCriteria" } } } @@ -2399,39 +2399,33 @@ "com.amazonaws.macie2#DescribeClassificationJobResponse": { "type": "structure", "members": { - "samplingPercentage": { - "target": "com.amazonaws.macie2#__integer", - "traits": { - "smithy.api#documentation": "The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.
", - "smithy.api#jsonName": "samplingPercentage" - } - }, - "name": { + "clientToken": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The custom name of the job.
", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "The token that was provided to ensure the idempotency of the request to create the job.
", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientToken" } }, - "jobArn": { - "target": "com.amazonaws.macie2#__string", + "createdAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job.
", - "smithy.api#jsonName": "jobArn" + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the job was created.
", + "smithy.api#jsonName": "createdAt" } }, - "lastRunTime": { - "target": "com.amazonaws.macie2#__timestampIso8601", + "customDataIdentifierIds": { + "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the job last ran.
", - "smithy.api#jsonName": "lastRunTime" + "smithy.api#documentation": "The custom data identifiers that the job uses to analyze data.
", + "smithy.api#jsonName": "customDataIdentifierIds" } }, - "tags": { - "target": "com.amazonaws.macie2#TagMap", + "description": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.
", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The custom description of the job.
", + "smithy.api#jsonName": "description" } }, "initialRun": { @@ -2441,47 +2435,46 @@ "smithy.api#jsonName": "initialRun" } }, - "userPausedDetails": { - "target": "com.amazonaws.macie2#UserPausedDetails", + "jobArn": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.
", - "smithy.api#jsonName": "userPausedDetails" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the job.
", + "smithy.api#jsonName": "jobArn" } }, - "description": { + "jobId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The custom description of the job.
", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "The unique identifier for the job.
", + "smithy.api#jsonName": "jobId" } }, - "clientToken": { - "target": "com.amazonaws.macie2#__string", + "jobStatus": { + "target": "com.amazonaws.macie2#JobStatus", "traits": { - "smithy.api#documentation": "The token that was provided to ensure the idempotency of the request to create the job.
", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "clientToken" + "smithy.api#documentation": "The current status of the job. Possible values are:
CANCELLED - You cancelled the job, or you paused the job and didn't resume it within 30 days of pausing it.
COMPLETE - For a one-time job, Amazon Macie finished processing all the data specified for the job. This value doesn't apply to recurring jobs.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
PAUSED - Amazon Macie started running the job but completion of the job would exceed one or more quotas for your account.
RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
USER_PAUSED - You paused the job. If you don't resume the job within 30 days of pausing it, the job will expire and be cancelled.
The custom data identifiers that the job uses to analyze data.
", - "smithy.api#jsonName": "customDataIdentifierIds" + "smithy.api#documentation": "The schedule for running the job. Possible values are:
ONE_TIME - The job runs only once.
SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.
The recurrence pattern for running the job. If the job is configured to run only once, this value is null.
", - "smithy.api#jsonName": "scheduleFrequency" + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the job last ran.
", + "smithy.api#jsonName": "lastRunTime" } }, - "jobStatus": { - "target": "com.amazonaws.macie2#JobStatus", + "name": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The current status of the job. Possible values are:
CANCELLED - You cancelled the job, or you paused the job and didn't resume it within 30 days of pausing it.
COMPLETE - For a one-time job, Amazon Macie finished processing all the data specified for the job. This value doesn't apply to recurring jobs.
IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
PAUSED - Amazon Macie started running the job but completion of the job would exceed one or more quotas for your account.
RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
USER_PAUSED - You paused the job. If you don't resume the job within 30 days of pausing it, the job will expire and be cancelled.
The custom name of the job.
", + "smithy.api#jsonName": "name" } }, "s3JobDefinition": { @@ -2491,11 +2484,18 @@ "smithy.api#jsonName": "s3JobDefinition" } }, - "createdAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", + "samplingPercentage": { + "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the job was created.
", - "smithy.api#jsonName": "createdAt" + "smithy.api#documentation": "The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.
", + "smithy.api#jsonName": "samplingPercentage" + } + }, + "scheduleFrequency": { + "target": "com.amazonaws.macie2#JobScheduleFrequency", + "traits": { + "smithy.api#documentation": "The recurrence pattern for running the job. If the job is configured to run only once, this value is null.
", + "smithy.api#jsonName": "scheduleFrequency" } }, "statistics": { @@ -2505,18 +2505,18 @@ "smithy.api#jsonName": "statistics" } }, - "jobType": { - "target": "com.amazonaws.macie2#JobType", + "tags": { + "target": "com.amazonaws.macie2#TagMap", "traits": { - "smithy.api#documentation": "The schedule for running the job. Possible values are:
ONE_TIME - The job runs only once.
SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.
A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.
", + "smithy.api#jsonName": "tags" } }, - "jobId": { - "target": "com.amazonaws.macie2#__string", + "userPausedDetails": { + "target": "com.amazonaws.macie2#UserPausedDetails", "traits": { - "smithy.api#documentation": "The unique identifier for the job.
", - "smithy.api#jsonName": "jobId" + "smithy.api#documentation": "If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.
", + "smithy.api#jsonName": "userPausedDetails" } } } @@ -2871,13 +2871,6 @@ "com.amazonaws.macie2#EnableMacieRequest": { "type": "structure", "members": { - "findingPublishingFrequency": { - "target": "com.amazonaws.macie2#FindingPublishingFrequency", - "traits": { - "smithy.api#documentation": "Specifies how often to publish updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).", - "smithy.api#jsonName": "findingPublishingFrequency" - } - }, "clientToken": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -2886,6 +2879,13 @@ "smithy.api#jsonName": "clientToken" } }, + "findingPublishingFrequency": { + "target": "com.amazonaws.macie2#FindingPublishingFrequency", + "traits": { + "smithy.api#documentation": "Specifies how often to publish updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).", + "smithy.api#jsonName": "findingPublishingFrequency" + } + }, "status": { "target": "com.amazonaws.macie2#MacieStatus", "traits": { @@ -3021,11 +3021,11 @@ "smithy.api#jsonName": "accountId" } }, - "sessionContext": { - "target": "com.amazonaws.macie2#SessionContext", + "arn": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The details of the session that was created for the credentials, including the entity that issued the session.
", - "smithy.api#jsonName": "sessionContext" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the entity that was used to get the credentials.
", + "smithy.api#jsonName": "arn" } }, "principalId": { @@ -3035,11 +3035,11 @@ "smithy.api#jsonName": "principalId" } }, - "arn": { - "target": "com.amazonaws.macie2#__string", + "sessionContext": { + "target": "com.amazonaws.macie2#SessionContext", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the entity that was used to get the credentials.
", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The details of the session that was created for the credentials, including the entity that issued the session.
", + "smithy.api#jsonName": "sessionContext" } } }, @@ -3050,20 +3050,6 @@ "com.amazonaws.macie2#Finding": { "type": "structure", "members": { - "count": { - "target": "com.amazonaws.macie2#__long", - "traits": { - "smithy.api#documentation": "The total number of occurrences of the finding.
", - "smithy.api#jsonName": "count" - } - }, - "type": { - "target": "com.amazonaws.macie2#FindingType", - "traits": { - "smithy.api#documentation": "The type of the finding.
", - "smithy.api#jsonName": "type" - } - }, "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -3071,25 +3057,32 @@ "smithy.api#jsonName": "accountId" } }, - "sample": { + "archived": { "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "Specifies whether the finding is a sample finding. A sample finding is a finding that uses example data to demonstrate what a finding might contain.
", - "smithy.api#jsonName": "sample" + "smithy.api#documentation": "Specifies whether the finding is archived.
", + "smithy.api#jsonName": "archived" } }, - "description": { - "target": "com.amazonaws.macie2#__string", + "category": { + "target": "com.amazonaws.macie2#FindingCategory", "traits": { - "smithy.api#documentation": "The description of the finding.
", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.
", + "smithy.api#jsonName": "category" } }, - "partition": { - "target": "com.amazonaws.macie2#__string", + "classificationDetails": { + "target": "com.amazonaws.macie2#ClassificationDetails", "traits": { - "smithy.api#documentation": "The AWS partition that Amazon Macie created the finding in.
", - "smithy.api#jsonName": "partition" + "smithy.api#documentation": "The details of a sensitive data finding. This value is null for a policy finding.
", + "smithy.api#jsonName": "classificationDetails" + } + }, + "count": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "The total number of occurrences of the finding.
", + "smithy.api#jsonName": "count" } }, "createdAt": { @@ -3099,39 +3092,39 @@ "smithy.api#jsonName": "createdAt" } }, - "title": { + "description": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The brief description of the finding.
", - "smithy.api#jsonName": "title" + "smithy.api#documentation": "The description of the finding.
", + "smithy.api#jsonName": "description" } }, - "schemaVersion": { + "id": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The version of the schema that was used to define the data structures in the finding.
", - "smithy.api#jsonName": "schemaVersion" + "smithy.api#documentation": "The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.
", + "smithy.api#jsonName": "id" } }, - "updatedAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", + "partition": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the finding was last updated. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new (unique) because they derive from individual classification jobs.
", - "smithy.api#jsonName": "updatedAt" + "smithy.api#documentation": "The AWS partition that Amazon Macie created the finding in.
", + "smithy.api#jsonName": "partition" } }, - "category": { - "target": "com.amazonaws.macie2#FindingCategory", + "policyDetails": { + "target": "com.amazonaws.macie2#PolicyDetails", "traits": { - "smithy.api#documentation": "The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.
", - "smithy.api#jsonName": "category" + "smithy.api#documentation": "The details of a policy finding. This value is null for a sensitive data finding.
", + "smithy.api#jsonName": "policyDetails" } }, - "classificationDetails": { - "target": "com.amazonaws.macie2#ClassificationDetails", + "region": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The details of a sensitive data finding. This value is null for a policy finding.
", - "smithy.api#jsonName": "classificationDetails" + "smithy.api#documentation": "The AWS Region that Amazon Macie created the finding in.
", + "smithy.api#jsonName": "region" } }, "resourcesAffected": { @@ -3141,39 +3134,46 @@ "smithy.api#jsonName": "resourcesAffected" } }, - "archived": { + "sample": { "target": "com.amazonaws.macie2#__boolean", "traits": { - "smithy.api#documentation": "Specifies whether the finding is archived.
", - "smithy.api#jsonName": "archived" + "smithy.api#documentation": "Specifies whether the finding is a sample finding. A sample finding is a finding that uses example data to demonstrate what a finding might contain.
", + "smithy.api#jsonName": "sample" } }, - "policyDetails": { - "target": "com.amazonaws.macie2#PolicyDetails", + "schemaVersion": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The details of a policy finding. This value is null for a sensitive data finding.
", - "smithy.api#jsonName": "policyDetails" + "smithy.api#documentation": "The version of the schema that was used to define the data structures in the finding.
", + "smithy.api#jsonName": "schemaVersion" } }, - "region": { - "target": "com.amazonaws.macie2#__string", + "severity": { + "target": "com.amazonaws.macie2#Severity", "traits": { - "smithy.api#documentation": "The AWS Region that Amazon Macie created the finding in.
", - "smithy.api#jsonName": "region" + "smithy.api#documentation": "The severity level and score for the finding.
", + "smithy.api#jsonName": "severity" } }, - "id": { + "title": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.
", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The brief description of the finding.
", + "smithy.api#jsonName": "title" } }, - "severity": { - "target": "com.amazonaws.macie2#Severity", + "type": { + "target": "com.amazonaws.macie2#FindingType", "traits": { - "smithy.api#documentation": "The severity level and score for the finding.
", - "smithy.api#jsonName": "severity" + "smithy.api#documentation": "The type of the finding.
", + "smithy.api#jsonName": "type" + } + }, + "updatedAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the finding was last updated. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new (unique) because they derive from individual classification jobs.
", + "smithy.api#jsonName": "updatedAt" } } }, @@ -3218,13 +3218,6 @@ "com.amazonaws.macie2#FindingActor": { "type": "structure", "members": { - "ipAddressDetails": { - "target": "com.amazonaws.macie2#IpAddressDetails", - "traits": { - "smithy.api#documentation": "The IP address of the device that the entity used to perform the action on the affected resource. This object also provides information such as the owner and geographic location for the IP address.
", - "smithy.api#jsonName": "ipAddressDetails" - } - }, "domainDetails": { "target": "com.amazonaws.macie2#DomainDetails", "traits": { @@ -3232,6 +3225,13 @@ "smithy.api#jsonName": "domainDetails" } }, + "ipAddressDetails": { + "target": "com.amazonaws.macie2#IpAddressDetails", + "traits": { + "smithy.api#documentation": "The IP address of the device that the entity used to perform the action on the affected resource. This object also provides information such as the owner and geographic location for the IP address.
", + "smithy.api#jsonName": "ipAddressDetails" + } + }, "userIdentity": { "target": "com.amazonaws.macie2#UserIdentity", "traits": { @@ -3400,20 +3400,6 @@ "com.amazonaws.macie2#FindingsFilterListItem": { "type": "structure", "members": { - "id": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The unique identifier for the filter.
", - "smithy.api#jsonName": "id" - } - }, - "name": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The custom name of the filter.
", - "smithy.api#jsonName": "name" - } - }, "action": { "target": "com.amazonaws.macie2#FindingsFilterAction", "traits": { @@ -3428,6 +3414,20 @@ "smithy.api#jsonName": "arn" } }, + "id": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The unique identifier for the filter.
", + "smithy.api#jsonName": "id" + } + }, + "name": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The custom name of the filter.
", + "smithy.api#jsonName": "name" + } + }, "tags": { "target": "com.amazonaws.macie2#TagMap", "traits": { @@ -3495,11 +3495,18 @@ "com.amazonaws.macie2#GetBucketStatisticsResponse": { "type": "structure", "members": { - "classifiableObjectCount": { + "bucketCount": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The total number of objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.
", - "smithy.api#jsonName": "classifiableObjectCount" + "smithy.api#documentation": "The total number of buckets.
", + "smithy.api#jsonName": "bucketCount" + } + }, + "bucketCountByEffectivePermission": { + "target": "com.amazonaws.macie2#BucketCountByEffectivePermission", + "traits": { + "smithy.api#documentation": "The total number of buckets that are publicly accessible based on a combination of permissions settings for each bucket.
", + "smithy.api#jsonName": "bucketCountByEffectivePermission" } }, "bucketCountByEncryptionType": { @@ -3509,39 +3516,32 @@ "smithy.api#jsonName": "bucketCountByEncryptionType" } }, - "sizeInBytesCompressed": { - "target": "com.amazonaws.macie2#__long", + "bucketCountBySharedAccessType": { + "target": "com.amazonaws.macie2#BucketCountBySharedAccessType", "traits": { - "smithy.api#documentation": "The total compressed storage size, in bytes, of the buckets.
", - "smithy.api#jsonName": "sizeInBytesCompressed" + "smithy.api#documentation": "The total number of buckets that are shared with another AWS account.
", + "smithy.api#jsonName": "bucketCountBySharedAccessType" } }, - "sizeInBytes": { + "classifiableObjectCount": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The total storage size, in bytes, of the buckets.
", - "smithy.api#jsonName": "sizeInBytes" - } - }, - "lastUpdated": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved data about the buckets from Amazon S3.
", - "smithy.api#jsonName": "lastUpdated" + "smithy.api#documentation": "The total number of objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.
", + "smithy.api#jsonName": "classifiableObjectCount" } }, - "unclassifiableObjectCount": { - "target": "com.amazonaws.macie2#ObjectLevelStatistics", + "classifiableSizeInBytes": { + "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The total number of objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
", - "smithy.api#jsonName": "unclassifiableObjectCount" + "smithy.api#documentation": "The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.
", + "smithy.api#jsonName": "classifiableSizeInBytes" } }, - "bucketCountBySharedAccessType": { - "target": "com.amazonaws.macie2#BucketCountBySharedAccessType", + "lastUpdated": { + "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "The total number of buckets that are shared with another AWS account.
", - "smithy.api#jsonName": "bucketCountBySharedAccessType" + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved data about the buckets from Amazon S3.
", + "smithy.api#jsonName": "lastUpdated" } }, "objectCount": { @@ -3551,25 +3551,25 @@ "smithy.api#jsonName": "objectCount" } }, - "bucketCountByEffectivePermission": { - "target": "com.amazonaws.macie2#BucketCountByEffectivePermission", + "sizeInBytes": { + "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The total number of buckets that are publicly accessible based on a combination of permissions settings for each bucket.
", - "smithy.api#jsonName": "bucketCountByEffectivePermission" + "smithy.api#documentation": "The total storage size, in bytes, of the buckets.
", + "smithy.api#jsonName": "sizeInBytes" } }, - "classifiableSizeInBytes": { + "sizeInBytesCompressed": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.
", - "smithy.api#jsonName": "classifiableSizeInBytes" + "smithy.api#documentation": "The total compressed storage size, in bytes, of the buckets.
", + "smithy.api#jsonName": "sizeInBytesCompressed" } }, - "bucketCount": { - "target": "com.amazonaws.macie2#__long", + "unclassifiableObjectCount": { + "target": "com.amazonaws.macie2#ObjectLevelStatistics", "traits": { - "smithy.api#documentation": "The total number of buckets.
", - "smithy.api#jsonName": "bucketCount" + "smithy.api#documentation": "The total number of objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.
", + "smithy.api#jsonName": "unclassifiableObjectCount" } }, "unclassifiableObjectSizeInBytes": { @@ -3693,18 +3693,18 @@ "com.amazonaws.macie2#GetCustomDataIdentifierResponse": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.macie2#TagMap", + "arn": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.
", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom data identifier.
", + "smithy.api#jsonName": "arn" } }, - "ignoreWords": { - "target": "com.amazonaws.macie2#__listOf__string", + "createdAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.
", - "smithy.api#jsonName": "ignoreWords" + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.
", + "smithy.api#jsonName": "createdAt" } }, "deleted": { @@ -3714,18 +3714,11 @@ "smithy.api#jsonName": "deleted" } }, - "createdAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.
", - "smithy.api#jsonName": "createdAt" - } - }, - "maximumMatchDistance": { - "target": "com.amazonaws.macie2#__integer", + "description": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern.
", - "smithy.api#jsonName": "maximumMatchDistance" + "smithy.api#documentation": "The custom description of the custom data identifier.
", + "smithy.api#jsonName": "description" } }, "id": { @@ -3735,25 +3728,25 @@ "smithy.api#jsonName": "id" } }, - "keywords": { + "ignoreWords": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.
", - "smithy.api#jsonName": "keywords" + "smithy.api#documentation": "An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.
", + "smithy.api#jsonName": "ignoreWords" } }, - "description": { - "target": "com.amazonaws.macie2#__string", + "keywords": { + "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "The custom description of the custom data identifier.
", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.
", + "smithy.api#jsonName": "keywords" } }, - "arn": { - "target": "com.amazonaws.macie2#__string", + "maximumMatchDistance": { + "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom data identifier.
", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern.
", + "smithy.api#jsonName": "maximumMatchDistance" } }, "name": { @@ -3769,6 +3762,13 @@ "smithy.api#documentation": "The regular expression (regex) that defines the pattern to match.
", "smithy.api#jsonName": "regex" } + }, + "tags": { + "target": "com.amazonaws.macie2#TagMap", + "traits": { + "smithy.api#documentation": "A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.
", + "smithy.api#jsonName": "tags" + } } } }, @@ -3815,11 +3815,11 @@ "com.amazonaws.macie2#GetFindingStatisticsRequest": { "type": "structure", "members": { - "sortCriteria": { - "target": "com.amazonaws.macie2#FindingStatisticsSortCriteria", + "findingCriteria": { + "target": "com.amazonaws.macie2#FindingCriteria", "traits": { - "smithy.api#documentation": "The criteria to use to sort the query results.
", - "smithy.api#jsonName": "sortCriteria" + "smithy.api#documentation": "The criteria to use to filter the query results.
", + "smithy.api#jsonName": "findingCriteria" } }, "groupBy": { @@ -3837,11 +3837,11 @@ "smithy.api#jsonName": "size" } }, - "findingCriteria": { - "target": "com.amazonaws.macie2#FindingCriteria", + "sortCriteria": { + "target": "com.amazonaws.macie2#FindingStatisticsSortCriteria", "traits": { - "smithy.api#documentation": "The criteria to use to filter the query results.
", - "smithy.api#jsonName": "findingCriteria" + "smithy.api#documentation": "The criteria to use to sort the query results.
", + "smithy.api#jsonName": "sortCriteria" } } } @@ -3954,6 +3954,13 @@ "com.amazonaws.macie2#GetFindingsFilterResponse": { "type": "structure", "members": { + "action": { + "target": "com.amazonaws.macie2#FindingsFilterAction", + "traits": { + "smithy.api#documentation": "The action that's performed on findings that meet the filter criteria (findingCriteria). Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
", + "smithy.api#jsonName": "action" + } + }, "arn": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -3961,32 +3968,32 @@ "smithy.api#jsonName": "arn" } }, - "id": { + "description": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the filter.
", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The custom description of the filter.
", + "smithy.api#jsonName": "description" } }, - "tags": { - "target": "com.amazonaws.macie2#TagMap", + "findingCriteria": { + "target": "com.amazonaws.macie2#FindingCriteria", "traits": { - "smithy.api#documentation": "A map of key-value pairs that identifies the tags (keys and values) that are associated with the filter.
", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The criteria that's used to filter findings.
", + "smithy.api#jsonName": "findingCriteria" } }, - "action": { - "target": "com.amazonaws.macie2#FindingsFilterAction", + "id": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The action that's performed on findings that meet the filter criteria (findingCriteria). Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
", - "smithy.api#jsonName": "action" + "smithy.api#documentation": "The unique identifier for the filter.
", + "smithy.api#jsonName": "id" } }, - "description": { + "name": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The custom description of the filter.
", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "The custom name of the filter.
", + "smithy.api#jsonName": "name" } }, "position": { @@ -3996,18 +4003,11 @@ "smithy.api#jsonName": "position" } }, - "name": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The custom name of the filter.
", - "smithy.api#jsonName": "name" - } - }, - "findingCriteria": { - "target": "com.amazonaws.macie2#FindingCriteria", + "tags": { + "target": "com.amazonaws.macie2#TagMap", "traits": { - "smithy.api#documentation": "The criteria that's used to filter findings.
", - "smithy.api#jsonName": "findingCriteria" + "smithy.api#documentation": "A map of key-value pairs that identifies the tags (keys and values) that are associated with the filter.
", + "smithy.api#jsonName": "tags" } } } @@ -4015,13 +4015,6 @@ "com.amazonaws.macie2#GetFindingsRequest": { "type": "structure", "members": { - "sortCriteria": { - "target": "com.amazonaws.macie2#SortCriteria", - "traits": { - "smithy.api#documentation": "The criteria for sorting the results of the request.
", - "smithy.api#jsonName": "sortCriteria" - } - }, "findingIds": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { @@ -4029,6 +4022,13 @@ "smithy.api#jsonName": "findingIds", "smithy.api#required": {} } + }, + "sortCriteria": { + "target": "com.amazonaws.macie2#SortCriteria", + "traits": { + "smithy.api#documentation": "The criteria for sorting the results of the request.
", + "smithy.api#jsonName": "sortCriteria" + } } } }, @@ -4147,20 +4147,6 @@ "com.amazonaws.macie2#GetMacieSessionResponse": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.macie2#MacieStatus", - "traits": { - "smithy.api#documentation": "The current status of the Amazon Macie account. Possible values are: PAUSED, the account is enabled but all Amazon Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Amazon Macie activities are enabled for the account.
", - "smithy.api#jsonName": "status" - } - }, - "updatedAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Amazon Macie account.
", - "smithy.api#jsonName": "updatedAt" - } - }, "createdAt": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { @@ -4181,6 +4167,20 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the service-linked role that allows Amazon Macie to monitor and analyze data in AWS resources for the account.
", "smithy.api#jsonName": "serviceRole" } + }, + "status": { + "target": "com.amazonaws.macie2#MacieStatus", + "traits": { + "smithy.api#documentation": "The current status of the Amazon Macie account. Possible values are: PAUSED, the account is enabled but all Amazon Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Amazon Macie activities are enabled for the account.
", + "smithy.api#jsonName": "status" + } + }, + "updatedAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Amazon Macie account.
", + "smithy.api#jsonName": "updatedAt" + } } } }, @@ -4296,20 +4296,6 @@ "com.amazonaws.macie2#GetMemberResponse": { "type": "structure", "members": { - "invitedAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.
", - "smithy.api#jsonName": "invitedAt" - } - }, - "updatedAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the master account.
", - "smithy.api#jsonName": "updatedAt" - } - }, "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -4317,11 +4303,11 @@ "smithy.api#jsonName": "accountId" } }, - "masterAccountId": { + "arn": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The AWS account ID for the master account.
", - "smithy.api#jsonName": "masterAccountId" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the account.
", + "smithy.api#jsonName": "arn" } }, "email": { @@ -4331,18 +4317,18 @@ "smithy.api#jsonName": "email" } }, - "tags": { - "target": "com.amazonaws.macie2#TagMap", + "invitedAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "A map of key-value pairs that identifies the tags (keys and values) that are associated with the member account in Amazon Macie.
", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.
", + "smithy.api#jsonName": "invitedAt" } }, - "arn": { + "masterAccountId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the account.
", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The AWS account ID for the master account.
", + "smithy.api#jsonName": "masterAccountId" } }, "relationshipStatus": { @@ -4351,6 +4337,20 @@ "smithy.api#documentation": "The current status of the relationship between the account and the master account.
", "smithy.api#jsonName": "relationshipStatus" } + }, + "tags": { + "target": "com.amazonaws.macie2#TagMap", + "traits": { + "smithy.api#documentation": "A map of key-value pairs that identifies the tags (keys and values) that are associated with the member account in Amazon Macie.
", + "smithy.api#jsonName": "tags" + } + }, + "updatedAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the master account.
", + "smithy.api#jsonName": "updatedAt" + } } } }, @@ -4410,11 +4410,11 @@ "smithy.api#jsonName": "filterBy" } }, - "sortBy": { - "target": "com.amazonaws.macie2#UsageStatisticsSortBy", + "maxResults": { + "target": "com.amazonaws.macie2#__integer", "traits": { - "smithy.api#documentation": "The criteria to use to sort the query results.
", - "smithy.api#jsonName": "sortBy" + "smithy.api#documentation": "The maximum number of items to include in each page of the response.
", + "smithy.api#jsonName": "maxResults" } }, "nextToken": { @@ -4424,11 +4424,11 @@ "smithy.api#jsonName": "nextToken" } }, - "maxResults": { - "target": "com.amazonaws.macie2#__integer", + "sortBy": { + "target": "com.amazonaws.macie2#UsageStatisticsSortBy", "traits": { - "smithy.api#documentation": "The maximum number of items to include in each page of the response.
", - "smithy.api#jsonName": "maxResults" + "smithy.api#documentation": "The criteria to use to sort the query results.
", + "smithy.api#jsonName": "sortBy" } } } @@ -4436,19 +4436,19 @@ "com.amazonaws.macie2#GetUsageStatisticsResponse": { "type": "structure", "members": { - "records": { - "target": "com.amazonaws.macie2#__listOfUsageRecord", - "traits": { - "smithy.api#documentation": "An array of objects that contains the results of the query. Each object contains the data for an account that meets the filter criteria specified in the request.
", - "smithy.api#jsonName": "records" - } - }, "nextToken": { "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#documentation": "The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
", "smithy.api#jsonName": "nextToken" } + }, + "records": { + "target": "com.amazonaws.macie2#__listOfUsageRecord", + "traits": { + "smithy.api#documentation": "An array of objects that contains the results of the query. Each object contains the data for an account that meets the filter criteria specified in the request.
", + "smithy.api#jsonName": "records" + } } } }, @@ -4534,19 +4534,19 @@ "com.amazonaws.macie2#GroupCount": { "type": "structure", "members": { - "groupKey": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The name of the property that defines the group in the query results, as specified by the groupBy property in the query request.
", - "smithy.api#jsonName": "groupKey" - } - }, "count": { "target": "com.amazonaws.macie2#__long", "traits": { "smithy.api#documentation": "The total number of findings in the group of query results.
", "smithy.api#jsonName": "count" } + }, + "groupKey": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The name of the property that defines the group in the query results, as specified by the groupBy property in the query request.
", + "smithy.api#jsonName": "groupKey" + } } }, "traits": { @@ -4556,11 +4556,11 @@ "com.amazonaws.macie2#IamUser": { "type": "structure", "members": { - "userName": { + "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The user name of the IAM user who performed the action.
", - "smithy.api#jsonName": "userName" + "smithy.api#documentation": "The unique identifier for the AWS account that's associated with the IAM user who performed the action.
", + "smithy.api#jsonName": "accountId" } }, "arn": { @@ -4570,18 +4570,18 @@ "smithy.api#jsonName": "arn" } }, - "accountId": { + "principalId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the AWS account that's associated with the IAM user who performed the action.
", - "smithy.api#jsonName": "accountId" + "smithy.api#documentation": "The unique identifier for the IAM user who performed the action.
", + "smithy.api#jsonName": "principalId" } }, - "principalId": { + "userName": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the IAM user who performed the action.
", - "smithy.api#jsonName": "principalId" + "smithy.api#documentation": "The user name of the IAM user who performed the action.
", + "smithy.api#jsonName": "userName" } } }, @@ -4609,13 +4609,6 @@ "com.amazonaws.macie2#Invitation": { "type": "structure", "members": { - "invitedAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.
", - "smithy.api#jsonName": "invitedAt" - } - }, "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -4623,19 +4616,26 @@ "smithy.api#jsonName": "accountId" } }, - "relationshipStatus": { - "target": "com.amazonaws.macie2#RelationshipStatus", - "traits": { - "smithy.api#documentation": "The status of the relationship between the account that sent the invitation (inviter account) and the account that received the invitation (invitee account).
", - "smithy.api#jsonName": "relationshipStatus" - } - }, "invitationId": { "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#documentation": "The unique identifier for the invitation. Amazon Macie uses this identifier to validate the inviter account with the invitee account.
", "smithy.api#jsonName": "invitationId" } + }, + "invitedAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.
", + "smithy.api#jsonName": "invitedAt" + } + }, + "relationshipStatus": { + "target": "com.amazonaws.macie2#RelationshipStatus", + "traits": { + "smithy.api#documentation": "The status of the relationship between the account that sent the invitation (inviter account) and the account that received the invitation (invitee account).
", + "smithy.api#jsonName": "relationshipStatus" + } } }, "traits": { @@ -4645,20 +4645,6 @@ "com.amazonaws.macie2#IpAddressDetails": { "type": "structure", "members": { - "ipCity": { - "target": "com.amazonaws.macie2#IpCity", - "traits": { - "smithy.api#documentation": "The city that the IP address originated from.
", - "smithy.api#jsonName": "ipCity" - } - }, - "ipGeoLocation": { - "target": "com.amazonaws.macie2#IpGeoLocation", - "traits": { - "smithy.api#documentation": "The geographic coordinates of the location that the IP address originated from.
", - "smithy.api#jsonName": "ipGeoLocation" - } - }, "ipAddressV4": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -4666,6 +4652,13 @@ "smithy.api#jsonName": "ipAddressV4" } }, + "ipCity": { + "target": "com.amazonaws.macie2#IpCity", + "traits": { + "smithy.api#documentation": "The city that the IP address originated from.
", + "smithy.api#jsonName": "ipCity" + } + }, "ipCountry": { "target": "com.amazonaws.macie2#IpCountry", "traits": { @@ -4673,6 +4666,13 @@ "smithy.api#jsonName": "ipCountry" } }, + "ipGeoLocation": { + "target": "com.amazonaws.macie2#IpGeoLocation", + "traits": { + "smithy.api#documentation": "The geographic coordinates of the location that the IP address originated from.
", + "smithy.api#jsonName": "ipGeoLocation" + } + }, "ipOwner": { "target": "com.amazonaws.macie2#IpOwner", "traits": { @@ -4703,18 +4703,18 @@ "com.amazonaws.macie2#IpCountry": { "type": "structure", "members": { - "name": { + "code": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The name of the country that the IP address originated from.
", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country that the IP address originated from. For example, US for the United States.
", + "smithy.api#jsonName": "code" } }, - "code": { + "name": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The two-character code, in ISO 3166-1 alpha-2 format, for the country that the IP address originated from. For example, US for the United States.
", - "smithy.api#jsonName": "code" + "smithy.api#documentation": "The name of the country that the IP address originated from.
", + "smithy.api#jsonName": "name" } } }, @@ -4761,18 +4761,18 @@ "smithy.api#jsonName": "asnOrg" } }, - "org": { + "isp": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The name of the organization that owned the IP address.
", - "smithy.api#jsonName": "org" + "smithy.api#documentation": "The name of the internet service provider (ISP) that owned the IP address.
", + "smithy.api#jsonName": "isp" } }, - "isp": { + "org": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The name of the internet service provider (ISP) that owned the IP address.
", - "smithy.api#jsonName": "isp" + "smithy.api#documentation": "The name of the organization that owned the IP address.
", + "smithy.api#jsonName": "org" } } }, @@ -4819,6 +4819,13 @@ "com.amazonaws.macie2#JobScheduleFrequency": { "type": "structure", "members": { + "dailySchedule": { + "target": "com.amazonaws.macie2#DailySchedule", + "traits": { + "smithy.api#documentation": "Specifies a daily recurrence pattern for running the job.
", + "smithy.api#jsonName": "dailySchedule" + } + }, "monthlySchedule": { "target": "com.amazonaws.macie2#MonthlySchedule", "traits": { @@ -4832,13 +4839,6 @@ "smithy.api#documentation": "Specifies a weekly recurrence pattern for running the job.
", "smithy.api#jsonName": "weeklySchedule" } - }, - "dailySchedule": { - "target": "com.amazonaws.macie2#DailySchedule", - "traits": { - "smithy.api#documentation": "Specifies a daily recurrence pattern for running the job.
", - "smithy.api#jsonName": "dailySchedule" - } } }, "traits": { @@ -4848,19 +4848,19 @@ "com.amazonaws.macie2#JobScopeTerm": { "type": "structure", "members": { - "tagScopeTerm": { - "target": "com.amazonaws.macie2#TagScopeTerm", - "traits": { - "smithy.api#documentation": "A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job.
", - "smithy.api#jsonName": "tagScopeTerm" - } - }, "simpleScopeTerm": { "target": "com.amazonaws.macie2#SimpleScopeTerm", "traits": { "smithy.api#documentation": "A property-based condition that defines a property, operator, and one or more values for including or excluding an object from the job.
", "smithy.api#jsonName": "simpleScopeTerm" } + }, + "tagScopeTerm": { + "target": "com.amazonaws.macie2#TagScopeTerm", + "traits": { + "smithy.api#documentation": "A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding an object from the job.
", + "smithy.api#jsonName": "tagScopeTerm" + } } }, "traits": { @@ -4917,6 +4917,13 @@ "com.amazonaws.macie2#JobSummary": { "type": "structure", "members": { + "bucketDefinitions": { + "target": "com.amazonaws.macie2#__listOfS3BucketDefinitionForJob", + "traits": { + "smithy.api#documentation": "The S3 buckets that the job is configured to analyze.
", + "smithy.api#jsonName": "bucketDefinitions" + } + }, "createdAt": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { @@ -4931,20 +4938,6 @@ "smithy.api#jsonName": "jobId" } }, - "jobType": { - "target": "com.amazonaws.macie2#JobType", - "traits": { - "smithy.api#documentation": "The schedule for running the job. Possible values are:
ONE_TIME - The job runs only once.
SCHEDULED - The job runs on a daily, weekly, or monthly basis.
If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.
", - "smithy.api#jsonName": "userPausedDetails" - } - }, "jobStatus": { "target": "com.amazonaws.macie2#JobStatus", "traits": { @@ -4952,11 +4945,11 @@ "smithy.api#jsonName": "jobStatus" } }, - "bucketDefinitions": { - "target": "com.amazonaws.macie2#__listOfS3BucketDefinitionForJob", + "jobType": { + "target": "com.amazonaws.macie2#JobType", "traits": { - "smithy.api#documentation": "The S3 buckets that the job is configured to analyze.
", - "smithy.api#jsonName": "bucketDefinitions" + "smithy.api#documentation": "The schedule for running the job. Possible values are:
ONE_TIME - The job runs only once.
SCHEDULED - The job runs on a daily, weekly, or monthly basis.
The custom name of the job.
", "smithy.api#jsonName": "name" } + }, + "userPausedDetails": { + "target": "com.amazonaws.macie2#UserPausedDetails", + "traits": { + "smithy.api#documentation": "If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.
", + "smithy.api#jsonName": "userPausedDetails" + } } }, "traits": { @@ -4990,18 +4990,18 @@ "com.amazonaws.macie2#KeyValuePair": { "type": "structure", "members": { - "value": { + "key": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be empty or null.
", - "smithy.api#jsonName": "value" + "smithy.api#documentation": "One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.
", + "smithy.api#jsonName": "key" } }, - "key": { + "value": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.
", - "smithy.api#jsonName": "key" + "smithy.api#documentation": "One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be empty or null.
", + "smithy.api#jsonName": "value" } } }, @@ -5067,6 +5067,13 @@ "com.amazonaws.macie2#ListClassificationJobsRequest": { "type": "structure", "members": { + "filterCriteria": { + "target": "com.amazonaws.macie2#ListJobsFilterCriteria", + "traits": { + "smithy.api#documentation": "The criteria to use to filter the results.
", + "smithy.api#jsonName": "filterCriteria" + } + }, "maxResults": { "target": "com.amazonaws.macie2#__integer", "traits": { @@ -5087,32 +5094,25 @@ "smithy.api#documentation": "The criteria to use to sort the results.
", "smithy.api#jsonName": "sortCriteria" } - }, - "filterCriteria": { - "target": "com.amazonaws.macie2#ListJobsFilterCriteria", - "traits": { - "smithy.api#documentation": "The criteria to use to filter the results.
", - "smithy.api#jsonName": "filterCriteria" - } } } }, "com.amazonaws.macie2#ListClassificationJobsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
", - "smithy.api#jsonName": "nextToken" - } - }, "items": { "target": "com.amazonaws.macie2#__listOfJobSummary", "traits": { "smithy.api#documentation": "An array of objects, one for each job that meets the filter criteria specified in the request.
", "smithy.api#jsonName": "items" } + }, + "nextToken": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
", + "smithy.api#jsonName": "nextToken" + } } } }, @@ -5184,19 +5184,19 @@ "com.amazonaws.macie2#ListCustomDataIdentifiersResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
", - "smithy.api#jsonName": "nextToken" - } - }, "items": { "target": "com.amazonaws.macie2#__listOfCustomDataIdentifierSummary", "traits": { "smithy.api#documentation": "An array of objects, one for each custom data identifier.
", "smithy.api#jsonName": "items" } + }, + "nextToken": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
", + "smithy.api#jsonName": "nextToken" + } } } }, @@ -5314,18 +5314,18 @@ "com.amazonaws.macie2#ListFindingsFiltersResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.macie2#__string", + "findingsFilterListItems": { + "target": "com.amazonaws.macie2#__listOfFindingsFilterListItem", "traits": { - "smithy.api#documentation": "The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
", - "smithy.api#jsonName": "nextToken" + "smithy.api#documentation": "An array of objects, one for each filter that's associated with the account.
", + "smithy.api#jsonName": "findingsFilterListItems" } }, - "findingsFilterListItems": { - "target": "com.amazonaws.macie2#__listOfFindingsFilterListItem", + "nextToken": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "An array of objects, one for each filter that's associated with the account.
", - "smithy.api#jsonName": "findingsFilterListItems" + "smithy.api#documentation": "The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
", + "smithy.api#jsonName": "nextToken" } } } @@ -5333,6 +5333,13 @@ "com.amazonaws.macie2#ListFindingsRequest": { "type": "structure", "members": { + "findingCriteria": { + "target": "com.amazonaws.macie2#FindingCriteria", + "traits": { + "smithy.api#documentation": "The criteria to use to filter the results.
", + "smithy.api#jsonName": "findingCriteria" + } + }, "maxResults": { "target": "com.amazonaws.macie2#__integer", "traits": { @@ -5340,13 +5347,6 @@ "smithy.api#jsonName": "maxResults" } }, - "sortCriteria": { - "target": "com.amazonaws.macie2#SortCriteria", - "traits": { - "smithy.api#documentation": "The criteria to use to sort the results.
", - "smithy.api#jsonName": "sortCriteria" - } - }, "nextToken": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -5354,11 +5354,11 @@ "smithy.api#jsonName": "nextToken" } }, - "findingCriteria": { - "target": "com.amazonaws.macie2#FindingCriteria", + "sortCriteria": { + "target": "com.amazonaws.macie2#SortCriteria", "traits": { - "smithy.api#documentation": "The criteria to use to filter the results.
", - "smithy.api#jsonName": "findingCriteria" + "smithy.api#documentation": "The criteria to use to sort the results.
", + "smithy.api#jsonName": "sortCriteria" } } } @@ -5431,38 +5431,38 @@ "com.amazonaws.macie2#ListInvitationsRequest": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The nextToken string that specifies which page of results to return in a paginated response.
", - "smithy.api#httpQuery": "nextToken" - } - }, "maxResults": { "target": "com.amazonaws.macie2#MaxResults", "traits": { "smithy.api#documentation": "The maximum number of items to include in each page of a paginated response.
", "smithy.api#httpQuery": "maxResults" } + }, + "nextToken": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The nextToken string that specifies which page of results to return in a paginated response.
", + "smithy.api#httpQuery": "nextToken" + } } } }, "com.amazonaws.macie2#ListInvitationsResponse": { "type": "structure", "members": { - "nextToken": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
", - "smithy.api#jsonName": "nextToken" - } - }, "invitations": { "target": "com.amazonaws.macie2#__listOfInvitation", "traits": { "smithy.api#documentation": "An array of objects, one for each invitation that was received by the account.
", "smithy.api#jsonName": "invitations" } + }, + "nextToken": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
", + "smithy.api#jsonName": "nextToken" + } } } }, @@ -5515,11 +5515,11 @@ "com.amazonaws.macie2#ListJobsFilterTerm": { "type": "structure", "members": { - "values": { - "target": "com.amazonaws.macie2#__listOf__string", + "comparator": { + "target": "com.amazonaws.macie2#JobComparator", "traits": { - "smithy.api#documentation": "An array that lists one or more values to use to filter the results.
", - "smithy.api#jsonName": "values" + "smithy.api#documentation": "The operator to use to filter the results.
", + "smithy.api#jsonName": "comparator" } }, "key": { @@ -5529,11 +5529,11 @@ "smithy.api#jsonName": "key" } }, - "comparator": { - "target": "com.amazonaws.macie2#JobComparator", + "values": { + "target": "com.amazonaws.macie2#__listOf__string", "traits": { - "smithy.api#documentation": "The operator to use to filter the results.
", - "smithy.api#jsonName": "comparator" + "smithy.api#documentation": "An array that lists one or more values to use to filter the results.
", + "smithy.api#jsonName": "values" } } }, @@ -5568,19 +5568,19 @@ "com.amazonaws.macie2#ListJobsSortCriteria": { "type": "structure", "members": { - "orderBy": { - "target": "com.amazonaws.macie2#OrderBy", - "traits": { - "smithy.api#documentation": "The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.
", - "smithy.api#jsonName": "orderBy" - } - }, "attributeName": { "target": "com.amazonaws.macie2#ListJobsSortAttributeName", "traits": { "smithy.api#documentation": "The property to sort the results by.
", "smithy.api#jsonName": "attributeName" } + }, + "orderBy": { + "target": "com.amazonaws.macie2#OrderBy", + "traits": { + "smithy.api#documentation": "The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.
", + "smithy.api#jsonName": "orderBy" + } } }, "traits": { @@ -5636,13 +5636,6 @@ "com.amazonaws.macie2#ListMembersRequest": { "type": "structure", "members": { - "onlyAssociated": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "Specifies which accounts to include in the response, based on the status of an account's relationship with the master account. By default, the response includes only current member accounts. To include all accounts, set the value for this parameter to false.
", - "smithy.api#httpQuery": "onlyAssociated" - } - }, "maxResults": { "target": "com.amazonaws.macie2#MaxResults", "traits": { @@ -5656,6 +5649,13 @@ "smithy.api#documentation": "The nextToken string that specifies which page of results to return in a paginated response.
", "smithy.api#httpQuery": "nextToken" } + }, + "onlyAssociated": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "Specifies which accounts to include in the response, based on the status of an account's relationship with the master account. By default, the response includes only current member accounts. To include all accounts, set the value for this parameter to false.
", + "smithy.api#httpQuery": "onlyAssociated" + } } } }, @@ -6005,18 +6005,25 @@ "com.amazonaws.macie2#Member": { "type": "structure", "members": { - "relationshipStatus": { - "target": "com.amazonaws.macie2#RelationshipStatus", + "accountId": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The current status of the relationship between the account and the master account.
", - "smithy.api#jsonName": "relationshipStatus" + "smithy.api#documentation": "The AWS account ID for the account.
", + "smithy.api#jsonName": "accountId" } }, - "tags": { - "target": "com.amazonaws.macie2#TagMap", + "arn": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "A map of key-value pairs that identifies the tags (keys and values) that are associated with the account in Amazon Macie.
", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the account.
", + "smithy.api#jsonName": "arn" + } + }, + "email": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The email address for the account.
", + "smithy.api#jsonName": "email" } }, "invitedAt": { @@ -6026,13 +6033,6 @@ "smithy.api#jsonName": "invitedAt" } }, - "accountId": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The AWS account ID for the account.
", - "smithy.api#jsonName": "accountId" - } - }, "masterAccountId": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -6040,11 +6040,18 @@ "smithy.api#jsonName": "masterAccountId" } }, - "arn": { - "target": "com.amazonaws.macie2#__string", + "relationshipStatus": { + "target": "com.amazonaws.macie2#RelationshipStatus", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the account.
", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The current status of the relationship between the account and the master account.
", + "smithy.api#jsonName": "relationshipStatus" + } + }, + "tags": { + "target": "com.amazonaws.macie2#TagMap", + "traits": { + "smithy.api#documentation": "A map of key-value pairs that identifies the tags (keys and values) that are associated with the account in Amazon Macie.
", + "smithy.api#jsonName": "tags" } }, "updatedAt": { @@ -6053,13 +6060,6 @@ "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the master account.
", "smithy.api#jsonName": "updatedAt" } - }, - "email": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The email address for the account.
", - "smithy.api#jsonName": "email" - } } }, "traits": { @@ -6084,32 +6084,32 @@ "com.amazonaws.macie2#ObjectCountByEncryptionType": { "type": "structure", "members": { - "unencrypted": { + "customerManaged": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The total number of objects that aren't encrypted or use client-side encryption.
", - "smithy.api#jsonName": "unencrypted" + "smithy.api#documentation": "The total number of objects that are encrypted using a customer-managed key. The objects use customer-provided server-side (SSE-C) encryption.
", + "smithy.api#jsonName": "customerManaged" } }, - "s3Managed": { + "kmsManaged": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The total number of objects that are encrypted using an Amazon S3-managed key. The objects use Amazon S3-managed (SSE-S3) encryption.
", - "smithy.api#jsonName": "s3Managed" + "smithy.api#documentation": "The total number of objects that are encrypted using an AWS Key Management Service (AWS KMS) customer master key (CMK). The objects use AWS KMS AWS-managed (AWS-KMS) encryption or AWS KMS customer-managed (SSE-KMS) encryption.
", + "smithy.api#jsonName": "kmsManaged" } }, - "kmsManaged": { + "s3Managed": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The total number of objects that are encrypted using an AWS Key Management Service (AWS KMS) customer master key (CMK). The objects use AWS KMS AWS-managed (AWS-KMS) encryption or AWS KMS customer-managed (SSE-KMS) encryption.
", - "smithy.api#jsonName": "kmsManaged" + "smithy.api#documentation": "The total number of objects that are encrypted using an Amazon S3-managed key. The objects use Amazon S3-managed (SSE-S3) encryption.
", + "smithy.api#jsonName": "s3Managed" } }, - "customerManaged": { + "unencrypted": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The total number of objects that are encrypted using a customer-managed key. The objects use customer-provided server-side (SSE-C) encryption.
", - "smithy.api#jsonName": "customerManaged" + "smithy.api#documentation": "The total number of objects that aren't encrypted or use client-side encryption.
", + "smithy.api#jsonName": "unencrypted" } } }, @@ -6127,18 +6127,18 @@ "smithy.api#jsonName": "fileType" } }, - "total": { + "storageClass": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.
", - "smithy.api#jsonName": "total" + "smithy.api#documentation": "The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.
", + "smithy.api#jsonName": "storageClass" } }, - "storageClass": { + "total": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.
", - "smithy.api#jsonName": "storageClass" + "smithy.api#documentation": "The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.
", + "smithy.api#jsonName": "total" } } }, @@ -6149,18 +6149,18 @@ "com.amazonaws.macie2#Occurrences": { "type": "structure", "members": { - "records": { - "target": "com.amazonaws.macie2#Records", + "cells": { + "target": "com.amazonaws.macie2#Cells", "traits": { - "smithy.api#documentation": "An array of objects, one for each occurrence of sensitive data in an Apache Parquet file. Each object specifies the row that contains the data. This value is null for all other types of files.
", - "smithy.api#jsonName": "records" + "smithy.api#documentation": "An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell or field that contains the data. This value is null for all other types of files.
", + "smithy.api#jsonName": "cells" } }, - "pages": { - "target": "com.amazonaws.macie2#Pages", + "lineRanges": { + "target": "com.amazonaws.macie2#Ranges", "traits": { - "smithy.api#documentation": "An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.
", - "smithy.api#jsonName": "pages" + "smithy.api#documentation": "An array of objects, one for each occurrence of sensitive data in a Microsoft Word document or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.
This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of: data in unstructured sections of an otherwise structured file, such as a comment in a file; and, data in a malformed file that Amazon Macie analyzes as plain text.
", + "smithy.api#jsonName": "lineRanges" } }, "offsetRanges": { @@ -6170,18 +6170,18 @@ "smithy.api#jsonName": "offsetRanges" } }, - "cells": { - "target": "com.amazonaws.macie2#Cells", + "pages": { + "target": "com.amazonaws.macie2#Pages", "traits": { - "smithy.api#documentation": "An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. Each object specifies the cell that contains the data. This value is null for all other types of files.
", - "smithy.api#jsonName": "cells" + "smithy.api#documentation": "An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. Each object specifies the page that contains the data, and the position of the data on that page. This value is null for all other types of files.
", + "smithy.api#jsonName": "pages" } }, - "lineRanges": { - "target": "com.amazonaws.macie2#Ranges", + "records": { + "target": "com.amazonaws.macie2#Records", "traits": { - "smithy.api#documentation": "An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Microsoft Word document, or non-binary text file, such as an HTML, JSON, TXT, or XML file. Each object specifies the line that contains the data, and the position of the data on that line.
This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the locations of: full names and addresses in a Microsoft Excel workbook, CSV file, or TSV file; data in unstructured sections of an otherwise structured file, such as a comment in a file; and, data in a malformed file that Amazon Macie analyzes as plain text.
", - "smithy.api#jsonName": "lineRanges" + "smithy.api#documentation": "An array of objects, one for each occurrence of sensitive data in an Apache Avro object container or Apache Parquet file. Each object specifies the field or record that contains the data. This value is null for all other types of files.
", + "smithy.api#jsonName": "records" } } }, @@ -6245,19 +6245,19 @@ "com.amazonaws.macie2#PolicyDetails": { "type": "structure", "members": { - "actor": { - "target": "com.amazonaws.macie2#FindingActor", - "traits": { - "smithy.api#documentation": "The entity that performed the action that produced the finding.
", - "smithy.api#jsonName": "actor" - } - }, "action": { "target": "com.amazonaws.macie2#FindingAction", "traits": { "smithy.api#documentation": "The action that produced the finding.
", "smithy.api#jsonName": "action" } + }, + "actor": { + "target": "com.amazonaws.macie2#FindingActor", + "traits": { + "smithy.api#documentation": "The entity that performed the action that produced the finding.
", + "smithy.api#jsonName": "actor" + } } }, "traits": { @@ -6355,7 +6355,7 @@ } }, "traits": { - "smithy.api#documentation": "Provides details about the location of an occurrence of sensitive data in an Adobe Portable Document Format file, Apache Avro object container, Microsoft Word document, or non-binary text file.
" + "smithy.api#documentation": "Provides details about the location of an occurrence of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.
" } }, "com.amazonaws.macie2#Ranges": { @@ -6364,22 +6364,29 @@ "target": "com.amazonaws.macie2#Range" }, "traits": { - "smithy.api#documentation": "Provides details about the location of occurrences of sensitive data in an Adobe Portable Document Format file, Apache Avro object container, Microsoft Word document, or non-binary text file.
" + "smithy.api#documentation": "Provides details about the location of occurrences of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.
" } }, "com.amazonaws.macie2#Record": { "type": "structure", "members": { + "jsonPath": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The path, as a JSONPath expression, to the field (in an Apache Avro object container) or record (in an Apache Parquet file) that contains the data.
If the name of an element exceeds 20 characters, Amazon Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.
", + "smithy.api#jsonName": "jsonPath" + } + }, "recordIndex": { "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The row index, starting from 0, for the row that contains the data.
", + "smithy.api#documentation": "The record index, starting from 0, for the record that contains the data.
", "smithy.api#jsonName": "recordIndex" } } }, "traits": { - "smithy.api#documentation": "Specifies the location of an occurrence of sensitive data in an Apache Parquet file.
" + "smithy.api#documentation": "Specifies the location of an occurrence of sensitive data in an Apache Avro object container or Apache Parquet file.
" } }, "com.amazonaws.macie2#Records": { @@ -6517,18 +6524,11 @@ "smithy.api#jsonName": "arn" } }, - "owner": { - "target": "com.amazonaws.macie2#S3BucketOwner", - "traits": { - "smithy.api#documentation": "The display name and account identifier for the user who owns the bucket.
", - "smithy.api#jsonName": "owner" - } - }, - "publicAccess": { - "target": "com.amazonaws.macie2#BucketPublicAccess", + "createdAt": { + "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "The permissions settings that determine whether the bucket is publicly accessible.
", - "smithy.api#jsonName": "publicAccess" + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
", + "smithy.api#jsonName": "createdAt" } }, "defaultServerSideEncryption": { @@ -6541,8 +6541,22 @@ "name": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The name of the bucket.
", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "The name of the bucket.
", + "smithy.api#jsonName": "name" + } + }, + "owner": { + "target": "com.amazonaws.macie2#S3BucketOwner", + "traits": { + "smithy.api#documentation": "The display name and account identifier for the user who owns the bucket.
", + "smithy.api#jsonName": "owner" + } + }, + "publicAccess": { + "target": "com.amazonaws.macie2#BucketPublicAccess", + "traits": { + "smithy.api#documentation": "The permissions settings that determine whether the bucket is publicly accessible.
", + "smithy.api#jsonName": "publicAccess" } }, "tags": { @@ -6551,13 +6565,6 @@ "smithy.api#documentation": "The tags that are associated with the bucket.
", "smithy.api#jsonName": "tags" } - }, - "createdAt": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the bucket was created.
", - "smithy.api#jsonName": "createdAt" - } } }, "traits": { @@ -6567,19 +6574,19 @@ "com.amazonaws.macie2#S3BucketDefinitionForJob": { "type": "structure", "members": { - "buckets": { - "target": "com.amazonaws.macie2#__listOf__string", - "traits": { - "smithy.api#documentation": "An array that lists the names of the buckets.
", - "smithy.api#jsonName": "buckets" - } - }, "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#documentation": "The unique identifier for the AWS account that owns one or more of the buckets. If specified, the job analyzes objects in all the buckets that are owned by the account and meet other conditions specified for the job.
", "smithy.api#jsonName": "accountId" } + }, + "buckets": { + "target": "com.amazonaws.macie2#__listOf__string", + "traits": { + "smithy.api#documentation": "An array that lists the names of the buckets.
", + "smithy.api#jsonName": "buckets" + } } }, "traits": { @@ -6589,18 +6596,18 @@ "com.amazonaws.macie2#S3BucketOwner": { "type": "structure", "members": { - "id": { + "displayName": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The AWS account ID for the user who owns the bucket.
", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The display name of the user who owns the bucket.
", + "smithy.api#jsonName": "displayName" } }, - "displayName": { + "id": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The display name of the user who owns the bucket.
", - "smithy.api#jsonName": "displayName" + "smithy.api#documentation": "The AWS account ID for the user who owns the bucket.
", + "smithy.api#jsonName": "id" } } }, @@ -6642,19 +6649,19 @@ "com.amazonaws.macie2#S3JobDefinition": { "type": "structure", "members": { - "scoping": { - "target": "com.amazonaws.macie2#Scoping", - "traits": { - "smithy.api#documentation": "The property- and tag-based conditions that determine which objects to include or exclude from the analysis.
", - "smithy.api#jsonName": "scoping" - } - }, "bucketDefinitions": { "target": "com.amazonaws.macie2#__listOfS3BucketDefinitionForJob", "traits": { "smithy.api#documentation": "An array of objects, one for each bucket that contains objects to analyze.
", "smithy.api#jsonName": "bucketDefinitions" } + }, + "scoping": { + "target": "com.amazonaws.macie2#Scoping", + "traits": { + "smithy.api#documentation": "The property- and tag-based conditions that determine which objects to include or exclude from the analysis.
", + "smithy.api#jsonName": "scoping" + } } }, "traits": { @@ -6664,6 +6671,13 @@ "com.amazonaws.macie2#S3Object": { "type": "structure", "members": { + "bucketArn": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bucket that contains the object.
", + "smithy.api#jsonName": "bucketArn" + } + }, "eTag": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -6671,11 +6685,25 @@ "smithy.api#jsonName": "eTag" } }, - "tags": { - "target": "com.amazonaws.macie2#KeyValuePairList", + "extension": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The tags that are associated with the object.
", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "The file name extension of the object. If the object doesn't have a file name extension, this value is \"\".
", + "smithy.api#jsonName": "extension" + } + }, + "key": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The full key (name) that's assigned to the object.
", + "smithy.api#jsonName": "key" + } + }, + "lastModified": { + "target": "com.amazonaws.macie2#__timestampIso8601", + "traits": { + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the object was last modified.
", + "smithy.api#jsonName": "lastModified" } }, "path": { @@ -6692,13 +6720,6 @@ "smithy.api#jsonName": "publicAccess" } }, - "extension": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The file name extension of the object. If the object doesn't have a file name extension, this value is \"\".
", - "smithy.api#jsonName": "extension" - } - }, "serverSideEncryption": { "target": "com.amazonaws.macie2#ServerSideEncryption", "traits": { @@ -6706,11 +6727,11 @@ "smithy.api#jsonName": "serverSideEncryption" } }, - "key": { - "target": "com.amazonaws.macie2#__string", + "size": { + "target": "com.amazonaws.macie2#__long", "traits": { - "smithy.api#documentation": "The full key (name) that's assigned to the object.
", - "smithy.api#jsonName": "key" + "smithy.api#documentation": "The total storage size, in bytes, of the object.
", + "smithy.api#jsonName": "size" } }, "storageClass": { @@ -6720,11 +6741,11 @@ "smithy.api#jsonName": "storageClass" } }, - "size": { - "target": "com.amazonaws.macie2#__long", + "tags": { + "target": "com.amazonaws.macie2#KeyValuePairList", "traits": { - "smithy.api#documentation": "The total storage size, in bytes, of the object.
", - "smithy.api#jsonName": "size" + "smithy.api#documentation": "The tags that are associated with the object.
", + "smithy.api#jsonName": "tags" } }, "versionId": { @@ -6733,20 +6754,6 @@ "smithy.api#documentation": "The identifier for the affected version of the object.
", "smithy.api#jsonName": "versionId" } - }, - "bucketArn": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bucket that contains the object.
", - "smithy.api#jsonName": "bucketArn" - } - }, - "lastModified": { - "target": "com.amazonaws.macie2#__timestampIso8601", - "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the object was last modified.
", - "smithy.api#jsonName": "lastModified" - } } }, "traits": { @@ -6784,18 +6791,18 @@ "com.amazonaws.macie2#Scoping": { "type": "structure", "members": { - "includes": { + "excludes": { "target": "com.amazonaws.macie2#JobScopingBlock", "traits": { - "smithy.api#documentation": "The property- or tag-based conditions that determine which objects to include in the analysis.
", - "smithy.api#jsonName": "includes" + "smithy.api#documentation": "The property- or tag-based conditions that determine which objects to exclude from the analysis.
", + "smithy.api#jsonName": "excludes" } }, - "excludes": { + "includes": { "target": "com.amazonaws.macie2#JobScopingBlock", "traits": { - "smithy.api#documentation": "The property- or tag-based conditions that determine which objects to exclude from the analysis.
", - "smithy.api#jsonName": "excludes" + "smithy.api#documentation": "The property- or tag-based conditions that determine which objects to include in the analysis.
", + "smithy.api#jsonName": "includes" } } }, @@ -6815,13 +6822,6 @@ "com.amazonaws.macie2#SensitiveDataItem": { "type": "structure", "members": { - "totalCount": { - "target": "com.amazonaws.macie2#__long", - "traits": { - "smithy.api#documentation": "The total number of occurrences of the sensitive data that was detected.
", - "smithy.api#jsonName": "totalCount" - } - }, "category": { "target": "com.amazonaws.macie2#SensitiveDataItemCategory", "traits": { @@ -6835,6 +6835,13 @@ "smithy.api#documentation": "An array of objects, one for each type of sensitive data that was detected. Each object reports the number of occurrences of a specific type of sensitive data that was detected, and the location of up to 15 of those occurrences.
", "smithy.api#jsonName": "detections" } + }, + "totalCount": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "The total number of occurrences of the sensitive data that was detected.
", + "smithy.api#jsonName": "totalCount" + } } }, "traits": { @@ -6890,13 +6897,6 @@ "com.amazonaws.macie2#ServiceLimit": { "type": "structure", "members": { - "unit": { - "target": "com.amazonaws.macie2#Unit", - "traits": { - "smithy.api#documentation": "The unit of measurement for the value specified by the value field.
", - "smithy.api#jsonName": "unit" - } - }, "isServiceLimited": { "target": "com.amazonaws.macie2#__boolean", "traits": { @@ -6904,6 +6904,13 @@ "smithy.api#jsonName": "isServiceLimited" } }, + "unit": { + "target": "com.amazonaws.macie2#Unit", + "traits": { + "smithy.api#documentation": "The unit of measurement for the value specified by the value field.
", + "smithy.api#jsonName": "unit" + } + }, "value": { "target": "com.amazonaws.macie2#__long", "traits": { @@ -6958,19 +6965,19 @@ "com.amazonaws.macie2#SessionContextAttributes": { "type": "structure", "members": { - "mfaAuthenticated": { - "target": "com.amazonaws.macie2#__boolean", - "traits": { - "smithy.api#documentation": "Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.
", - "smithy.api#jsonName": "mfaAuthenticated" - } - }, "creationDate": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { "smithy.api#documentation": "The date and time, in UTC and ISO 8601 format, when the credentials were issued.
", "smithy.api#jsonName": "creationDate" } + }, + "mfaAuthenticated": { + "target": "com.amazonaws.macie2#__boolean", + "traits": { + "smithy.api#documentation": "Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.
", + "smithy.api#jsonName": "mfaAuthenticated" + } } }, "traits": { @@ -6987,32 +6994,32 @@ "smithy.api#jsonName": "accountId" } }, - "type": { + "arn": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The source of the temporary security credentials, such as Root, IAMUser, or Role.
", - "smithy.api#jsonName": "type" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source account, IAM user, or role that was used to get the credentials.
", + "smithy.api#jsonName": "arn" } }, - "userName": { + "principalId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The name or alias of the user or role that issued the session. This value is null if the credentials were obtained from a root account that doesn't have an alias.
", - "smithy.api#jsonName": "userName" + "smithy.api#documentation": "The unique identifier for the entity that was used to get the credentials.
", + "smithy.api#jsonName": "principalId" } }, - "arn": { + "type": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source account, IAM user, or role that was used to get the credentials.
", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The source of the temporary security credentials, such as Root, IAMUser, or Role.
", + "smithy.api#jsonName": "type" } }, - "principalId": { + "userName": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the entity that was used to get the credentials.
", - "smithy.api#jsonName": "principalId" + "smithy.api#documentation": "The name or alias of the user or role that issued the session. This value is null if the credentials were obtained from a root account that doesn't have an alias.
", + "smithy.api#jsonName": "userName" } } }, @@ -7023,19 +7030,19 @@ "com.amazonaws.macie2#Severity": { "type": "structure", "members": { - "score": { - "target": "com.amazonaws.macie2#__long", - "traits": { - "smithy.api#documentation": "The numerical representation of the finding's severity, ranging from 1 (least severe) to 3 (most severe).
", - "smithy.api#jsonName": "score" - } - }, "description": { "target": "com.amazonaws.macie2#SeverityDescription", "traits": { "smithy.api#documentation": "The qualitative representation of the finding's severity, ranging from Low (least severe) to High (most severe).
", "smithy.api#jsonName": "description" } + }, + "score": { + "target": "com.amazonaws.macie2#__long", + "traits": { + "smithy.api#documentation": "The numerical representation of the finding's severity, ranging from 1 (least severe) to 3 (most severe).
", + "smithy.api#jsonName": "score" + } } }, "traits": { @@ -7095,19 +7102,19 @@ "smithy.api#jsonName": "comparator" } }, - "values": { - "target": "com.amazonaws.macie2#__listOf__string", - "traits": { - "smithy.api#documentation": "An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION, this array can specify multiple values and Amazon Macie uses an OR operator to join the values. Otherwise, this array can specify only one value. Valid values for each supported property (key) are:
OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: doc, docx, pdf
OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.
TAG - A string that represents a tag key for an object. For advanced options, use a TagScopeTerm object, instead of a SimpleScopeTerm object, to define a tag-based condition for the job.
The object property to use in the condition.
", "smithy.api#jsonName": "key" } + }, + "values": { + "target": "com.amazonaws.macie2#__listOf__string", + "traits": { + "smithy.api#documentation": "An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION, this array can specify multiple values and Amazon Macie uses an OR operator to join the values. Otherwise, this array can specify only one value. Valid values for each supported property (key) are:
OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: doc, docx, pdf
OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.
TAG - A string that represents a tag key for an object. For advanced options, use a TagScopeTerm object, instead of a SimpleScopeTerm object, to define a tag-based condition for the job.
The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.
", - "smithy.api#jsonName": "orderBy" - } - }, "attributeName": { "target": "com.amazonaws.macie2#__string", "traits": { "smithy.api#documentation": "The name of the property to sort the results by. This value can be the name of any property that Amazon Macie defines for a finding.
", "smithy.api#jsonName": "attributeName" } + }, + "orderBy": { + "target": "com.amazonaws.macie2#OrderBy", + "traits": { + "smithy.api#documentation": "The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.
", + "smithy.api#jsonName": "orderBy" + } } }, "traits": { @@ -7226,14 +7233,6 @@ "com.amazonaws.macie2#TagResourceRequest": { "type": "structure", "members": { - "tags": { - "target": "com.amazonaws.macie2#TagMap", - "traits": { - "smithy.api#documentation": "A map of key-value pairs that specifies the tags to associate with the resource.
A resource can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
", - "smithy.api#jsonName": "tags", - "smithy.api#required": {} - } - }, "resourceArn": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -7241,6 +7240,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "tags": { + "target": "com.amazonaws.macie2#TagMap", + "traits": { + "smithy.api#documentation": "A map of key-value pairs that specifies the tags to associate with the resource.
A resource can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
", + "smithy.api#jsonName": "tags", + "smithy.api#required": {} + } } } }, @@ -7251,11 +7258,11 @@ "com.amazonaws.macie2#TagScopeTerm": { "type": "structure", "members": { - "tagValues": { - "target": "com.amazonaws.macie2#__listOfTagValuePair", + "comparator": { + "target": "com.amazonaws.macie2#JobComparator", "traits": { - "smithy.api#documentation": "The tag keys or tag key and value pairs to use in the condition.
", - "smithy.api#jsonName": "tagValues" + "smithy.api#documentation": "The operator to use in the condition. Valid operators are EQ (equals) or NE (not equals).
", + "smithy.api#jsonName": "comparator" } }, "key": { @@ -7265,19 +7272,19 @@ "smithy.api#jsonName": "key" } }, + "tagValues": { + "target": "com.amazonaws.macie2#__listOfTagValuePair", + "traits": { + "smithy.api#documentation": "The tag keys or tag key and value pairs to use in the condition.
", + "smithy.api#jsonName": "tagValues" + } + }, "target": { "target": "com.amazonaws.macie2#TagTarget", "traits": { "smithy.api#documentation": "The type of object to apply the condition to.
", "smithy.api#jsonName": "target" } - }, - "comparator": { - "target": "com.amazonaws.macie2#JobComparator", - "traits": { - "smithy.api#documentation": "The operator to use in the condition. Valid operators are EQ (equals) or NE (not equals).
", - "smithy.api#jsonName": "comparator" - } } }, "traits": { @@ -7361,22 +7368,6 @@ "com.amazonaws.macie2#TestCustomDataIdentifierRequest": { "type": "structure", "members": { - "regex": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.
", - "smithy.api#jsonName": "regex", - "smithy.api#required": {} - } - }, - "sampleText": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.
", - "smithy.api#jsonName": "sampleText", - "smithy.api#required": {} - } - }, "ignoreWords": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { @@ -7397,6 +7388,22 @@ "smithy.api#documentation": "The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.
", "smithy.api#jsonName": "maximumMatchDistance" } + }, + "regex": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.
", + "smithy.api#jsonName": "regex", + "smithy.api#required": {} + } + }, + "sampleText": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.
", + "smithy.api#jsonName": "sampleText", + "smithy.api#required": {} + } } } }, @@ -7619,13 +7626,6 @@ "com.amazonaws.macie2#UpdateFindingsFilterRequest": { "type": "structure", "members": { - "position": { - "target": "com.amazonaws.macie2#__integer", - "traits": { - "smithy.api#documentation": "The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.
", - "smithy.api#jsonName": "position" - } - }, "action": { "target": "com.amazonaws.macie2#FindingsFilterAction", "traits": { @@ -7633,13 +7633,6 @@ "smithy.api#jsonName": "action" } }, - "name": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.
We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.
", - "smithy.api#jsonName": "name" - } - }, "description": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -7647,6 +7640,13 @@ "smithy.api#jsonName": "description" } }, + "findingCriteria": { + "target": "com.amazonaws.macie2#FindingCriteria", + "traits": { + "smithy.api#documentation": "The criteria to use to filter findings.
", + "smithy.api#jsonName": "findingCriteria" + } + }, "id": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -7655,11 +7655,18 @@ "smithy.api#required": {} } }, - "findingCriteria": { - "target": "com.amazonaws.macie2#FindingCriteria", + "name": { + "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The criteria to use to filter findings.
", - "smithy.api#jsonName": "findingCriteria" + "smithy.api#documentation": "A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.
We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.
", + "smithy.api#jsonName": "name" + } + }, + "position": { + "target": "com.amazonaws.macie2#__integer", + "traits": { + "smithy.api#documentation": "The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.
", + "smithy.api#jsonName": "position" } } } @@ -7667,18 +7674,18 @@ "com.amazonaws.macie2#UpdateFindingsFilterResponse": { "type": "structure", "members": { - "id": { + "arn": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the filter that was updated.
", - "smithy.api#jsonName": "id" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the filter that was updated.
", + "smithy.api#jsonName": "arn" } }, - "arn": { + "id": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the filter that was updated.
", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "The unique identifier for the filter that was updated.
", + "smithy.api#jsonName": "id" } } } @@ -7726,19 +7733,19 @@ "com.amazonaws.macie2#UpdateMacieSessionRequest": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.macie2#MacieStatus", - "traits": { - "smithy.api#documentation": "Specifies whether to change the status of the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.
", - "smithy.api#jsonName": "status" - } - }, "findingPublishingFrequency": { "target": "com.amazonaws.macie2#FindingPublishingFrequency", "traits": { "smithy.api#documentation": "Specifies how often to publish updates to policy findings for the account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).", "smithy.api#jsonName": "findingPublishingFrequency" } + }, + "status": { + "target": "com.amazonaws.macie2#MacieStatus", + "traits": { + "smithy.api#documentation": "Specifies whether to change the status of the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.
", + "smithy.api#jsonName": "status" + } } } }, @@ -7789,14 +7796,6 @@ "com.amazonaws.macie2#UpdateMemberSessionRequest": { "type": "structure", "members": { - "status": { - "target": "com.amazonaws.macie2#MacieStatus", - "traits": { - "smithy.api#documentation": "Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.
", - "smithy.api#jsonName": "status", - "smithy.api#required": {} - } - }, "id": { "target": "com.amazonaws.macie2#__string", "traits": { @@ -7804,6 +7803,14 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "status": { + "target": "com.amazonaws.macie2#MacieStatus", + "traits": { + "smithy.api#documentation": "Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.
", + "smithy.api#jsonName": "status", + "smithy.api#required": {} + } } } }, @@ -7907,6 +7914,13 @@ "com.amazonaws.macie2#UsageRecord": { "type": "structure", "members": { + "accountId": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The unique identifier for the AWS account that the data applies to.
", + "smithy.api#jsonName": "accountId" + } + }, "freeTrialStartDate": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { @@ -7920,13 +7934,6 @@ "smithy.api#documentation": "An array of objects that contains usage data and quotas for the account. Each object contains the data for a specific usage metric and the corresponding quota.
", "smithy.api#jsonName": "usage" } - }, - "accountId": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The unique identifier for the AWS account that the data applies to.
", - "smithy.api#jsonName": "accountId" - } } }, "traits": { @@ -7936,13 +7943,6 @@ "com.amazonaws.macie2#UsageStatisticsFilter": { "type": "structure", "members": { - "key": { - "target": "com.amazonaws.macie2#UsageStatisticsFilterKey", - "traits": { - "smithy.api#documentation": "The field to use in the condition.
", - "smithy.api#jsonName": "key" - } - }, "comparator": { "target": "com.amazonaws.macie2#UsageStatisticsFilterComparator", "traits": { @@ -7950,6 +7950,13 @@ "smithy.api#jsonName": "comparator" } }, + "key": { + "target": "com.amazonaws.macie2#UsageStatisticsFilterKey", + "traits": { + "smithy.api#documentation": "The field to use in the condition.
", + "smithy.api#jsonName": "key" + } + }, "values": { "target": "com.amazonaws.macie2#__listOf__string", "traits": { @@ -8025,19 +8032,19 @@ "com.amazonaws.macie2#UsageStatisticsSortBy": { "type": "structure", "members": { - "orderBy": { - "target": "com.amazonaws.macie2#OrderBy", - "traits": { - "smithy.api#documentation": "The sort order to apply to the results, based on the value for the field specified by the key property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.
", - "smithy.api#jsonName": "orderBy" - } - }, "key": { "target": "com.amazonaws.macie2#UsageStatisticsSortKey", "traits": { "smithy.api#documentation": "The field to sort the results by.
", "smithy.api#jsonName": "key" } + }, + "orderBy": { + "target": "com.amazonaws.macie2#OrderBy", + "traits": { + "smithy.api#documentation": "The sort order to apply to the results, based on the value for the field specified by the key property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.
", + "smithy.api#jsonName": "orderBy" + } } }, "traits": { @@ -8071,13 +8078,6 @@ "com.amazonaws.macie2#UsageTotal": { "type": "structure", "members": { - "estimatedCost": { - "target": "com.amazonaws.macie2#__string", - "traits": { - "smithy.api#documentation": "The estimated value for the metric.
", - "smithy.api#jsonName": "estimatedCost" - } - }, "currency": { "target": "com.amazonaws.macie2#Currency", "traits": { @@ -8085,6 +8085,13 @@ "smithy.api#jsonName": "currency" } }, + "estimatedCost": { + "target": "com.amazonaws.macie2#__string", + "traits": { + "smithy.api#documentation": "The estimated value for the metric.
", + "smithy.api#jsonName": "estimatedCost" + } + }, "type": { "target": "com.amazonaws.macie2#UsageType", "traits": { @@ -8116,20 +8123,6 @@ "com.amazonaws.macie2#UserIdentity": { "type": "structure", "members": { - "awsAccount": { - "target": "com.amazonaws.macie2#AwsAccount", - "traits": { - "smithy.api#documentation": "If the action was performed using the credentials for another AWS account, the details of that account.
", - "smithy.api#jsonName": "awsAccount" - } - }, - "type": { - "target": "com.amazonaws.macie2#UserIdentityType", - "traits": { - "smithy.api#documentation": "The type of entity that performed the action.
", - "smithy.api#jsonName": "type" - } - }, "assumedRole": { "target": "com.amazonaws.macie2#AssumedRole", "traits": { @@ -8137,6 +8130,13 @@ "smithy.api#jsonName": "assumedRole" } }, + "awsAccount": { + "target": "com.amazonaws.macie2#AwsAccount", + "traits": { + "smithy.api#documentation": "If the action was performed using the credentials for another AWS account, the details of that account.
", + "smithy.api#jsonName": "awsAccount" + } + }, "awsService": { "target": "com.amazonaws.macie2#AwsService", "traits": { @@ -8144,11 +8144,11 @@ "smithy.api#jsonName": "awsService" } }, - "root": { - "target": "com.amazonaws.macie2#UserIdentityRoot", + "federatedUser": { + "target": "com.amazonaws.macie2#FederatedUser", "traits": { - "smithy.api#documentation": "If the action was performed using the credentials for your AWS account, the details of your account.
", - "smithy.api#jsonName": "root" + "smithy.api#documentation": "If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the AWS Security Token Service (AWS STS) API, the identifiers, session context, and other details about the identity.
", + "smithy.api#jsonName": "federatedUser" } }, "iamUser": { @@ -8158,11 +8158,18 @@ "smithy.api#jsonName": "iamUser" } }, - "federatedUser": { - "target": "com.amazonaws.macie2#FederatedUser", + "root": { + "target": "com.amazonaws.macie2#UserIdentityRoot", "traits": { - "smithy.api#documentation": "If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the AWS Security Token Service (AWS STS) API, the identifiers, session context, and other details about the identity.
", - "smithy.api#jsonName": "federatedUser" + "smithy.api#documentation": "If the action was performed using the credentials for your AWS account, the details of your account.
", + "smithy.api#jsonName": "root" + } + }, + "type": { + "target": "com.amazonaws.macie2#UserIdentityType", + "traits": { + "smithy.api#documentation": "The type of entity that performed the action.
", + "smithy.api#jsonName": "type" } } }, @@ -8173,11 +8180,11 @@ "com.amazonaws.macie2#UserIdentityRoot": { "type": "structure", "members": { - "principalId": { + "accountId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the entity that performed the action.
", - "smithy.api#jsonName": "principalId" + "smithy.api#documentation": "The unique identifier for the AWS account.
", + "smithy.api#jsonName": "accountId" } }, "arn": { @@ -8187,11 +8194,11 @@ "smithy.api#jsonName": "arn" } }, - "accountId": { + "principalId": { "target": "com.amazonaws.macie2#__string", "traits": { - "smithy.api#documentation": "The unique identifier for the AWS account.
", - "smithy.api#jsonName": "accountId" + "smithy.api#documentation": "The unique identifier for the entity that performed the action.
", + "smithy.api#jsonName": "principalId" } } }, @@ -8234,11 +8241,11 @@ "com.amazonaws.macie2#UserPausedDetails": { "type": "structure", "members": { - "jobPausedAt": { + "jobExpiresAt": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when you paused the job.
", - "smithy.api#jsonName": "jobPausedAt" + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the job will expire and be cancelled if you don't resume it first. If you don't resume a job within 30 days of pausing it, the job expires and Amazon Macie cancels it.
", + "smithy.api#jsonName": "jobExpiresAt" } }, "jobImminentExpirationHealthEventArn": { @@ -8248,11 +8255,11 @@ "smithy.api#jsonName": "jobImminentExpirationHealthEventArn" } }, - "jobExpiresAt": { + "jobPausedAt": { "target": "com.amazonaws.macie2#__timestampIso8601", "traits": { - "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when the job will expire and be cancelled if you don't resume it first. If you don't resume a job within 30 days of pausing it, the job expires and Amazon Macie cancels it.
", - "smithy.api#jsonName": "jobExpiresAt" + "smithy.api#documentation": "The date and time, in UTC and extended ISO 8601 format, when you paused the job.
", + "smithy.api#jsonName": "jobPausedAt" } } }, diff --git a/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json b/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json index 80b3b0120a44..33f8ed3e4690 100644 --- a/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json +++ b/codegen/sdk-codegen/aws-models/mediaconvert.2017-08-29.json @@ -128,18 +128,18 @@ "com.amazonaws.mediaconvert#AacSettings": { "type": "structure", "members": { - "VbrQuality": { - "target": "com.amazonaws.mediaconvert#AacVbrQuality", + "AudioDescriptionBroadcasterMix": { + "target": "com.amazonaws.mediaconvert#AacAudioDescriptionBroadcasterMix", "traits": { - "smithy.api#documentation": "VBR Quality Level - Only used if rate_control_mode is VBR.", - "smithy.api#jsonName": "vbrQuality" + "smithy.api#documentation": "Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for AudioType will be set to 3, which signals to downstream systems that this stream contains \"broadcaster mixed AD\". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed audio + audio description (AD). In this case, the encoder will use any values you provide for AudioType and FollowInputAudioType.", + "smithy.api#jsonName": "audioDescriptionBroadcasterMix" } }, - "RawFormat": { - "target": "com.amazonaws.mediaconvert#AacRawFormat", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin6000Max1024000", "traits": { - "smithy.api#documentation": "Enables LATM/LOAS AAC output. Note that if you use LATM/LOAS AAC in an output, you must choose \"No container\" for the output container.", - "smithy.api#jsonName": "rawFormat" + "smithy.api#documentation": "Specify the average bitrate in bits per second. The set of valid values for this setting is: 6000, 8000, 10000, 12000, 14000, 16000, 20000, 24000, 28000, 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 288000, 320000, 384000, 448000, 512000, 576000, 640000, 768000, 896000, 1024000. The value you set is also constrained by the values that you choose for Profile (codecProfile), Bitrate control mode (codingMode), and Sample rate (sampleRate). Default values depend on Bitrate control mode and Profile.", + "smithy.api#jsonName": "bitrate" } }, "CodecProfile": { @@ -149,11 +149,11 @@ "smithy.api#jsonName": "codecProfile" } }, - "SampleRate": { - "target": "com.amazonaws.mediaconvert#__integerMin8000Max96000", + "CodingMode": { + "target": "com.amazonaws.mediaconvert#AacCodingMode", "traits": { - "smithy.api#documentation": "Sample rate in Hz. Valid values depend on rate control mode and profile.", - "smithy.api#jsonName": "sampleRate" + "smithy.api#documentation": "Mono (Audio Description), Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. \"1.0 - Audio Description (Receiver Mix)\" setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.", + "smithy.api#jsonName": "codingMode" } }, "RateControlMode": { @@ -163,25 +163,18 @@ "smithy.api#jsonName": "rateControlMode" } }, - "CodingMode": { - "target": "com.amazonaws.mediaconvert#AacCodingMode", - "traits": { - "smithy.api#documentation": "Mono (Audio Description), Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. \"1.0 - Audio Description (Receiver Mix)\" setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E.", - "smithy.api#jsonName": "codingMode" - } - }, - "AudioDescriptionBroadcasterMix": { - "target": "com.amazonaws.mediaconvert#AacAudioDescriptionBroadcasterMix", + "RawFormat": { + "target": "com.amazonaws.mediaconvert#AacRawFormat", "traits": { - "smithy.api#documentation": "Choose BROADCASTER_MIXED_AD when the input contains pre-mixed main audio + audio description (AD) as a stereo pair. The value for AudioType will be set to 3, which signals to downstream systems that this stream contains \"broadcaster mixed AD\". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. When you choose BROADCASTER_MIXED_AD, the encoder ignores any values you provide in AudioType and FollowInputAudioType. Choose NORMAL when the input does not contain pre-mixed audio + audio description (AD). In this case, the encoder will use any values you provide for AudioType and FollowInputAudioType.", - "smithy.api#jsonName": "audioDescriptionBroadcasterMix" + "smithy.api#documentation": "Enables LATM/LOAS AAC output. Note that if you use LATM/LOAS AAC in an output, you must choose \"No container\" for the output container.", + "smithy.api#jsonName": "rawFormat" } }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin6000Max1024000", + "SampleRate": { + "target": "com.amazonaws.mediaconvert#__integerMin8000Max96000", "traits": { - "smithy.api#documentation": "Specify the average bitrate in bits per second. The set of valid values for this setting is: 6000, 8000, 10000, 12000, 14000, 16000, 20000, 24000, 28000, 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 288000, 320000, 384000, 448000, 512000, 576000, 640000, 768000, 896000, 1024000. The value you set is also constrained by the values that you choose for Profile (codecProfile), Bitrate control mode (codingMode), and Sample rate (sampleRate). Default values depend on Bitrate control mode and Profile.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "Sample rate in Hz. Valid values depend on rate control mode and profile.", + "smithy.api#jsonName": "sampleRate" } }, "Specification": { @@ -190,6 +183,13 @@ "smithy.api#documentation": "Use MPEG-2 AAC instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.", "smithy.api#jsonName": "specification" } + }, + "VbrQuality": { + "target": "com.amazonaws.mediaconvert#AacVbrQuality", + "traits": { + "smithy.api#documentation": "VBR Quality Level - Only used if rate_control_mode is VBR.", + "smithy.api#jsonName": "vbrQuality" + } } }, "traits": { @@ -358,6 +358,13 @@ "smithy.api#jsonName": "bitrate" } }, + "BitstreamMode": { + "target": "com.amazonaws.mediaconvert#Ac3BitstreamMode", + "traits": { + "smithy.api#documentation": "Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E).", + "smithy.api#jsonName": "bitstreamMode" + } + }, "CodingMode": { "target": "com.amazonaws.mediaconvert#Ac3CodingMode", "traits": { @@ -372,13 +379,6 @@ "smithy.api#jsonName": "dialnorm" } }, - "BitstreamMode": { - "target": "com.amazonaws.mediaconvert#Ac3BitstreamMode", - "traits": { - "smithy.api#documentation": "Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E).", - "smithy.api#jsonName": "bitstreamMode" - } - }, "DynamicRangeCompressionProfile": { "target": "com.amazonaws.mediaconvert#Ac3DynamicRangeCompressionProfile", "traits": { @@ -386,6 +386,13 @@ "smithy.api#jsonName": "dynamicRangeCompressionProfile" } }, + "LfeFilter": { + "target": "com.amazonaws.mediaconvert#Ac3LfeFilter", + "traits": { + "smithy.api#documentation": "Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.", + "smithy.api#jsonName": "lfeFilter" + } + }, "MetadataControl": { "target": "com.amazonaws.mediaconvert#Ac3MetadataControl", "traits": { @@ -399,13 +406,6 @@ "smithy.api#documentation": "This value is always 48000. It represents the sample rate in Hz.", "smithy.api#jsonName": "sampleRate" } - }, - "LfeFilter": { - "target": "com.amazonaws.mediaconvert#Ac3LfeFilter", - "traits": { - "smithy.api#documentation": "Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.", - "smithy.api#jsonName": "lfeFilter" - } } }, "traits": { @@ -495,11 +495,11 @@ "com.amazonaws.mediaconvert#AiffSettings": { "type": "structure", "members": { - "SampleRate": { - "target": "com.amazonaws.mediaconvert#__integerMin8000Max192000", + "BitDepth": { + "target": "com.amazonaws.mediaconvert#__integerMin16Max24", "traits": { - "smithy.api#documentation": "Sample rate in hz.", - "smithy.api#jsonName": "sampleRate" + "smithy.api#documentation": "Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track.", + "smithy.api#jsonName": "bitDepth" } }, "Channels": { @@ -509,11 +509,11 @@ "smithy.api#jsonName": "channels" } }, - "BitDepth": { - "target": "com.amazonaws.mediaconvert#__integerMin16Max24", + "SampleRate": { + "target": "com.amazonaws.mediaconvert#__integerMin8000Max192000", "traits": { - "smithy.api#documentation": "Specify Bit depth (BitDepth), in bits per sample, to choose the encoding quality for this audio track.", - "smithy.api#jsonName": "bitDepth" + "smithy.api#documentation": "Sample rate in hz.", + "smithy.api#jsonName": "sampleRate" } } }, @@ -556,11 +556,11 @@ "com.amazonaws.mediaconvert#AncillarySourceSettings": { "type": "structure", "members": { - "TerminateCaptions": { - "target": "com.amazonaws.mediaconvert#AncillaryTerminateCaptions", + "Convert608To708": { + "target": "com.amazonaws.mediaconvert#AncillaryConvert608To708", "traits": { - "smithy.api#documentation": "By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.", - "smithy.api#jsonName": "terminateCaptions" + "smithy.api#documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.", + "smithy.api#jsonName": "convert608To708" } }, "SourceAncillaryChannelNumber": { @@ -570,11 +570,11 @@ "smithy.api#jsonName": "sourceAncillaryChannelNumber" } }, - "Convert608To708": { - "target": "com.amazonaws.mediaconvert#AncillaryConvert608To708", + "TerminateCaptions": { + "target": "com.amazonaws.mediaconvert#AncillaryTerminateCaptions", "traits": { - "smithy.api#documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.", - "smithy.api#jsonName": "convert608To708" + "smithy.api#documentation": "By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.", + "smithy.api#jsonName": "terminateCaptions" } } }, @@ -820,11 +820,11 @@ "smithy.api#jsonName": "ac3Settings" } }, - "WavSettings": { - "target": "com.amazonaws.mediaconvert#WavSettings", + "AiffSettings": { + "target": "com.amazonaws.mediaconvert#AiffSettings", "traits": { - "smithy.api#documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value WAV.", - "smithy.api#jsonName": "wavSettings" + "smithy.api#documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF.", + "smithy.api#jsonName": "aiffSettings" } }, "Codec": { @@ -834,18 +834,18 @@ "smithy.api#jsonName": "codec" } }, - "VorbisSettings": { - "target": "com.amazonaws.mediaconvert#VorbisSettings", + "Eac3AtmosSettings": { + "target": "com.amazonaws.mediaconvert#Eac3AtmosSettings", "traits": { - "smithy.api#documentation": "Required when you set Codec, under AudioDescriptions>CodecSettings, to the value Vorbis.", - "smithy.api#jsonName": "vorbisSettings" + "smithy.api#documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3_ATMOS.", + "smithy.api#jsonName": "eac3AtmosSettings" } }, - "AiffSettings": { - "target": "com.amazonaws.mediaconvert#AiffSettings", + "Eac3Settings": { + "target": "com.amazonaws.mediaconvert#Eac3Settings", "traits": { - "smithy.api#documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value AIFF.", - "smithy.api#jsonName": "aiffSettings" + "smithy.api#documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3.", + "smithy.api#jsonName": "eac3Settings" } }, "Mp2Settings": { @@ -855,6 +855,13 @@ "smithy.api#jsonName": "mp2Settings" } }, + "Mp3Settings": { + "target": "com.amazonaws.mediaconvert#Mp3Settings", + "traits": { + "smithy.api#documentation": "Required when you set Codec, under AudioDescriptions>CodecSettings, to the value MP3.", + "smithy.api#jsonName": "mp3Settings" + } + }, "OpusSettings": { "target": "com.amazonaws.mediaconvert#OpusSettings", "traits": { @@ -862,25 +869,18 @@ "smithy.api#jsonName": "opusSettings" } }, - "Eac3AtmosSettings": { - "target": "com.amazonaws.mediaconvert#Eac3AtmosSettings", - "traits": { - "smithy.api#documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3_ATMOS.", - "smithy.api#jsonName": "eac3AtmosSettings" - } - }, - "Mp3Settings": { - "target": "com.amazonaws.mediaconvert#Mp3Settings", + "VorbisSettings": { + "target": "com.amazonaws.mediaconvert#VorbisSettings", "traits": { - "smithy.api#documentation": "Required when you set Codec, under AudioDescriptions>CodecSettings, to the value MP3.", - "smithy.api#jsonName": "mp3Settings" + "smithy.api#documentation": "Required when you set Codec, under AudioDescriptions>CodecSettings, to the value Vorbis.", + "smithy.api#jsonName": "vorbisSettings" } }, - "Eac3Settings": { - "target": "com.amazonaws.mediaconvert#Eac3Settings", + "WavSettings": { + "target": "com.amazonaws.mediaconvert#WavSettings", "traits": { - "smithy.api#documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value EAC3.", - "smithy.api#jsonName": "eac3Settings" + "smithy.api#documentation": "Required when you set (Codec) under (AudioDescriptions)>(CodecSettings) to the value WAV.", + "smithy.api#jsonName": "wavSettings" } } }, @@ -907,20 +907,6 @@ "com.amazonaws.mediaconvert#AudioDescription": { "type": "structure", "members": { - "AudioType": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max255", - "traits": { - "smithy.api#documentation": "Applies only if Follow Input Audio Type is unchecked (false). A number between 0 and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = Reserved.", - "smithy.api#jsonName": "audioType" - } - }, - "AudioSourceName": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Specifies which audio data to use from each input. In the simplest case, specify an \"Audio Selector\":#inputs-audio_selector by name based on its order within each input. For example if you specify \"Audio Selector 3\", then the third audio selector will be used from each input. If an input does not have an \"Audio Selector 3\", then the audio selector marked as \"default\" in that input will be used. If there is no audio selector marked as \"default\", silence will be inserted for the duration of that input. Alternatively, an \"Audio Selector Group\":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no audio_source_name is specified, then \"Audio Selector 1\" will be chosen automatically.", - "smithy.api#jsonName": "audioSourceName" - } - }, "AudioChannelTaggingSettings": { "target": "com.amazonaws.mediaconvert#AudioChannelTaggingSettings", "traits": { @@ -928,13 +914,6 @@ "smithy.api#jsonName": "audioChannelTaggingSettings" } }, - "LanguageCodeControl": { - "target": "com.amazonaws.mediaconvert#AudioLanguageCodeControl", - "traits": { - "smithy.api#documentation": "Specify which source for language code takes precedence for this audio track. When you choose Follow input (FOLLOW_INPUT), the service uses the language code from the input track if it's present. If there's no languge code on the input track, the service uses the code that you specify in the setting Language code (languageCode or customLanguageCode). When you choose Use configured (USE_CONFIGURED), the service uses the language code that you specify.", - "smithy.api#jsonName": "languageCodeControl" - } - }, "AudioNormalizationSettings": { "target": "com.amazonaws.mediaconvert#AudioNormalizationSettings", "traits": { @@ -942,25 +921,25 @@ "smithy.api#jsonName": "audioNormalizationSettings" } }, - "LanguageCode": { - "target": "com.amazonaws.mediaconvert#LanguageCode", + "AudioSourceName": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.", - "smithy.api#jsonName": "languageCode" + "smithy.api#documentation": "Specifies which audio data to use from each input. In the simplest case, specify an \"Audio Selector\":#inputs-audio_selector by name based on its order within each input. For example if you specify \"Audio Selector 3\", then the third audio selector will be used from each input. If an input does not have an \"Audio Selector 3\", then the audio selector marked as \"default\" in that input will be used. If there is no audio selector marked as \"default\", silence will be inserted for the duration of that input. Alternatively, an \"Audio Selector Group\":#inputs-audio_selector_group name may be specified, with similar default/silence behavior. If no audio_source_name is specified, then \"Audio Selector 1\" will be chosen automatically.", + "smithy.api#jsonName": "audioSourceName" } }, - "RemixSettings": { - "target": "com.amazonaws.mediaconvert#RemixSettings", + "AudioType": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Advanced audio remixing settings.", - "smithy.api#jsonName": "remixSettings" + "smithy.api#documentation": "Applies only if Follow Input Audio Type is unchecked (false). A number between 0 and 255. The following are defined in ISO-IEC 13818-1: 0 = Undefined, 1 = Clean Effects, 2 = Hearing Impaired, 3 = Visually Impaired Commentary, 4-255 = Reserved.", + "smithy.api#jsonName": "audioType" } }, - "StreamName": { - "target": "com.amazonaws.mediaconvert#__stringPatternWS", + "AudioTypeControl": { + "target": "com.amazonaws.mediaconvert#AudioTypeControl", "traits": { - "smithy.api#documentation": "Specify a label for this output audio stream. For example, \"English\", \"Director commentary\", or \"track_2\". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.", - "smithy.api#jsonName": "streamName" + "smithy.api#documentation": "When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise the value in Audio Type is included in the output. Note that this field and audioType are both ignored if audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD.", + "smithy.api#jsonName": "audioTypeControl" } }, "CodecSettings": { @@ -977,11 +956,32 @@ "smithy.api#jsonName": "customLanguageCode" } }, - "AudioTypeControl": { - "target": "com.amazonaws.mediaconvert#AudioTypeControl", + "LanguageCode": { + "target": "com.amazonaws.mediaconvert#LanguageCode", "traits": { - "smithy.api#documentation": "When set to FOLLOW_INPUT, if the input contains an ISO 639 audio_type, then that value is passed through to the output. If the input contains no ISO 639 audio_type, the value in Audio Type is included in the output. Otherwise the value in Audio Type is included in the output. Note that this field and audioType are both ignored if audioDescriptionBroadcasterMix is set to BROADCASTER_MIXED_AD.", - "smithy.api#jsonName": "audioTypeControl" + "smithy.api#documentation": "Indicates the language of the audio output track. The ISO 639 language specified in the 'Language Code' drop down will be used when 'Follow Input Language Code' is not selected or when 'Follow Input Language Code' is selected but there is no ISO 639 language code specified by the input.", + "smithy.api#jsonName": "languageCode" + } + }, + "LanguageCodeControl": { + "target": "com.amazonaws.mediaconvert#AudioLanguageCodeControl", + "traits": { + "smithy.api#documentation": "Specify which source for language code takes precedence for this audio track. When you choose Follow input (FOLLOW_INPUT), the service uses the language code from the input track if it's present. If there's no languge code on the input track, the service uses the code that you specify in the setting Language code (languageCode or customLanguageCode). When you choose Use configured (USE_CONFIGURED), the service uses the language code that you specify.", + "smithy.api#jsonName": "languageCodeControl" + } + }, + "RemixSettings": { + "target": "com.amazonaws.mediaconvert#RemixSettings", + "traits": { + "smithy.api#documentation": "Advanced audio remixing settings.", + "smithy.api#jsonName": "remixSettings" + } + }, + "StreamName": { + "target": "com.amazonaws.mediaconvert#__stringPatternWS", + "traits": { + "smithy.api#documentation": "Specify a label for this output audio stream. For example, \"English\", \"Director commentary\", or \"track_2\". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.", + "smithy.api#jsonName": "streamName" } } }, @@ -1094,13 +1094,6 @@ "smithy.api#jsonName": "algorithmControl" } }, - "TargetLkfs": { - "target": "com.amazonaws.mediaconvert#__doubleMinNegative59Max0", - "traits": { - "smithy.api#documentation": "When you use Audio normalization (AudioNormalizationSettings), optionally use this setting to specify a target loudness. If you don't specify a value here, the encoder chooses a value for you, based on the algorithm that you choose for Algorithm (algorithm). If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the encoder will choose -23 LKFS.", - "smithy.api#jsonName": "targetLkfs" - } - }, "CorrectionGateLevel": { "target": "com.amazonaws.mediaconvert#__integerMinNegative70Max0", "traits": { @@ -1121,6 +1114,13 @@ "smithy.api#documentation": "If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.", "smithy.api#jsonName": "peakCalculation" } + }, + "TargetLkfs": { + "target": "com.amazonaws.mediaconvert#__doubleMinNegative59Max0", + "traits": { + "smithy.api#documentation": "When you use Audio normalization (AudioNormalizationSettings), optionally use this setting to specify a target loudness. If you don't specify a value here, the encoder chooses a value for you, based on the algorithm that you choose for Algorithm (algorithm). If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the encoder will choose -23 LKFS.", + "smithy.api#jsonName": "targetLkfs" + } } }, "traits": { @@ -1130,6 +1130,27 @@ "com.amazonaws.mediaconvert#AudioSelector": { "type": "structure", "members": { + "CustomLanguageCode": { + "target": "com.amazonaws.mediaconvert#__stringMin3Max3PatternAZaZ3", + "traits": { + "smithy.api#documentation": "Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language code", + "smithy.api#jsonName": "customLanguageCode" + } + }, + "DefaultSelection": { + "target": "com.amazonaws.mediaconvert#AudioDefaultSelection", + "traits": { + "smithy.api#documentation": "Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio.", + "smithy.api#jsonName": "defaultSelection" + } + }, + "ExternalAudioFileInput": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE", + "traits": { + "smithy.api#documentation": "Specifies audio data from an external file source.", + "smithy.api#jsonName": "externalAudioFileInput" + } + }, "LanguageCode": { "target": "com.amazonaws.mediaconvert#LanguageCode", "traits": { @@ -1144,13 +1165,6 @@ "smithy.api#jsonName": "offset" } }, - "DefaultSelection": { - "target": "com.amazonaws.mediaconvert#AudioDefaultSelection", - "traits": { - "smithy.api#documentation": "Enable this setting on one audio selector to set it as the default for the job. The service uses this default for outputs where it can't find the specified input audio. If you don't set a default, those outputs have no audio.", - "smithy.api#jsonName": "defaultSelection" - } - }, "Pids": { "target": "com.amazonaws.mediaconvert#__listOf__integerMin1Max2147483647", "traits": { @@ -1158,11 +1172,11 @@ "smithy.api#jsonName": "pids" } }, - "Tracks": { - "target": "com.amazonaws.mediaconvert#__listOf__integerMin1Max2147483647", + "ProgramSelection": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max8", "traits": { - "smithy.api#documentation": "Identify a track from the input audio to include in this selector by entering the track index number. To include several tracks in a single audio selector, specify multiple tracks as follows. Using the console, enter a comma-separated list. For examle, type \"1,2,3\" to include tracks 1 through 3. Specifying directly in your JSON job file, provide the track numbers in an array. For example, \"tracks\": [1,2,3].", - "smithy.api#jsonName": "tracks" + "smithy.api#documentation": "Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track. To select multiple programs, create multiple selectors with the same Track and different Program numbers. In the console, this setting is visible when you set Selector type to Track. Choose the program number from the dropdown list. If you are sending a JSON file, provide the program ID, which is part of the audio metadata. If your input file has incorrect metadata, you can choose All channels instead of a program number to have the service ignore the program IDs and include all the programs in the track.", + "smithy.api#jsonName": "programSelection" } }, "RemixSettings": { @@ -1179,25 +1193,11 @@ "smithy.api#jsonName": "selectorType" } }, - "CustomLanguageCode": { - "target": "com.amazonaws.mediaconvert#__stringMin3Max3PatternAZaZ3", - "traits": { - "smithy.api#documentation": "Selects a specific language code from within an audio source, using the ISO 639-2 or ISO 639-3 three-letter language code", - "smithy.api#jsonName": "customLanguageCode" - } - }, - "ExternalAudioFileInput": { - "target": "com.amazonaws.mediaconvert#__stringPatternS3MM2PPWWEEBBMMMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEEHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8LLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMAAAACCAAIIFFFFMMPP2AACC3EECC3DDTTSSEE", - "traits": { - "smithy.api#documentation": "Specifies audio data from an external file source.", - "smithy.api#jsonName": "externalAudioFileInput" - } - }, - "ProgramSelection": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max8", + "Tracks": { + "target": "com.amazonaws.mediaconvert#__listOf__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Use this setting for input streams that contain Dolby E, to have the service extract specific program data from the track. To select multiple programs, create multiple selectors with the same Track and different Program numbers. In the console, this setting is visible when you set Selector type to Track. Choose the program number from the dropdown list. If you are sending a JSON file, provide the program ID, which is part of the audio metadata. If your input file has incorrect metadata, you can choose All channels instead of a program number to have the service ignore the program IDs and include all the programs in the track.", - "smithy.api#jsonName": "programSelection" + "smithy.api#documentation": "Identify a track from the input audio to include in this selector by entering the track index number. To include several tracks in a single audio selector, specify multiple tracks as follows. Using the console, enter a comma-separated list. For examle, type \"1,2,3\" to include tracks 1 through 3. Specifying directly in your JSON job file, provide the track numbers in an array. For example, \"tracks\": [1,2,3].", + "smithy.api#jsonName": "tracks" } } }, @@ -1256,6 +1256,50 @@ ] } }, + "com.amazonaws.mediaconvert#AutomatedAbrSettings": { + "type": "structure", + "members": { + "MaxAbrBitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin100000Max100000000", + "traits": { + "smithy.api#documentation": "Optional. The maximum target bit rate used in your automated ABR stack. Use this value to set an upper limit on the bandwidth consumed by the highest-quality rendition. This is the rendition that is delivered to viewers with the fastest internet connections. If you don't specify a value, MediaConvert uses 8,000,000 (8 mb/s) by default.", + "smithy.api#jsonName": "maxAbrBitrate" + } + }, + "MaxRenditions": { + "target": "com.amazonaws.mediaconvert#__integerMin3Max15", + "traits": { + "smithy.api#documentation": "Optional. The maximum number of renditions that MediaConvert will create in your automated ABR stack. The number of renditions is determined automatically, based on analysis of each job, but will never exceed this limit. When you set this to Auto in the console, which is equivalent to excluding it from your JSON job specification, MediaConvert defaults to a limit of 15.", + "smithy.api#jsonName": "maxRenditions" + } + }, + "MinAbrBitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin100000Max100000000", + "traits": { + "smithy.api#documentation": "Optional. The minimum target bitrate used in your automated ABR stack. Use this value to set a lower limit on the bitrate of video delivered to viewers with slow internet connections. If you don't specify a value, MediaConvert uses 600,000 (600 kb/s) by default.", + "smithy.api#jsonName": "minAbrBitrate" + } + } + }, + "traits": { + "smithy.api#documentation": "Use automated ABR to have MediaConvert set up the renditions in your ABR package for you automatically, based on characteristics of your input video. This feature optimizes video quality while minimizing the overall size of your ABR package." + } + }, + "com.amazonaws.mediaconvert#AutomatedEncodingSettings": { + "type": "structure", + "members": { + "AbrSettings": { + "target": "com.amazonaws.mediaconvert#AutomatedAbrSettings", + "traits": { + "smithy.api#documentation": "Use automated ABR to have MediaConvert set up the renditions in your ABR package for you automatically, based on characteristics of your input video. This feature optimizes video quality while minimizing the overall size of your ABR package.", + "smithy.api#jsonName": "abrSettings" + } + } + }, + "traits": { + "smithy.api#documentation": "Use automated encoding to have MediaConvert choose your encoding settings for you, based on characteristics of your input video." + } + }, "com.amazonaws.mediaconvert#Av1AdaptiveQuantization": { "type": "string", "traits": { @@ -1361,11 +1405,39 @@ "com.amazonaws.mediaconvert#Av1Settings": { "type": "structure", "members": { - "QvbrSettings": { - "target": "com.amazonaws.mediaconvert#Av1QvbrSettings", + "AdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#Av1AdaptiveQuantization", "traits": { - "smithy.api#documentation": "Settings for quality-defined variable bitrate encoding with the AV1 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.", - "smithy.api#jsonName": "qvbrSettings" + "smithy.api#documentation": "Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to Spatial adaptive quantization (spatialAdaptiveQuantization).", + "smithy.api#jsonName": "adaptiveQuantization" + } + }, + "FramerateControl": { + "target": "com.amazonaws.mediaconvert#Av1FramerateControl", + "traits": { + "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#jsonName": "framerateControl" + } + }, + "FramerateConversionAlgorithm": { + "target": "com.amazonaws.mediaconvert#Av1FramerateConversionAlgorithm", + "traits": { + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#jsonName": "framerateConversionAlgorithm" + } + }, + "FramerateDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateDenominator" + } + }, + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" } }, "GopSize": { @@ -1375,13 +1447,6 @@ "smithy.api#jsonName": "gopSize" } }, - "NumberBFramesBetweenReferenceFrames": { - "target": "com.amazonaws.mediaconvert#__integerMin7Max15", - "traits": { - "smithy.api#documentation": "Specify the number of B-frames. With AV1, MediaConvert supports only 7 or 15.", - "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" - } - }, "MaxBitrate": { "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", "traits": { @@ -1389,25 +1454,25 @@ "smithy.api#jsonName": "maxBitrate" } }, - "FramerateConversionAlgorithm": { - "target": "com.amazonaws.mediaconvert#Av1FramerateConversionAlgorithm", + "NumberBFramesBetweenReferenceFrames": { + "target": "com.amazonaws.mediaconvert#__integerMin7Max15", "traits": { - "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", - "smithy.api#jsonName": "framerateConversionAlgorithm" + "smithy.api#documentation": "Specify the number of B-frames. With AV1, MediaConvert supports only 7 or 15.", + "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" } }, - "AdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#Av1AdaptiveQuantization", + "QvbrSettings": { + "target": "com.amazonaws.mediaconvert#Av1QvbrSettings", "traits": { - "smithy.api#documentation": "Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to Spatial adaptive quantization (spatialAdaptiveQuantization).", - "smithy.api#jsonName": "adaptiveQuantization" + "smithy.api#documentation": "Settings for quality-defined variable bitrate encoding with the AV1 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.", + "smithy.api#jsonName": "qvbrSettings" } }, - "FramerateDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "RateControlMode": { + "target": "com.amazonaws.mediaconvert#Av1RateControlMode", "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateDenominator" + "smithy.api#documentation": "'With AV1 outputs, for rate control mode, MediaConvert supports only quality-defined variable bitrate (QVBR). You can''t use CBR or VBR.'", + "smithy.api#jsonName": "rateControlMode" } }, "Slices": { @@ -1417,33 +1482,12 @@ "smithy.api#jsonName": "slices" } }, - "FramerateControl": { - "target": "com.amazonaws.mediaconvert#Av1FramerateControl", - "traits": { - "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", - "smithy.api#jsonName": "framerateControl" - } - }, "SpatialAdaptiveQuantization": { "target": "com.amazonaws.mediaconvert#Av1SpatialAdaptiveQuantization", "traits": { "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", "smithy.api#jsonName": "spatialAdaptiveQuantization" } - }, - "FramerateNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateNumerator" - } - }, - "RateControlMode": { - "target": "com.amazonaws.mediaconvert#Av1RateControlMode", - "traits": { - "smithy.api#documentation": "'With AV1 outputs, for rate control mode, MediaConvert supports only quality-defined variable bitrate (QVBR). You can''t use CBR or VBR.'", - "smithy.api#jsonName": "rateControlMode" - } } }, "traits": { @@ -1575,11 +1619,11 @@ "smithy.api#jsonName": "avcIntraClass" } }, - "InterlaceMode": { - "target": "com.amazonaws.mediaconvert#AvcIntraInterlaceMode", + "FramerateControl": { + "target": "com.amazonaws.mediaconvert#AvcIntraFramerateControl", "traits": { - "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", - "smithy.api#jsonName": "interlaceMode" + "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#jsonName": "framerateControl" } }, "FramerateConversionAlgorithm": { @@ -1596,13 +1640,6 @@ "smithy.api#jsonName": "framerateDenominator" } }, - "FramerateControl": { - "target": "com.amazonaws.mediaconvert#AvcIntraFramerateControl", - "traits": { - "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", - "smithy.api#jsonName": "framerateControl" - } - }, "FramerateNumerator": { "target": "com.amazonaws.mediaconvert#__integerMin24Max60000", "traits": { @@ -1610,11 +1647,11 @@ "smithy.api#jsonName": "framerateNumerator" } }, - "Telecine": { - "target": "com.amazonaws.mediaconvert#AvcIntraTelecine", + "InterlaceMode": { + "target": "com.amazonaws.mediaconvert#AvcIntraInterlaceMode", "traits": { - "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine (HARD) to create a smoother picture. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", - "smithy.api#jsonName": "telecine" + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", + "smithy.api#jsonName": "interlaceMode" } }, "SlowPal": { @@ -1623,6 +1660,13 @@ "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", "smithy.api#jsonName": "slowPal" } + }, + "Telecine": { + "target": "com.amazonaws.mediaconvert#AvcIntraTelecine", + "traits": { + "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine (HARD) to create a smoother picture. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", + "smithy.api#jsonName": "telecine" + } } }, "traits": { @@ -1704,25 +1748,11 @@ "com.amazonaws.mediaconvert#BurninDestinationSettings": { "type": "structure", "members": { - "ShadowYOffset": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", - "traits": { - "smithy.api#documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowYOffset" - } - }, - "XPosition": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", - "traits": { - "smithy.api#documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "xPosition" - } - }, - "TeletextSpacing": { - "target": "com.amazonaws.mediaconvert#BurninSubtitleTeletextSpacing", + "Alignment": { + "target": "com.amazonaws.mediaconvert#BurninSubtitleAlignment", "traits": { - "smithy.api#documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", - "smithy.api#jsonName": "teletextSpacing" + "smithy.api#documentation": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "alignment" } }, "BackgroundColor": { @@ -1732,25 +1762,11 @@ "smithy.api#jsonName": "backgroundColor" } }, - "FontSize": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max96", - "traits": { - "smithy.api#documentation": "A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontSize" - } - }, - "Alignment": { - "target": "com.amazonaws.mediaconvert#BurninSubtitleAlignment", - "traits": { - "smithy.api#documentation": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "alignment" - } - }, - "ShadowXOffset": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", + "BackgroundOpacity": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowXOffset" + "smithy.api#documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "backgroundOpacity" } }, "FontColor": { @@ -1760,25 +1776,39 @@ "smithy.api#jsonName": "fontColor" } }, - "ShadowColor": { - "target": "com.amazonaws.mediaconvert#BurninSubtitleShadowColor", + "FontOpacity": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowColor" + "smithy.api#documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontOpacity" } }, - "OutlineColor": { - "target": "com.amazonaws.mediaconvert#BurninSubtitleOutlineColor", + "FontResolution": { + "target": "com.amazonaws.mediaconvert#__integerMin96Max600", "traits": { - "smithy.api#documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "outlineColor" + "smithy.api#documentation": "Font resolution in DPI (dots per inch); default is 96 dpi.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontResolution" } }, - "ShadowOpacity": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max255", + "FontScript": { + "target": "com.amazonaws.mediaconvert#FontScript", "traits": { - "smithy.api#documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowOpacity" + "smithy.api#documentation": "Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use \"AUTOMATIC\" or leave unset. This is used to help determine the appropriate font for rendering burn-in captions.", + "smithy.api#jsonName": "fontScript" + } + }, + "FontSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max96", + "traits": { + "smithy.api#documentation": "A positive integer indicates the exact font size in points. Set to 0 for automatic font size selection. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontSize" + } + }, + "OutlineColor": { + "target": "com.amazonaws.mediaconvert#BurninSubtitleOutlineColor", + "traits": { + "smithy.api#documentation": "Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "outlineColor" } }, "OutlineSize": { @@ -1788,39 +1818,53 @@ "smithy.api#jsonName": "outlineSize" } }, - "BackgroundOpacity": { + "ShadowColor": { + "target": "com.amazonaws.mediaconvert#BurninSubtitleShadowColor", + "traits": { + "smithy.api#documentation": "Specifies the color of the shadow cast by the captions.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowColor" + } + }, + "ShadowOpacity": { "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "backgroundOpacity" + "smithy.api#documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowOpacity" } }, - "YPosition": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "ShadowXOffset": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { - "smithy.api#documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "yPosition" + "smithy.api#documentation": "Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowXOffset" } }, - "FontOpacity": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max255", + "ShadowYOffset": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { - "smithy.api#documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontOpacity" + "smithy.api#documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowYOffset" } }, - "FontResolution": { - "target": "com.amazonaws.mediaconvert#__integerMin96Max600", + "TeletextSpacing": { + "target": "com.amazonaws.mediaconvert#BurninSubtitleTeletextSpacing", "traits": { - "smithy.api#documentation": "Font resolution in DPI (dots per inch); default is 96 dpi.\nAll burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontResolution" + "smithy.api#documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", + "smithy.api#jsonName": "teletextSpacing" } }, - "FontScript": { - "target": "com.amazonaws.mediaconvert#FontScript", + "XPosition": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use \"AUTOMATIC\" or leave unset. This is used to help determine the appropriate font for rendering burn-in captions.", - "smithy.api#jsonName": "fontScript" + "smithy.api#documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "xPosition" + } + }, + "YPosition": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "yPosition" } } }, @@ -2028,6 +2072,20 @@ "smithy.api#jsonName": "captionSelectorName" } }, + "CustomLanguageCode": { + "target": "com.amazonaws.mediaconvert#__stringPatternAZaZ23AZaZ", + "traits": { + "smithy.api#documentation": "Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.", + "smithy.api#jsonName": "customLanguageCode" + } + }, + "DestinationSettings": { + "target": "com.amazonaws.mediaconvert#CaptionDestinationSettings", + "traits": { + "smithy.api#documentation": "Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.", + "smithy.api#jsonName": "destinationSettings" + } + }, "LanguageCode": { "target": "com.amazonaws.mediaconvert#LanguageCode", "traits": { @@ -2041,20 +2099,6 @@ "smithy.api#documentation": "Specify a label for this set of output captions. For example, \"English\", \"Director commentary\", or \"track_2\". For streaming outputs, MediaConvert passes this information into destination manifests for display on the end-viewer's player device. For outputs in other output groups, the service ignores this setting.", "smithy.api#jsonName": "languageDescription" } - }, - "DestinationSettings": { - "target": "com.amazonaws.mediaconvert#CaptionDestinationSettings", - "traits": { - "smithy.api#documentation": "Specific settings required by destination type. Note that burnin_destination_settings are not available if the source of the caption data is Embedded or Teletext.", - "smithy.api#jsonName": "destinationSettings" - } - }, - "CustomLanguageCode": { - "target": "com.amazonaws.mediaconvert#__stringPatternAZaZ23AZaZ", - "traits": { - "smithy.api#documentation": "Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.", - "smithy.api#jsonName": "customLanguageCode" - } } }, "traits": { @@ -2064,11 +2108,11 @@ "com.amazonaws.mediaconvert#CaptionDescriptionPreset": { "type": "structure", "members": { - "LanguageCode": { - "target": "com.amazonaws.mediaconvert#LanguageCode", + "CustomLanguageCode": { + "target": "com.amazonaws.mediaconvert#__stringPatternAZaZ23AZaZ", "traits": { - "smithy.api#documentation": "Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.", - "smithy.api#jsonName": "languageCode" + "smithy.api#documentation": "Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.", + "smithy.api#jsonName": "customLanguageCode" } }, "DestinationSettings": { @@ -2078,11 +2122,11 @@ "smithy.api#jsonName": "destinationSettings" } }, - "CustomLanguageCode": { - "target": "com.amazonaws.mediaconvert#__stringPatternAZaZ23AZaZ", + "LanguageCode": { + "target": "com.amazonaws.mediaconvert#LanguageCode", "traits": { - "smithy.api#documentation": "Specify the language for this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information when automatically selecting the font script for rendering the captions text. For all outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming outputs, you can also use any other code in the full RFC-5646 specification. Streaming outputs are those that are in one of the following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth Streaming.", - "smithy.api#jsonName": "customLanguageCode" + "smithy.api#documentation": "Specify the language of this captions output track. For most captions output formats, the encoder puts this language information in the output captions metadata. If your output captions format is DVB-Sub or Burn in, the encoder uses this language information to choose the font language for rendering the captions text.", + "smithy.api#jsonName": "languageCode" } }, "LanguageDescription": { @@ -2100,20 +2144,6 @@ "com.amazonaws.mediaconvert#CaptionDestinationSettings": { "type": "structure", "members": { - "ImscDestinationSettings": { - "target": "com.amazonaws.mediaconvert#ImscDestinationSettings", - "traits": { - "smithy.api#documentation": "Settings specific to IMSC caption outputs.", - "smithy.api#jsonName": "imscDestinationSettings" - } - }, - "TtmlDestinationSettings": { - "target": "com.amazonaws.mediaconvert#TtmlDestinationSettings", - "traits": { - "smithy.api#documentation": "Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough).", - "smithy.api#jsonName": "ttmlDestinationSettings" - } - }, "BurninDestinationSettings": { "target": "com.amazonaws.mediaconvert#BurninDestinationSettings", "traits": { @@ -2128,11 +2158,11 @@ "smithy.api#jsonName": "destinationType" } }, - "SccDestinationSettings": { - "target": "com.amazonaws.mediaconvert#SccDestinationSettings", + "DvbSubDestinationSettings": { + "target": "com.amazonaws.mediaconvert#DvbSubDestinationSettings", "traits": { - "smithy.api#documentation": "Settings for SCC caption output.", - "smithy.api#jsonName": "sccDestinationSettings" + "smithy.api#documentation": "DVB-Sub Destination Settings", + "smithy.api#jsonName": "dvbSubDestinationSettings" } }, "EmbeddedDestinationSettings": { @@ -2142,11 +2172,18 @@ "smithy.api#jsonName": "embeddedDestinationSettings" } }, - "DvbSubDestinationSettings": { - "target": "com.amazonaws.mediaconvert#DvbSubDestinationSettings", + "ImscDestinationSettings": { + "target": "com.amazonaws.mediaconvert#ImscDestinationSettings", "traits": { - "smithy.api#documentation": "DVB-Sub Destination Settings", - "smithy.api#jsonName": "dvbSubDestinationSettings" + "smithy.api#documentation": "Settings specific to IMSC caption outputs.", + "smithy.api#jsonName": "imscDestinationSettings" + } + }, + "SccDestinationSettings": { + "target": "com.amazonaws.mediaconvert#SccDestinationSettings", + "traits": { + "smithy.api#documentation": "Settings for SCC caption output.", + "smithy.api#jsonName": "sccDestinationSettings" } }, "TeletextDestinationSettings": { @@ -2155,6 +2192,13 @@ "smithy.api#documentation": "Settings for Teletext caption output", "smithy.api#jsonName": "teletextDestinationSettings" } + }, + "TtmlDestinationSettings": { + "target": "com.amazonaws.mediaconvert#TtmlDestinationSettings", + "traits": { + "smithy.api#documentation": "Settings specific to TTML caption outputs, including Pass style information (TtmlStylePassthrough).", + "smithy.api#jsonName": "ttmlDestinationSettings" + } } }, "traits": { @@ -2227,19 +2271,19 @@ "smithy.api#jsonName": "customLanguageCode" } }, - "SourceSettings": { - "target": "com.amazonaws.mediaconvert#CaptionSourceSettings", - "traits": { - "smithy.api#documentation": "If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.", - "smithy.api#jsonName": "sourceSettings" - } - }, "LanguageCode": { "target": "com.amazonaws.mediaconvert#LanguageCode", "traits": { "smithy.api#documentation": "The specific language to extract from source. If input is SCTE-27, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub and output is Burn-in or SMPTE-TT, complete this field and/or PID to select the caption language to extract. If input is DVB-Sub that is being passed through, omit this field (and PID field); there is no way to extract a specific language with pass-through captions.", "smithy.api#jsonName": "languageCode" } + }, + "SourceSettings": { + "target": "com.amazonaws.mediaconvert#CaptionSourceSettings", + "traits": { + "smithy.api#documentation": "If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml file, specify the URI of the input captions source file. If your input captions are IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.", + "smithy.api#jsonName": "sourceSettings" + } } }, "traits": { @@ -2271,6 +2315,13 @@ "com.amazonaws.mediaconvert#CaptionSourceSettings": { "type": "structure", "members": { + "AncillarySourceSettings": { + "target": "com.amazonaws.mediaconvert#AncillarySourceSettings", + "traits": { + "smithy.api#documentation": "Settings for ancillary captions source.", + "smithy.api#jsonName": "ancillarySourceSettings" + } + }, "DvbSubSourceSettings": { "target": "com.amazonaws.mediaconvert#DvbSubSourceSettings", "traits": { @@ -2285,6 +2336,13 @@ "smithy.api#jsonName": "embeddedSourceSettings" } }, + "FileSourceSettings": { + "target": "com.amazonaws.mediaconvert#FileSourceSettings", + "traits": { + "smithy.api#documentation": "If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.", + "smithy.api#jsonName": "fileSourceSettings" + } + }, "SourceType": { "target": "com.amazonaws.mediaconvert#CaptionSourceType", "traits": { @@ -2292,11 +2350,11 @@ "smithy.api#jsonName": "sourceType" } }, - "AncillarySourceSettings": { - "target": "com.amazonaws.mediaconvert#AncillarySourceSettings", + "TeletextSourceSettings": { + "target": "com.amazonaws.mediaconvert#TeletextSourceSettings", "traits": { - "smithy.api#documentation": "Settings for ancillary captions source.", - "smithy.api#jsonName": "ancillarySourceSettings" + "smithy.api#documentation": "Settings specific to Teletext caption sources, including Page number.", + "smithy.api#jsonName": "teletextSourceSettings" } }, "TrackSourceSettings": { @@ -2305,20 +2363,6 @@ "smithy.api#documentation": "Settings specific to caption sources that are specified by track number. Currently, this is only IMSC captions in an IMF package. If your caption source is IMSC 1.1 in a separate xml file, use FileSourceSettings instead of TrackSourceSettings.", "smithy.api#jsonName": "trackSourceSettings" } - }, - "FileSourceSettings": { - "target": "com.amazonaws.mediaconvert#FileSourceSettings", - "traits": { - "smithy.api#documentation": "If your input captions are SCC, SMI, SRT, STL, TTML, or IMSC 1.1 in an xml file, specify the URI of the input caption source file. If your caption source is IMSC in an IMF package, use TrackSourceSettings instead of FileSoureSettings.", - "smithy.api#jsonName": "fileSourceSettings" - } - }, - "TeletextSourceSettings": { - "target": "com.amazonaws.mediaconvert#TeletextSourceSettings", - "traits": { - "smithy.api#documentation": "Settings specific to Teletext caption sources, including Page number.", - "smithy.api#jsonName": "teletextSourceSettings" - } } }, "traits": { @@ -2399,19 +2443,19 @@ "com.amazonaws.mediaconvert#CmafAdditionalManifest": { "type": "structure", "members": { - "SelectedOutputs": { - "target": "com.amazonaws.mediaconvert#__listOf__stringMin1", - "traits": { - "smithy.api#documentation": "Specify the outputs that you want this additional top-level manifest to reference.", - "smithy.api#jsonName": "selectedOutputs" - } - }, "ManifestNameModifier": { "target": "com.amazonaws.mediaconvert#__stringMin1", "traits": { "smithy.api#documentation": "Specify a name modifier that the service adds to the name of this manifest to make it different from the file names of the other main manifests in the output group. For example, say that the default main manifest for your HLS group is film-name.m3u8. If you enter \"-no-premium\" for this setting, then the file name the service generates for this top-level manifest is film-name-no-premium.m3u8. For HLS output groups, specify a manifestNameModifier that is different from the nameModifier of the output. The service uses the output name modifier to create unique names for the individual variant manifests.", "smithy.api#jsonName": "manifestNameModifier" } + }, + "SelectedOutputs": { + "target": "com.amazonaws.mediaconvert#__listOf__stringMin1", + "traits": { + "smithy.api#documentation": "Specify the outputs that you want this additional top-level manifest to reference.", + "smithy.api#jsonName": "selectedOutputs" + } } }, "traits": { @@ -2460,11 +2504,11 @@ "smithy.api#jsonName": "constantInitializationVector" } }, - "SpekeKeyProvider": { - "target": "com.amazonaws.mediaconvert#SpekeKeyProviderCmaf", + "EncryptionMethod": { + "target": "com.amazonaws.mediaconvert#CmafEncryptionType", "traits": { - "smithy.api#documentation": "If your output group type is CMAF, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is HLS, DASH, or Microsoft Smooth, use the SpekeKeyProvider settings instead.", - "smithy.api#jsonName": "spekeKeyProvider" + "smithy.api#documentation": "Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample (SAMPLE-AES) or AES_CTR (AES-CTR).", + "smithy.api#jsonName": "encryptionMethod" } }, "InitializationVectorInManifest": { @@ -2474,6 +2518,13 @@ "smithy.api#jsonName": "initializationVectorInManifest" } }, + "SpekeKeyProvider": { + "target": "com.amazonaws.mediaconvert#SpekeKeyProviderCmaf", + "traits": { + "smithy.api#documentation": "If your output group type is CMAF, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is HLS, DASH, or Microsoft Smooth, use the SpekeKeyProvider settings instead.", + "smithy.api#jsonName": "spekeKeyProvider" + } + }, "StaticKeyProvider": { "target": "com.amazonaws.mediaconvert#StaticKeyProvider", "traits": { @@ -2487,13 +2538,6 @@ "smithy.api#documentation": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.", "smithy.api#jsonName": "type" } - }, - "EncryptionMethod": { - "target": "com.amazonaws.mediaconvert#CmafEncryptionType", - "traits": { - "smithy.api#documentation": "Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample (SAMPLE-AES) or AES_CTR (AES-CTR).", - "smithy.api#jsonName": "encryptionMethod" - } } }, "traits": { @@ -2526,67 +2570,67 @@ "smithy.api#jsonName": "additionalManifests" } }, - "ManifestCompression": { - "target": "com.amazonaws.mediaconvert#CmafManifestCompression", + "BaseUrl": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "When set to GZIP, compresses HLS playlist.", - "smithy.api#jsonName": "manifestCompression" + "smithy.api#documentation": "A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.", + "smithy.api#jsonName": "baseUrl" } }, - "FragmentLength": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "ClientCache": { + "target": "com.amazonaws.mediaconvert#CmafClientCache", "traits": { - "smithy.api#documentation": "Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.", - "smithy.api#jsonName": "fragmentLength" + "smithy.api#documentation": "When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.", + "smithy.api#jsonName": "clientCache" } }, - "BaseUrl": { - "target": "com.amazonaws.mediaconvert#__string", + "CodecSpecification": { + "target": "com.amazonaws.mediaconvert#CmafCodecSpecification", "traits": { - "smithy.api#documentation": "A partial URI prefix that will be put in the manifest file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.", - "smithy.api#jsonName": "baseUrl" + "smithy.api#documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.", + "smithy.api#jsonName": "codecSpecification" } }, - "WriteSegmentTimelineInRepresentation": { - "target": "com.amazonaws.mediaconvert#CmafWriteSegmentTimelineInRepresentation", + "Destination": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3", "traits": { - "smithy.api#documentation": "When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.", - "smithy.api#jsonName": "writeSegmentTimelineInRepresentation" + "smithy.api#documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.", + "smithy.api#jsonName": "destination" } }, - "SegmentControl": { - "target": "com.amazonaws.mediaconvert#CmafSegmentControl", + "DestinationSettings": { + "target": "com.amazonaws.mediaconvert#DestinationSettings", "traits": { - "smithy.api#documentation": "When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.", - "smithy.api#jsonName": "segmentControl" + "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", + "smithy.api#jsonName": "destinationSettings" } }, - "ClientCache": { - "target": "com.amazonaws.mediaconvert#CmafClientCache", + "Encryption": { + "target": "com.amazonaws.mediaconvert#CmafEncryptionSettings", "traits": { - "smithy.api#documentation": "When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.", - "smithy.api#jsonName": "clientCache" + "smithy.api#documentation": "DRM settings.", + "smithy.api#jsonName": "encryption" } }, - "Destination": { - "target": "com.amazonaws.mediaconvert#__stringPatternS3", + "FragmentLength": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.", - "smithy.api#jsonName": "destination" + "smithy.api#documentation": "Length of fragments to generate (in seconds). Fragment length must be compatible with GOP size and Framerate. Note that fragments will end on the next keyframe after this number of seconds, so actual fragment length may be longer. When Emit Single File is checked, the fragmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.", + "smithy.api#jsonName": "fragmentLength" } }, - "CodecSpecification": { - "target": "com.amazonaws.mediaconvert#CmafCodecSpecification", + "ManifestCompression": { + "target": "com.amazonaws.mediaconvert#CmafManifestCompression", "traits": { - "smithy.api#documentation": "Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.", - "smithy.api#jsonName": "codecSpecification" + "smithy.api#documentation": "When set to GZIP, compresses HLS playlist.", + "smithy.api#jsonName": "manifestCompression" } }, - "SegmentLength": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "ManifestDurationFormat": { + "target": "com.amazonaws.mediaconvert#CmafManifestDurationFormat", "traits": { - "smithy.api#documentation": "Use this setting to specify the length, in seconds, of each individual CMAF segment. This value applies to the whole package; that is, to every output in the output group. Note that segments end on the first keyframe after this number of seconds, so the actual segment length might be slightly longer. If you set Segment control (CmafSegmentControl) to single file, the service puts the content of each output in a single file that has metadata that marks these segments. If you set it to segmented files, the service creates multiple files for each output, each with the content of one segment.", - "smithy.api#jsonName": "segmentLength" + "smithy.api#documentation": "Indicates whether the output manifest should use floating point values for segment duration.", + "smithy.api#jsonName": "manifestDurationFormat" } }, "MinBufferTime": { @@ -2596,6 +2640,13 @@ "smithy.api#jsonName": "minBufferTime" } }, + "MinFinalSegmentLength": { + "target": "com.amazonaws.mediaconvert#__doubleMin0Max2147483647", + "traits": { + "smithy.api#documentation": "Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.", + "smithy.api#jsonName": "minFinalSegmentLength" + } + }, "MpdProfile": { "target": "com.amazonaws.mediaconvert#CmafMpdProfile", "traits": { @@ -2603,18 +2654,18 @@ "smithy.api#jsonName": "mpdProfile" } }, - "DestinationSettings": { - "target": "com.amazonaws.mediaconvert#DestinationSettings", + "SegmentControl": { + "target": "com.amazonaws.mediaconvert#CmafSegmentControl", "traits": { - "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", - "smithy.api#jsonName": "destinationSettings" + "smithy.api#documentation": "When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.", + "smithy.api#jsonName": "segmentControl" } }, - "MinFinalSegmentLength": { - "target": "com.amazonaws.mediaconvert#__doubleMin0Max2147483647", + "SegmentLength": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Keep this setting at the default value of 0, unless you are troubleshooting a problem with how devices play back the end of your video asset. If you know that player devices are hanging on the final segment of your video because the length of your final segment is too short, use this setting to specify a minimum final segment length, in seconds. Choose a value that is greater than or equal to 1 and less than your segment length. When you specify a value for this setting, the encoder will combine any final segment that is shorter than the length that you specify with the previous segment. For example, your segment length is 3 seconds and your final segment is .5 seconds without a minimum final segment length; when you set the minimum final segment length to 1, your final segment is 3.5 seconds.", - "smithy.api#jsonName": "minFinalSegmentLength" + "smithy.api#documentation": "Use this setting to specify the length, in seconds, of each individual CMAF segment. This value applies to the whole package; that is, to every output in the output group. Note that segments end on the first keyframe after this number of seconds, so the actual segment length might be slightly longer. If you set Segment control (CmafSegmentControl) to single file, the service puts the content of each output in a single file that has metadata that marks these segments. If you set it to segmented files, the service creates multiple files for each output, each with the content of one segment.", + "smithy.api#jsonName": "segmentLength" } }, "StreamInfResolution": { @@ -2624,20 +2675,6 @@ "smithy.api#jsonName": "streamInfResolution" } }, - "WriteHlsManifest": { - "target": "com.amazonaws.mediaconvert#CmafWriteHLSManifest", - "traits": { - "smithy.api#documentation": "When set to ENABLED, an Apple HLS manifest will be generated for this output.", - "smithy.api#jsonName": "writeHlsManifest" - } - }, - "Encryption": { - "target": "com.amazonaws.mediaconvert#CmafEncryptionSettings", - "traits": { - "smithy.api#documentation": "DRM settings.", - "smithy.api#jsonName": "encryption" - } - }, "WriteDashManifest": { "target": "com.amazonaws.mediaconvert#CmafWriteDASHManifest", "traits": { @@ -2645,11 +2682,18 @@ "smithy.api#jsonName": "writeDashManifest" } }, - "ManifestDurationFormat": { - "target": "com.amazonaws.mediaconvert#CmafManifestDurationFormat", + "WriteHlsManifest": { + "target": "com.amazonaws.mediaconvert#CmafWriteHLSManifest", "traits": { - "smithy.api#documentation": "Indicates whether the output manifest should use floating point values for segment duration.", - "smithy.api#jsonName": "manifestDurationFormat" + "smithy.api#documentation": "When set to ENABLED, an Apple HLS manifest will be generated for this output.", + "smithy.api#jsonName": "writeHlsManifest" + } + }, + "WriteSegmentTimelineInRepresentation": { + "target": "com.amazonaws.mediaconvert#CmafWriteSegmentTimelineInRepresentation", + "traits": { + "smithy.api#documentation": "When you enable Precise segment duration in DASH manifests (writeSegmentTimelineInRepresentation), your DASH manifest shows precise segment durations. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When this feature isn't enabled, the segment durations in your DASH manifest are approximate. The segment duration information appears in the duration attribute of the SegmentTemplate element.", + "smithy.api#jsonName": "writeSegmentTimelineInRepresentation" } } }, @@ -2874,25 +2918,11 @@ "com.amazonaws.mediaconvert#ColorCorrector": { "type": "structure", "members": { - "Hue": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative180Max180", - "traits": { - "smithy.api#documentation": "Hue in degrees.", - "smithy.api#jsonName": "hue" - } - }, - "Contrast": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max100", - "traits": { - "smithy.api#documentation": "Contrast level.", - "smithy.api#jsonName": "contrast" - } - }, - "Saturation": { + "Brightness": { "target": "com.amazonaws.mediaconvert#__integerMin1Max100", "traits": { - "smithy.api#documentation": "Saturation level.", - "smithy.api#jsonName": "saturation" + "smithy.api#documentation": "Brightness level.", + "smithy.api#jsonName": "brightness" } }, "ColorSpaceConversion": { @@ -2902,11 +2932,11 @@ "smithy.api#jsonName": "colorSpaceConversion" } }, - "Brightness": { + "Contrast": { "target": "com.amazonaws.mediaconvert#__integerMin1Max100", "traits": { - "smithy.api#documentation": "Brightness level.", - "smithy.api#jsonName": "brightness" + "smithy.api#documentation": "Contrast level.", + "smithy.api#jsonName": "contrast" } }, "Hdr10Metadata": { @@ -2915,6 +2945,20 @@ "smithy.api#documentation": "Use these settings when you convert to the HDR 10 color space. Specify the SMPTE ST 2086 Mastering Display Color Volume static metadata that you want signaled in the output. These values don't affect the pixel values that are encoded in the video stream. They are intended to help the downstream video player display content in a way that reflects the intentions of the the content creator. When you set Color space conversion (ColorSpaceConversion) to HDR 10 (FORCE_HDR10), these settings are required. You must set values for Max frame average light level (maxFrameAverageLightLevel) and Max content light level (maxContentLightLevel); these settings don't have a default value. The default values for the other HDR 10 metadata settings are defined by the P3D65 color space. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.", "smithy.api#jsonName": "hdr10Metadata" } + }, + "Hue": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative180Max180", + "traits": { + "smithy.api#documentation": "Hue in degrees.", + "smithy.api#jsonName": "hue" + } + }, + "Saturation": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max100", + "traits": { + "smithy.api#documentation": "Saturation level.", + "smithy.api#jsonName": "saturation" + } } }, "traits": { @@ -3040,11 +3084,11 @@ "com.amazonaws.mediaconvert#ContainerSettings": { "type": "structure", "members": { - "M2tsSettings": { - "target": "com.amazonaws.mediaconvert#M2tsSettings", + "CmfcSettings": { + "target": "com.amazonaws.mediaconvert#CmfcSettings", "traits": { - "smithy.api#documentation": "MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset.", - "smithy.api#jsonName": "m2tsSettings" + "smithy.api#documentation": "Settings for MP4 segments in CMAF", + "smithy.api#jsonName": "cmfcSettings" } }, "Container": { @@ -3061,25 +3105,11 @@ "smithy.api#jsonName": "f4vSettings" } }, - "MxfSettings": { - "target": "com.amazonaws.mediaconvert#MxfSettings", - "traits": { - "smithy.api#documentation": "MXF settings", - "smithy.api#jsonName": "mxfSettings" - } - }, - "MpdSettings": { - "target": "com.amazonaws.mediaconvert#MpdSettings", - "traits": { - "smithy.api#documentation": "Settings for MP4 segments in DASH", - "smithy.api#jsonName": "mpdSettings" - } - }, - "Mp4Settings": { - "target": "com.amazonaws.mediaconvert#Mp4Settings", + "M2tsSettings": { + "target": "com.amazonaws.mediaconvert#M2tsSettings", "traits": { - "smithy.api#documentation": "Settings for MP4 container. You can create audio-only AAC outputs with this container.", - "smithy.api#jsonName": "mp4Settings" + "smithy.api#documentation": "MPEG-2 TS container settings. These apply to outputs in a File output group when the output's container (ContainerType) is MPEG-2 Transport Stream (M2TS). In these assets, data is organized by the program map table (PMT). Each transport stream program contains subsets of data, including audio, video, and metadata. Each of these subsets of data has a numerical label called a packet identifier (PID). Each transport stream program corresponds to one MediaConvert output. The PMT lists the types of data in a program along with their PID. Downstream systems and players use the program map table to look up the PID for each type of data it accesses and then uses the PIDs to locate specific data within the asset.", + "smithy.api#jsonName": "m2tsSettings" } }, "M3u8Settings": { @@ -3096,11 +3126,25 @@ "smithy.api#jsonName": "movSettings" } }, - "CmfcSettings": { - "target": "com.amazonaws.mediaconvert#CmfcSettings", + "Mp4Settings": { + "target": "com.amazonaws.mediaconvert#Mp4Settings", "traits": { - "smithy.api#documentation": "Settings for MP4 segments in CMAF", - "smithy.api#jsonName": "cmfcSettings" + "smithy.api#documentation": "Settings for MP4 container. You can create audio-only AAC outputs with this container.", + "smithy.api#jsonName": "mp4Settings" + } + }, + "MpdSettings": { + "target": "com.amazonaws.mediaconvert#MpdSettings", + "traits": { + "smithy.api#documentation": "Settings for MP4 segments in DASH", + "smithy.api#jsonName": "mpdSettings" + } + }, + "MxfSettings": { + "target": "com.amazonaws.mediaconvert#MxfSettings", + "traits": { + "smithy.api#documentation": "MXF settings", + "smithy.api#jsonName": "mxfSettings" } } }, @@ -3200,12 +3244,26 @@ "com.amazonaws.mediaconvert#CreateJobRequest": { "type": "structure", "members": { - "Role": { + "AccelerationSettings": { + "target": "com.amazonaws.mediaconvert#AccelerationSettings", + "traits": { + "smithy.api#documentation": "Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.", + "smithy.api#jsonName": "accelerationSettings" + } + }, + "BillingTagsSource": { + "target": "com.amazonaws.mediaconvert#BillingTagsSource", + "traits": { + "smithy.api#documentation": "Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.", + "smithy.api#jsonName": "billingTagsSource" + } + }, + "ClientRequestToken": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.", - "smithy.api#jsonName": "role", - "smithy.api#required": {} + "smithy.api#documentation": "Optional. Idempotency token for CreateJob operation.", + "smithy.api#idempotencyToken": {}, + "smithy.api#jsonName": "clientRequestToken" } }, "HopDestinations": { @@ -3215,53 +3273,33 @@ "smithy.api#jsonName": "hopDestinations" } }, - "SimulateReservedQueue": { - "target": "com.amazonaws.mediaconvert#SimulateReservedQueue", + "JobTemplate": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Optional. Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.", - "smithy.api#jsonName": "simulateReservedQueue" + "smithy.api#documentation": "Optional. When you create a job, you can either specify a job template or specify the transcoding settings individually.", + "smithy.api#jsonName": "jobTemplate" } }, - "Tags": { - "target": "com.amazonaws.mediaconvert#__mapOf__string", + "Priority": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", "traits": { - "smithy.api#documentation": "Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "Optional. Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.", + "smithy.api#jsonName": "priority" } }, - "UserMetadata": { - "target": "com.amazonaws.mediaconvert#__mapOf__string", + "Queue": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.", - "smithy.api#jsonName": "userMetadata" - } - }, - "StatusUpdateInterval": { - "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", - "traits": { - "smithy.api#documentation": "Optional. Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", - "smithy.api#jsonName": "statusUpdateInterval" - } - }, - "Priority": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", - "traits": { - "smithy.api#documentation": "Optional. Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.", - "smithy.api#jsonName": "priority" - } - }, - "BillingTagsSource": { - "target": "com.amazonaws.mediaconvert#BillingTagsSource", - "traits": { - "smithy.api#documentation": "Optional. Choose a tag type that AWS Billing and Cost Management will use to sort your AWS Elemental MediaConvert costs on any billing report that you set up. Any transcoding outputs that don't have an associated tag will appear in your billing report unsorted. If you don't choose a valid value for this field, your job outputs will appear on the billing report unsorted.", - "smithy.api#jsonName": "billingTagsSource" + "smithy.api#documentation": "Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.", + "smithy.api#jsonName": "queue" } }, - "JobTemplate": { + "Role": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Optional. When you create a job, you can either specify a job template or specify the transcoding settings individually.", - "smithy.api#jsonName": "jobTemplate" + "smithy.api#documentation": "Required. The IAM role you use for creating this job. For details about permissions, see the User Guide topic at the User Guide at https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.", + "smithy.api#jsonName": "role", + "smithy.api#required": {} } }, "Settings": { @@ -3272,26 +3310,32 @@ "smithy.api#required": {} } }, - "Queue": { - "target": "com.amazonaws.mediaconvert#__string", + "SimulateReservedQueue": { + "target": "com.amazonaws.mediaconvert#SimulateReservedQueue", "traits": { - "smithy.api#documentation": "Optional. When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html.", - "smithy.api#jsonName": "queue" + "smithy.api#documentation": "Optional. Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.", + "smithy.api#jsonName": "simulateReservedQueue" } }, - "AccelerationSettings": { - "target": "com.amazonaws.mediaconvert#AccelerationSettings", + "StatusUpdateInterval": { + "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", "traits": { - "smithy.api#documentation": "Optional. Accelerated transcoding can significantly speed up jobs with long, visually complex content. Outputs that use this feature incur pro-tier pricing. For information about feature limitations, see the AWS Elemental MediaConvert User Guide.", - "smithy.api#jsonName": "accelerationSettings" + "smithy.api#documentation": "Optional. Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", + "smithy.api#jsonName": "statusUpdateInterval" } }, - "ClientRequestToken": { - "target": "com.amazonaws.mediaconvert#__string", + "Tags": { + "target": "com.amazonaws.mediaconvert#__mapOf__string", "traits": { - "smithy.api#documentation": "Optional. Idempotency token for CreateJob operation.", - "smithy.api#idempotencyToken": {}, - "smithy.api#jsonName": "clientRequestToken" + "smithy.api#documentation": "Optional. The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.", + "smithy.api#jsonName": "tags" + } + }, + "UserMetadata": { + "target": "com.amazonaws.mediaconvert#__mapOf__string", + "traits": { + "smithy.api#documentation": "Optional. User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.", + "smithy.api#jsonName": "userMetadata" } } } @@ -3355,6 +3399,13 @@ "smithy.api#jsonName": "accelerationSettings" } }, + "Category": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Optional. A category for the job template you are creating", + "smithy.api#jsonName": "category" + } + }, "Description": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -3362,6 +3413,21 @@ "smithy.api#jsonName": "description" } }, + "HopDestinations": { + "target": "com.amazonaws.mediaconvert#__listOfHopDestination", + "traits": { + "smithy.api#documentation": "Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.", + "smithy.api#jsonName": "hopDestinations" + } + }, + "Name": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "The name of the job template you are creating.", + "smithy.api#jsonName": "name", + "smithy.api#required": {} + } + }, "Priority": { "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", "traits": { @@ -3369,13 +3435,6 @@ "smithy.api#jsonName": "priority" } }, - "StatusUpdateInterval": { - "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", - "traits": { - "smithy.api#documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", - "smithy.api#jsonName": "statusUpdateInterval" - } - }, "Queue": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -3383,20 +3442,6 @@ "smithy.api#jsonName": "queue" } }, - "Category": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Optional. A category for the job template you are creating", - "smithy.api#jsonName": "category" - } - }, - "Tags": { - "target": "com.amazonaws.mediaconvert#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.", - "smithy.api#jsonName": "tags" - } - }, "Settings": { "target": "com.amazonaws.mediaconvert#JobTemplateSettings", "traits": { @@ -3405,19 +3450,18 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.mediaconvert#__string", + "StatusUpdateInterval": { + "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", "traits": { - "smithy.api#documentation": "The name of the job template you are creating.", - "smithy.api#jsonName": "name", - "smithy.api#required": {} + "smithy.api#documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", + "smithy.api#jsonName": "statusUpdateInterval" } }, - "HopDestinations": { - "target": "com.amazonaws.mediaconvert#__listOfHopDestination", + "Tags": { + "target": "com.amazonaws.mediaconvert#__mapOf__string", "traits": { - "smithy.api#documentation": "Optional. Use queue hopping to avoid overly long waits in the backlog of the queue that you submit your job to. Specify an alternate queue and the maximum time that your job will wait in the initial queue before hopping. For more information about this feature, see the AWS Elemental MediaConvert User Guide.", - "smithy.api#jsonName": "hopDestinations" + "smithy.api#documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.", + "smithy.api#jsonName": "tags" } } } @@ -3474,18 +3518,18 @@ "com.amazonaws.mediaconvert#CreatePresetRequest": { "type": "structure", "members": { - "Description": { + "Category": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Optional. A description of the preset you are creating.", - "smithy.api#jsonName": "description" + "smithy.api#documentation": "Optional. A category for the preset you are creating.", + "smithy.api#jsonName": "category" } }, - "Tags": { - "target": "com.amazonaws.mediaconvert#__mapOf__string", + "Description": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "Optional. A description of the preset you are creating.", + "smithy.api#jsonName": "description" } }, "Name": { @@ -3504,11 +3548,11 @@ "smithy.api#required": {} } }, - "Category": { - "target": "com.amazonaws.mediaconvert#__string", + "Tags": { + "target": "com.amazonaws.mediaconvert#__mapOf__string", "traits": { - "smithy.api#documentation": "Optional. A category for the preset you are creating.", - "smithy.api#jsonName": "category" + "smithy.api#documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.", + "smithy.api#jsonName": "tags" } } } @@ -3580,13 +3624,6 @@ "smithy.api#required": {} } }, - "ReservationPlanSettings": { - "target": "com.amazonaws.mediaconvert#ReservationPlanSettings", - "traits": { - "smithy.api#documentation": "Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.", - "smithy.api#jsonName": "reservationPlanSettings" - } - }, "PricingPlan": { "target": "com.amazonaws.mediaconvert#PricingPlan", "traits": { @@ -3594,11 +3631,11 @@ "smithy.api#jsonName": "pricingPlan" } }, - "Tags": { - "target": "com.amazonaws.mediaconvert#__mapOf__string", + "ReservationPlanSettings": { + "target": "com.amazonaws.mediaconvert#ReservationPlanSettings", "traits": { - "smithy.api#documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.", - "smithy.api#jsonName": "tags" + "smithy.api#documentation": "Details about the pricing plan for your reserved queue. Required for reserved queues and not applicable to on-demand queues.", + "smithy.api#jsonName": "reservationPlanSettings" } }, "Status": { @@ -3607,6 +3644,13 @@ "smithy.api#documentation": "Initial state of the queue. If you create a paused queue, then jobs in that queue won't begin.", "smithy.api#jsonName": "status" } + }, + "Tags": { + "target": "com.amazonaws.mediaconvert#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.", + "smithy.api#jsonName": "tags" + } } } }, @@ -3625,19 +3669,19 @@ "com.amazonaws.mediaconvert#DashAdditionalManifest": { "type": "structure", "members": { - "SelectedOutputs": { - "target": "com.amazonaws.mediaconvert#__listOf__stringMin1", - "traits": { - "smithy.api#documentation": "Specify the outputs that you want this additional top-level manifest to reference.", - "smithy.api#jsonName": "selectedOutputs" - } - }, "ManifestNameModifier": { "target": "com.amazonaws.mediaconvert#__stringMin1", "traits": { "smithy.api#documentation": "Specify a name modifier that the service adds to the name of this manifest to make it different from the file names of the other main manifests in the output group. For example, say that the default main manifest for your DASH group is film-name.mpd. If you enter \"-no-premium\" for this setting, then the file name the service generates for this top-level manifest is film-name-no-premium.mpd.", "smithy.api#jsonName": "manifestNameModifier" } + }, + "SelectedOutputs": { + "target": "com.amazonaws.mediaconvert#__listOf__stringMin1", + "traits": { + "smithy.api#documentation": "Specify the outputs that you want this additional top-level manifest to reference.", + "smithy.api#jsonName": "selectedOutputs" + } } }, "traits": { @@ -3647,19 +3691,19 @@ "com.amazonaws.mediaconvert#DashIsoEncryptionSettings": { "type": "structure", "members": { - "SpekeKeyProvider": { - "target": "com.amazonaws.mediaconvert#SpekeKeyProvider", - "traits": { - "smithy.api#documentation": "If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead.", - "smithy.api#jsonName": "spekeKeyProvider" - } - }, "PlaybackDeviceCompatibility": { "target": "com.amazonaws.mediaconvert#DashIsoPlaybackDeviceCompatibility", "traits": { "smithy.api#documentation": "This setting can improve the compatibility of your output with video players on obsolete devices. It applies only to DASH H.264 outputs with DRM encryption. Choose Unencrypted SEI (UNENCRYPTED_SEI) only to correct problems with playback on older devices. Otherwise, keep the default setting CENC v1 (CENC_V1). If you choose Unencrypted SEI, for that output, the service will exclude the access unit delimiter and will leave the SEI NAL units unencrypted.", "smithy.api#jsonName": "playbackDeviceCompatibility" } + }, + "SpekeKeyProvider": { + "target": "com.amazonaws.mediaconvert#SpekeKeyProvider", + "traits": { + "smithy.api#documentation": "If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead.", + "smithy.api#jsonName": "spekeKeyProvider" + } } }, "traits": { @@ -3669,32 +3713,18 @@ "com.amazonaws.mediaconvert#DashIsoGroupSettings": { "type": "structure", "members": { - "DestinationSettings": { - "target": "com.amazonaws.mediaconvert#DestinationSettings", - "traits": { - "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", - "smithy.api#jsonName": "destinationSettings" - } - }, - "WriteSegmentTimelineInRepresentation": { - "target": "com.amazonaws.mediaconvert#DashIsoWriteSegmentTimelineInRepresentation", - "traits": { - "smithy.api#documentation": "If you get an HTTP error in the 400 range when you play back your DASH output, enable this setting and run your transcoding job again. When you enable this setting, the service writes precise segment durations in the DASH manifest. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When you don't enable this setting, the service writes approximate segment durations in your DASH manifest.", - "smithy.api#jsonName": "writeSegmentTimelineInRepresentation" - } - }, - "MinBufferTime": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "AdditionalManifests": { + "target": "com.amazonaws.mediaconvert#__listOfDashAdditionalManifest", "traits": { - "smithy.api#documentation": "Minimum time of initially buffered media that is needed to ensure smooth playout.", - "smithy.api#jsonName": "minBufferTime" + "smithy.api#documentation": "By default, the service creates one .mpd DASH manifest for each DASH ISO output group in your job. This default manifest references every output in the output group. To create additional DASH manifests that reference a subset of the outputs in the output group, specify a list of them here.", + "smithy.api#jsonName": "additionalManifests" } }, - "Encryption": { - "target": "com.amazonaws.mediaconvert#DashIsoEncryptionSettings", + "BaseUrl": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "DRM settings.", - "smithy.api#jsonName": "encryption" + "smithy.api#documentation": "A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.", + "smithy.api#jsonName": "baseUrl" } }, "Destination": { @@ -3704,18 +3734,18 @@ "smithy.api#jsonName": "destination" } }, - "MpdProfile": { - "target": "com.amazonaws.mediaconvert#DashIsoMpdProfile", + "DestinationSettings": { + "target": "com.amazonaws.mediaconvert#DestinationSettings", "traits": { - "smithy.api#documentation": "Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).", - "smithy.api#jsonName": "mpdProfile" + "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", + "smithy.api#jsonName": "destinationSettings" } }, - "BaseUrl": { - "target": "com.amazonaws.mediaconvert#__string", + "Encryption": { + "target": "com.amazonaws.mediaconvert#DashIsoEncryptionSettings", "traits": { - "smithy.api#documentation": "A partial URI prefix that will be put in the manifest (.mpd) file at the top level BaseURL element. Can be used if streams are delivered from a different URL than the manifest file.", - "smithy.api#jsonName": "baseUrl" + "smithy.api#documentation": "DRM settings.", + "smithy.api#jsonName": "encryption" } }, "FragmentLength": { @@ -3725,32 +3755,46 @@ "smithy.api#jsonName": "fragmentLength" } }, - "SegmentLength": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "HbbtvCompliance": { + "target": "com.amazonaws.mediaconvert#DashIsoHbbtvCompliance", "traits": { - "smithy.api#documentation": "Length of mpd segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. When Emit Single File is checked, the segmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.", - "smithy.api#jsonName": "segmentLength" + "smithy.api#documentation": "Supports HbbTV specification as indicated", + "smithy.api#jsonName": "hbbtvCompliance" } }, - "SegmentControl": { - "target": "com.amazonaws.mediaconvert#DashIsoSegmentControl", + "MinBufferTime": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.", - "smithy.api#jsonName": "segmentControl" + "smithy.api#documentation": "Minimum time of initially buffered media that is needed to ensure smooth playout.", + "smithy.api#jsonName": "minBufferTime" } }, - "AdditionalManifests": { - "target": "com.amazonaws.mediaconvert#__listOfDashAdditionalManifest", + "MpdProfile": { + "target": "com.amazonaws.mediaconvert#DashIsoMpdProfile", "traits": { - "smithy.api#documentation": "By default, the service creates one .mpd DASH manifest for each DASH ISO output group in your job. This default manifest references every output in the output group. To create additional DASH manifests that reference a subset of the outputs in the output group, specify a list of them here.", - "smithy.api#jsonName": "additionalManifests" + "smithy.api#documentation": "Specify whether your DASH profile is on-demand or main. When you choose Main profile (MAIN_PROFILE), the service signals urn:mpeg:dash:profile:isoff-main:2011 in your .mpd DASH manifest. When you choose On-demand (ON_DEMAND_PROFILE), the service signals urn:mpeg:dash:profile:isoff-on-demand:2011 in your .mpd. When you choose On-demand, you must also set the output group setting Segment control (SegmentControl) to Single file (SINGLE_FILE).", + "smithy.api#jsonName": "mpdProfile" } }, - "HbbtvCompliance": { - "target": "com.amazonaws.mediaconvert#DashIsoHbbtvCompliance", + "SegmentControl": { + "target": "com.amazonaws.mediaconvert#DashIsoSegmentControl", "traits": { - "smithy.api#documentation": "Supports HbbTV specification as indicated", - "smithy.api#jsonName": "hbbtvCompliance" + "smithy.api#documentation": "When set to SINGLE_FILE, a single output file is generated, which is internally segmented using the Fragment Length and Segment Length. When set to SEGMENTED_FILES, separate segment files will be created.", + "smithy.api#jsonName": "segmentControl" + } + }, + "SegmentLength": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "Length of mpd segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer. When Emit Single File is checked, the segmentation is internal to a single output file and it does not cause the creation of many output files as in other output types.", + "smithy.api#jsonName": "segmentLength" + } + }, + "WriteSegmentTimelineInRepresentation": { + "target": "com.amazonaws.mediaconvert#DashIsoWriteSegmentTimelineInRepresentation", + "traits": { + "smithy.api#documentation": "If you get an HTTP error in the 400 range when you play back your DASH output, enable this setting and run your transcoding job again. When you enable this setting, the service writes precise segment durations in the DASH manifest. The segment duration information appears inside the SegmentTimeline element, inside SegmentTemplate at the Representation level. When you don't enable this setting, the service writes approximate segment durations in your DASH manifest.", + "smithy.api#jsonName": "writeSegmentTimelineInRepresentation" } } }, @@ -3885,13 +3929,6 @@ "com.amazonaws.mediaconvert#Deinterlacer": { "type": "structure", "members": { - "Mode": { - "target": "com.amazonaws.mediaconvert#DeinterlacerMode", - "traits": { - "smithy.api#documentation": "Use Deinterlacer (DeinterlaceMode) to choose how the service will do deinterlacing. Default is Deinterlace. - Deinterlace converts interlaced to progressive. - Inverse telecine converts Hard Telecine 29.97i to progressive 23.976p. - Adaptive auto-detects and converts to progressive.", - "smithy.api#jsonName": "mode" - } - }, "Algorithm": { "target": "com.amazonaws.mediaconvert#DeinterlaceAlgorithm", "traits": { @@ -3905,6 +3942,13 @@ "smithy.api#documentation": "- When set to NORMAL (default), the deinterlacer does not convert frames that are tagged in metadata as progressive. It will only convert those that are tagged as some other type. - When set to FORCE_ALL_FRAMES, the deinterlacer converts every frame to progressive - even those that are already tagged as progressive. Turn Force mode on only if there is a good chance that the metadata has tagged frames as progressive when they are not progressive. Do not turn on otherwise; processing frames that are already progressive into progressive will probably result in lower quality video.", "smithy.api#jsonName": "control" } + }, + "Mode": { + "target": "com.amazonaws.mediaconvert#DeinterlacerMode", + "traits": { + "smithy.api#documentation": "Use Deinterlacer (DeinterlaceMode) to choose how the service will do deinterlacing. Default is Deinterlace. - Deinterlace converts interlaced to progressive. - Inverse telecine converts Hard Telecine 29.97i to progressive 23.976p. - Adaptive auto-detects and converts to progressive.", + "smithy.api#jsonName": "mode" + } } }, "traits": { @@ -4178,19 +4222,19 @@ "smithy.api#jsonName": "maxResults" } }, - "NextToken": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Use this string, provided with the response to a previous request, to request the next batch of endpoints.", - "smithy.api#jsonName": "nextToken" - } - }, "Mode": { "target": "com.amazonaws.mediaconvert#DescribeEndpointsMode", "traits": { "smithy.api#documentation": "Optional field, defaults to DEFAULT. Specify DEFAULT for this operation to return your endpoints if any exist, or to create an endpoint for you and return it if one doesn't already exist. Specify GET_ONLY to return your endpoints if any exist, or an empty list if none exist.", "smithy.api#jsonName": "mode" } + }, + "NextToken": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Use this string, provided with the response to a previous request, to request the next batch of endpoints.", + "smithy.api#jsonName": "nextToken" + } } }, "traits": { @@ -4200,19 +4244,19 @@ "com.amazonaws.mediaconvert#DescribeEndpointsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Use this string to request the next batch of endpoints.", - "smithy.api#jsonName": "nextToken" - } - }, "Endpoints": { "target": "com.amazonaws.mediaconvert#__listOfEndpoint", "traits": { "smithy.api#documentation": "List of endpoints", "smithy.api#jsonName": "endpoints" } + }, + "NextToken": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Use this string to request the next batch of endpoints.", + "smithy.api#jsonName": "nextToken" + } } } }, @@ -4288,13 +4332,6 @@ "com.amazonaws.mediaconvert#DolbyVision": { "type": "structure", "members": { - "Profile": { - "target": "com.amazonaws.mediaconvert#DolbyVisionProfile", - "traits": { - "smithy.api#documentation": "In the current MediaConvert implementation, the Dolby Vision profile is always 5 (PROFILE_5). Therefore, all of your inputs must contain Dolby Vision frame interleaved data.", - "smithy.api#jsonName": "profile" - } - }, "L6Metadata": { "target": "com.amazonaws.mediaconvert#DolbyVisionLevel6Metadata", "traits": { @@ -4308,6 +4345,13 @@ "smithy.api#documentation": "Use Dolby Vision Mode to choose how the service will handle Dolby Vision MaxCLL and MaxFALL properies.", "smithy.api#jsonName": "l6Mode" } + }, + "Profile": { + "target": "com.amazonaws.mediaconvert#DolbyVisionProfile", + "traits": { + "smithy.api#documentation": "In the current MediaConvert implementation, the Dolby Vision profile is always 5 (PROFILE_5). Therefore, all of your inputs must contain Dolby Vision frame interleaved data.", + "smithy.api#jsonName": "profile" + } } }, "traits": { @@ -4387,13 +4431,6 @@ "com.amazonaws.mediaconvert#DvbNitSettings": { "type": "structure", "members": { - "NitInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin25Max10000", - "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", - "smithy.api#jsonName": "nitInterval" - } - }, "NetworkId": { "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", "traits": { @@ -4407,6 +4444,13 @@ "smithy.api#documentation": "The network name text placed in the network_name_descriptor inside the Network Information Table. Maximum length is 256 characters.", "smithy.api#jsonName": "networkName" } + }, + "NitInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin25Max10000", + "traits": { + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", + "smithy.api#jsonName": "nitInterval" + } } }, "traits": { @@ -4416,20 +4460,6 @@ "com.amazonaws.mediaconvert#DvbSdtSettings": { "type": "structure", "members": { - "ServiceName": { - "target": "com.amazonaws.mediaconvert#__stringMin1Max256", - "traits": { - "smithy.api#documentation": "The service name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters.", - "smithy.api#jsonName": "serviceName" - } - }, - "ServiceProviderName": { - "target": "com.amazonaws.mediaconvert#__stringMin1Max256", - "traits": { - "smithy.api#documentation": "The service provider name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters.", - "smithy.api#jsonName": "serviceProviderName" - } - }, "OutputSdt": { "target": "com.amazonaws.mediaconvert#OutputSdt", "traits": { @@ -4443,6 +4473,20 @@ "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", "smithy.api#jsonName": "sdtInterval" } + }, + "ServiceName": { + "target": "com.amazonaws.mediaconvert#__stringMin1Max256", + "traits": { + "smithy.api#documentation": "The service name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters.", + "smithy.api#jsonName": "serviceName" + } + }, + "ServiceProviderName": { + "target": "com.amazonaws.mediaconvert#__stringMin1Max256", + "traits": { + "smithy.api#documentation": "The service provider name placed in the service_descriptor in the Service Description Table. Maximum length is 256 characters.", + "smithy.api#jsonName": "serviceProviderName" + } } }, "traits": { @@ -4452,6 +4496,20 @@ "com.amazonaws.mediaconvert#DvbSubDestinationSettings": { "type": "structure", "members": { + "Alignment": { + "target": "com.amazonaws.mediaconvert#DvbSubtitleAlignment", + "traits": { + "smithy.api#documentation": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "alignment" + } + }, + "BackgroundColor": { + "target": "com.amazonaws.mediaconvert#DvbSubtitleBackgroundColor", + "traits": { + "smithy.api#documentation": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "backgroundColor" + } + }, "BackgroundOpacity": { "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { @@ -4459,18 +4517,32 @@ "smithy.api#jsonName": "backgroundOpacity" } }, - "OutlineSize": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max10", + "FontColor": { + "target": "com.amazonaws.mediaconvert#DvbSubtitleFontColor", "traits": { - "smithy.api#documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "outlineSize" + "smithy.api#documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontColor" } }, - "ShadowOpacity": { + "FontOpacity": { "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowOpacity" + "smithy.api#documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontOpacity" + } + }, + "FontResolution": { + "target": "com.amazonaws.mediaconvert#__integerMin96Max600", + "traits": { + "smithy.api#documentation": "Font resolution in DPI (dots per inch); default is 96 dpi.\nAll burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "fontResolution" + } + }, + "FontScript": { + "target": "com.amazonaws.mediaconvert#FontScript", + "traits": { + "smithy.api#documentation": "Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use \"AUTOMATIC\" or leave unset. This is used to help determine the appropriate font for rendering DVB-Sub captions.", + "smithy.api#jsonName": "fontScript" } }, "FontSize": { @@ -4487,11 +4559,11 @@ "smithy.api#jsonName": "outlineColor" } }, - "SubtitlingType": { - "target": "com.amazonaws.mediaconvert#DvbSubtitlingType", + "OutlineSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max10", "traits": { - "smithy.api#documentation": "Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your subtitles include audio descriptions and dialogue. Choose standard if your subtitles include only dialogue.", - "smithy.api#jsonName": "subtitlingType" + "smithy.api#documentation": "Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "outlineSize" } }, "ShadowColor": { @@ -4501,25 +4573,11 @@ "smithy.api#jsonName": "shadowColor" } }, - "ShadowYOffset": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", - "traits": { - "smithy.api#documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "shadowYOffset" - } - }, - "TeletextSpacing": { - "target": "com.amazonaws.mediaconvert#DvbSubtitleTeletextSpacing", - "traits": { - "smithy.api#documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", - "smithy.api#jsonName": "teletextSpacing" - } - }, - "FontColor": { - "target": "com.amazonaws.mediaconvert#DvbSubtitleFontColor", + "ShadowOpacity": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max255", "traits": { - "smithy.api#documentation": "Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontColor" + "smithy.api#documentation": "Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowOpacity" } }, "ShadowXOffset": { @@ -4529,39 +4587,32 @@ "smithy.api#jsonName": "shadowXOffset" } }, - "XPosition": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", - "traits": { - "smithy.api#documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "xPosition" - } - }, - "Alignment": { - "target": "com.amazonaws.mediaconvert#DvbSubtitleAlignment", + "ShadowYOffset": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { - "smithy.api#documentation": "If no explicit x_position or y_position is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "alignment" + "smithy.api#documentation": "Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "shadowYOffset" } }, - "BackgroundColor": { - "target": "com.amazonaws.mediaconvert#DvbSubtitleBackgroundColor", + "SubtitlingType": { + "target": "com.amazonaws.mediaconvert#DvbSubtitlingType", "traits": { - "smithy.api#documentation": "Specifies the color of the rectangle behind the captions.\nAll burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "backgroundColor" + "smithy.api#documentation": "Specify whether your DVB subtitles are standard or for hearing impaired. Choose hearing impaired if your subtitles include audio descriptions and dialogue. Choose standard if your subtitles include only dialogue.", + "smithy.api#jsonName": "subtitlingType" } }, - "FontScript": { - "target": "com.amazonaws.mediaconvert#FontScript", + "TeletextSpacing": { + "target": "com.amazonaws.mediaconvert#DvbSubtitleTeletextSpacing", "traits": { - "smithy.api#documentation": "Provide the font script, using an ISO 15924 script code, if the LanguageCode is not sufficient for determining the script type. Where LanguageCode or CustomLanguageCode is sufficient, use \"AUTOMATIC\" or leave unset. This is used to help determine the appropriate font for rendering DVB-Sub captions.", - "smithy.api#jsonName": "fontScript" + "smithy.api#documentation": "Only applies to jobs with input captions in Teletext or STL formats. Specify whether the spacing between letters in your captions is set by the captions grid or varies depending on letter width. Choose fixed grid to conform to the spacing specified in the captions file more accurately. Choose proportional to make the text easier to read if the captions are closed caption.", + "smithy.api#jsonName": "teletextSpacing" } }, - "FontResolution": { - "target": "com.amazonaws.mediaconvert#__integerMin96Max600", + "XPosition": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Font resolution in DPI (dots per inch); default is 96 dpi.\nAll burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontResolution" + "smithy.api#documentation": "Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit x_position is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", + "smithy.api#jsonName": "xPosition" } }, "YPosition": { @@ -4570,13 +4621,6 @@ "smithy.api#documentation": "Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit y_position is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.", "smithy.api#jsonName": "yPosition" } - }, - "FontOpacity": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max255", - "traits": { - "smithy.api#documentation": "Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent.\nAll burn-in and DVB-Sub font settings must match.", - "smithy.api#jsonName": "fontOpacity" - } } }, "traits": { @@ -4900,18 +4944,32 @@ "com.amazonaws.mediaconvert#Eac3AtmosSettings": { "type": "structure", "members": { - "LtRtSurroundMixLevel": { - "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin384000Max768000", "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel.", - "smithy.api#jsonName": "ltRtSurroundMixLevel" + "smithy.api#documentation": "Specify the average bitrate in bits per second.\nValid values: 384k, 448k, 640k, 768k", + "smithy.api#jsonName": "bitrate" } }, - "LoRoSurroundMixLevel": { - "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", + "BitstreamMode": { + "target": "com.amazonaws.mediaconvert#Eac3AtmosBitstreamMode", "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left only/Right only (Lo/Ro surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel.", - "smithy.api#jsonName": "loRoSurroundMixLevel" + "smithy.api#documentation": "Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).", + "smithy.api#jsonName": "bitstreamMode" + } + }, + "CodingMode": { + "target": "com.amazonaws.mediaconvert#Eac3AtmosCodingMode", + "traits": { + "smithy.api#documentation": "The coding mode for Dolby Digital Plus JOC (Atmos) is always 9.1.6 (CODING_MODE_9_1_6).", + "smithy.api#jsonName": "codingMode" + } + }, + "DialogueIntelligence": { + "target": "com.amazonaws.mediaconvert#Eac3AtmosDialogueIntelligence", + "traits": { + "smithy.api#documentation": "Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue analysis.", + "smithy.api#jsonName": "dialogueIntelligence" } }, "DynamicRangeCompressionLine": { @@ -4921,6 +4979,27 @@ "smithy.api#jsonName": "dynamicRangeCompressionLine" } }, + "DynamicRangeCompressionRf": { + "target": "com.amazonaws.mediaconvert#Eac3AtmosDynamicRangeCompressionRf", + "traits": { + "smithy.api#documentation": "Specify how the service limits the audio dynamic range when compressing the audio.", + "smithy.api#jsonName": "dynamicRangeCompressionRf" + } + }, + "LoRoCenterMixLevel": { + "target": "com.amazonaws.mediaconvert#__doubleMinNegative6Max3", + "traits": { + "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left only/Right only center mix\n(Lo/Ro center). MediaConvert uses this value for downmixing. How the service uses this\nvalue depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix).\nValid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0.", + "smithy.api#jsonName": "loRoCenterMixLevel" + } + }, + "LoRoSurroundMixLevel": { + "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", + "traits": { + "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left only/Right only (Lo/Ro surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel.", + "smithy.api#jsonName": "loRoSurroundMixLevel" + } + }, "LtRtCenterMixLevel": { "target": "com.amazonaws.mediaconvert#__doubleMinNegative6Max3", "traits": { @@ -4928,6 +5007,13 @@ "smithy.api#jsonName": "ltRtCenterMixLevel" } }, + "LtRtSurroundMixLevel": { + "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", + "traits": { + "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel.", + "smithy.api#jsonName": "ltRtSurroundMixLevel" + } + }, "MeteringMode": { "target": "com.amazonaws.mediaconvert#Eac3AtmosMeteringMode", "traits": { @@ -4935,20 +5021,6 @@ "smithy.api#jsonName": "meteringMode" } }, - "BitstreamMode": { - "target": "com.amazonaws.mediaconvert#Eac3AtmosBitstreamMode", - "traits": { - "smithy.api#documentation": "Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).", - "smithy.api#jsonName": "bitstreamMode" - } - }, - "DynamicRangeCompressionRf": { - "target": "com.amazonaws.mediaconvert#Eac3AtmosDynamicRangeCompressionRf", - "traits": { - "smithy.api#documentation": "Specify how the service limits the audio dynamic range when compressing the audio.", - "smithy.api#jsonName": "dynamicRangeCompressionRf" - } - }, "SampleRate": { "target": "com.amazonaws.mediaconvert#__integerMin48000Max48000", "traits": { @@ -4956,11 +5028,11 @@ "smithy.api#jsonName": "sampleRate" } }, - "CodingMode": { - "target": "com.amazonaws.mediaconvert#Eac3AtmosCodingMode", + "SpeechThreshold": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max100", "traits": { - "smithy.api#documentation": "The coding mode for Dolby Digital Plus JOC (Atmos) is always 9.1.6 (CODING_MODE_9_1_6).", - "smithy.api#jsonName": "codingMode" + "smithy.api#documentation": "Specify the percentage of audio content that must be speech before the encoder uses the measured speech loudness as the overall program loudness.", + "smithy.api#jsonName": "speechThreshold" } }, "StereoDownmix": { @@ -4976,34 +5048,6 @@ "smithy.api#documentation": "Specify whether your input audio has an additional center rear surround channel matrix encoded into your left and right surround channels.", "smithy.api#jsonName": "surroundExMode" } - }, - "SpeechThreshold": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max100", - "traits": { - "smithy.api#documentation": "Specify the percentage of audio content that must be speech before the encoder uses the measured speech loudness as the overall program loudness.", - "smithy.api#jsonName": "speechThreshold" - } - }, - "LoRoCenterMixLevel": { - "target": "com.amazonaws.mediaconvert#__doubleMinNegative6Max3", - "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Atmos setting: Left only/Right only center mix\n(Lo/Ro center). MediaConvert uses this value for downmixing. How the service uses this\nvalue depends on the value that you choose for Stereo downmix (Eac3AtmosStereoDownmix).\nValid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0.", - "smithy.api#jsonName": "loRoCenterMixLevel" - } - }, - "DialogueIntelligence": { - "target": "com.amazonaws.mediaconvert#Eac3AtmosDialogueIntelligence", - "traits": { - "smithy.api#documentation": "Enable Dolby Dialogue Intelligence to adjust loudness based on dialogue analysis.", - "smithy.api#jsonName": "dialogueIntelligence" - } - }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin384000Max768000", - "traits": { - "smithy.api#documentation": "Specify the average bitrate in bits per second.\nValid values: 384k, 448k, 640k, 768k", - "smithy.api#jsonName": "bitrate" - } } }, "traits": { @@ -5281,39 +5325,46 @@ "com.amazonaws.mediaconvert#Eac3Settings": { "type": "structure", "members": { - "SurroundExMode": { - "target": "com.amazonaws.mediaconvert#Eac3SurroundExMode", + "AttenuationControl": { + "target": "com.amazonaws.mediaconvert#Eac3AttenuationControl", "traits": { - "smithy.api#documentation": "When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.", - "smithy.api#jsonName": "surroundExMode" + "smithy.api#documentation": "If set to ATTENUATE_3_DB, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.", + "smithy.api#jsonName": "attenuationControl" } }, - "LtRtCenterMixLevel": { - "target": "com.amazonaws.mediaconvert#__doubleMinNegative60Max3", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin64000Max640000", "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Digital Plus setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left total/Right total center (ltRtCenterMixLevel).", - "smithy.api#jsonName": "ltRtCenterMixLevel" + "smithy.api#documentation": "Specify the average bitrate in bits per second. Valid bitrates depend on the coding mode.", + "smithy.api#jsonName": "bitrate" } }, - "Dialnorm": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max31", + "BitstreamMode": { + "target": "com.amazonaws.mediaconvert#Eac3BitstreamMode", "traits": { - "smithy.api#documentation": "Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.", - "smithy.api#jsonName": "dialnorm" + "smithy.api#documentation": "Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).", + "smithy.api#jsonName": "bitstreamMode" } }, - "LoRoSurroundMixLevel": { - "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", + "CodingMode": { + "target": "com.amazonaws.mediaconvert#Eac3CodingMode", "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Digital Plus setting: Left only/Right only (Lo/Ro surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left only/Right only surround (loRoSurroundMixLevel).", - "smithy.api#jsonName": "loRoSurroundMixLevel" + "smithy.api#documentation": "Dolby Digital Plus coding mode. Determines number of channels.", + "smithy.api#jsonName": "codingMode" } }, - "LtRtSurroundMixLevel": { - "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", + "DcFilter": { + "target": "com.amazonaws.mediaconvert#Eac3DcFilter", "traits": { - "smithy.api#documentation": "Specify a value for the following Dolby Digital Plus setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left total/Right total surround (ltRtSurroundMixLevel).", - "smithy.api#jsonName": "ltRtSurroundMixLevel" + "smithy.api#documentation": "Activates a DC highpass filter for all input channels.", + "smithy.api#jsonName": "dcFilter" + } + }, + "Dialnorm": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max31", + "traits": { + "smithy.api#documentation": "Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.", + "smithy.api#jsonName": "dialnorm" } }, "DynamicRangeCompressionLine": { @@ -5323,18 +5374,25 @@ "smithy.api#jsonName": "dynamicRangeCompressionLine" } }, - "MetadataControl": { - "target": "com.amazonaws.mediaconvert#Eac3MetadataControl", + "DynamicRangeCompressionRf": { + "target": "com.amazonaws.mediaconvert#Eac3DynamicRangeCompressionRf", "traits": { - "smithy.api#documentation": "When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.", - "smithy.api#jsonName": "metadataControl" + "smithy.api#documentation": "Specify how the service limits the audio dynamic range when compressing the audio.", + "smithy.api#jsonName": "dynamicRangeCompressionRf" } }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin64000Max640000", + "LfeControl": { + "target": "com.amazonaws.mediaconvert#Eac3LfeControl", "traits": { - "smithy.api#documentation": "Specify the average bitrate in bits per second. Valid bitrates depend on the coding mode.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "When encoding 3/2 audio, controls whether the LFE channel is enabled", + "smithy.api#jsonName": "lfeControl" + } + }, + "LfeFilter": { + "target": "com.amazonaws.mediaconvert#Eac3LfeFilter", + "traits": { + "smithy.api#documentation": "Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.", + "smithy.api#jsonName": "lfeFilter" } }, "LoRoCenterMixLevel": { @@ -5344,25 +5402,32 @@ "smithy.api#jsonName": "loRoCenterMixLevel" } }, - "LfeFilter": { - "target": "com.amazonaws.mediaconvert#Eac3LfeFilter", + "LoRoSurroundMixLevel": { + "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", "traits": { - "smithy.api#documentation": "Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.", - "smithy.api#jsonName": "lfeFilter" + "smithy.api#documentation": "Specify a value for the following Dolby Digital Plus setting: Left only/Right only (Lo/Ro surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left only/Right only surround (loRoSurroundMixLevel).", + "smithy.api#jsonName": "loRoSurroundMixLevel" } }, - "LfeControl": { - "target": "com.amazonaws.mediaconvert#Eac3LfeControl", + "LtRtCenterMixLevel": { + "target": "com.amazonaws.mediaconvert#__doubleMinNegative60Max3", "traits": { - "smithy.api#documentation": "When encoding 3/2 audio, controls whether the LFE channel is enabled", - "smithy.api#jsonName": "lfeControl" + "smithy.api#documentation": "Specify a value for the following Dolby Digital Plus setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left total/Right total center (ltRtCenterMixLevel).", + "smithy.api#jsonName": "ltRtCenterMixLevel" } }, - "DynamicRangeCompressionRf": { - "target": "com.amazonaws.mediaconvert#Eac3DynamicRangeCompressionRf", + "LtRtSurroundMixLevel": { + "target": "com.amazonaws.mediaconvert#__doubleMinNegative60MaxNegative1", "traits": { - "smithy.api#documentation": "Specify how the service limits the audio dynamic range when compressing the audio.", - "smithy.api#jsonName": "dynamicRangeCompressionRf" + "smithy.api#documentation": "Specify a value for the following Dolby Digital Plus setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. How the service uses this value depends on the value that you choose for Stereo downmix (Eac3StereoDownmix). Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. This setting applies only if you keep the default value of 3/2 - L, R, C, Ls, Rs (CODING_MODE_3_2) for the setting Coding mode (Eac3CodingMode). If you choose a different value for Coding mode, the service ignores Left total/Right total surround (ltRtSurroundMixLevel).", + "smithy.api#jsonName": "ltRtSurroundMixLevel" + } + }, + "MetadataControl": { + "target": "com.amazonaws.mediaconvert#Eac3MetadataControl", + "traits": { + "smithy.api#documentation": "When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.", + "smithy.api#jsonName": "metadataControl" } }, "PassthroughControl": { @@ -5379,20 +5444,6 @@ "smithy.api#jsonName": "phaseControl" } }, - "CodingMode": { - "target": "com.amazonaws.mediaconvert#Eac3CodingMode", - "traits": { - "smithy.api#documentation": "Dolby Digital Plus coding mode. Determines number of channels.", - "smithy.api#jsonName": "codingMode" - } - }, - "SurroundMode": { - "target": "com.amazonaws.mediaconvert#Eac3SurroundMode", - "traits": { - "smithy.api#documentation": "When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.", - "smithy.api#jsonName": "surroundMode" - } - }, "SampleRate": { "target": "com.amazonaws.mediaconvert#__integerMin48000Max48000", "traits": { @@ -5407,25 +5458,18 @@ "smithy.api#jsonName": "stereoDownmix" } }, - "BitstreamMode": { - "target": "com.amazonaws.mediaconvert#Eac3BitstreamMode", - "traits": { - "smithy.api#documentation": "Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 bitstream mode, see ATSC A/52-2012 (Annex E).", - "smithy.api#jsonName": "bitstreamMode" - } - }, - "AttenuationControl": { - "target": "com.amazonaws.mediaconvert#Eac3AttenuationControl", + "SurroundExMode": { + "target": "com.amazonaws.mediaconvert#Eac3SurroundExMode", "traits": { - "smithy.api#documentation": "If set to ATTENUATE_3_DB, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.", - "smithy.api#jsonName": "attenuationControl" + "smithy.api#documentation": "When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.", + "smithy.api#jsonName": "surroundExMode" } }, - "DcFilter": { - "target": "com.amazonaws.mediaconvert#Eac3DcFilter", + "SurroundMode": { + "target": "com.amazonaws.mediaconvert#Eac3SurroundMode", "traits": { - "smithy.api#documentation": "Activates a DC highpass filter for all input channels.", - "smithy.api#jsonName": "dcFilter" + "smithy.api#documentation": "When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.", + "smithy.api#jsonName": "surroundMode" } } }, @@ -5516,19 +5560,19 @@ "com.amazonaws.mediaconvert#EmbeddedDestinationSettings": { "type": "structure", "members": { - "Destination708ServiceNumber": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max6", - "traits": { - "smithy.api#documentation": "Ignore this setting unless your input captions are SCC format and you want both 608 and 708 captions embedded in your output stream. Optionally, specify the 708 service number for each output captions channel. Choose a different number for each channel. To use this setting, also set Force 608 to 708 upconvert (Convert608To708) to Upconvert (UPCONVERT) in your input captions selector settings. If you choose to upconvert but don't specify a 708 service number, MediaConvert uses the number that you specify for CC channel number (destination608ChannelNumber) for the 708 service number. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded.", - "smithy.api#jsonName": "destination708ServiceNumber" - } - }, "Destination608ChannelNumber": { "target": "com.amazonaws.mediaconvert#__integerMin1Max4", "traits": { "smithy.api#documentation": "Ignore this setting unless your input captions are SCC format and your output captions are embedded in the video stream. Specify a CC number for each captions channel in this output. If you have two channels, choose CC numbers that aren't in the same field. For example, choose 1 and 3. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded.", "smithy.api#jsonName": "destination608ChannelNumber" } + }, + "Destination708ServiceNumber": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max6", + "traits": { + "smithy.api#documentation": "Ignore this setting unless your input captions are SCC format and you want both 608 and 708 captions embedded in your output stream. Optionally, specify the 708 service number for each output captions channel. Choose a different number for each channel. To use this setting, also set Force 608 to 708 upconvert (Convert608To708) to Upconvert (UPCONVERT) in your input captions selector settings. If you choose to upconvert but don't specify a 708 service number, MediaConvert uses the number that you specify for CC channel number (destination608ChannelNumber) for the 708 service number. For more information, see https://docs.aws.amazon.com/console/mediaconvert/dual-scc-to-embedded.", + "smithy.api#jsonName": "destination708ServiceNumber" + } } }, "traits": { @@ -5538,11 +5582,11 @@ "com.amazonaws.mediaconvert#EmbeddedSourceSettings": { "type": "structure", "members": { - "Source608TrackNumber": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max1", + "Convert608To708": { + "target": "com.amazonaws.mediaconvert#EmbeddedConvert608To708", "traits": { - "smithy.api#documentation": "Specifies the video track index used for extracting captions. The system only supports one input video track, so this should always be set to '1'.", - "smithy.api#jsonName": "source608TrackNumber" + "smithy.api#documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.", + "smithy.api#jsonName": "convert608To708" } }, "Source608ChannelNumber": { @@ -5552,19 +5596,19 @@ "smithy.api#jsonName": "source608ChannelNumber" } }, + "Source608TrackNumber": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max1", + "traits": { + "smithy.api#documentation": "Specifies the video track index used for extracting captions. The system only supports one input video track, so this should always be set to '1'.", + "smithy.api#jsonName": "source608TrackNumber" + } + }, "TerminateCaptions": { "target": "com.amazonaws.mediaconvert#EmbeddedTerminateCaptions", "traits": { "smithy.api#documentation": "By default, the service terminates any unterminated captions at the end of each input. If you want the caption to continue onto your next input, disable this setting.", "smithy.api#jsonName": "terminateCaptions" } - }, - "Convert608To708": { - "target": "com.amazonaws.mediaconvert#EmbeddedConvert608To708", - "traits": { - "smithy.api#documentation": "Specify whether this set of input captions appears in your outputs in both 608 and 708 format. If you choose Upconvert (UPCONVERT), MediaConvert includes the captions data in two ways: it passes the 608 data through using the 608 compatibility bytes fields of the 708 wrapper, and it also translates the 608 data into 708.", - "smithy.api#jsonName": "convert608To708" - } } }, "traits": { @@ -5620,11 +5664,11 @@ "com.amazonaws.mediaconvert#EsamSettings": { "type": "structure", "members": { - "SignalProcessingNotification": { - "target": "com.amazonaws.mediaconvert#EsamSignalProcessingNotification", + "ManifestConfirmConditionNotification": { + "target": "com.amazonaws.mediaconvert#EsamManifestConfirmConditionNotification", "traits": { - "smithy.api#documentation": "Specifies an ESAM SignalProcessingNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses the signal processing instructions that you provide in the setting SCC XML (sccXml).", - "smithy.api#jsonName": "signalProcessingNotification" + "smithy.api#documentation": "Specifies an ESAM ManifestConfirmConditionNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses the manifest conditioning instructions that you provide in the setting MCC XML (mccXml).", + "smithy.api#jsonName": "manifestConfirmConditionNotification" } }, "ResponseSignalPreroll": { @@ -5634,11 +5678,11 @@ "smithy.api#jsonName": "responseSignalPreroll" } }, - "ManifestConfirmConditionNotification": { - "target": "com.amazonaws.mediaconvert#EsamManifestConfirmConditionNotification", + "SignalProcessingNotification": { + "target": "com.amazonaws.mediaconvert#EsamSignalProcessingNotification", "traits": { - "smithy.api#documentation": "Specifies an ESAM ManifestConfirmConditionNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses the manifest conditioning instructions that you provide in the setting MCC XML (mccXml).", - "smithy.api#jsonName": "manifestConfirmConditionNotification" + "smithy.api#documentation": "Specifies an ESAM SignalProcessingNotification XML as per OC-SP-ESAM-API-I03-131025. The transcoder uses the signal processing instructions that you provide in the setting SCC XML (sccXml).", + "smithy.api#jsonName": "signalProcessingNotification" } } }, @@ -5733,20 +5777,6 @@ "com.amazonaws.mediaconvert#FileSourceSettings": { "type": "structure", "members": { - "Framerate": { - "target": "com.amazonaws.mediaconvert#CaptionSourceFramerate", - "traits": { - "smithy.api#documentation": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction, using the settings Framerate numerator (framerateNumerator) and Framerate denominator (framerateDenominator). For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps.", - "smithy.api#jsonName": "framerate" - } - }, - "TimeDelta": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", - "traits": { - "smithy.api#documentation": "Specifies a time delta in seconds to offset the captions from the source file.", - "smithy.api#jsonName": "timeDelta" - } - }, "Convert608To708": { "target": "com.amazonaws.mediaconvert#FileSourceConvert608To708", "traits": { @@ -5754,12 +5784,26 @@ "smithy.api#jsonName": "convert608To708" } }, + "Framerate": { + "target": "com.amazonaws.mediaconvert#CaptionSourceFramerate", + "traits": { + "smithy.api#documentation": "Ignore this setting unless your input captions format is SCC. To have the service compensate for differing frame rates between your input captions and input video, specify the frame rate of the captions file. Specify this value as a fraction, using the settings Framerate numerator (framerateNumerator) and Framerate denominator (framerateDenominator). For example, you might specify 24 / 1 for 24 fps, 25 / 1 for 25 fps, 24000 / 1001 for 23.976 fps, or 30000 / 1001 for 29.97 fps.", + "smithy.api#jsonName": "framerate" + } + }, "SourceFile": { "target": "com.amazonaws.mediaconvert#__stringMin14PatternS3SccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMIHttpsSccSCCTtmlTTMLDfxpDFXPStlSTLSrtSRTXmlXMLSmiSMI", "traits": { "smithy.api#documentation": "External caption file used for loading captions. Accepted file extensions are 'scc', 'ttml', 'dfxp', 'stl', 'srt', 'xml', and 'smi'.", "smithy.api#jsonName": "sourceFile" } + }, + "TimeDelta": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", + "traits": { + "smithy.api#documentation": "Specifies a time delta in seconds to offset the captions from the source file.", + "smithy.api#jsonName": "timeDelta" + } } }, "traits": { @@ -5812,6 +5856,13 @@ "smithy.api#jsonName": "framerateDenominator" } }, + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.", + "smithy.api#jsonName": "framerateNumerator" + } + }, "MaxCaptures": { "target": "com.amazonaws.mediaconvert#__integerMin1Max10000000", "traits": { @@ -5825,13 +5876,6 @@ "smithy.api#documentation": "JPEG Quality - a higher value equals higher quality.", "smithy.api#jsonName": "quality" } - }, - "FramerateNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places.", - "smithy.api#jsonName": "framerateNumerator" - } } }, "traits": { @@ -6089,12 +6133,16 @@ "com.amazonaws.mediaconvert#H264AdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to the following settings: Flicker adaptive quantization (flickerAdaptiveQuantization), Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization).", + "smithy.api#documentation": "Keep the default value, Auto (AUTO), for this setting to have MediaConvert automatically apply the best types of quantization for your video content. When you want to apply your quantization settings manually, you must set H264AdaptiveQuantization to a value other than Auto (AUTO). Use this setting to specify the strength of any adaptive quantization filters that you enable. If you don't want MediaConvert to do any adaptive quantization in this transcode, set Adaptive quantization (H264AdaptiveQuantization) to Off (OFF). Related settings: The value that you choose here applies to the following settings: H264FlickerAdaptiveQuantization, H264SpatialAdaptiveQuantization, and H264TemporalAdaptiveQuantization.", "smithy.api#enum": [ { "value": "OFF", "name": "OFF" }, + { + "value": "AUTO", + "name": "AUTO" + }, { "value": "LOW", "name": "LOW" @@ -6277,7 +6325,7 @@ "com.amazonaws.mediaconvert#H264FlickerAdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must also set adaptiveQuantization to a value other than Off (OFF).", + "smithy.api#documentation": "Only use this setting when you change the default value, AUTO, for the setting H264AdaptiveQuantization. When you keep all defaults, excluding H264AdaptiveQuantization and all other adaptive quantization from your JSON job specification, MediaConvert automatically applies the best types of quantization for your video content. When you set H264AdaptiveQuantization to a value other than AUTO, the default value for H264FlickerAdaptiveQuantization is Disabled (DISABLED). Change this value to Enabled (ENABLED) to reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. To manually enable or disable H264FlickerAdaptiveQuantization, you must set Adaptive quantization (H264AdaptiveQuantization) to a value other than AUTO.", "smithy.api#enum": [ { "value": "DISABLED", @@ -6432,19 +6480,19 @@ "smithy.api#jsonName": "maxAverageBitrate" } }, - "QvbrQualityLevelFineTune": { - "target": "com.amazonaws.mediaconvert#__doubleMin0Max1", - "traits": { - "smithy.api#documentation": "Optional. Specify a value here to set the QVBR quality to a level that is between whole numbers. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. MediaConvert rounds your QVBR quality level to the nearest third of a whole number. For example, if you set qvbrQualityLevel to 7 and you set qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33.", - "smithy.api#jsonName": "qvbrQualityLevelFineTune" - } - }, "QvbrQualityLevel": { "target": "com.amazonaws.mediaconvert#__integerMin1Max10", "traits": { "smithy.api#documentation": "Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h264Settings. Specify the general target quality level for this output, from 1 to 10. Use higher numbers for greater quality. Level 10 results in nearly lossless compression. The quality level for most broadcast-quality transcodes is between 6 and 9. Optionally, to specify a value between whole numbers, also provide a value for the setting qvbrQualityLevelFineTune. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33.", "smithy.api#jsonName": "qvbrQualityLevel" } + }, + "QvbrQualityLevelFineTune": { + "target": "com.amazonaws.mediaconvert#__doubleMin0Max1", + "traits": { + "smithy.api#documentation": "Optional. Specify a value here to set the QVBR quality to a level that is between whole numbers. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. MediaConvert rounds your QVBR quality level to the nearest third of a whole number. For example, if you set qvbrQualityLevel to 7 and you set qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33.", + "smithy.api#jsonName": "qvbrQualityLevelFineTune" + } } }, "traits": { @@ -6510,32 +6558,39 @@ "com.amazonaws.mediaconvert#H264Settings": { "type": "structure", "members": { - "NumberReferenceFrames": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max6", + "AdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#H264AdaptiveQuantization", "traits": { - "smithy.api#documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.", - "smithy.api#jsonName": "numberReferenceFrames" + "smithy.api#documentation": "Keep the default value, Auto (AUTO), for this setting to have MediaConvert automatically apply the best types of quantization for your video content. When you want to apply your quantization settings manually, you must set H264AdaptiveQuantization to a value other than Auto (AUTO). Use this setting to specify the strength of any adaptive quantization filters that you enable. If you don't want MediaConvert to do any adaptive quantization in this transcode, set Adaptive quantization (H264AdaptiveQuantization) to Off (OFF). Related settings: The value that you choose here applies to the following settings: H264FlickerAdaptiveQuantization, H264SpatialAdaptiveQuantization, and H264TemporalAdaptiveQuantization.", + "smithy.api#jsonName": "adaptiveQuantization" } }, - "UnregisteredSeiTimecode": { - "target": "com.amazonaws.mediaconvert#H264UnregisteredSeiTimecode", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", "traits": { - "smithy.api#documentation": "Inserts timecode for each frame as 4 bytes of an unregistered SEI message.", - "smithy.api#jsonName": "unregisteredSeiTimecode" + "smithy.api#documentation": "Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000.", + "smithy.api#jsonName": "bitrate" } }, - "TemporalAdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#H264TemporalAdaptiveQuantization", + "CodecLevel": { + "target": "com.amazonaws.mediaconvert#H264CodecLevel", "traits": { - "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization).", - "smithy.api#jsonName": "temporalAdaptiveQuantization" + "smithy.api#documentation": "Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to specify, choose Auto (AUTO).", + "smithy.api#jsonName": "codecLevel" } }, - "FramerateConversionAlgorithm": { - "target": "com.amazonaws.mediaconvert#H264FramerateConversionAlgorithm", + "CodecProfile": { + "target": "com.amazonaws.mediaconvert#H264CodecProfile", "traits": { - "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", - "smithy.api#jsonName": "framerateConversionAlgorithm" + "smithy.api#documentation": "H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License.", + "smithy.api#jsonName": "codecProfile" + } + }, + "DynamicSubGop": { + "target": "com.amazonaws.mediaconvert#H264DynamicSubGop", + "traits": { + "smithy.api#documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).", + "smithy.api#jsonName": "dynamicSubGop" } }, "EntropyEncoding": { @@ -6545,27 +6600,6 @@ "smithy.api#jsonName": "entropyEncoding" } }, - "SceneChangeDetect": { - "target": "com.amazonaws.mediaconvert#H264SceneChangeDetect", - "traits": { - "smithy.api#documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.", - "smithy.api#jsonName": "sceneChangeDetect" - } - }, - "RepeatPps": { - "target": "com.amazonaws.mediaconvert#H264RepeatPps", - "traits": { - "smithy.api#documentation": "Places a PPS header on each encoded picture, even if repeated.", - "smithy.api#jsonName": "repeatPps" - } - }, - "MaxBitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", - "traits": { - "smithy.api#documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR.", - "smithy.api#jsonName": "maxBitrate" - } - }, "FieldEncoding": { "target": "com.amazonaws.mediaconvert#H264FieldEncoding", "traits": { @@ -6573,46 +6607,39 @@ "smithy.api#jsonName": "fieldEncoding" } }, - "ParDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", - "smithy.api#jsonName": "parDenominator" - } - }, - "MinIInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max30", + "FlickerAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#H264FlickerAdaptiveQuantization", "traits": { - "smithy.api#documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", - "smithy.api#jsonName": "minIInterval" + "smithy.api#documentation": "Only use this setting when you change the default value, AUTO, for the setting H264AdaptiveQuantization. When you keep all defaults, excluding H264AdaptiveQuantization and all other adaptive quantization from your JSON job specification, MediaConvert automatically applies the best types of quantization for your video content. When you set H264AdaptiveQuantization to a value other than AUTO, the default value for H264FlickerAdaptiveQuantization is Disabled (DISABLED). Change this value to Enabled (ENABLED) to reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. To manually enable or disable H264FlickerAdaptiveQuantization, you must set Adaptive quantization (H264AdaptiveQuantization) to a value other than AUTO.", + "smithy.api#jsonName": "flickerAdaptiveQuantization" } }, - "HrdBufferInitialFillPercentage": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max100", + "FramerateControl": { + "target": "com.amazonaws.mediaconvert#H264FramerateControl", "traits": { - "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", - "smithy.api#jsonName": "hrdBufferInitialFillPercentage" + "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#jsonName": "framerateControl" } }, - "CodecProfile": { - "target": "com.amazonaws.mediaconvert#H264CodecProfile", + "FramerateConversionAlgorithm": { + "target": "com.amazonaws.mediaconvert#H264FramerateConversionAlgorithm", "traits": { - "smithy.api#documentation": "H.264 Profile. High 4:2:2 and 10-bit profiles are only available with the AVC-I License.", - "smithy.api#jsonName": "codecProfile" + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#jsonName": "framerateConversionAlgorithm" } }, - "ParNumerator": { + "FramerateDenominator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", - "smithy.api#jsonName": "parNumerator" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateDenominator" } }, - "AdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#H264AdaptiveQuantization", + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to the following settings: Flicker adaptive quantization (flickerAdaptiveQuantization), Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization).", - "smithy.api#jsonName": "adaptiveQuantization" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" } }, "GopBReference": { @@ -6629,39 +6656,32 @@ "smithy.api#jsonName": "gopClosedCadence" } }, - "FramerateDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateDenominator" - } - }, - "Telecine": { - "target": "com.amazonaws.mediaconvert#H264Telecine", + "GopSize": { + "target": "com.amazonaws.mediaconvert#__doubleMin0", "traits": { - "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard or soft telecine to create a smoother picture. Hard telecine (HARD) produces a 29.97i output. Soft telecine (SOFT) produces an output with a 23.976 output that signals to the video player device to do the conversion during play back. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", - "smithy.api#jsonName": "telecine" + "smithy.api#documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.", + "smithy.api#jsonName": "gopSize" } }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", + "GopSizeUnits": { + "target": "com.amazonaws.mediaconvert#H264GopSizeUnits", "traits": { - "smithy.api#documentation": "Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "Indicates if the GOP Size in H264 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", + "smithy.api#jsonName": "gopSizeUnits" } }, - "CodecLevel": { - "target": "com.amazonaws.mediaconvert#H264CodecLevel", + "HrdBufferInitialFillPercentage": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max100", "traits": { - "smithy.api#documentation": "Specify an H.264 level that is consistent with your output video settings. If you aren't sure what level to specify, choose Auto (AUTO).", - "smithy.api#jsonName": "codecLevel" + "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", + "smithy.api#jsonName": "hrdBufferInitialFillPercentage" } }, - "QvbrSettings": { - "target": "com.amazonaws.mediaconvert#H264QvbrSettings", + "HrdBufferSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max1152000000", "traits": { - "smithy.api#documentation": "Settings for quality-defined variable bitrate encoding with the H.264 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.", - "smithy.api#jsonName": "qvbrSettings" + "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", + "smithy.api#jsonName": "hrdBufferSize" } }, "InterlaceMode": { @@ -6671,39 +6691,32 @@ "smithy.api#jsonName": "interlaceMode" } }, - "HrdBufferSize": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max1152000000", + "MaxBitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", "traits": { - "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", - "smithy.api#jsonName": "hrdBufferSize" + "smithy.api#documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR.", + "smithy.api#jsonName": "maxBitrate" } }, - "SpatialAdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#H264SpatialAdaptiveQuantization", + "MinIInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max30", "traits": { - "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", - "smithy.api#jsonName": "spatialAdaptiveQuantization" + "smithy.api#documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", + "smithy.api#jsonName": "minIInterval" } }, - "FramerateNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "NumberBFramesBetweenReferenceFrames": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max7", "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateNumerator" - } - }, - "RateControlMode": { - "target": "com.amazonaws.mediaconvert#H264RateControlMode", - "traits": { - "smithy.api#documentation": "Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).", - "smithy.api#jsonName": "rateControlMode" + "smithy.api#documentation": "Number of B-frames between reference frames.", + "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" } }, - "GopSizeUnits": { - "target": "com.amazonaws.mediaconvert#H264GopSizeUnits", + "NumberReferenceFrames": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max6", "traits": { - "smithy.api#documentation": "Indicates if the GOP Size in H264 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", - "smithy.api#jsonName": "gopSizeUnits" + "smithy.api#documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.", + "smithy.api#jsonName": "numberReferenceFrames" } }, "ParControl": { @@ -6713,11 +6726,53 @@ "smithy.api#jsonName": "parControl" } }, - "FramerateControl": { - "target": "com.amazonaws.mediaconvert#H264FramerateControl", + "ParDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", - "smithy.api#jsonName": "framerateControl" + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", + "smithy.api#jsonName": "parDenominator" + } + }, + "ParNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", + "smithy.api#jsonName": "parNumerator" + } + }, + "QualityTuningLevel": { + "target": "com.amazonaws.mediaconvert#H264QualityTuningLevel", + "traits": { + "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", + "smithy.api#jsonName": "qualityTuningLevel" + } + }, + "QvbrSettings": { + "target": "com.amazonaws.mediaconvert#H264QvbrSettings", + "traits": { + "smithy.api#documentation": "Settings for quality-defined variable bitrate encoding with the H.264 codec. Required when you set Rate control mode to QVBR. Not valid when you set Rate control mode to a value other than QVBR, or when you don't define Rate control mode.", + "smithy.api#jsonName": "qvbrSettings" + } + }, + "RateControlMode": { + "target": "com.amazonaws.mediaconvert#H264RateControlMode", + "traits": { + "smithy.api#documentation": "Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).", + "smithy.api#jsonName": "rateControlMode" + } + }, + "RepeatPps": { + "target": "com.amazonaws.mediaconvert#H264RepeatPps", + "traits": { + "smithy.api#documentation": "Places a PPS header on each encoded picture, even if repeated.", + "smithy.api#jsonName": "repeatPps" + } + }, + "SceneChangeDetect": { + "target": "com.amazonaws.mediaconvert#H264SceneChangeDetect", + "traits": { + "smithy.api#documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.", + "smithy.api#jsonName": "sceneChangeDetect" } }, "Slices": { @@ -6734,11 +6789,18 @@ "smithy.api#jsonName": "slowPal" } }, - "GopSize": { - "target": "com.amazonaws.mediaconvert#__doubleMin0", + "Softness": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max128", "traits": { - "smithy.api#documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.", - "smithy.api#jsonName": "gopSize" + "smithy.api#documentation": "Ignore this setting unless you need to comply with a specification that requires a specific value. If you don't have a specification requirement, we recommend that you adjust the softness of your output by using a lower value for the setting Sharpness (sharpness) or by enabling a noise reducer filter (noiseReducerFilter). The Softness (softness) setting specifies the quantization matrices that the encoder uses. Keep the default value, 0, for flat quantization. Choose the value 1 or 16 to use the default JVT softening quantization matricies from the H.264 specification. Choose a value from 17 to 128 to use planar interpolation. Increasing values from 17 to 128 result in increasing reduction of high-frequency data. The value 128 results in the softest video.", + "smithy.api#jsonName": "softness" + } + }, + "SpatialAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#H264SpatialAdaptiveQuantization", + "traits": { + "smithy.api#documentation": "Only use this setting when you change the default value, Auto (AUTO), for the setting H264AdaptiveQuantization. When you keep all defaults, excluding H264AdaptiveQuantization and all other adaptive quantization from your JSON job specification, MediaConvert automatically applies the best types of quantization for your video content. When you set H264AdaptiveQuantization to a value other than AUTO, the default value for H264SpatialAdaptiveQuantization is Enabled (ENABLED). Keep this default value to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to set H264SpatialAdaptiveQuantization to Disabled (DISABLED). Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (H264AdaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher. To manually enable or disable H264SpatialAdaptiveQuantization, you must set Adaptive quantization (H264AdaptiveQuantization) to a value other than AUTO.", + "smithy.api#jsonName": "spatialAdaptiveQuantization" } }, "Syntax": { @@ -6748,39 +6810,25 @@ "smithy.api#jsonName": "syntax" } }, - "NumberBFramesBetweenReferenceFrames": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max7", - "traits": { - "smithy.api#documentation": "Number of B-frames between reference frames.", - "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" - } - }, - "FlickerAdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#H264FlickerAdaptiveQuantization", - "traits": { - "smithy.api#documentation": "Enable this setting to have the encoder reduce I-frame pop. I-frame pop appears as a visual flicker that can arise when the encoder saves bits by copying some macroblocks many times from frame to frame, and then refreshes them at the I-frame. When you enable this setting, the encoder updates these macroblocks slightly more often to smooth out the flicker. This setting is disabled by default. Related setting: In addition to enabling this setting, you must also set adaptiveQuantization to a value other than Off (OFF).", - "smithy.api#jsonName": "flickerAdaptiveQuantization" - } - }, - "Softness": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max128", + "Telecine": { + "target": "com.amazonaws.mediaconvert#H264Telecine", "traits": { - "smithy.api#documentation": "Ignore this setting unless you need to comply with a specification that requires a specific value. If you don't have a specification requirement, we recommend that you adjust the softness of your output by using a lower value for the setting Sharpness (sharpness) or by enabling a noise reducer filter (noiseReducerFilter). The Softness (softness) setting specifies the quantization matrices that the encoder uses. Keep the default value, 0, for flat quantization. Choose the value 1 or 16 to use the default JVT softening quantization matricies from the H.264 specification. Choose a value from 17 to 128 to use planar interpolation. Increasing values from 17 to 128 result in increasing reduction of high-frequency data. The value 128 results in the softest video.", - "smithy.api#jsonName": "softness" + "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard or soft telecine to create a smoother picture. Hard telecine (HARD) produces a 29.97i output. Soft telecine (SOFT) produces an output with a 23.976 output that signals to the video player device to do the conversion during play back. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", + "smithy.api#jsonName": "telecine" } }, - "QualityTuningLevel": { - "target": "com.amazonaws.mediaconvert#H264QualityTuningLevel", + "TemporalAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#H264TemporalAdaptiveQuantization", "traits": { - "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", - "smithy.api#jsonName": "qualityTuningLevel" + "smithy.api#documentation": "Only use this setting when you change the default value, AUTO, for the setting H264AdaptiveQuantization. When you keep all defaults, excluding H264AdaptiveQuantization and all other adaptive quantization from your JSON job specification, MediaConvert automatically applies the best types of quantization for your video content. When you set H264AdaptiveQuantization to a value other than AUTO, the default value for H264TemporalAdaptiveQuantization is Enabled (ENABLED). Keep this default value to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to set H264TemporalAdaptiveQuantization to Disabled (DISABLED). Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization). To manually enable or disable H264TemporalAdaptiveQuantization, you must set Adaptive quantization (H264AdaptiveQuantization) to a value other than AUTO.", + "smithy.api#jsonName": "temporalAdaptiveQuantization" } }, - "DynamicSubGop": { - "target": "com.amazonaws.mediaconvert#H264DynamicSubGop", + "UnregisteredSeiTimecode": { + "target": "com.amazonaws.mediaconvert#H264UnregisteredSeiTimecode", "traits": { - "smithy.api#documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).", - "smithy.api#jsonName": "dynamicSubGop" + "smithy.api#documentation": "Inserts timecode for each frame as 4 bytes of an unregistered SEI message.", + "smithy.api#jsonName": "unregisteredSeiTimecode" } } }, @@ -6807,7 +6855,7 @@ "com.amazonaws.mediaconvert#H264SpatialAdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", + "smithy.api#documentation": "Only use this setting when you change the default value, Auto (AUTO), for the setting H264AdaptiveQuantization. When you keep all defaults, excluding H264AdaptiveQuantization and all other adaptive quantization from your JSON job specification, MediaConvert automatically applies the best types of quantization for your video content. When you set H264AdaptiveQuantization to a value other than AUTO, the default value for H264SpatialAdaptiveQuantization is Enabled (ENABLED). Keep this default value to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to set H264SpatialAdaptiveQuantization to Disabled (DISABLED). Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (H264AdaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher. To manually enable or disable H264SpatialAdaptiveQuantization, you must set Adaptive quantization (H264AdaptiveQuantization) to a value other than AUTO.", "smithy.api#enum": [ { "value": "DISABLED", @@ -6859,7 +6907,7 @@ "com.amazonaws.mediaconvert#H264TemporalAdaptiveQuantization": { "type": "string", "traits": { - "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization).", + "smithy.api#documentation": "Only use this setting when you change the default value, AUTO, for the setting H264AdaptiveQuantization. When you keep all defaults, excluding H264AdaptiveQuantization and all other adaptive quantization from your JSON job specification, MediaConvert automatically applies the best types of quantization for your video content. When you set H264AdaptiveQuantization to a value other than AUTO, the default value for H264TemporalAdaptiveQuantization is Enabled (ENABLED). Keep this default value to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to set H264TemporalAdaptiveQuantization to Disabled (DISABLED). Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization). To manually enable or disable H264TemporalAdaptiveQuantization, you must set Adaptive quantization (H264AdaptiveQuantization) to a value other than AUTO.", "smithy.api#enum": [ { "value": "DISABLED", @@ -7214,19 +7262,19 @@ "smithy.api#jsonName": "maxAverageBitrate" } }, - "QvbrQualityLevelFineTune": { - "target": "com.amazonaws.mediaconvert#__doubleMin0Max1", - "traits": { - "smithy.api#documentation": "Optional. Specify a value here to set the QVBR quality to a level that is between whole numbers. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. MediaConvert rounds your QVBR quality level to the nearest third of a whole number. For example, if you set qvbrQualityLevel to 7 and you set qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33.", - "smithy.api#jsonName": "qvbrQualityLevelFineTune" - } - }, "QvbrQualityLevel": { "target": "com.amazonaws.mediaconvert#__integerMin1Max10", "traits": { "smithy.api#documentation": "Required when you use QVBR rate control mode. That is, when you specify qvbrSettings within h265Settings. Specify the general target quality level for this output, from 1 to 10. Use higher numbers for greater quality. Level 10 results in nearly lossless compression. The quality level for most broadcast-quality transcodes is between 6 and 9. Optionally, to specify a value between whole numbers, also provide a value for the setting qvbrQualityLevelFineTune. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33.", "smithy.api#jsonName": "qvbrQualityLevel" } + }, + "QvbrQualityLevelFineTune": { + "target": "com.amazonaws.mediaconvert#__doubleMin0Max1", + "traits": { + "smithy.api#documentation": "Optional. Specify a value here to set the QVBR quality to a level that is between whole numbers. For example, if you want your QVBR quality level to be 7.33, set qvbrQualityLevel to 7 and set qvbrQualityLevelFineTune to .33. MediaConvert rounds your QVBR quality level to the nearest third of a whole number. For example, if you set qvbrQualityLevel to 7 and you set qvbrQualityLevelFineTune to .25, your actual QVBR quality level is 7.33.", + "smithy.api#jsonName": "qvbrQualityLevelFineTune" + } } }, "traits": { @@ -7296,55 +7344,6 @@ "com.amazonaws.mediaconvert#H265Settings": { "type": "structure", "members": { - "SceneChangeDetect": { - "target": "com.amazonaws.mediaconvert#H265SceneChangeDetect", - "traits": { - "smithy.api#documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.", - "smithy.api#jsonName": "sceneChangeDetect" - } - }, - "MinIInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max30", - "traits": { - "smithy.api#documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", - "smithy.api#jsonName": "minIInterval" - } - }, - "QualityTuningLevel": { - "target": "com.amazonaws.mediaconvert#H265QualityTuningLevel", - "traits": { - "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", - "smithy.api#jsonName": "qualityTuningLevel" - } - }, - "MaxBitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin1000Max1466400000", - "traits": { - "smithy.api#documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR.", - "smithy.api#jsonName": "maxBitrate" - } - }, - "HrdBufferInitialFillPercentage": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max100", - "traits": { - "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", - "smithy.api#jsonName": "hrdBufferInitialFillPercentage" - } - }, - "RateControlMode": { - "target": "com.amazonaws.mediaconvert#H265RateControlMode", - "traits": { - "smithy.api#documentation": "Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).", - "smithy.api#jsonName": "rateControlMode" - } - }, - "ParNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", - "smithy.api#jsonName": "parNumerator" - } - }, "AdaptiveQuantization": { "target": "com.amazonaws.mediaconvert#H265AdaptiveQuantization", "traits": { @@ -7359,25 +7358,18 @@ "smithy.api#jsonName": "alternateTransferFunctionSei" } }, - "ParDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", - "smithy.api#jsonName": "parDenominator" - } - }, - "NumberBFramesBetweenReferenceFrames": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max7", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin1000Max1466400000", "traits": { - "smithy.api#documentation": "Number of B-frames between reference frames.", - "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" + "smithy.api#documentation": "Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000.", + "smithy.api#jsonName": "bitrate" } }, - "FramerateDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "CodecLevel": { + "target": "com.amazonaws.mediaconvert#H265CodecLevel", "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateDenominator" + "smithy.api#documentation": "H.265 Level.", + "smithy.api#jsonName": "codecLevel" } }, "CodecProfile": { @@ -7387,11 +7379,11 @@ "smithy.api#jsonName": "codecProfile" } }, - "TemporalIds": { - "target": "com.amazonaws.mediaconvert#H265TemporalIds", + "DynamicSubGop": { + "target": "com.amazonaws.mediaconvert#H265DynamicSubGop", "traits": { - "smithy.api#documentation": "Enables temporal layer identifiers in the encoded bitstream. Up to 3 layers are supported depending on GOP structure: I- and P-frames form one layer, reference B-frames can form a second layer and non-reference b-frames can form a third layer. Decoders can optionally decode only the lower temporal layers to generate a lower frame rate output. For example, given a bitstream with temporal IDs and with b-frames = 1 (i.e. IbPbPb display order), a decoder could decode all the frames for full frame rate output or only the I and P frames (lowest temporal layer) for a half frame rate output.", - "smithy.api#jsonName": "temporalIds" + "smithy.api#documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).", + "smithy.api#jsonName": "dynamicSubGop" } }, "FlickerAdaptiveQuantization": { @@ -7401,46 +7393,46 @@ "smithy.api#jsonName": "flickerAdaptiveQuantization" } }, - "SampleAdaptiveOffsetFilterMode": { - "target": "com.amazonaws.mediaconvert#H265SampleAdaptiveOffsetFilterMode", + "FramerateControl": { + "target": "com.amazonaws.mediaconvert#H265FramerateControl", "traits": { - "smithy.api#documentation": "Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on content", - "smithy.api#jsonName": "sampleAdaptiveOffsetFilterMode" + "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#jsonName": "framerateControl" } }, - "DynamicSubGop": { - "target": "com.amazonaws.mediaconvert#H265DynamicSubGop", + "FramerateConversionAlgorithm": { + "target": "com.amazonaws.mediaconvert#H265FramerateConversionAlgorithm", "traits": { - "smithy.api#documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).", - "smithy.api#jsonName": "dynamicSubGop" + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#jsonName": "framerateConversionAlgorithm" } }, - "UnregisteredSeiTimecode": { - "target": "com.amazonaws.mediaconvert#H265UnregisteredSeiTimecode", + "FramerateDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Inserts timecode for each frame as 4 bytes of an unregistered SEI message.", - "smithy.api#jsonName": "unregisteredSeiTimecode" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateDenominator" } }, - "TemporalAdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#H265TemporalAdaptiveQuantization", + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization).", - "smithy.api#jsonName": "temporalAdaptiveQuantization" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" } }, - "InterlaceMode": { - "target": "com.amazonaws.mediaconvert#H265InterlaceMode", + "GopBReference": { + "target": "com.amazonaws.mediaconvert#H265GopBReference", "traits": { - "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", - "smithy.api#jsonName": "interlaceMode" + "smithy.api#documentation": "If enable, use reference B frames for GOP structures that have B frames > 1.", + "smithy.api#jsonName": "gopBReference" } }, - "CodecLevel": { - "target": "com.amazonaws.mediaconvert#H265CodecLevel", + "GopClosedCadence": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "H.265 Level.", - "smithy.api#jsonName": "codecLevel" + "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", + "smithy.api#jsonName": "gopClosedCadence" } }, "GopSize": { @@ -7450,39 +7442,60 @@ "smithy.api#jsonName": "gopSize" } }, - "SlowPal": { - "target": "com.amazonaws.mediaconvert#H265SlowPal", + "GopSizeUnits": { + "target": "com.amazonaws.mediaconvert#H265GopSizeUnits", "traits": { - "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", - "smithy.api#jsonName": "slowPal" + "smithy.api#documentation": "Indicates if the GOP Size in H265 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", + "smithy.api#jsonName": "gopSizeUnits" } }, - "Bitrate": { + "HrdBufferInitialFillPercentage": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max100", + "traits": { + "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", + "smithy.api#jsonName": "hrdBufferInitialFillPercentage" + } + }, + "HrdBufferSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max1466400000", + "traits": { + "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", + "smithy.api#jsonName": "hrdBufferSize" + } + }, + "InterlaceMode": { + "target": "com.amazonaws.mediaconvert#H265InterlaceMode", + "traits": { + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", + "smithy.api#jsonName": "interlaceMode" + } + }, + "MaxBitrate": { "target": "com.amazonaws.mediaconvert#__integerMin1000Max1466400000", "traits": { - "smithy.api#documentation": "Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000. Required when Rate control mode is QVBR.", + "smithy.api#jsonName": "maxBitrate" } }, - "WriteMp4PackagingType": { - "target": "com.amazonaws.mediaconvert#H265WriteMp4PackagingType", + "MinIInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max30", "traits": { - "smithy.api#documentation": "If the location of parameter set NAL units doesn't matter in your workflow, ignore this setting. Use this setting only with CMAF or DASH outputs, or with standalone file outputs in an MPEG-4 container (MP4 outputs). Choose HVC1 to mark your output as HVC1. This makes your output compliant with the following specification: ISO IECJTC1 SC29 N13798 Text ISO/IEC FDIS 14496-15 3rd Edition. For these outputs, the service stores parameter set NAL units in the sample headers but not in the samples directly. For MP4 outputs, when you choose HVC1, your output video might not work properly with some downstream systems and video players. The service defaults to marking your output as HEV1. For these outputs, the service writes parameter set NAL units directly into the samples.", - "smithy.api#jsonName": "writeMp4PackagingType" + "smithy.api#documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", + "smithy.api#jsonName": "minIInterval" } }, - "FramerateControl": { - "target": "com.amazonaws.mediaconvert#H265FramerateControl", + "NumberBFramesBetweenReferenceFrames": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max7", "traits": { - "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", - "smithy.api#jsonName": "framerateControl" + "smithy.api#documentation": "Number of B-frames between reference frames.", + "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" } }, - "Slices": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max32", + "NumberReferenceFrames": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max6", "traits": { - "smithy.api#documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.", - "smithy.api#jsonName": "slices" + "smithy.api#documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.", + "smithy.api#jsonName": "numberReferenceFrames" } }, "ParControl": { @@ -7492,6 +7505,27 @@ "smithy.api#jsonName": "parControl" } }, + "ParDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", + "smithy.api#jsonName": "parDenominator" + } + }, + "ParNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", + "smithy.api#jsonName": "parNumerator" + } + }, + "QualityTuningLevel": { + "target": "com.amazonaws.mediaconvert#H265QualityTuningLevel", + "traits": { + "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", + "smithy.api#jsonName": "qualityTuningLevel" + } + }, "QvbrSettings": { "target": "com.amazonaws.mediaconvert#H265QvbrSettings", "traits": { @@ -7499,60 +7533,67 @@ "smithy.api#jsonName": "qvbrSettings" } }, - "Telecine": { - "target": "com.amazonaws.mediaconvert#H265Telecine", + "RateControlMode": { + "target": "com.amazonaws.mediaconvert#H265RateControlMode", "traits": { - "smithy.api#documentation": "This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i.", - "smithy.api#jsonName": "telecine" + "smithy.api#documentation": "Use this setting to specify whether this output has a variable bitrate (VBR), constant bitrate (CBR) or quality-defined variable bitrate (QVBR).", + "smithy.api#jsonName": "rateControlMode" } }, - "FramerateNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "SampleAdaptiveOffsetFilterMode": { + "target": "com.amazonaws.mediaconvert#H265SampleAdaptiveOffsetFilterMode", "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateNumerator" + "smithy.api#documentation": "Specify Sample Adaptive Offset (SAO) filter strength. Adaptive mode dynamically selects best strength based on content", + "smithy.api#jsonName": "sampleAdaptiveOffsetFilterMode" } }, - "SpatialAdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#H265SpatialAdaptiveQuantization", + "SceneChangeDetect": { + "target": "com.amazonaws.mediaconvert#H265SceneChangeDetect", "traits": { - "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", - "smithy.api#jsonName": "spatialAdaptiveQuantization" + "smithy.api#documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default. If this output uses QVBR, choose Transition detection (TRANSITION_DETECTION) for further video quality improvement. For more information about QVBR, see https://docs.aws.amazon.com/console/mediaconvert/cbr-vbr-qvbr.", + "smithy.api#jsonName": "sceneChangeDetect" } }, - "GopClosedCadence": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "Slices": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max32", "traits": { - "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", - "smithy.api#jsonName": "gopClosedCadence" + "smithy.api#documentation": "Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures.", + "smithy.api#jsonName": "slices" } }, - "NumberReferenceFrames": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max6", + "SlowPal": { + "target": "com.amazonaws.mediaconvert#H265SlowPal", "traits": { - "smithy.api#documentation": "Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.", - "smithy.api#jsonName": "numberReferenceFrames" + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", + "smithy.api#jsonName": "slowPal" } }, - "FramerateConversionAlgorithm": { - "target": "com.amazonaws.mediaconvert#H265FramerateConversionAlgorithm", + "SpatialAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#H265SpatialAdaptiveQuantization", "traits": { - "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", - "smithy.api#jsonName": "framerateConversionAlgorithm" + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", + "smithy.api#jsonName": "spatialAdaptiveQuantization" } }, - "GopBReference": { - "target": "com.amazonaws.mediaconvert#H265GopBReference", + "Telecine": { + "target": "com.amazonaws.mediaconvert#H265Telecine", "traits": { - "smithy.api#documentation": "If enable, use reference B frames for GOP structures that have B frames > 1.", - "smithy.api#jsonName": "gopBReference" + "smithy.api#documentation": "This field applies only if the Streams > Advanced > Framerate (framerate) field is set to 29.970. This field works with the Streams > Advanced > Preprocessors > Deinterlacer field (deinterlace_mode) and the Streams > Advanced > Interlaced Mode field (interlace_mode) to identify the scan type for the output: Progressive, Interlaced, Hard Telecine or Soft Telecine. - Hard: produces 29.97i output from 23.976 input. - Soft: produces 23.976; the player converts this output to 29.97i.", + "smithy.api#jsonName": "telecine" } }, - "GopSizeUnits": { - "target": "com.amazonaws.mediaconvert#H265GopSizeUnits", + "TemporalAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#H265TemporalAdaptiveQuantization", "traits": { - "smithy.api#documentation": "Indicates if the GOP Size in H265 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", - "smithy.api#jsonName": "gopSizeUnits" + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization).", + "smithy.api#jsonName": "temporalAdaptiveQuantization" + } + }, + "TemporalIds": { + "target": "com.amazonaws.mediaconvert#H265TemporalIds", + "traits": { + "smithy.api#documentation": "Enables temporal layer identifiers in the encoded bitstream. Up to 3 layers are supported depending on GOP structure: I- and P-frames form one layer, reference B-frames can form a second layer and non-reference b-frames can form a third layer. Decoders can optionally decode only the lower temporal layers to generate a lower frame rate output. For example, given a bitstream with temporal IDs and with b-frames = 1 (i.e. IbPbPb display order), a decoder could decode all the frames for full frame rate output or only the I and P frames (lowest temporal layer) for a half frame rate output.", + "smithy.api#jsonName": "temporalIds" } }, "Tiles": { @@ -7562,11 +7603,18 @@ "smithy.api#jsonName": "tiles" } }, - "HrdBufferSize": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max1466400000", + "UnregisteredSeiTimecode": { + "target": "com.amazonaws.mediaconvert#H265UnregisteredSeiTimecode", "traits": { - "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", - "smithy.api#jsonName": "hrdBufferSize" + "smithy.api#documentation": "Inserts timecode for each frame as 4 bytes of an unregistered SEI message.", + "smithy.api#jsonName": "unregisteredSeiTimecode" + } + }, + "WriteMp4PackagingType": { + "target": "com.amazonaws.mediaconvert#H265WriteMp4PackagingType", + "traits": { + "smithy.api#documentation": "If the location of parameter set NAL units doesn't matter in your workflow, ignore this setting. Use this setting only with CMAF or DASH outputs, or with standalone file outputs in an MPEG-4 container (MP4 outputs). Choose HVC1 to mark your output as HVC1. This makes your output compliant with the following specification: ISO IECJTC1 SC29 N13798 Text ISO/IEC FDIS 14496-15 3rd Edition. For these outputs, the service stores parameter set NAL units in the sample headers but not in the samples directly. For MP4 outputs, when you choose HVC1, your output video might not work properly with some downstream systems and video players. The service defaults to marking your output as HEV1. For these outputs, the service writes parameter set NAL units directly into the samples.", + "smithy.api#jsonName": "writeMp4PackagingType" } } }, @@ -7709,13 +7757,6 @@ "com.amazonaws.mediaconvert#Hdr10Metadata": { "type": "structure", "members": { - "MaxLuminance": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", - "traits": { - "smithy.api#documentation": "Nominal maximum mastering display luminance in units of of 0.0001 candelas per square meter.", - "smithy.api#jsonName": "maxLuminance" - } - }, "BluePrimaryX": { "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", "traits": { @@ -7730,25 +7771,39 @@ "smithy.api#jsonName": "bluePrimaryY" } }, - "WhitePointY": { + "GreenPrimaryX": { "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", "traits": { "smithy.api#documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.", - "smithy.api#jsonName": "whitePointY" + "smithy.api#jsonName": "greenPrimaryX" } }, - "RedPrimaryX": { + "GreenPrimaryY": { "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", "traits": { "smithy.api#documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.", - "smithy.api#jsonName": "redPrimaryX" + "smithy.api#jsonName": "greenPrimaryY" } }, - "WhitePointX": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", + "MaxContentLightLevel": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", "traits": { - "smithy.api#documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.", - "smithy.api#jsonName": "whitePointX" + "smithy.api#documentation": "Maximum light level among all samples in the coded video sequence, in units of candelas per square meter. This setting doesn't have a default value; you must specify a value that is suitable for the content.", + "smithy.api#jsonName": "maxContentLightLevel" + } + }, + "MaxFrameAverageLightLevel": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", + "traits": { + "smithy.api#documentation": "Maximum average light level of any frame in the coded video sequence, in units of candelas per square meter. This setting doesn't have a default value; you must specify a value that is suitable for the content.", + "smithy.api#jsonName": "maxFrameAverageLightLevel" + } + }, + "MaxLuminance": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "Nominal maximum mastering display luminance in units of of 0.0001 candelas per square meter.", + "smithy.api#jsonName": "maxLuminance" } }, "MinLuminance": { @@ -7758,39 +7813,32 @@ "smithy.api#jsonName": "minLuminance" } }, - "RedPrimaryY": { + "RedPrimaryX": { "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", "traits": { "smithy.api#documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.", - "smithy.api#jsonName": "redPrimaryY" + "smithy.api#jsonName": "redPrimaryX" } }, - "GreenPrimaryY": { + "RedPrimaryY": { "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", "traits": { "smithy.api#documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.", - "smithy.api#jsonName": "greenPrimaryY" - } - }, - "MaxFrameAverageLightLevel": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", - "traits": { - "smithy.api#documentation": "Maximum average light level of any frame in the coded video sequence, in units of candelas per square meter. This setting doesn't have a default value; you must specify a value that is suitable for the content.", - "smithy.api#jsonName": "maxFrameAverageLightLevel" + "smithy.api#jsonName": "redPrimaryY" } }, - "GreenPrimaryX": { + "WhitePointX": { "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", "traits": { "smithy.api#documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.", - "smithy.api#jsonName": "greenPrimaryX" + "smithy.api#jsonName": "whitePointX" } }, - "MaxContentLightLevel": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", + "WhitePointY": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max50000", "traits": { - "smithy.api#documentation": "Maximum light level among all samples in the coded video sequence, in units of candelas per square meter. This setting doesn't have a default value; you must specify a value that is suitable for the content.", - "smithy.api#jsonName": "maxContentLightLevel" + "smithy.api#documentation": "HDR Master Display Information must be provided by a color grader, using color grading tools. Range is 0 to 50,000, each increment represents 0.00002 in CIE1931 color coordinate. Note that this setting is not for color correction.", + "smithy.api#jsonName": "whitePointY" } } }, @@ -7894,13 +7942,6 @@ "com.amazonaws.mediaconvert#HlsCaptionLanguageMapping": { "type": "structure", "members": { - "CustomLanguageCode": { - "target": "com.amazonaws.mediaconvert#__stringMin3Max3PatternAZaZ3", - "traits": { - "smithy.api#documentation": "Specify the language for this captions channel, using the ISO 639-2 or ISO 639-3 three-letter language code", - "smithy.api#jsonName": "customLanguageCode" - } - }, "CaptionChannel": { "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { @@ -7908,11 +7949,11 @@ "smithy.api#jsonName": "captionChannel" } }, - "LanguageDescription": { - "target": "com.amazonaws.mediaconvert#__string", + "CustomLanguageCode": { + "target": "com.amazonaws.mediaconvert#__stringMin3Max3PatternAZaZ3", "traits": { - "smithy.api#documentation": "Caption language description.", - "smithy.api#jsonName": "languageDescription" + "smithy.api#documentation": "Specify the language for this captions channel, using the ISO 639-2 or ISO 639-3 three-letter language code", + "smithy.api#jsonName": "customLanguageCode" } }, "LanguageCode": { @@ -7921,9 +7962,16 @@ "smithy.api#documentation": "Specify the language, using the ISO 639-2 three-letter code listed at https://www.loc.gov/standards/iso639-2/php/code_list.php.", "smithy.api#jsonName": "languageCode" } - } - }, - "traits": { + }, + "LanguageDescription": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Caption language description.", + "smithy.api#jsonName": "languageDescription" + } + } + }, + "traits": { "smithy.api#documentation": "Caption Language Mapping" } }, @@ -7998,6 +8046,13 @@ "com.amazonaws.mediaconvert#HlsEncryptionSettings": { "type": "structure", "members": { + "ConstantInitializationVector": { + "target": "com.amazonaws.mediaconvert#__stringMin32Max32Pattern09aFAF32", + "traits": { + "smithy.api#documentation": "This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default.", + "smithy.api#jsonName": "constantInitializationVector" + } + }, "EncryptionMethod": { "target": "com.amazonaws.mediaconvert#HlsEncryptionType", "traits": { @@ -8005,25 +8060,18 @@ "smithy.api#jsonName": "encryptionMethod" } }, - "StaticKeyProvider": { - "target": "com.amazonaws.mediaconvert#StaticKeyProvider", - "traits": { - "smithy.api#documentation": "Use these settings to set up encryption with a static key provider.", - "smithy.api#jsonName": "staticKeyProvider" - } - }, - "Type": { - "target": "com.amazonaws.mediaconvert#HlsKeyProviderType", + "InitializationVectorInManifest": { + "target": "com.amazonaws.mediaconvert#HlsInitializationVectorInManifest", "traits": { - "smithy.api#documentation": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.", - "smithy.api#jsonName": "type" + "smithy.api#documentation": "The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.", + "smithy.api#jsonName": "initializationVectorInManifest" } }, - "ConstantInitializationVector": { - "target": "com.amazonaws.mediaconvert#__stringMin32Max32Pattern09aFAF32", + "OfflineEncrypted": { + "target": "com.amazonaws.mediaconvert#HlsOfflineEncrypted", "traits": { - "smithy.api#documentation": "This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default.", - "smithy.api#jsonName": "constantInitializationVector" + "smithy.api#documentation": "Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection.", + "smithy.api#jsonName": "offlineEncrypted" } }, "SpekeKeyProvider": { @@ -8033,18 +8081,18 @@ "smithy.api#jsonName": "spekeKeyProvider" } }, - "OfflineEncrypted": { - "target": "com.amazonaws.mediaconvert#HlsOfflineEncrypted", + "StaticKeyProvider": { + "target": "com.amazonaws.mediaconvert#StaticKeyProvider", "traits": { - "smithy.api#documentation": "Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection.", - "smithy.api#jsonName": "offlineEncrypted" + "smithy.api#documentation": "Use these settings to set up encryption with a static key provider.", + "smithy.api#jsonName": "staticKeyProvider" } }, - "InitializationVectorInManifest": { - "target": "com.amazonaws.mediaconvert#HlsInitializationVectorInManifest", + "Type": { + "target": "com.amazonaws.mediaconvert#HlsKeyProviderType", "traits": { - "smithy.api#documentation": "The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.", - "smithy.api#jsonName": "initializationVectorInManifest" + "smithy.api#documentation": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html.", + "smithy.api#jsonName": "type" } } }, @@ -8071,27 +8119,6 @@ "com.amazonaws.mediaconvert#HlsGroupSettings": { "type": "structure", "members": { - "TimestampDeltaMilliseconds": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", - "traits": { - "smithy.api#documentation": "Provides an extra millisecond delta offset to fine tune the timestamps.", - "smithy.api#jsonName": "timestampDeltaMilliseconds" - } - }, - "DestinationSettings": { - "target": "com.amazonaws.mediaconvert#DestinationSettings", - "traits": { - "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", - "smithy.api#jsonName": "destinationSettings" - } - }, - "DirectoryStructure": { - "target": "com.amazonaws.mediaconvert#HlsDirectoryStructure", - "traits": { - "smithy.api#documentation": "Indicates whether segments should be placed in subdirectories.", - "smithy.api#jsonName": "directoryStructure" - } - }, "AdMarkers": { "target": "com.amazonaws.mediaconvert#__listOfHlsAdMarkers", "traits": { @@ -8099,11 +8126,18 @@ "smithy.api#jsonName": "adMarkers" } }, - "ManifestDurationFormat": { - "target": "com.amazonaws.mediaconvert#HlsManifestDurationFormat", + "AdditionalManifests": { + "target": "com.amazonaws.mediaconvert#__listOfHlsAdditionalManifest", "traits": { - "smithy.api#documentation": "Indicates whether the output manifest should use floating point values for segment duration.", - "smithy.api#jsonName": "manifestDurationFormat" + "smithy.api#documentation": "By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here.", + "smithy.api#jsonName": "additionalManifests" + } + }, + "AudioOnlyHeader": { + "target": "com.amazonaws.mediaconvert#HlsAudioOnlyHeader", + "traits": { + "smithy.api#documentation": "Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include (INCLUDE), to output audio-only headers. Choose Exclude (EXCLUDE) to remove the audio-only headers from your audio segments.", + "smithy.api#jsonName": "audioOnlyHeader" } }, "BaseUrl": { @@ -8113,6 +8147,13 @@ "smithy.api#jsonName": "baseUrl" } }, + "CaptionLanguageMappings": { + "target": "com.amazonaws.mediaconvert#__listOfHlsCaptionLanguageMapping", + "traits": { + "smithy.api#documentation": "Language to be used on Caption outputs", + "smithy.api#jsonName": "captionLanguageMappings" + } + }, "CaptionLanguageSetting": { "target": "com.amazonaws.mediaconvert#HlsCaptionLanguageSetting", "traits": { @@ -8120,6 +8161,13 @@ "smithy.api#jsonName": "captionLanguageSetting" } }, + "ClientCache": { + "target": "com.amazonaws.mediaconvert#HlsClientCache", + "traits": { + "smithy.api#documentation": "When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.", + "smithy.api#jsonName": "clientCache" + } + }, "CodecSpecification": { "target": "com.amazonaws.mediaconvert#HlsCodecSpecification", "traits": { @@ -8127,13 +8175,6 @@ "smithy.api#jsonName": "codecSpecification" } }, - "SegmentControl": { - "target": "com.amazonaws.mediaconvert#HlsSegmentControl", - "traits": { - "smithy.api#documentation": "When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.", - "smithy.api#jsonName": "segmentControl" - } - }, "Destination": { "target": "com.amazonaws.mediaconvert#__stringPatternS3", "traits": { @@ -8141,25 +8182,39 @@ "smithy.api#jsonName": "destination" } }, - "ClientCache": { - "target": "com.amazonaws.mediaconvert#HlsClientCache", + "DestinationSettings": { + "target": "com.amazonaws.mediaconvert#DestinationSettings", "traits": { - "smithy.api#documentation": "When set to ENABLED, sets #EXT-X-ALLOW-CACHE:no tag, which prevents client from saving media segments for later replay.", - "smithy.api#jsonName": "clientCache" + "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", + "smithy.api#jsonName": "destinationSettings" } }, - "CaptionLanguageMappings": { - "target": "com.amazonaws.mediaconvert#__listOfHlsCaptionLanguageMapping", + "DirectoryStructure": { + "target": "com.amazonaws.mediaconvert#HlsDirectoryStructure", "traits": { - "smithy.api#documentation": "Language to be used on Caption outputs", - "smithy.api#jsonName": "captionLanguageMappings" + "smithy.api#documentation": "Indicates whether segments should be placed in subdirectories.", + "smithy.api#jsonName": "directoryStructure" } }, - "TimedMetadataId3Frame": { - "target": "com.amazonaws.mediaconvert#HlsTimedMetadataId3Frame", + "Encryption": { + "target": "com.amazonaws.mediaconvert#HlsEncryptionSettings", "traits": { - "smithy.api#documentation": "Indicates ID3 frame that has the timecode.", - "smithy.api#jsonName": "timedMetadataId3Frame" + "smithy.api#documentation": "DRM settings.", + "smithy.api#jsonName": "encryption" + } + }, + "ManifestCompression": { + "target": "com.amazonaws.mediaconvert#HlsManifestCompression", + "traits": { + "smithy.api#documentation": "When set to GZIP, compresses HLS playlist.", + "smithy.api#jsonName": "manifestCompression" + } + }, + "ManifestDurationFormat": { + "target": "com.amazonaws.mediaconvert#HlsManifestDurationFormat", + "traits": { + "smithy.api#documentation": "Indicates whether the output manifest should use floating point values for segment duration.", + "smithy.api#jsonName": "manifestDurationFormat" } }, "MinFinalSegmentLength": { @@ -8169,6 +8224,13 @@ "smithy.api#jsonName": "minFinalSegmentLength" } }, + "MinSegmentLength": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.", + "smithy.api#jsonName": "minSegmentLength" + } + }, "OutputSelection": { "target": "com.amazonaws.mediaconvert#HlsOutputSelection", "traits": { @@ -8176,13 +8238,6 @@ "smithy.api#jsonName": "outputSelection" } }, - "StreamInfResolution": { - "target": "com.amazonaws.mediaconvert#HlsStreamInfResolution", - "traits": { - "smithy.api#documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.", - "smithy.api#jsonName": "streamInfResolution" - } - }, "ProgramDateTime": { "target": "com.amazonaws.mediaconvert#HlsProgramDateTime", "traits": { @@ -8190,25 +8245,18 @@ "smithy.api#jsonName": "programDateTime" } }, - "Encryption": { - "target": "com.amazonaws.mediaconvert#HlsEncryptionSettings", - "traits": { - "smithy.api#documentation": "DRM settings.", - "smithy.api#jsonName": "encryption" - } - }, - "ManifestCompression": { - "target": "com.amazonaws.mediaconvert#HlsManifestCompression", + "ProgramDateTimePeriod": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max3600", "traits": { - "smithy.api#documentation": "When set to GZIP, compresses HLS playlist.", - "smithy.api#jsonName": "manifestCompression" + "smithy.api#documentation": "Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.", + "smithy.api#jsonName": "programDateTimePeriod" } }, - "AdditionalManifests": { - "target": "com.amazonaws.mediaconvert#__listOfHlsAdditionalManifest", + "SegmentControl": { + "target": "com.amazonaws.mediaconvert#HlsSegmentControl", "traits": { - "smithy.api#documentation": "By default, the service creates one top-level .m3u8 HLS manifest for each HLS output group in your job. This default manifest references every output in the output group. To create additional top-level manifests that reference a subset of the outputs in the output group, specify a list of them here.", - "smithy.api#jsonName": "additionalManifests" + "smithy.api#documentation": "When set to SINGLE_FILE, emits program as a single media resource (.ts) file, uses #EXT-X-BYTERANGE tags to index segment for playback.", + "smithy.api#jsonName": "segmentControl" } }, "SegmentLength": { @@ -8225,32 +8273,32 @@ "smithy.api#jsonName": "segmentsPerSubdirectory" } }, - "TimedMetadataId3Period": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", + "StreamInfResolution": { + "target": "com.amazonaws.mediaconvert#HlsStreamInfResolution", "traits": { - "smithy.api#documentation": "Timed Metadata interval in seconds.", - "smithy.api#jsonName": "timedMetadataId3Period" + "smithy.api#documentation": "Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.", + "smithy.api#jsonName": "streamInfResolution" } }, - "MinSegmentLength": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "TimedMetadataId3Frame": { + "target": "com.amazonaws.mediaconvert#HlsTimedMetadataId3Frame", "traits": { - "smithy.api#documentation": "When set, Minimum Segment Size is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.", - "smithy.api#jsonName": "minSegmentLength" + "smithy.api#documentation": "Indicates ID3 frame that has the timecode.", + "smithy.api#jsonName": "timedMetadataId3Frame" } }, - "AudioOnlyHeader": { - "target": "com.amazonaws.mediaconvert#HlsAudioOnlyHeader", + "TimedMetadataId3Period": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { - "smithy.api#documentation": "Ignore this setting unless you are using FairPlay DRM with Verimatrix and you encounter playback issues. Keep the default value, Include (INCLUDE), to output audio-only headers. Choose Exclude (EXCLUDE) to remove the audio-only headers from your audio segments.", - "smithy.api#jsonName": "audioOnlyHeader" + "smithy.api#documentation": "Timed Metadata interval in seconds.", + "smithy.api#jsonName": "timedMetadataId3Period" } }, - "ProgramDateTimePeriod": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max3600", + "TimestampDeltaMilliseconds": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", "traits": { - "smithy.api#documentation": "Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.", - "smithy.api#jsonName": "programDateTimePeriod" + "smithy.api#documentation": "Provides an extra millisecond delta offset to fine tune the timestamps.", + "smithy.api#jsonName": "timestampDeltaMilliseconds" } } }, @@ -8412,18 +8460,18 @@ "smithy.api#jsonName": "audioGroupId" } }, - "IFrameOnlyManifest": { - "target": "com.amazonaws.mediaconvert#HlsIFrameOnlyManifest", + "AudioOnlyContainer": { + "target": "com.amazonaws.mediaconvert#HlsAudioOnlyContainer", "traits": { - "smithy.api#documentation": "When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest", - "smithy.api#jsonName": "iFrameOnlyManifest" + "smithy.api#documentation": "Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic (AUTOMATIC) to create an audio-only file in a raw container. Regardless of the value that you specify here, if this output has video, the service will place the output into an MPEG2-TS container.", + "smithy.api#jsonName": "audioOnlyContainer" } }, - "SegmentModifier": { + "AudioRenditionSets": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Use this setting to add an identifying string to the filename of each segment. The service adds this string between the name modifier and segment index number. You can use format identifiers in the string. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html", - "smithy.api#jsonName": "segmentModifier" + "smithy.api#documentation": "List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.", + "smithy.api#jsonName": "audioRenditionSets" } }, "AudioTrackType": { @@ -8433,18 +8481,18 @@ "smithy.api#jsonName": "audioTrackType" } }, - "AudioRenditionSets": { - "target": "com.amazonaws.mediaconvert#__string", + "IFrameOnlyManifest": { + "target": "com.amazonaws.mediaconvert#HlsIFrameOnlyManifest", "traits": { - "smithy.api#documentation": "List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.", - "smithy.api#jsonName": "audioRenditionSets" + "smithy.api#documentation": "When set to INCLUDE, writes I-Frame Only Manifest in addition to the HLS manifest", + "smithy.api#jsonName": "iFrameOnlyManifest" } }, - "AudioOnlyContainer": { - "target": "com.amazonaws.mediaconvert#HlsAudioOnlyContainer", + "SegmentModifier": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic (AUTOMATIC) to create an audio-only file in a raw container. Regardless of the value that you specify here, if this output has video, the service will place the output into an MPEG2-TS container.", - "smithy.api#jsonName": "audioOnlyContainer" + "smithy.api#documentation": "Use this setting to add an identifying string to the filename of each segment. The service adds this string between the name modifier and segment index number. You can use format identifiers in the string. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html", + "smithy.api#jsonName": "segmentModifier" } } }, @@ -8491,11 +8539,11 @@ "com.amazonaws.mediaconvert#HopDestination": { "type": "structure", "members": { - "WaitMinutes": { - "target": "com.amazonaws.mediaconvert#__integer", + "Priority": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", "traits": { - "smithy.api#documentation": "Required for setting up a job to use queue hopping. Minimum wait time in minutes until the job can hop to the destination queue. Valid range is 1 to 1440 minutes, inclusive.", - "smithy.api#jsonName": "waitMinutes" + "smithy.api#documentation": "Optional. When you set up a job to use queue hopping, you can specify a different relative priority for the job in the destination queue. If you don't specify, the relative priority will remain the same as in the previous queue.", + "smithy.api#jsonName": "priority" } }, "Queue": { @@ -8505,11 +8553,11 @@ "smithy.api#jsonName": "queue" } }, - "Priority": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", + "WaitMinutes": { + "target": "com.amazonaws.mediaconvert#__integer", "traits": { - "smithy.api#documentation": "Optional. When you set up a job to use queue hopping, you can specify a different relative priority for the job in the destination queue. If you don't specify, the relative priority will remain the same as in the previous queue.", - "smithy.api#jsonName": "priority" + "smithy.api#documentation": "Required for setting up a job to use queue hopping. Minimum wait time in minutes until the job can hop to the destination queue. Valid range is 1 to 1440 minutes, inclusive.", + "smithy.api#jsonName": "waitMinutes" } } }, @@ -8520,19 +8568,19 @@ "com.amazonaws.mediaconvert#Id3Insertion": { "type": "structure", "members": { - "Timecode": { - "target": "com.amazonaws.mediaconvert#__stringPattern010920405090509092", - "traits": { - "smithy.api#documentation": "Provide a Timecode (TimeCode) in HH:MM:SS:FF or HH:MM:SS;FF format.", - "smithy.api#jsonName": "timecode" - } - }, "Id3": { "target": "com.amazonaws.mediaconvert#__stringPatternAZaZ0902", "traits": { "smithy.api#documentation": "Use ID3 tag (Id3) to provide a tag value in base64-encode format.", "smithy.api#jsonName": "id3" } + }, + "Timecode": { + "target": "com.amazonaws.mediaconvert#__stringPattern010920405090509092", + "traits": { + "smithy.api#documentation": "Provide a Timecode (TimeCode) in HH:MM:SS:FF or HH:MM:SS;FF format.", + "smithy.api#jsonName": "timecode" + } } }, "traits": { @@ -8588,11 +8636,11 @@ "com.amazonaws.mediaconvert#Input": { "type": "structure", "members": { - "ProgramNumber": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "AudioSelectorGroups": { + "target": "com.amazonaws.mediaconvert#__mapOfAudioSelectorGroup", "traits": { - "smithy.api#documentation": "Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default.", - "smithy.api#jsonName": "programNumber" + "smithy.api#documentation": "Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups. See \"Audio Selector Group\":#inputs-audio_selector_group for more information.", + "smithy.api#jsonName": "audioSelectorGroups" } }, "AudioSelectors": { @@ -8609,11 +8657,25 @@ "smithy.api#jsonName": "captionSelectors" } }, - "PsiControl": { - "target": "com.amazonaws.mediaconvert#InputPsiControl", + "Crop": { + "target": "com.amazonaws.mediaconvert#Rectangle", "traits": { - "smithy.api#documentation": "Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data.", - "smithy.api#jsonName": "psiControl" + "smithy.api#documentation": "Use Cropping selection (crop) to specify the video area that the service will include in the output video frame. If you specify a value here, it will override any value that you specify in the output setting Cropping selection (crop).", + "smithy.api#jsonName": "crop" + } + }, + "DeblockFilter": { + "target": "com.amazonaws.mediaconvert#InputDeblockFilter", + "traits": { + "smithy.api#documentation": "Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video inputs.", + "smithy.api#jsonName": "deblockFilter" + } + }, + "DecryptionSettings": { + "target": "com.amazonaws.mediaconvert#InputDecryptionSettings", + "traits": { + "smithy.api#documentation": "Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt your content.", + "smithy.api#jsonName": "decryptionSettings" } }, "DenoiseFilter": { @@ -8623,11 +8685,18 @@ "smithy.api#jsonName": "denoiseFilter" } }, - "TimecodeSource": { - "target": "com.amazonaws.mediaconvert#InputTimecodeSource", + "FileInput": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3MM2PPMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL", "traits": { - "smithy.api#documentation": "Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.", - "smithy.api#jsonName": "timecodeSource" + "smithy.api#documentation": "Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, \"s3://bucket/vf/cpl.xml\". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that contain assets referenced by the CPL.", + "smithy.api#jsonName": "fileInput" + } + }, + "FilterEnable": { + "target": "com.amazonaws.mediaconvert#InputFilterEnable", + "traits": { + "smithy.api#documentation": "Specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The input is filtered regardless of input type.", + "smithy.api#jsonName": "filterEnable" } }, "FilterStrength": { @@ -8637,11 +8706,11 @@ "smithy.api#jsonName": "filterStrength" } }, - "AudioSelectorGroups": { - "target": "com.amazonaws.mediaconvert#__mapOfAudioSelectorGroup", + "ImageInserter": { + "target": "com.amazonaws.mediaconvert#ImageInserter", "traits": { - "smithy.api#documentation": "Specifies set of audio selectors within an input to combine. An input may have multiple audio selector groups. See \"Audio Selector Group\":#inputs-audio_selector_group for more information.", - "smithy.api#jsonName": "audioSelectorGroups" + "smithy.api#documentation": "Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input individually. This setting is disabled by default.", + "smithy.api#jsonName": "imageInserter" } }, "InputClippings": { @@ -8651,13 +8720,6 @@ "smithy.api#jsonName": "inputClippings" } }, - "TimecodeStart": { - "target": "com.amazonaws.mediaconvert#__stringMin11Max11Pattern01D20305D205D", - "traits": { - "smithy.api#documentation": "Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start (SPECIFIEDSTART). For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.", - "smithy.api#jsonName": "timecodeStart" - } - }, "InputScanType": { "target": "com.amazonaws.mediaconvert#InputScanType", "traits": { @@ -8665,60 +8727,46 @@ "smithy.api#jsonName": "inputScanType" } }, - "ImageInserter": { - "target": "com.amazonaws.mediaconvert#ImageInserter", - "traits": { - "smithy.api#documentation": "Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input individually. This setting is disabled by default.", - "smithy.api#jsonName": "imageInserter" - } - }, - "FileInput": { - "target": "com.amazonaws.mediaconvert#__stringPatternS3MM2PPMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLLHttpsMM2VVMMPPEEGGMMPP3AAVVIIMMPP4FFLLVVMMPPTTMMPPGGMM4VVTTRRPPFF4VVMM2TTSSTTSS264HH264MMKKVVMMKKAAMMOOVVMMTTSSMM2TTWWMMVVAASSFFVVOOBB3GGPP3GGPPPPMMXXFFDDIIVVXXXXVVIIDDRRAAWWDDVVGGXXFFMM1VV3GG2VVMMFFMM3UU8WWEEBBMMLLCCHHGGXXFFMMPPEEGG2MMXXFFMMPPEEGG2MMXXFFHHDDWWAAVVYY4MMXXMMLL", - "traits": { - "smithy.api#documentation": "Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, \"s3://bucket/vf/cpl.xml\". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that contain assets referenced by the CPL.", - "smithy.api#jsonName": "fileInput" - } - }, - "DecryptionSettings": { - "target": "com.amazonaws.mediaconvert#InputDecryptionSettings", + "Position": { + "target": "com.amazonaws.mediaconvert#Rectangle", "traits": { - "smithy.api#documentation": "Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt your content.", - "smithy.api#jsonName": "decryptionSettings" + "smithy.api#documentation": "Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black. If you specify a value here, it will override any value that you specify in the output setting Selection placement (position). If you specify a value here, this will override any AFD values in your input, even if you set Respond to AFD (RespondToAfd) to Respond (RESPOND). If you specify a value here, this will ignore anything that you specify for the setting Scaling Behavior (scalingBehavior).", + "smithy.api#jsonName": "position" } }, - "FilterEnable": { - "target": "com.amazonaws.mediaconvert#InputFilterEnable", + "ProgramNumber": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The input is filtered regardless of input type.", - "smithy.api#jsonName": "filterEnable" + "smithy.api#documentation": "Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default.", + "smithy.api#jsonName": "programNumber" } }, - "Crop": { - "target": "com.amazonaws.mediaconvert#Rectangle", + "PsiControl": { + "target": "com.amazonaws.mediaconvert#InputPsiControl", "traits": { - "smithy.api#documentation": "Use Cropping selection (crop) to specify the video area that the service will include in the output video frame. If you specify a value here, it will override any value that you specify in the output setting Cropping selection (crop).", - "smithy.api#jsonName": "crop" + "smithy.api#documentation": "Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data.", + "smithy.api#jsonName": "psiControl" } }, - "DeblockFilter": { - "target": "com.amazonaws.mediaconvert#InputDeblockFilter", + "SupplementalImps": { + "target": "com.amazonaws.mediaconvert#__listOf__stringPatternS3ASSETMAPXml", "traits": { - "smithy.api#documentation": "Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video inputs.", - "smithy.api#jsonName": "deblockFilter" + "smithy.api#documentation": "Provide a list of any necessary supplemental IMPs. You need supplemental IMPs if the CPL that you're using for your input is in an incomplete IMP. Specify either the supplemental IMP directories with a trailing slash or the ASSETMAP.xml files. For example [\"s3://bucket/ov/\", \"s3://bucket/vf2/ASSETMAP.xml\"]. You don't need to specify the IMP that contains your input CPL, because the service automatically detects it.", + "smithy.api#jsonName": "supplementalImps" } }, - "Position": { - "target": "com.amazonaws.mediaconvert#Rectangle", + "TimecodeSource": { + "target": "com.amazonaws.mediaconvert#InputTimecodeSource", "traits": { - "smithy.api#documentation": "Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black. If you specify a value here, it will override any value that you specify in the output setting Selection placement (position). If you specify a value here, this will override any AFD values in your input, even if you set Respond to AFD (RespondToAfd) to Respond (RESPOND). If you specify a value here, this will ignore anything that you specify for the setting Scaling Behavior (scalingBehavior).", - "smithy.api#jsonName": "position" + "smithy.api#documentation": "Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.", + "smithy.api#jsonName": "timecodeSource" } }, - "SupplementalImps": { - "target": "com.amazonaws.mediaconvert#__listOf__stringPatternS3ASSETMAPXml", + "TimecodeStart": { + "target": "com.amazonaws.mediaconvert#__stringMin11Max11Pattern01D20305D205D", "traits": { - "smithy.api#documentation": "Provide a list of any necessary supplemental IMPs. You need supplemental IMPs if the CPL that you're using for your input is in an incomplete IMP. Specify either the supplemental IMP directories with a trailing slash or the ASSETMAP.xml files. For example [\"s3://bucket/ov/\", \"s3://bucket/vf2/ASSETMAP.xml\"]. You don't need to specify the IMP that contains your input CPL, because the service automatically detects it.", - "smithy.api#jsonName": "supplementalImps" + "smithy.api#documentation": "Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start (SPECIFIEDSTART). For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.", + "smithy.api#jsonName": "timecodeStart" } }, "VideoSelector": { @@ -8736,18 +8784,18 @@ "com.amazonaws.mediaconvert#InputClipping": { "type": "structure", "members": { - "StartTimecode": { + "EndTimecode": { "target": "com.amazonaws.mediaconvert#__stringPattern010920405090509092", "traits": { - "smithy.api#documentation": "Set Start timecode (StartTimecode) to the beginning of the portion of the input you are clipping. The frame corresponding to the Start timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for Input timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to begin five minutes into the video, use 01:05:00:00.", - "smithy.api#jsonName": "startTimecode" + "smithy.api#documentation": "Set End timecode (EndTimecode) to the end of the portion of the input you are clipping. The frame corresponding to the End timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for timecode source under input settings (InputTimecodeSource). For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to end six minutes into the video, use 01:06:00:00.", + "smithy.api#jsonName": "endTimecode" } }, - "EndTimecode": { + "StartTimecode": { "target": "com.amazonaws.mediaconvert#__stringPattern010920405090509092", "traits": { - "smithy.api#documentation": "Set End timecode (EndTimecode) to the end of the portion of the input you are clipping. The frame corresponding to the End timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for timecode source under input settings (InputTimecodeSource). For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to end six minutes into the video, use 01:06:00:00.", - "smithy.api#jsonName": "endTimecode" + "smithy.api#documentation": "Set Start timecode (StartTimecode) to the beginning of the portion of the input you are clipping. The frame corresponding to the Start timecode value is included in the clip. Start timecode or End timecode may be left blank, but not both. Use the format HH:MM:SS:FF or HH:MM:SS;FF, where HH is the hour, MM is the minute, SS is the second, and FF is the frame number. When choosing this value, take into account your setting for Input timecode source. For example, if you have embedded timecodes that start at 01:00:00:00 and you want your clip to begin five minutes into the video, use 01:05:00:00.", + "smithy.api#jsonName": "startTimecode" } } }, @@ -8774,6 +8822,20 @@ "com.amazonaws.mediaconvert#InputDecryptionSettings": { "type": "structure", "members": { + "DecryptionMode": { + "target": "com.amazonaws.mediaconvert#DecryptionMode", + "traits": { + "smithy.api#documentation": "Specify the encryption mode that you used to encrypt your input files.", + "smithy.api#jsonName": "decryptionMode" + } + }, + "EncryptedDecryptionKey": { + "target": "com.amazonaws.mediaconvert#__stringMin24Max512PatternAZaZ0902", + "traits": { + "smithy.api#documentation": "Warning! Don't provide your encryption key in plaintext. Your job settings could be intercepted, making your encrypted content vulnerable. Specify the encrypted version of the data key that you used to encrypt your content. The data key must be encrypted by AWS Key Management Service (KMS). The key can be 128, 192, or 256 bits.", + "smithy.api#jsonName": "encryptedDecryptionKey" + } + }, "InitializationVector": { "target": "com.amazonaws.mediaconvert#__stringMin16Max24PatternAZaZ0922AZaZ0916", "traits": { @@ -8787,20 +8849,6 @@ "smithy.api#documentation": "Specify the AWS Region for AWS Key Management Service (KMS) that you used to encrypt your data key, if that Region is different from the one you are using for AWS Elemental MediaConvert.", "smithy.api#jsonName": "kmsKeyRegion" } - }, - "EncryptedDecryptionKey": { - "target": "com.amazonaws.mediaconvert#__stringMin24Max512PatternAZaZ0902", - "traits": { - "smithy.api#documentation": "Warning! Don't provide your encryption key in plaintext. Your job settings could be intercepted, making your encrypted content vulnerable. Specify the encrypted version of the data key that you used to encrypt your content. The data key must be encrypted by AWS Key Management Service (KMS). The key can be 128, 192, or 256 bits.", - "smithy.api#jsonName": "encryptedDecryptionKey" - } - }, - "DecryptionMode": { - "target": "com.amazonaws.mediaconvert#DecryptionMode", - "traits": { - "smithy.api#documentation": "Specify the encryption mode that you used to encrypt your input files.", - "smithy.api#jsonName": "decryptionMode" - } } }, "traits": { @@ -8913,6 +8961,27 @@ "smithy.api#jsonName": "audioSelectorGroups" } }, + "AudioSelectors": { + "target": "com.amazonaws.mediaconvert#__mapOfAudioSelector", + "traits": { + "smithy.api#documentation": "Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use multiple Audio selectors per input.", + "smithy.api#jsonName": "audioSelectors" + } + }, + "CaptionSelectors": { + "target": "com.amazonaws.mediaconvert#__mapOfCaptionSelector", + "traits": { + "smithy.api#documentation": "Use captions selectors to specify the captions data from your input that you use in your outputs. You can use up to 20 captions selectors per input.", + "smithy.api#jsonName": "captionSelectors" + } + }, + "Crop": { + "target": "com.amazonaws.mediaconvert#Rectangle", + "traits": { + "smithy.api#documentation": "Use Cropping selection (crop) to specify the video area that the service will include in the output video frame. If you specify a value here, it will override any value that you specify in the output setting Cropping selection (crop).", + "smithy.api#jsonName": "crop" + } + }, "DeblockFilter": { "target": "com.amazonaws.mediaconvert#InputDeblockFilter", "traits": { @@ -8920,25 +8989,25 @@ "smithy.api#jsonName": "deblockFilter" } }, - "InputClippings": { - "target": "com.amazonaws.mediaconvert#__listOfInputClipping", + "DenoiseFilter": { + "target": "com.amazonaws.mediaconvert#InputDenoiseFilter", "traits": { - "smithy.api#documentation": "(InputClippings) contains sets of start and end times that together specify a portion of the input to be used in the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify them.", - "smithy.api#jsonName": "inputClippings" + "smithy.api#documentation": "Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs.", + "smithy.api#jsonName": "denoiseFilter" } }, - "TimecodeStart": { - "target": "com.amazonaws.mediaconvert#__stringMin11Max11Pattern01D20305D205D", + "FilterEnable": { + "target": "com.amazonaws.mediaconvert#InputFilterEnable", "traits": { - "smithy.api#documentation": "Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start (SPECIFIEDSTART). For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.", - "smithy.api#jsonName": "timecodeStart" + "smithy.api#documentation": "Specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The input is filtered regardless of input type.", + "smithy.api#jsonName": "filterEnable" } }, - "InputScanType": { - "target": "com.amazonaws.mediaconvert#InputScanType", + "FilterStrength": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative5Max5", "traits": { - "smithy.api#documentation": "When you have a progressive segmented frame (PsF) input, use this setting to flag the input as PsF. MediaConvert doesn't automatically detect PsF. Therefore, flagging your input as PsF results in better preservation of video quality when you do deinterlacing and frame rate conversion. If you don't specify, the default value is Auto (AUTO). Auto is the correct setting for all inputs that are not PsF. Don't set this value to PsF when your input is interlaced. Doing so creates horizontal interlacing artifacts.", - "smithy.api#jsonName": "inputScanType" + "smithy.api#documentation": "Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0.", + "smithy.api#jsonName": "filterStrength" } }, "ImageInserter": { @@ -8948,18 +9017,18 @@ "smithy.api#jsonName": "imageInserter" } }, - "ProgramNumber": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "InputClippings": { + "target": "com.amazonaws.mediaconvert#__listOfInputClipping", "traits": { - "smithy.api#documentation": "Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default.", - "smithy.api#jsonName": "programNumber" + "smithy.api#documentation": "(InputClippings) contains sets of start and end times that together specify a portion of the input to be used in the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify them.", + "smithy.api#jsonName": "inputClippings" } }, - "FilterStrength": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative5Max5", + "InputScanType": { + "target": "com.amazonaws.mediaconvert#InputScanType", "traits": { - "smithy.api#documentation": "Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0.", - "smithy.api#jsonName": "filterStrength" + "smithy.api#documentation": "When you have a progressive segmented frame (PsF) input, use this setting to flag the input as PsF. MediaConvert doesn't automatically detect PsF. Therefore, flagging your input as PsF results in better preservation of video quality when you do deinterlacing and frame rate conversion. If you don't specify, the default value is Auto (AUTO). Auto is the correct setting for all inputs that are not PsF. Don't set this value to PsF when your input is interlaced. Doing so creates horizontal interlacing artifacts.", + "smithy.api#jsonName": "inputScanType" } }, "Position": { @@ -8969,6 +9038,13 @@ "smithy.api#jsonName": "position" } }, + "ProgramNumber": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default.", + "smithy.api#jsonName": "programNumber" + } + }, "PsiControl": { "target": "com.amazonaws.mediaconvert#InputPsiControl", "traits": { @@ -8983,18 +9059,11 @@ "smithy.api#jsonName": "timecodeSource" } }, - "AudioSelectors": { - "target": "com.amazonaws.mediaconvert#__mapOfAudioSelector", - "traits": { - "smithy.api#documentation": "Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use multiple Audio selectors per input.", - "smithy.api#jsonName": "audioSelectors" - } - }, - "CaptionSelectors": { - "target": "com.amazonaws.mediaconvert#__mapOfCaptionSelector", + "TimecodeStart": { + "target": "com.amazonaws.mediaconvert#__stringMin11Max11Pattern01D20305D205D", "traits": { - "smithy.api#documentation": "Use captions selectors to specify the captions data from your input that you use in your outputs. You can use up to 20 captions selectors per input.", - "smithy.api#jsonName": "captionSelectors" + "smithy.api#documentation": "Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start (SPECIFIEDSTART). For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.", + "smithy.api#jsonName": "timecodeStart" } }, "VideoSelector": { @@ -9003,27 +9072,6 @@ "smithy.api#documentation": "Selector for video.", "smithy.api#jsonName": "videoSelector" } - }, - "DenoiseFilter": { - "target": "com.amazonaws.mediaconvert#InputDenoiseFilter", - "traits": { - "smithy.api#documentation": "Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs.", - "smithy.api#jsonName": "denoiseFilter" - } - }, - "FilterEnable": { - "target": "com.amazonaws.mediaconvert#InputFilterEnable", - "traits": { - "smithy.api#documentation": "Specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The input is filtered regardless of input type.", - "smithy.api#jsonName": "filterEnable" - } - }, - "Crop": { - "target": "com.amazonaws.mediaconvert#Rectangle", - "traits": { - "smithy.api#documentation": "Use Cropping selection (crop) to specify the video area that the service will include in the output video frame. If you specify a value here, it will override any value that you specify in the output setting Cropping selection (crop).", - "smithy.api#jsonName": "crop" - } } }, "traits": { @@ -9053,13 +9101,6 @@ "com.amazonaws.mediaconvert#InsertableImage": { "type": "structure", "members": { - "Layer": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max99", - "traits": { - "smithy.api#documentation": "Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.", - "smithy.api#jsonName": "layer" - } - }, "Duration": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { @@ -9067,13 +9108,6 @@ "smithy.api#jsonName": "duration" } }, - "StartTime": { - "target": "com.amazonaws.mediaconvert#__stringPattern01D20305D205D", - "traits": { - "smithy.api#documentation": "Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.", - "smithy.api#jsonName": "startTime" - } - }, "FadeIn": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { @@ -9081,11 +9115,11 @@ "smithy.api#jsonName": "fadeIn" } }, - "Width": { + "FadeOut": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.", - "smithy.api#jsonName": "width" + "smithy.api#documentation": "Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration.", + "smithy.api#jsonName": "fadeOut" } }, "Height": { @@ -9095,6 +9129,13 @@ "smithy.api#jsonName": "height" } }, + "ImageInserterInput": { + "target": "com.amazonaws.mediaconvert#__stringMin14PatternS3BmpBMPPngPNGTgaTGAHttpsBmpBMPPngPNGTgaTGA", + "traits": { + "smithy.api#documentation": "Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.", + "smithy.api#jsonName": "imageInserterInput" + } + }, "ImageX": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { @@ -9102,6 +9143,20 @@ "smithy.api#jsonName": "imageX" } }, + "ImageY": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "traits": { + "smithy.api#documentation": "Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.", + "smithy.api#jsonName": "imageY" + } + }, + "Layer": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max99", + "traits": { + "smithy.api#documentation": "Specify how overlapping inserted images appear. Images with higher values for Layer appear on top of images with lower values for Layer.", + "smithy.api#jsonName": "layer" + } + }, "Opacity": { "target": "com.amazonaws.mediaconvert#__integerMin0Max100", "traits": { @@ -9109,25 +9164,18 @@ "smithy.api#jsonName": "opacity" } }, - "ImageInserterInput": { - "target": "com.amazonaws.mediaconvert#__stringMin14PatternS3BmpBMPPngPNGTgaTGAHttpsBmpBMPPngPNGTgaTGA", - "traits": { - "smithy.api#documentation": "Specify the HTTP, HTTPS, or Amazon S3 location of the image that you want to overlay on the video. Use a PNG or TGA file.", - "smithy.api#jsonName": "imageInserterInput" - } - }, - "FadeOut": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "StartTime": { + "target": "com.amazonaws.mediaconvert#__stringPattern01D20305D205D", "traits": { - "smithy.api#documentation": "Specify the length of time, in milliseconds, between the end of the time that you have specified for the image overlay Duration and when the overlaid image has faded to total transparency. If you don't specify a value for Fade-out, the image will disappear abruptly at the end of the inserted image duration.", - "smithy.api#jsonName": "fadeOut" + "smithy.api#documentation": "Specify the timecode of the frame that you want the overlay to first appear on. This must be in timecode (HH:MM:SS:FF or HH:MM:SS;FF) format. Remember to take into account your timecode source settings.", + "smithy.api#jsonName": "startTime" } }, - "ImageY": { + "Width": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Specify the distance, in pixels, between the overlaid image and the top edge of the video frame. Required for any image overlay that you specify.", - "smithy.api#jsonName": "imageY" + "smithy.api#documentation": "Specify the width of the inserted image in pixels. If you specify a value that's larger than the video resolution width, the service will crop your overlaid image to fit. To use the native width of the image, keep this setting blank.", + "smithy.api#jsonName": "width" } } }, @@ -9154,20 +9202,6 @@ "com.amazonaws.mediaconvert#Job": { "type": "structure", "members": { - "QueueTransitions": { - "target": "com.amazonaws.mediaconvert#__listOfQueueTransition", - "traits": { - "smithy.api#documentation": "The job's queue hopping history.", - "smithy.api#jsonName": "queueTransitions" - } - }, - "UserMetadata": { - "target": "com.amazonaws.mediaconvert#__mapOf__string", - "traits": { - "smithy.api#documentation": "User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.", - "smithy.api#jsonName": "userMetadata" - } - }, "AccelerationSettings": { "target": "com.amazonaws.mediaconvert#AccelerationSettings", "traits": { @@ -9175,18 +9209,18 @@ "smithy.api#jsonName": "accelerationSettings" } }, - "JobPercentComplete": { - "target": "com.amazonaws.mediaconvert#__integer", + "AccelerationStatus": { + "target": "com.amazonaws.mediaconvert#AccelerationStatus", "traits": { - "smithy.api#documentation": "An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value.", - "smithy.api#jsonName": "jobPercentComplete" + "smithy.api#documentation": "Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.", + "smithy.api#jsonName": "accelerationStatus" } }, - "StatusUpdateInterval": { - "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", + "Arn": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", - "smithy.api#jsonName": "statusUpdateInterval" + "smithy.api#documentation": "An identifier for this resource that is unique within all of AWS.", + "smithy.api#jsonName": "arn" } }, "BillingTagsSource": { @@ -9196,11 +9230,11 @@ "smithy.api#jsonName": "billingTagsSource" } }, - "Priority": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", + "CreatedAt": { + "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { - "smithy.api#documentation": "Relative priority on the job.", - "smithy.api#jsonName": "priority" + "smithy.api#documentation": "The time, in Unix epoch format in seconds, when the job got created.", + "smithy.api#jsonName": "createdAt" } }, "CurrentPhase": { @@ -9210,40 +9244,18 @@ "smithy.api#jsonName": "currentPhase" } }, - "RetryCount": { + "ErrorCode": { "target": "com.amazonaws.mediaconvert#__integer", "traits": { - "smithy.api#documentation": "The number of times that the service automatically attempted to process your job after encountering an error.", - "smithy.api#jsonName": "retryCount" + "smithy.api#documentation": "Error code for the job", + "smithy.api#jsonName": "errorCode" } }, - "Queue": { + "ErrorMessage": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html", - "smithy.api#jsonName": "queue" - } - }, - "SimulateReservedQueue": { - "target": "com.amazonaws.mediaconvert#SimulateReservedQueue", - "traits": { - "smithy.api#documentation": "Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.", - "smithy.api#jsonName": "simulateReservedQueue" - } - }, - "Settings": { - "target": "com.amazonaws.mediaconvert#JobSettings", - "traits": { - "smithy.api#documentation": "JobSettings contains all the transcode settings for a job.", - "smithy.api#jsonName": "settings", - "smithy.api#required": {} - } - }, - "ErrorCode": { - "target": "com.amazonaws.mediaconvert#__integer", - "traits": { - "smithy.api#documentation": "Error code for the job", - "smithy.api#jsonName": "errorCode" + "smithy.api#documentation": "Error message of Job", + "smithy.api#jsonName": "errorMessage" } }, "HopDestinations": { @@ -9253,13 +9265,6 @@ "smithy.api#jsonName": "hopDestinations" } }, - "OutputGroupDetails": { - "target": "com.amazonaws.mediaconvert#__listOfOutputGroupDetail", - "traits": { - "smithy.api#documentation": "List of output group details", - "smithy.api#jsonName": "outputGroupDetails" - } - }, "Id": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -9267,6 +9272,13 @@ "smithy.api#jsonName": "id" } }, + "JobPercentComplete": { + "target": "com.amazonaws.mediaconvert#__integer", + "traits": { + "smithy.api#documentation": "An estimate of how far your job has progressed. This estimate is shown as a percentage of the total time from when your job leaves its queue to when your output files appear in your output Amazon S3 bucket. AWS Elemental MediaConvert provides jobPercentComplete in CloudWatch STATUS_UPDATE events and in the response to GetJob and ListJobs requests. The jobPercentComplete estimate is reliable for the following input containers: Quicktime, Transport Stream, MP4, and MXF. For some jobs, the service can't provide information about job progress. In those cases, jobPercentComplete returns a null value.", + "smithy.api#jsonName": "jobPercentComplete" + } + }, "JobTemplate": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -9274,13 +9286,6 @@ "smithy.api#jsonName": "jobTemplate" } }, - "Timing": { - "target": "com.amazonaws.mediaconvert#Timing", - "traits": { - "smithy.api#documentation": "Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.", - "smithy.api#jsonName": "timing" - } - }, "Messages": { "target": "com.amazonaws.mediaconvert#JobMessages", "traits": { @@ -9288,18 +9293,39 @@ "smithy.api#jsonName": "messages" } }, - "AccelerationStatus": { - "target": "com.amazonaws.mediaconvert#AccelerationStatus", + "OutputGroupDetails": { + "target": "com.amazonaws.mediaconvert#__listOfOutputGroupDetail", "traits": { - "smithy.api#documentation": "Describes whether the current job is running with accelerated transcoding. For jobs that have Acceleration (AccelerationMode) set to DISABLED, AccelerationStatus is always NOT_APPLICABLE. For jobs that have Acceleration (AccelerationMode) set to ENABLED or PREFERRED, AccelerationStatus is one of the other states. AccelerationStatus is IN_PROGRESS initially, while the service determines whether the input files and job settings are compatible with accelerated transcoding. If they are, AcclerationStatus is ACCELERATED. If your input files and job settings aren't compatible with accelerated transcoding, the service either fails your job or runs it without accelerated transcoding, depending on how you set Acceleration (AccelerationMode). When the service runs your job without accelerated transcoding, AccelerationStatus is NOT_ACCELERATED.", - "smithy.api#jsonName": "accelerationStatus" + "smithy.api#documentation": "List of output group details", + "smithy.api#jsonName": "outputGroupDetails" } }, - "CreatedAt": { - "target": "com.amazonaws.mediaconvert#__timestampUnix", + "Priority": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", "traits": { - "smithy.api#documentation": "The time, in Unix epoch format in seconds, when the job got created.", - "smithy.api#jsonName": "createdAt" + "smithy.api#documentation": "Relative priority on the job.", + "smithy.api#jsonName": "priority" + } + }, + "Queue": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "When you create a job, you can specify a queue to send it to. If you don't specify, the job will go to the default queue. For more about queues, see the User Guide topic at https://docs.aws.amazon.com/mediaconvert/latest/ug/what-is.html", + "smithy.api#jsonName": "queue" + } + }, + "QueueTransitions": { + "target": "com.amazonaws.mediaconvert#__listOfQueueTransition", + "traits": { + "smithy.api#documentation": "The job's queue hopping history.", + "smithy.api#jsonName": "queueTransitions" + } + }, + "RetryCount": { + "target": "com.amazonaws.mediaconvert#__integer", + "traits": { + "smithy.api#documentation": "The number of times that the service automatically attempted to process your job after encountering an error.", + "smithy.api#jsonName": "retryCount" } }, "Role": { @@ -9310,6 +9336,21 @@ "smithy.api#required": {} } }, + "Settings": { + "target": "com.amazonaws.mediaconvert#JobSettings", + "traits": { + "smithy.api#documentation": "JobSettings contains all the transcode settings for a job.", + "smithy.api#jsonName": "settings", + "smithy.api#required": {} + } + }, + "SimulateReservedQueue": { + "target": "com.amazonaws.mediaconvert#SimulateReservedQueue", + "traits": { + "smithy.api#documentation": "Enable this setting when you run a test job to estimate how many reserved transcoding slots (RTS) you need. When this is enabled, MediaConvert runs your job from an on-demand queue with similar performance to what you will see with one RTS in a reserved queue. This setting is disabled by default.", + "smithy.api#jsonName": "simulateReservedQueue" + } + }, "Status": { "target": "com.amazonaws.mediaconvert#JobStatus", "traits": { @@ -9317,18 +9358,25 @@ "smithy.api#jsonName": "status" } }, - "Arn": { - "target": "com.amazonaws.mediaconvert#__string", + "StatusUpdateInterval": { + "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", "traits": { - "smithy.api#documentation": "An identifier for this resource that is unique within all of AWS.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", + "smithy.api#jsonName": "statusUpdateInterval" } }, - "ErrorMessage": { - "target": "com.amazonaws.mediaconvert#__string", + "Timing": { + "target": "com.amazonaws.mediaconvert#Timing", "traits": { - "smithy.api#documentation": "Error message of Job", - "smithy.api#jsonName": "errorMessage" + "smithy.api#documentation": "Information about when jobs are submitted, started, and finished is specified in Unix epoch format in seconds.", + "smithy.api#jsonName": "timing" + } + }, + "UserMetadata": { + "target": "com.amazonaws.mediaconvert#__mapOf__string", + "traits": { + "smithy.api#documentation": "User-defined metadata that you want to associate with an MediaConvert job. You specify metadata in key/value pairs.", + "smithy.api#jsonName": "userMetadata" } } }, @@ -9381,6 +9429,13 @@ "com.amazonaws.mediaconvert#JobSettings": { "type": "structure", "members": { + "AdAvailOffset": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative1000Max1000", + "traits": { + "smithy.api#documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.", + "smithy.api#jsonName": "adAvailOffset" + } + }, "AvailBlanking": { "target": "com.amazonaws.mediaconvert#AvailBlanking", "traits": { @@ -9388,13 +9443,6 @@ "smithy.api#jsonName": "availBlanking" } }, - "NielsenConfiguration": { - "target": "com.amazonaws.mediaconvert#NielsenConfiguration", - "traits": { - "smithy.api#documentation": "Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting.", - "smithy.api#jsonName": "nielsenConfiguration" - } - }, "Esam": { "target": "com.amazonaws.mediaconvert#EsamSettings", "traits": { @@ -9402,25 +9450,11 @@ "smithy.api#jsonName": "esam" } }, - "TimecodeConfig": { - "target": "com.amazonaws.mediaconvert#TimecodeConfig", - "traits": { - "smithy.api#documentation": "Contains settings used to acquire and adjust timecode information from inputs.", - "smithy.api#jsonName": "timecodeConfig" - } - }, - "NielsenNonLinearWatermark": { - "target": "com.amazonaws.mediaconvert#NielsenNonLinearWatermarkSettings", - "traits": { - "smithy.api#documentation": "Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]", - "smithy.api#jsonName": "nielsenNonLinearWatermark" - } - }, - "AdAvailOffset": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative1000Max1000", + "Inputs": { + "target": "com.amazonaws.mediaconvert#__listOfInput", "traits": { - "smithy.api#documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.", - "smithy.api#jsonName": "adAvailOffset" + "smithy.api#documentation": "Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.", + "smithy.api#jsonName": "inputs" } }, "MotionImageInserter": { @@ -9430,11 +9464,18 @@ "smithy.api#jsonName": "motionImageInserter" } }, - "Inputs": { - "target": "com.amazonaws.mediaconvert#__listOfInput", + "NielsenConfiguration": { + "target": "com.amazonaws.mediaconvert#NielsenConfiguration", "traits": { - "smithy.api#documentation": "Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.", - "smithy.api#jsonName": "inputs" + "smithy.api#documentation": "Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting.", + "smithy.api#jsonName": "nielsenConfiguration" + } + }, + "NielsenNonLinearWatermark": { + "target": "com.amazonaws.mediaconvert#NielsenNonLinearWatermarkSettings", + "traits": { + "smithy.api#documentation": "Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]", + "smithy.api#jsonName": "nielsenNonLinearWatermark" } }, "OutputGroups": { @@ -9444,6 +9485,13 @@ "smithy.api#jsonName": "outputGroups" } }, + "TimecodeConfig": { + "target": "com.amazonaws.mediaconvert#TimecodeConfig", + "traits": { + "smithy.api#documentation": "Contains settings used to acquire and adjust timecode information from inputs.", + "smithy.api#jsonName": "timecodeConfig" + } + }, "TimedMetadataInsertion": { "target": "com.amazonaws.mediaconvert#TimedMetadataInsertion", "traits": { @@ -9487,13 +9535,6 @@ "com.amazonaws.mediaconvert#JobTemplate": { "type": "structure", "members": { - "HopDestinations": { - "target": "com.amazonaws.mediaconvert#__listOfHopDestination", - "traits": { - "smithy.api#documentation": "Optional list of hop destinations.", - "smithy.api#jsonName": "hopDestinations" - } - }, "AccelerationSettings": { "target": "com.amazonaws.mediaconvert#AccelerationSettings", "traits": { @@ -9501,26 +9542,18 @@ "smithy.api#jsonName": "accelerationSettings" } }, - "Type": { - "target": "com.amazonaws.mediaconvert#Type", - "traits": { - "smithy.api#documentation": "A job template can be of two types: system or custom. System or built-in job templates can't be modified or deleted by the user.", - "smithy.api#jsonName": "type" - } - }, - "Name": { + "Arn": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "A name you create for each job template. Each name must be unique within your account.", - "smithy.api#jsonName": "name", - "smithy.api#required": {} + "smithy.api#documentation": "An identifier for this resource that is unique within all of AWS.", + "smithy.api#jsonName": "arn" } }, - "Queue": { + "Category": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue.", - "smithy.api#jsonName": "queue" + "smithy.api#documentation": "An optional category you create to organize your job templates.", + "smithy.api#jsonName": "category" } }, "CreatedAt": { @@ -9537,18 +9570,40 @@ "smithy.api#jsonName": "description" } }, - "Category": { + "HopDestinations": { + "target": "com.amazonaws.mediaconvert#__listOfHopDestination", + "traits": { + "smithy.api#documentation": "Optional list of hop destinations.", + "smithy.api#jsonName": "hopDestinations" + } + }, + "LastUpdated": { + "target": "com.amazonaws.mediaconvert#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp in epoch seconds when the Job template was last updated.", + "smithy.api#jsonName": "lastUpdated" + } + }, + "Name": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "An optional category you create to organize your job templates.", - "smithy.api#jsonName": "category" + "smithy.api#documentation": "A name you create for each job template. Each name must be unique within your account.", + "smithy.api#jsonName": "name", + "smithy.api#required": {} } }, - "Arn": { + "Priority": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", + "traits": { + "smithy.api#documentation": "Relative priority on the job.", + "smithy.api#jsonName": "priority" + } + }, + "Queue": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "An identifier for this resource that is unique within all of AWS.", - "smithy.api#jsonName": "arn" + "smithy.api#documentation": "Optional. The queue that jobs created from this template are assigned to. If you don't specify this, jobs will go to the default queue.", + "smithy.api#jsonName": "queue" } }, "Settings": { @@ -9566,18 +9621,11 @@ "smithy.api#jsonName": "statusUpdateInterval" } }, - "LastUpdated": { - "target": "com.amazonaws.mediaconvert#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp in epoch seconds when the Job template was last updated.", - "smithy.api#jsonName": "lastUpdated" - } - }, - "Priority": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", + "Type": { + "target": "com.amazonaws.mediaconvert#Type", "traits": { - "smithy.api#documentation": "Relative priority on the job.", - "smithy.api#jsonName": "priority" + "smithy.api#documentation": "A job template can be of two types: system or custom. System or built-in job templates can't be modified or deleted by the user.", + "smithy.api#jsonName": "type" } } }, @@ -9608,39 +9656,39 @@ "com.amazonaws.mediaconvert#JobTemplateSettings": { "type": "structure", "members": { - "Inputs": { - "target": "com.amazonaws.mediaconvert#__listOfInputTemplate", + "AdAvailOffset": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative1000Max1000", "traits": { - "smithy.api#documentation": "Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template.", - "smithy.api#jsonName": "inputs" + "smithy.api#documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.", + "smithy.api#jsonName": "adAvailOffset" } }, - "MotionImageInserter": { - "target": "com.amazonaws.mediaconvert#MotionImageInserter", + "AvailBlanking": { + "target": "com.amazonaws.mediaconvert#AvailBlanking", "traits": { - "smithy.api#documentation": "Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups.", - "smithy.api#jsonName": "motionImageInserter" + "smithy.api#documentation": "Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.", + "smithy.api#jsonName": "availBlanking" } }, - "NielsenNonLinearWatermark": { - "target": "com.amazonaws.mediaconvert#NielsenNonLinearWatermarkSettings", + "Esam": { + "target": "com.amazonaws.mediaconvert#EsamSettings", "traits": { - "smithy.api#documentation": "Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]", - "smithy.api#jsonName": "nielsenNonLinearWatermark" + "smithy.api#documentation": "Settings for Event Signaling And Messaging (ESAM).", + "smithy.api#jsonName": "esam" } }, - "TimecodeConfig": { - "target": "com.amazonaws.mediaconvert#TimecodeConfig", + "Inputs": { + "target": "com.amazonaws.mediaconvert#__listOfInputTemplate", "traits": { - "smithy.api#documentation": "Contains settings used to acquire and adjust timecode information from inputs.", - "smithy.api#jsonName": "timecodeConfig" + "smithy.api#documentation": "Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template.", + "smithy.api#jsonName": "inputs" } }, - "OutputGroups": { - "target": "com.amazonaws.mediaconvert#__listOfOutputGroup", + "MotionImageInserter": { + "target": "com.amazonaws.mediaconvert#MotionImageInserter", "traits": { - "smithy.api#documentation": "(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings", - "smithy.api#jsonName": "outputGroups" + "smithy.api#documentation": "Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups.", + "smithy.api#jsonName": "motionImageInserter" } }, "NielsenConfiguration": { @@ -9650,32 +9698,32 @@ "smithy.api#jsonName": "nielsenConfiguration" } }, - "AvailBlanking": { - "target": "com.amazonaws.mediaconvert#AvailBlanking", + "NielsenNonLinearWatermark": { + "target": "com.amazonaws.mediaconvert#NielsenNonLinearWatermarkSettings", "traits": { - "smithy.api#documentation": "Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.", - "smithy.api#jsonName": "availBlanking" + "smithy.api#documentation": "Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]", + "smithy.api#jsonName": "nielsenNonLinearWatermark" } }, - "TimedMetadataInsertion": { - "target": "com.amazonaws.mediaconvert#TimedMetadataInsertion", + "OutputGroups": { + "target": "com.amazonaws.mediaconvert#__listOfOutputGroup", "traits": { - "smithy.api#documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.", - "smithy.api#jsonName": "timedMetadataInsertion" + "smithy.api#documentation": "(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings", + "smithy.api#jsonName": "outputGroups" } }, - "Esam": { - "target": "com.amazonaws.mediaconvert#EsamSettings", + "TimecodeConfig": { + "target": "com.amazonaws.mediaconvert#TimecodeConfig", "traits": { - "smithy.api#documentation": "Settings for Event Signaling And Messaging (ESAM).", - "smithy.api#jsonName": "esam" + "smithy.api#documentation": "Contains settings used to acquire and adjust timecode information from inputs.", + "smithy.api#jsonName": "timecodeConfig" } }, - "AdAvailOffset": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative1000Max1000", + "TimedMetadataInsertion": { + "target": "com.amazonaws.mediaconvert#TimedMetadataInsertion", "traits": { - "smithy.api#documentation": "When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.", - "smithy.api#jsonName": "adAvailOffset" + "smithy.api#documentation": "Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.", + "smithy.api#jsonName": "timedMetadataInsertion" } } }, @@ -10501,6 +10549,13 @@ "com.amazonaws.mediaconvert#ListJobTemplatesRequest": { "type": "structure", "members": { + "Category": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Optionally, specify a job template category to limit responses to only job templates from that category.", + "smithy.api#httpQuery": "category" + } + }, "ListBy": { "target": "com.amazonaws.mediaconvert#JobTemplateListBy", "traits": { @@ -10508,13 +10563,6 @@ "smithy.api#httpQuery": "listBy" } }, - "NextToken": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Use this string, provided with the response to a previous request, to request the next batch of job templates.", - "smithy.api#httpQuery": "nextToken" - } - }, "MaxResults": { "target": "com.amazonaws.mediaconvert#__integerMin1Max20", "traits": { @@ -10522,38 +10570,38 @@ "smithy.api#httpQuery": "maxResults" } }, + "NextToken": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Use this string, provided with the response to a previous request, to request the next batch of job templates.", + "smithy.api#httpQuery": "nextToken" + } + }, "Order": { "target": "com.amazonaws.mediaconvert#Order", "traits": { "smithy.api#documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", "smithy.api#httpQuery": "order" } - }, - "Category": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Optionally, specify a job template category to limit responses to only job templates from that category.", - "smithy.api#httpQuery": "category" - } } } }, "com.amazonaws.mediaconvert#ListJobTemplatesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Use this string to request the next batch of job templates.", - "smithy.api#jsonName": "nextToken" - } - }, "JobTemplates": { "target": "com.amazonaws.mediaconvert#__listOfJobTemplate", "traits": { "smithy.api#documentation": "List of Job templates.", "smithy.api#jsonName": "jobTemplates" } + }, + "NextToken": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Use this string to request the next batch of job templates.", + "smithy.api#jsonName": "nextToken" + } } } }, @@ -10603,6 +10651,13 @@ "com.amazonaws.mediaconvert#ListJobsRequest": { "type": "structure", "members": { + "MaxResults": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max20", + "traits": { + "smithy.api#documentation": "Optional. Number of jobs, up to twenty, that will be returned at one time.", + "smithy.api#httpQuery": "maxResults" + } + }, "NextToken": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -10610,6 +10665,13 @@ "smithy.api#httpQuery": "nextToken" } }, + "Order": { + "target": "com.amazonaws.mediaconvert#Order", + "traits": { + "smithy.api#documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", + "smithy.api#httpQuery": "order" + } + }, "Queue": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -10623,39 +10685,25 @@ "smithy.api#documentation": "Optional. A job's status can be SUBMITTED, PROGRESSING, COMPLETE, CANCELED, or ERROR.", "smithy.api#httpQuery": "status" } - }, - "MaxResults": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max20", - "traits": { - "smithy.api#documentation": "Optional. Number of jobs, up to twenty, that will be returned at one time.", - "smithy.api#httpQuery": "maxResults" - } - }, - "Order": { - "target": "com.amazonaws.mediaconvert#Order", - "traits": { - "smithy.api#documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", - "smithy.api#httpQuery": "order" - } } } }, "com.amazonaws.mediaconvert#ListJobsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Use this string to request the next batch of jobs.", - "smithy.api#jsonName": "nextToken" - } - }, "Jobs": { "target": "com.amazonaws.mediaconvert#__listOfJob", "traits": { "smithy.api#documentation": "List of jobs", "smithy.api#jsonName": "jobs" } + }, + "NextToken": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Use this string to request the next batch of jobs.", + "smithy.api#jsonName": "nextToken" + } } } }, @@ -10705,11 +10753,18 @@ "com.amazonaws.mediaconvert#ListPresetsRequest": { "type": "structure", "members": { - "Order": { - "target": "com.amazonaws.mediaconvert#Order", + "Category": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", - "smithy.api#httpQuery": "order" + "smithy.api#documentation": "Optionally, specify a preset category to limit responses to only presets from that category.", + "smithy.api#httpQuery": "category" + } + }, + "ListBy": { + "target": "com.amazonaws.mediaconvert#PresetListBy", + "traits": { + "smithy.api#documentation": "Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.", + "smithy.api#httpQuery": "listBy" } }, "MaxResults": { @@ -10719,13 +10774,6 @@ "smithy.api#httpQuery": "maxResults" } }, - "Category": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Optionally, specify a preset category to limit responses to only presets from that category.", - "smithy.api#httpQuery": "category" - } - }, "NextToken": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -10733,11 +10781,11 @@ "smithy.api#httpQuery": "nextToken" } }, - "ListBy": { - "target": "com.amazonaws.mediaconvert#PresetListBy", + "Order": { + "target": "com.amazonaws.mediaconvert#Order", "traits": { - "smithy.api#documentation": "Optional. When you request a list of presets, you can choose to list them alphabetically by NAME or chronologically by CREATION_DATE. If you don't specify, the service will list them by name.", - "smithy.api#httpQuery": "listBy" + "smithy.api#documentation": "Optional. When you request lists of resources, you can specify whether they are sorted in ASCENDING or DESCENDING order. Default varies by resource.", + "smithy.api#httpQuery": "order" } } } @@ -10745,19 +10793,19 @@ "com.amazonaws.mediaconvert#ListPresetsResponse": { "type": "structure", "members": { - "Presets": { - "target": "com.amazonaws.mediaconvert#__listOfPreset", - "traits": { - "smithy.api#documentation": "List of presets", - "smithy.api#jsonName": "presets" - } - }, "NextToken": { "target": "com.amazonaws.mediaconvert#__string", "traits": { "smithy.api#documentation": "Use this string to request the next batch of presets.", "smithy.api#jsonName": "nextToken" } + }, + "Presets": { + "target": "com.amazonaws.mediaconvert#__listOfPreset", + "traits": { + "smithy.api#documentation": "List of presets", + "smithy.api#jsonName": "presets" + } } } }, @@ -10807,13 +10855,6 @@ "com.amazonaws.mediaconvert#ListQueuesRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max20", - "traits": { - "smithy.api#documentation": "Optional. Number of queues, up to twenty, that will be returned at one time.", - "smithy.api#httpQuery": "maxResults" - } - }, "ListBy": { "target": "com.amazonaws.mediaconvert#QueueListBy", "traits": { @@ -10821,6 +10862,13 @@ "smithy.api#httpQuery": "listBy" } }, + "MaxResults": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max20", + "traits": { + "smithy.api#documentation": "Optional. Number of queues, up to twenty, that will be returned at one time.", + "smithy.api#httpQuery": "maxResults" + } + }, "NextToken": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -11144,11 +11192,11 @@ "com.amazonaws.mediaconvert#M2tsSettings": { "type": "structure", "members": { - "SegmentationTime": { - "target": "com.amazonaws.mediaconvert#__doubleMin0", + "AudioBufferModel": { + "target": "com.amazonaws.mediaconvert#M2tsAudioBufferModel", "traits": { - "smithy.api#documentation": "Specify the length, in seconds, of each segment. Required unless markers is set to _none_.", - "smithy.api#jsonName": "segmentationTime" + "smithy.api#documentation": "Selects between the DVB and ATSC buffer models for Dolby Digital audio.", + "smithy.api#jsonName": "audioBufferModel" } }, "AudioFramesPerPes": { @@ -11158,60 +11206,18 @@ "smithy.api#jsonName": "audioFramesPerPes" } }, - "PcrPid": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", - "traits": { - "smithy.api#documentation": "Specify the packet identifier (PID) for the program clock reference (PCR) in this output. If you do not specify a value, the service will use the value for Video PID (VideoPid).", - "smithy.api#jsonName": "pcrPid" - } - }, - "PrivateMetadataPid": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", - "traits": { - "smithy.api#documentation": "Specify the packet identifier (PID) of the private metadata stream. Default is 503.", - "smithy.api#jsonName": "privateMetadataPid" - } - }, - "Scte35Pid": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", - "traits": { - "smithy.api#documentation": "Specify the packet identifier (PID) of the SCTE-35 stream in the transport stream.", - "smithy.api#jsonName": "scte35Pid" - } - }, - "FragmentTime": { - "target": "com.amazonaws.mediaconvert#__doubleMin0", - "traits": { - "smithy.api#documentation": "The length, in seconds, of each fragment. Only used with EBP markers.", - "smithy.api#jsonName": "fragmentTime" - } - }, - "DvbSdtSettings": { - "target": "com.amazonaws.mediaconvert#DvbSdtSettings", - "traits": { - "smithy.api#documentation": "Inserts DVB Service Description Table (NIT) at the specified table repetition interval.", - "smithy.api#jsonName": "dvbSdtSettings" - } - }, - "MinEbpInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max10000", - "traits": { - "smithy.api#documentation": "When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is \"stretched\" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.", - "smithy.api#jsonName": "minEbpInterval" - } - }, - "AudioBufferModel": { - "target": "com.amazonaws.mediaconvert#M2tsAudioBufferModel", + "AudioPids": { + "target": "com.amazonaws.mediaconvert#__listOf__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Selects between the DVB and ATSC buffer models for Dolby Digital audio.", - "smithy.api#jsonName": "audioBufferModel" + "smithy.api#documentation": "Specify the packet identifiers (PIDs) for any elementary audio streams you include in this output. Specify multiple PIDs as a JSON array. Default is the range 482-492.", + "smithy.api#jsonName": "audioPids" } }, - "ForceTsVideoEbpOrder": { - "target": "com.amazonaws.mediaconvert#M2tsForceTsVideoEbpOrder", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force (FORCE).", - "smithy.api#jsonName": "forceTsVideoEbpOrder" + "smithy.api#documentation": "Specify the output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. Other common values are 3750000, 7500000, and 15000000.", + "smithy.api#jsonName": "bitrate" } }, "BufferModel": { @@ -11221,39 +11227,32 @@ "smithy.api#jsonName": "bufferModel" } }, - "VideoPid": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", - "traits": { - "smithy.api#documentation": "Specify the packet identifier (PID) of the elementary video stream in the transport stream.", - "smithy.api#jsonName": "videoPid" - } - }, - "NielsenId3": { - "target": "com.amazonaws.mediaconvert#M2tsNielsenId3", + "DvbNitSettings": { + "target": "com.amazonaws.mediaconvert#DvbNitSettings", "traits": { - "smithy.api#documentation": "If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.", - "smithy.api#jsonName": "nielsenId3" + "smithy.api#documentation": "Inserts DVB Network Information Table (NIT) at the specified table repetition interval.", + "smithy.api#jsonName": "dvbNitSettings" } }, - "EbpAudioInterval": { - "target": "com.amazonaws.mediaconvert#M2tsEbpAudioInterval", + "DvbSdtSettings": { + "target": "com.amazonaws.mediaconvert#DvbSdtSettings", "traits": { - "smithy.api#documentation": "When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).", - "smithy.api#jsonName": "ebpAudioInterval" + "smithy.api#documentation": "Inserts DVB Service Description Table (NIT) at the specified table repetition interval.", + "smithy.api#jsonName": "dvbSdtSettings" } }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "DvbSubPids": { + "target": "com.amazonaws.mediaconvert#__listOf__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Specify the output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate. Other common values are 3750000, 7500000, and 15000000.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "Specify the packet identifiers (PIDs) for DVB subtitle data included in this output. Specify multiple PIDs as a JSON array. Default is the range 460-479.", + "smithy.api#jsonName": "dvbSubPids" } }, - "MaxPcrInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max500", + "DvbTdtSettings": { + "target": "com.amazonaws.mediaconvert#DvbTdtSettings", "traits": { - "smithy.api#documentation": "Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream.", - "smithy.api#jsonName": "maxPcrInterval" + "smithy.api#documentation": "Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.", + "smithy.api#jsonName": "dvbTdtSettings" } }, "DvbTeletextPid": { @@ -11263,6 +11262,13 @@ "smithy.api#jsonName": "dvbTeletextPid" } }, + "EbpAudioInterval": { + "target": "com.amazonaws.mediaconvert#M2tsEbpAudioInterval", + "traits": { + "smithy.api#documentation": "When set to VIDEO_AND_FIXED_INTERVALS, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. When set to VIDEO_INTERVAL, these additional markers will not be inserted. Only applicable when EBP segmentation markers are is selected (segmentationMarkers is EBP or EBP_LEGACY).", + "smithy.api#jsonName": "ebpAudioInterval" + } + }, "EbpPlacement": { "target": "com.amazonaws.mediaconvert#M2tsEbpPlacement", "traits": { @@ -11270,32 +11276,46 @@ "smithy.api#jsonName": "ebpPlacement" } }, - "DvbSubPids": { - "target": "com.amazonaws.mediaconvert#__listOf__integerMin32Max8182", + "EsRateInPes": { + "target": "com.amazonaws.mediaconvert#M2tsEsRateInPes", "traits": { - "smithy.api#documentation": "Specify the packet identifiers (PIDs) for DVB subtitle data included in this output. Specify multiple PIDs as a JSON array. Default is the range 460-479.", - "smithy.api#jsonName": "dvbSubPids" + "smithy.api#documentation": "Controls whether to include the ES Rate field in the PES header.", + "smithy.api#jsonName": "esRateInPes" } }, - "Scte35Esam": { - "target": "com.amazonaws.mediaconvert#M2tsScte35Esam", + "ForceTsVideoEbpOrder": { + "target": "com.amazonaws.mediaconvert#M2tsForceTsVideoEbpOrder", "traits": { - "smithy.api#documentation": "Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).", - "smithy.api#jsonName": "scte35Esam" + "smithy.api#documentation": "Keep the default value (DEFAULT) unless you know that your audio EBP markers are incorrectly appearing before your video EBP markers. To correct this problem, set this value to Force (FORCE).", + "smithy.api#jsonName": "forceTsVideoEbpOrder" } }, - "TimedMetadataPid": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", + "FragmentTime": { + "target": "com.amazonaws.mediaconvert#__doubleMin0", "traits": { - "smithy.api#documentation": "Specify the packet identifier (PID) for timed metadata in this output. Default is 502.", - "smithy.api#jsonName": "timedMetadataPid" + "smithy.api#documentation": "The length, in seconds, of each fragment. Only used with EBP markers.", + "smithy.api#jsonName": "fragmentTime" } }, - "PmtInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max1000", + "MaxPcrInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max500", "traits": { - "smithy.api#documentation": "Specify the number of milliseconds between instances of the program map table (PMT) in the output transport stream.", - "smithy.api#jsonName": "pmtInterval" + "smithy.api#documentation": "Specify the maximum time, in milliseconds, between Program Clock References (PCRs) inserted into the transport stream.", + "smithy.api#jsonName": "maxPcrInterval" + } + }, + "MinEbpInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max10000", + "traits": { + "smithy.api#documentation": "When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is \"stretched\" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.", + "smithy.api#jsonName": "minEbpInterval" + } + }, + "NielsenId3": { + "target": "com.amazonaws.mediaconvert#M2tsNielsenId3", + "traits": { + "smithy.api#documentation": "If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.", + "smithy.api#jsonName": "nielsenId3" } }, "NullPacketBitrate": { @@ -11305,11 +11325,11 @@ "smithy.api#jsonName": "nullPacketBitrate" } }, - "RateMode": { - "target": "com.amazonaws.mediaconvert#M2tsRateMode", + "PatInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max1000", "traits": { - "smithy.api#documentation": "When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate.", - "smithy.api#jsonName": "rateMode" + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", + "smithy.api#jsonName": "patInterval" } }, "PcrControl": { @@ -11319,67 +11339,67 @@ "smithy.api#jsonName": "pcrControl" } }, - "DvbTdtSettings": { - "target": "com.amazonaws.mediaconvert#DvbTdtSettings", + "PcrPid": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.", - "smithy.api#jsonName": "dvbTdtSettings" + "smithy.api#documentation": "Specify the packet identifier (PID) for the program clock reference (PCR) in this output. If you do not specify a value, the service will use the value for Video PID (VideoPid).", + "smithy.api#jsonName": "pcrPid" } }, - "ProgramNumber": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", + "PmtInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max1000", "traits": { - "smithy.api#documentation": "Use Program number (programNumber) to specify the program number used in the program map table (PMT) for this output. Default is 1. Program numbers and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.", - "smithy.api#jsonName": "programNumber" + "smithy.api#documentation": "Specify the number of milliseconds between instances of the program map table (PMT) in the output transport stream.", + "smithy.api#jsonName": "pmtInterval" } }, - "AudioPids": { - "target": "com.amazonaws.mediaconvert#__listOf__integerMin32Max8182", + "PmtPid": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Specify the packet identifiers (PIDs) for any elementary audio streams you include in this output. Specify multiple PIDs as a JSON array. Default is the range 482-492.", - "smithy.api#jsonName": "audioPids" + "smithy.api#documentation": "Specify the packet identifier (PID) for the program map table (PMT) itself. Default is 480.", + "smithy.api#jsonName": "pmtPid" } }, - "TransportStreamId": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", + "PrivateMetadataPid": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Specify the ID for the transport stream itself in the program map table for this output. Transport stream IDs and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.", - "smithy.api#jsonName": "transportStreamId" + "smithy.api#documentation": "Specify the packet identifier (PID) of the private metadata stream. Default is 503.", + "smithy.api#jsonName": "privateMetadataPid" } }, - "DvbNitSettings": { - "target": "com.amazonaws.mediaconvert#DvbNitSettings", + "ProgramNumber": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", "traits": { - "smithy.api#documentation": "Inserts DVB Network Information Table (NIT) at the specified table repetition interval.", - "smithy.api#jsonName": "dvbNitSettings" + "smithy.api#documentation": "Use Program number (programNumber) to specify the program number used in the program map table (PMT) for this output. Default is 1. Program numbers and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.", + "smithy.api#jsonName": "programNumber" } }, - "Scte35Source": { - "target": "com.amazonaws.mediaconvert#M2tsScte35Source", + "RateMode": { + "target": "com.amazonaws.mediaconvert#M2tsRateMode", "traits": { - "smithy.api#documentation": "For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). Also enable ESAM SCTE-35 (include the property scte35Esam).", - "smithy.api#jsonName": "scte35Source" + "smithy.api#documentation": "When set to CBR, inserts null packets into transport stream to fill specified bitrate. When set to VBR, the bitrate setting acts as the maximum bitrate, but the output will not be padded up to that bitrate.", + "smithy.api#jsonName": "rateMode" } }, - "PmtPid": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", + "Scte35Esam": { + "target": "com.amazonaws.mediaconvert#M2tsScte35Esam", "traits": { - "smithy.api#documentation": "Specify the packet identifier (PID) for the program map table (PMT) itself. Default is 480.", - "smithy.api#jsonName": "pmtPid" + "smithy.api#documentation": "Include this in your job settings to put SCTE-35 markers in your HLS and transport stream outputs at the insertion points that you specify in an ESAM XML document. Provide the document in the setting SCC XML (sccXml).", + "smithy.api#jsonName": "scte35Esam" } }, - "PatInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max1000", + "Scte35Pid": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", - "smithy.api#jsonName": "patInterval" + "smithy.api#documentation": "Specify the packet identifier (PID) of the SCTE-35 stream in the transport stream.", + "smithy.api#jsonName": "scte35Pid" } }, - "EsRateInPes": { - "target": "com.amazonaws.mediaconvert#M2tsEsRateInPes", + "Scte35Source": { + "target": "com.amazonaws.mediaconvert#M2tsScte35Source", "traits": { - "smithy.api#documentation": "Controls whether to include the ES Rate field in the PES header.", - "smithy.api#jsonName": "esRateInPes" + "smithy.api#documentation": "For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE). Also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml). Also enable ESAM SCTE-35 (include the property scte35Esam).", + "smithy.api#jsonName": "scte35Source" } }, "SegmentationMarkers": { @@ -11395,6 +11415,34 @@ "smithy.api#documentation": "The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of \"reset_cadence\" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of of $segmentation_time seconds. When a segmentation style of \"maintain_cadence\" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentation_time seconds. Note that EBP lookahead is a slight exception to this rule.", "smithy.api#jsonName": "segmentationStyle" } + }, + "SegmentationTime": { + "target": "com.amazonaws.mediaconvert#__doubleMin0", + "traits": { + "smithy.api#documentation": "Specify the length, in seconds, of each segment. Required unless markers is set to _none_.", + "smithy.api#jsonName": "segmentationTime" + } + }, + "TimedMetadataPid": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", + "traits": { + "smithy.api#documentation": "Specify the packet identifier (PID) for timed metadata in this output. Default is 502.", + "smithy.api#jsonName": "timedMetadataPid" + } + }, + "TransportStreamId": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", + "traits": { + "smithy.api#documentation": "Specify the ID for the transport stream itself in the program map table for this output. Transport stream IDs and program map tables are parts of MPEG-2 transport stream containers, used for organizing data.", + "smithy.api#jsonName": "transportStreamId" + } + }, + "VideoPid": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", + "traits": { + "smithy.api#documentation": "Specify the packet identifier (PID) of the elementary video stream in the transport stream.", + "smithy.api#jsonName": "videoPid" + } } }, "traits": { @@ -11452,13 +11500,6 @@ "com.amazonaws.mediaconvert#M3u8Settings": { "type": "structure", "members": { - "PmtInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max1000", - "traits": { - "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", - "smithy.api#jsonName": "pmtInterval" - } - }, "AudioFramesPerPes": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { @@ -11466,18 +11507,18 @@ "smithy.api#jsonName": "audioFramesPerPes" } }, - "TimedMetadataPid": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", + "AudioPids": { + "target": "com.amazonaws.mediaconvert#__listOf__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream.", - "smithy.api#jsonName": "timedMetadataPid" + "smithy.api#documentation": "Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation.", + "smithy.api#jsonName": "audioPids" } }, - "PcrControl": { - "target": "com.amazonaws.mediaconvert#M3u8PcrControl", + "NielsenId3": { + "target": "com.amazonaws.mediaconvert#M3u8NielsenId3", "traits": { - "smithy.api#documentation": "When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.", - "smithy.api#jsonName": "pcrControl" + "smithy.api#documentation": "If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.", + "smithy.api#jsonName": "nielsenId3" } }, "PatInterval": { @@ -11487,6 +11528,13 @@ "smithy.api#jsonName": "patInterval" } }, + "PcrControl": { + "target": "com.amazonaws.mediaconvert#M3u8PcrControl", + "traits": { + "smithy.api#documentation": "When set to PCR_EVERY_PES_PACKET a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream.", + "smithy.api#jsonName": "pcrControl" + } + }, "PcrPid": { "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { @@ -11494,32 +11542,25 @@ "smithy.api#jsonName": "pcrPid" } }, - "Scte35Source": { - "target": "com.amazonaws.mediaconvert#M3u8Scte35Source", - "traits": { - "smithy.api#documentation": "For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE) if you don't want manifest conditioning. Choose Passthrough (PASSTHROUGH) and choose Ad markers (adMarkers) if you do want manifest conditioning. In both cases, also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml).", - "smithy.api#jsonName": "scte35Source" - } - }, - "TransportStreamId": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", + "PmtInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max1000", "traits": { - "smithy.api#documentation": "The value of the transport stream ID field in the Program Map Table.", - "smithy.api#jsonName": "transportStreamId" + "smithy.api#documentation": "The number of milliseconds between instances of this table in the output transport stream.", + "smithy.api#jsonName": "pmtInterval" } }, - "VideoPid": { + "PmtPid": { "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream.", - "smithy.api#jsonName": "videoPid" + "smithy.api#documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream.", + "smithy.api#jsonName": "pmtPid" } }, - "TimedMetadata": { - "target": "com.amazonaws.mediaconvert#TimedMetadata", + "PrivateMetadataPid": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Applies only to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.", - "smithy.api#jsonName": "timedMetadata" + "smithy.api#documentation": "Packet Identifier (PID) of the private metadata stream in the transport stream.", + "smithy.api#jsonName": "privateMetadataPid" } }, "ProgramNumber": { @@ -11536,32 +11577,39 @@ "smithy.api#jsonName": "scte35Pid" } }, - "PmtPid": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", + "Scte35Source": { + "target": "com.amazonaws.mediaconvert#M3u8Scte35Source", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream.", - "smithy.api#jsonName": "pmtPid" + "smithy.api#documentation": "For SCTE-35 markers from your input-- Choose Passthrough (PASSTHROUGH) if you want SCTE-35 markers that appear in your input to also appear in this output. Choose None (NONE) if you don't want SCTE-35 markers in this output. For SCTE-35 markers from an ESAM XML document-- Choose None (NONE) if you don't want manifest conditioning. Choose Passthrough (PASSTHROUGH) and choose Ad markers (adMarkers) if you do want manifest conditioning. In both cases, also provide the ESAM XML as a string in the setting Signal processing notification XML (sccXml).", + "smithy.api#jsonName": "scte35Source" + } + }, + "TimedMetadata": { + "target": "com.amazonaws.mediaconvert#TimedMetadata", + "traits": { + "smithy.api#documentation": "Applies only to HLS outputs. Use this setting to specify whether the service inserts the ID3 timed metadata from the input in this output.", + "smithy.api#jsonName": "timedMetadata" } }, - "PrivateMetadataPid": { + "TimedMetadataPid": { "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the private metadata stream in the transport stream.", - "smithy.api#jsonName": "privateMetadataPid" + "smithy.api#documentation": "Packet Identifier (PID) of the timed metadata stream in the transport stream.", + "smithy.api#jsonName": "timedMetadataPid" } }, - "AudioPids": { - "target": "com.amazonaws.mediaconvert#__listOf__integerMin32Max8182", + "TransportStreamId": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max65535", "traits": { - "smithy.api#documentation": "Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation.", - "smithy.api#jsonName": "audioPids" + "smithy.api#documentation": "The value of the transport stream ID field in the Program Map Table.", + "smithy.api#jsonName": "transportStreamId" } }, - "NielsenId3": { - "target": "com.amazonaws.mediaconvert#M3u8NielsenId3", + "VideoPid": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8182", "traits": { - "smithy.api#documentation": "If INSERT, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.", - "smithy.api#jsonName": "nielsenId3" + "smithy.api#documentation": "Packet Identifier (PID) of the elementary video stream in the transport stream.", + "smithy.api#jsonName": "videoPid" } } }, @@ -11667,6 +11715,13 @@ "com.amazonaws.mediaconvert#MotionImageInserter": { "type": "structure", "members": { + "Framerate": { + "target": "com.amazonaws.mediaconvert#MotionImageInsertionFramerate", + "traits": { + "smithy.api#documentation": "If your motion graphic asset is a .mov file, keep this setting unspecified. If your motion graphic asset is a series of .png files, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. Make sure that the number of images in your series matches the frame rate and your intended overlay duration. For example, if you want a 30-second overlay at 30 fps, you should have 900 .png images. This overlay frame rate doesn't need to match the frame rate of the underlying video.", + "smithy.api#jsonName": "framerate" + } + }, "Input": { "target": "com.amazonaws.mediaconvert#__stringMin14Max1285PatternS3Mov09PngHttpsMov09Png", "traits": { @@ -11674,13 +11729,6 @@ "smithy.api#jsonName": "input" } }, - "Offset": { - "target": "com.amazonaws.mediaconvert#MotionImageInsertionOffset", - "traits": { - "smithy.api#documentation": "Use Offset to specify the placement of your motion graphic overlay on the video frame. Specify in pixels, from the upper-left corner of the frame. If you don't specify an offset, the service scales your overlay to the full size of the frame. Otherwise, the service inserts the overlay at its native resolution and scales the size up or down with any video scaling.", - "smithy.api#jsonName": "offset" - } - }, "InsertionMode": { "target": "com.amazonaws.mediaconvert#MotionImageInsertionMode", "traits": { @@ -11688,18 +11736,11 @@ "smithy.api#jsonName": "insertionMode" } }, - "Framerate": { - "target": "com.amazonaws.mediaconvert#MotionImageInsertionFramerate", - "traits": { - "smithy.api#documentation": "If your motion graphic asset is a .mov file, keep this setting unspecified. If your motion graphic asset is a series of .png files, specify the frame rate of the overlay in frames per second, as a fraction. For example, specify 24 fps as 24/1. Make sure that the number of images in your series matches the frame rate and your intended overlay duration. For example, if you want a 30-second overlay at 30 fps, you should have 900 .png images. This overlay frame rate doesn't need to match the frame rate of the underlying video.", - "smithy.api#jsonName": "framerate" - } - }, - "StartTime": { - "target": "com.amazonaws.mediaconvert#__stringMin11Max11Pattern01D20305D205D", + "Offset": { + "target": "com.amazonaws.mediaconvert#MotionImageInsertionOffset", "traits": { - "smithy.api#documentation": "Specify when the motion overlay begins. Use timecode format (HH:MM:SS:FF or HH:MM:SS;FF). Make sure that the timecode you provide here takes into account how you have set up your timecode configuration under both job settings and input settings. The simplest way to do that is to set both to start at 0. If you need to set up your job to follow timecodes embedded in your source that don't start at zero, make sure that you specify a start time that is after the first embedded timecode. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-timecode.html Find job-wide and input timecode configuration settings in your JSON job settings specification at settings>timecodeConfig>source and settings>inputs>timecodeSource.", - "smithy.api#jsonName": "startTime" + "smithy.api#documentation": "Use Offset to specify the placement of your motion graphic overlay on the video frame. Specify in pixels, from the upper-left corner of the frame. If you don't specify an offset, the service scales your overlay to the full size of the frame. Otherwise, the service inserts the overlay at its native resolution and scales the size up or down with any video scaling.", + "smithy.api#jsonName": "offset" } }, "Playback": { @@ -11708,6 +11749,13 @@ "smithy.api#documentation": "Specify whether your motion graphic overlay repeats on a loop or plays only once.", "smithy.api#jsonName": "playback" } + }, + "StartTime": { + "target": "com.amazonaws.mediaconvert#__stringMin11Max11Pattern01D20305D205D", + "traits": { + "smithy.api#documentation": "Specify when the motion overlay begins. Use timecode format (HH:MM:SS:FF or HH:MM:SS;FF). Make sure that the timecode you provide here takes into account how you have set up your timecode configuration under both job settings and input settings. The simplest way to do that is to set both to start at 0. If you need to set up your job to follow timecodes embedded in your source that don't start at zero, make sure that you specify a start time that is after the first embedded timecode. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/setting-up-timecode.html Find job-wide and input timecode configuration settings in your JSON job settings specification at settings>timecodeConfig>source and settings>inputs>timecodeSource.", + "smithy.api#jsonName": "startTime" + } } }, "traits": { @@ -11880,18 +11928,11 @@ "smithy.api#jsonName": "clapAtom" } }, - "Reference": { - "target": "com.amazonaws.mediaconvert#MovReference", - "traits": { - "smithy.api#documentation": "Always keep the default value (SELF_CONTAINED) for this setting.", - "smithy.api#jsonName": "reference" - } - }, - "PaddingControl": { - "target": "com.amazonaws.mediaconvert#MovPaddingControl", + "CslgAtom": { + "target": "com.amazonaws.mediaconvert#MovCslgAtom", "traits": { - "smithy.api#documentation": "To make this output compatible with Omenon, keep the default value, OMNEON. Unless you need Omneon compatibility, set this value to NONE. When you keep the default value, OMNEON, MediaConvert increases the length of the edit list atom. This might cause file rejections when a recipient of the output file doesn't expct this extra padding.", - "smithy.api#jsonName": "paddingControl" + "smithy.api#documentation": "When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools.", + "smithy.api#jsonName": "cslgAtom" } }, "Mpeg2FourCCControl": { @@ -11901,11 +11942,18 @@ "smithy.api#jsonName": "mpeg2FourCCControl" } }, - "CslgAtom": { - "target": "com.amazonaws.mediaconvert#MovCslgAtom", + "PaddingControl": { + "target": "com.amazonaws.mediaconvert#MovPaddingControl", "traits": { - "smithy.api#documentation": "When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools.", - "smithy.api#jsonName": "cslgAtom" + "smithy.api#documentation": "To make this output compatible with Omenon, keep the default value, OMNEON. Unless you need Omneon compatibility, set this value to NONE. When you keep the default value, OMNEON, MediaConvert increases the length of the edit list atom. This might cause file rejections when a recipient of the output file doesn't expct this extra padding.", + "smithy.api#jsonName": "paddingControl" + } + }, + "Reference": { + "target": "com.amazonaws.mediaconvert#MovReference", + "traits": { + "smithy.api#documentation": "Always keep the default value (SELF_CONTAINED) for this setting.", + "smithy.api#jsonName": "reference" } } }, @@ -11961,6 +12009,13 @@ "com.amazonaws.mediaconvert#Mp3Settings": { "type": "structure", "members": { + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin16000Max320000", + "traits": { + "smithy.api#documentation": "Specify the average bitrate in bits per second.", + "smithy.api#jsonName": "bitrate" + } + }, "Channels": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2", "traits": { @@ -11988,13 +12043,6 @@ "smithy.api#documentation": "Required when you set Bitrate control mode (rateControlMode) to VBR. Specify the audio quality of this MP3 output from 0 (highest quality) to 9 (lowest quality).", "smithy.api#jsonName": "vbrQuality" } - }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin16000Max320000", - "traits": { - "smithy.api#documentation": "Specify the average bitrate in bits per second.", - "smithy.api#jsonName": "bitrate" - } } }, "traits": { @@ -12052,6 +12100,13 @@ "com.amazonaws.mediaconvert#Mp4Settings": { "type": "structure", "members": { + "CslgAtom": { + "target": "com.amazonaws.mediaconvert#Mp4CslgAtom", + "traits": { + "smithy.api#documentation": "When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools.", + "smithy.api#jsonName": "cslgAtom" + } + }, "CttsVersion": { "target": "com.amazonaws.mediaconvert#__integerMin0Max1", "traits": { @@ -12066,13 +12121,6 @@ "smithy.api#jsonName": "freeSpaceBox" } }, - "Mp4MajorBrand": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Overrides the \"Major Brand\" field in the output file. Usually not necessary to specify.", - "smithy.api#jsonName": "mp4MajorBrand" - } - }, "MoovPlacement": { "target": "com.amazonaws.mediaconvert#Mp4MoovPlacement", "traits": { @@ -12080,11 +12128,11 @@ "smithy.api#jsonName": "moovPlacement" } }, - "CslgAtom": { - "target": "com.amazonaws.mediaconvert#Mp4CslgAtom", + "Mp4MajorBrand": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "When enabled, file composition times will start at zero, composition times in the 'ctts' (composition time to sample) box for B-frames will be negative, and a 'cslg' (composition shift least greatest) box will be included per 14496-1 amendment 1. This improves compatibility with Apple players and tools.", - "smithy.api#jsonName": "cslgAtom" + "smithy.api#documentation": "Overrides the \"Major Brand\" field in the output file. Usually not necessary to specify.", + "smithy.api#jsonName": "mp4MajorBrand" } } }, @@ -12428,53 +12476,60 @@ "com.amazonaws.mediaconvert#Mpeg2Settings": { "type": "structure", "members": { - "NumberBFramesBetweenReferenceFrames": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max7", + "AdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#Mpeg2AdaptiveQuantization", "traits": { - "smithy.api#documentation": "Number of B-frames between reference frames.", - "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" + "smithy.api#documentation": "Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to the following settings: Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization).", + "smithy.api#jsonName": "adaptiveQuantization" } }, - "SpatialAdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#Mpeg2SpatialAdaptiveQuantization", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin1000Max288000000", "traits": { - "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", - "smithy.api#jsonName": "spatialAdaptiveQuantization" + "smithy.api#documentation": "Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000.", + "smithy.api#jsonName": "bitrate" } }, - "GopClosedCadence": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "CodecLevel": { + "target": "com.amazonaws.mediaconvert#Mpeg2CodecLevel", "traits": { - "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", - "smithy.api#jsonName": "gopClosedCadence" + "smithy.api#documentation": "Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output.", + "smithy.api#jsonName": "codecLevel" } }, - "FramerateDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max1001", + "CodecProfile": { + "target": "com.amazonaws.mediaconvert#Mpeg2CodecProfile", "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateDenominator" + "smithy.api#documentation": "Use Profile (Mpeg2CodecProfile) to set the MPEG-2 profile for the video output.", + "smithy.api#jsonName": "codecProfile" } }, - "AdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#Mpeg2AdaptiveQuantization", + "DynamicSubGop": { + "target": "com.amazonaws.mediaconvert#Mpeg2DynamicSubGop", "traits": { - "smithy.api#documentation": "Specify the strength of any adaptive quantization filters that you enable. The value that you choose here applies to the following settings: Spatial adaptive quantization (spatialAdaptiveQuantization), and Temporal adaptive quantization (temporalAdaptiveQuantization).", - "smithy.api#jsonName": "adaptiveQuantization" + "smithy.api#documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).", + "smithy.api#jsonName": "dynamicSubGop" } }, - "Syntax": { - "target": "com.amazonaws.mediaconvert#Mpeg2Syntax", + "FramerateControl": { + "target": "com.amazonaws.mediaconvert#Mpeg2FramerateControl", "traits": { - "smithy.api#documentation": "Specify whether this output's video uses the D10 syntax. Keep the default value to not use the syntax. Related settings: When you choose D10 (D_10) for your MXF profile (profile), you must also set this value to to D10 (D_10).", - "smithy.api#jsonName": "syntax" + "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#jsonName": "framerateControl" } }, - "ParControl": { - "target": "com.amazonaws.mediaconvert#Mpeg2ParControl", + "FramerateConversionAlgorithm": { + "target": "com.amazonaws.mediaconvert#Mpeg2FramerateConversionAlgorithm", "traits": { - "smithy.api#documentation": "Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses the PAR from your input video for your output. To specify a different PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.", - "smithy.api#jsonName": "parControl" + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#jsonName": "framerateConversionAlgorithm" + } + }, + "FramerateDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max1001", + "traits": { + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateDenominator" } }, "FramerateNumerator": { @@ -12484,74 +12539,81 @@ "smithy.api#jsonName": "framerateNumerator" } }, - "RateControlMode": { - "target": "com.amazonaws.mediaconvert#Mpeg2RateControlMode", + "GopClosedCadence": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Use Rate control mode (Mpeg2RateControlMode) to specifiy whether the bitrate is variable (vbr) or constant (cbr).", - "smithy.api#jsonName": "rateControlMode" + "smithy.api#documentation": "Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.", + "smithy.api#jsonName": "gopClosedCadence" } }, - "DynamicSubGop": { - "target": "com.amazonaws.mediaconvert#Mpeg2DynamicSubGop", + "GopSize": { + "target": "com.amazonaws.mediaconvert#__doubleMin0", "traits": { - "smithy.api#documentation": "Choose Adaptive to improve subjective video quality for high-motion content. This will cause the service to use fewer B-frames (which infer information based on other frames) for high-motion portions of the video and more B-frames for low-motion portions. The maximum number of B-frames is limited by the value you provide for the setting B frames between reference frames (numberBFramesBetweenReferenceFrames).", - "smithy.api#jsonName": "dynamicSubGop" + "smithy.api#documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.", + "smithy.api#jsonName": "gopSize" } }, - "SceneChangeDetect": { - "target": "com.amazonaws.mediaconvert#Mpeg2SceneChangeDetect", + "GopSizeUnits": { + "target": "com.amazonaws.mediaconvert#Mpeg2GopSizeUnits", "traits": { - "smithy.api#documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default.", - "smithy.api#jsonName": "sceneChangeDetect" + "smithy.api#documentation": "Indicates if the GOP Size in MPEG2 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", + "smithy.api#jsonName": "gopSizeUnits" } }, - "QualityTuningLevel": { - "target": "com.amazonaws.mediaconvert#Mpeg2QualityTuningLevel", + "HrdBufferInitialFillPercentage": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max100", "traits": { - "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", - "smithy.api#jsonName": "qualityTuningLevel" + "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", + "smithy.api#jsonName": "hrdBufferInitialFillPercentage" } }, - "FramerateControl": { - "target": "com.amazonaws.mediaconvert#Mpeg2FramerateControl", + "HrdBufferSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max47185920", "traits": { - "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", - "smithy.api#jsonName": "framerateControl" + "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", + "smithy.api#jsonName": "hrdBufferSize" } }, - "TemporalAdaptiveQuantization": { - "target": "com.amazonaws.mediaconvert#Mpeg2TemporalAdaptiveQuantization", + "InterlaceMode": { + "target": "com.amazonaws.mediaconvert#Mpeg2InterlaceMode", "traits": { - "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization).", - "smithy.api#jsonName": "temporalAdaptiveQuantization" + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", + "smithy.api#jsonName": "interlaceMode" } }, - "MinIInterval": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max30", + "IntraDcPrecision": { + "target": "com.amazonaws.mediaconvert#Mpeg2IntraDcPrecision", "traits": { - "smithy.api#documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", - "smithy.api#jsonName": "minIInterval" + "smithy.api#documentation": "Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for intra-block DC coefficients. If you choose the value auto, the service will automatically select the precision based on the per-frame compression ratio.", + "smithy.api#jsonName": "intraDcPrecision" } }, - "GopSize": { - "target": "com.amazonaws.mediaconvert#__doubleMin0", + "MaxBitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin1000Max300000000", + "traits": { + "smithy.api#documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000.", + "smithy.api#jsonName": "maxBitrate" + } + }, + "MinIInterval": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max30", "traits": { - "smithy.api#documentation": "GOP Length (keyframe interval) in frames or seconds. Must be greater than zero.", - "smithy.api#jsonName": "gopSize" + "smithy.api#documentation": "Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. This setting is only used when Scene Change Detect is enabled. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1", + "smithy.api#jsonName": "minIInterval" } }, - "Softness": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max128", + "NumberBFramesBetweenReferenceFrames": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max7", "traits": { - "smithy.api#documentation": "Ignore this setting unless you need to comply with a specification that requires a specific value. If you don't have a specification requirement, we recommend that you adjust the softness of your output by using a lower value for the setting Sharpness (sharpness) or by enabling a noise reducer filter (noiseReducerFilter). The Softness (softness) setting specifies the quantization matrices that the encoder uses. Keep the default value, 0, to use the AWS Elemental default matrices. Choose a value from 17 to 128 to use planar interpolation. Increasing values from 17 to 128 result in increasing reduction of high-frequency data. The value 128 results in the softest video.", - "smithy.api#jsonName": "softness" + "smithy.api#documentation": "Number of B-frames between reference frames.", + "smithy.api#jsonName": "numberBFramesBetweenReferenceFrames" } }, - "CodecLevel": { - "target": "com.amazonaws.mediaconvert#Mpeg2CodecLevel", + "ParControl": { + "target": "com.amazonaws.mediaconvert#Mpeg2ParControl", "traits": { - "smithy.api#documentation": "Use Level (Mpeg2CodecLevel) to set the MPEG-2 level for the video output.", - "smithy.api#jsonName": "codecLevel" + "smithy.api#documentation": "Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses the PAR from your input video for your output. To specify a different PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.", + "smithy.api#jsonName": "parControl" } }, "ParDenominator": { @@ -12561,32 +12623,32 @@ "smithy.api#jsonName": "parDenominator" } }, - "CodecProfile": { - "target": "com.amazonaws.mediaconvert#Mpeg2CodecProfile", + "ParNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Use Profile (Mpeg2CodecProfile) to set the MPEG-2 profile for the video output.", - "smithy.api#jsonName": "codecProfile" + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", + "smithy.api#jsonName": "parNumerator" } }, - "Telecine": { - "target": "com.amazonaws.mediaconvert#Mpeg2Telecine", + "QualityTuningLevel": { + "target": "com.amazonaws.mediaconvert#Mpeg2QualityTuningLevel", "traits": { - "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard or soft telecine to create a smoother picture. Hard telecine (HARD) produces a 29.97i output. Soft telecine (SOFT) produces an output with a 23.976 output that signals to the video player device to do the conversion during play back. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", - "smithy.api#jsonName": "telecine" + "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, single-pass encoding.", + "smithy.api#jsonName": "qualityTuningLevel" } }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin1000Max288000000", + "RateControlMode": { + "target": "com.amazonaws.mediaconvert#Mpeg2RateControlMode", "traits": { - "smithy.api#documentation": "Specify the average bitrate in bits per second. Required for VBR and CBR. For MS Smooth outputs, bitrates must be unique when rounded down to the nearest multiple of 1000.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "Use Rate control mode (Mpeg2RateControlMode) to specifiy whether the bitrate is variable (vbr) or constant (cbr).", + "smithy.api#jsonName": "rateControlMode" } }, - "GopSizeUnits": { - "target": "com.amazonaws.mediaconvert#Mpeg2GopSizeUnits", + "SceneChangeDetect": { + "target": "com.amazonaws.mediaconvert#Mpeg2SceneChangeDetect", "traits": { - "smithy.api#documentation": "Indicates if the GOP Size in MPEG2 is specified in frames or seconds. If seconds the system will convert the GOP Size into a frame count at run time.", - "smithy.api#jsonName": "gopSizeUnits" + "smithy.api#documentation": "Enable this setting to insert I-frames at scene changes that the service automatically detects. This improves video quality and is enabled by default.", + "smithy.api#jsonName": "sceneChangeDetect" } }, "SlowPal": { @@ -12596,53 +12658,39 @@ "smithy.api#jsonName": "slowPal" } }, - "HrdBufferInitialFillPercentage": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max100", - "traits": { - "smithy.api#documentation": "Percentage of the buffer that should initially be filled (HRD buffer model).", - "smithy.api#jsonName": "hrdBufferInitialFillPercentage" - } - }, - "ParNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", - "smithy.api#jsonName": "parNumerator" - } - }, - "HrdBufferSize": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max47185920", + "Softness": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max128", "traits": { - "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", - "smithy.api#jsonName": "hrdBufferSize" + "smithy.api#documentation": "Ignore this setting unless you need to comply with a specification that requires a specific value. If you don't have a specification requirement, we recommend that you adjust the softness of your output by using a lower value for the setting Sharpness (sharpness) or by enabling a noise reducer filter (noiseReducerFilter). The Softness (softness) setting specifies the quantization matrices that the encoder uses. Keep the default value, 0, to use the AWS Elemental default matrices. Choose a value from 17 to 128 to use planar interpolation. Increasing values from 17 to 128 result in increasing reduction of high-frequency data. The value 128 results in the softest video.", + "smithy.api#jsonName": "softness" } }, - "MaxBitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin1000Max300000000", + "SpatialAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#Mpeg2SpatialAdaptiveQuantization", "traits": { - "smithy.api#documentation": "Maximum bitrate in bits/second. For example, enter five megabits per second as 5000000.", - "smithy.api#jsonName": "maxBitrate" + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on spatial variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas that can sustain more distortion with no noticeable visual degradation and uses more bits on areas where any small distortion will be noticeable. For example, complex textured blocks are encoded with fewer bits and smooth textured blocks are encoded with more bits. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen with a lot of complex texture, you might choose to disable this feature. Related setting: When you enable spatial adaptive quantization, set the value for Adaptive quantization (adaptiveQuantization) depending on your content. For homogeneous content, such as cartoons and video games, set it to Low. For content with a wider variety of textures, set it to High or Higher.", + "smithy.api#jsonName": "spatialAdaptiveQuantization" } }, - "FramerateConversionAlgorithm": { - "target": "com.amazonaws.mediaconvert#Mpeg2FramerateConversionAlgorithm", + "Syntax": { + "target": "com.amazonaws.mediaconvert#Mpeg2Syntax", "traits": { - "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", - "smithy.api#jsonName": "framerateConversionAlgorithm" + "smithy.api#documentation": "Specify whether this output's video uses the D10 syntax. Keep the default value to not use the syntax. Related settings: When you choose D10 (D_10) for your MXF profile (profile), you must also set this value to to D10 (D_10).", + "smithy.api#jsonName": "syntax" } }, - "IntraDcPrecision": { - "target": "com.amazonaws.mediaconvert#Mpeg2IntraDcPrecision", + "Telecine": { + "target": "com.amazonaws.mediaconvert#Mpeg2Telecine", "traits": { - "smithy.api#documentation": "Use Intra DC precision (Mpeg2IntraDcPrecision) to set quantization precision for intra-block DC coefficients. If you choose the value auto, the service will automatically select the precision based on the per-frame compression ratio.", - "smithy.api#jsonName": "intraDcPrecision" + "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard or soft telecine to create a smoother picture. Hard telecine (HARD) produces a 29.97i output. Soft telecine (SOFT) produces an output with a 23.976 output that signals to the video player device to do the conversion during play back. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", + "smithy.api#jsonName": "telecine" } }, - "InterlaceMode": { - "target": "com.amazonaws.mediaconvert#Mpeg2InterlaceMode", + "TemporalAdaptiveQuantization": { + "target": "com.amazonaws.mediaconvert#Mpeg2TemporalAdaptiveQuantization", "traits": { - "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", - "smithy.api#jsonName": "interlaceMode" + "smithy.api#documentation": "Keep the default value, Enabled (ENABLED), to adjust quantization within each frame based on temporal variation of content complexity. When you enable this feature, the encoder uses fewer bits on areas of the frame that aren't moving and uses more bits on complex objects with sharp edges that move a lot. For example, this feature improves the readability of text tickers on newscasts and scoreboards on sports matches. Enabling this feature will almost always improve your video quality. Note, though, that this feature doesn't take into account where the viewer's attention is likely to be. If viewers are likely to be focusing their attention on a part of the screen that doesn't have moving objects with sharp edges, such as sports athletes' faces, you might choose to disable this feature. Related setting: When you enable temporal quantization, adjust the strength of the filter with the setting Adaptive quantization (adaptiveQuantization).", + "smithy.api#jsonName": "temporalAdaptiveQuantization" } } }, @@ -12737,19 +12785,19 @@ "com.amazonaws.mediaconvert#MsSmoothAdditionalManifest": { "type": "structure", "members": { - "SelectedOutputs": { - "target": "com.amazonaws.mediaconvert#__listOf__stringMin1", - "traits": { - "smithy.api#documentation": "Specify the outputs that you want this additional top-level manifest to reference.", - "smithy.api#jsonName": "selectedOutputs" - } - }, "ManifestNameModifier": { "target": "com.amazonaws.mediaconvert#__stringMin1", "traits": { "smithy.api#documentation": "Specify a name modifier that the service adds to the name of this manifest to make it different from the file names of the other main manifests in the output group. For example, say that the default main manifest for your Microsoft Smooth group is film-name.ismv. If you enter \"-no-premium\" for this setting, then the file name the service generates for this top-level manifest is film-name-no-premium.ismv.", "smithy.api#jsonName": "manifestNameModifier" } + }, + "SelectedOutputs": { + "target": "com.amazonaws.mediaconvert#__listOf__stringMin1", + "traits": { + "smithy.api#documentation": "Specify the outputs that you want this additional top-level manifest to reference.", + "smithy.api#jsonName": "selectedOutputs" + } } }, "traits": { @@ -12790,20 +12838,6 @@ "com.amazonaws.mediaconvert#MsSmoothGroupSettings": { "type": "structure", "members": { - "DestinationSettings": { - "target": "com.amazonaws.mediaconvert#DestinationSettings", - "traits": { - "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", - "smithy.api#jsonName": "destinationSettings" - } - }, - "FragmentLength": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "Use Fragment length (FragmentLength) to specify the mp4 fragment sizes in seconds. Fragment length must be compatible with GOP size and frame rate.", - "smithy.api#jsonName": "fragmentLength" - } - }, "AdditionalManifests": { "target": "com.amazonaws.mediaconvert#__listOfMsSmoothAdditionalManifest", "traits": { @@ -12811,13 +12845,6 @@ "smithy.api#jsonName": "additionalManifests" } }, - "Destination": { - "target": "com.amazonaws.mediaconvert#__stringPatternS3", - "traits": { - "smithy.api#documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.", - "smithy.api#jsonName": "destination" - } - }, "AudioDeduplication": { "target": "com.amazonaws.mediaconvert#MsSmoothAudioDeduplication", "traits": { @@ -12825,11 +12852,18 @@ "smithy.api#jsonName": "audioDeduplication" } }, - "ManifestEncoding": { - "target": "com.amazonaws.mediaconvert#MsSmoothManifestEncoding", + "Destination": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3", "traits": { - "smithy.api#documentation": "Use Manifest encoding (MsSmoothManifestEncoding) to specify the encoding format for the server and client manifest. Valid options are utf8 and utf16.", - "smithy.api#jsonName": "manifestEncoding" + "smithy.api#documentation": "Use Destination (Destination) to specify the S3 output location and the output filename base. Destination accepts format identifiers. If you do not specify the base filename in the URI, the service will use the filename of the input file. If your job has multiple inputs, the service uses the filename of the first input file.", + "smithy.api#jsonName": "destination" + } + }, + "DestinationSettings": { + "target": "com.amazonaws.mediaconvert#DestinationSettings", + "traits": { + "smithy.api#documentation": "Settings associated with the destination. Will vary based on the type of destination", + "smithy.api#jsonName": "destinationSettings" } }, "Encryption": { @@ -12838,6 +12872,20 @@ "smithy.api#documentation": "If you are using DRM, set DRM System (MsSmoothEncryptionSettings) to specify the value SpekeKeyProvider.", "smithy.api#jsonName": "encryption" } + }, + "FragmentLength": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "Use Fragment length (FragmentLength) to specify the mp4 fragment sizes in seconds. Fragment length must be compatible with GOP size and frame rate.", + "smithy.api#jsonName": "fragmentLength" + } + }, + "ManifestEncoding": { + "target": "com.amazonaws.mediaconvert#MsSmoothManifestEncoding", + "traits": { + "smithy.api#documentation": "Use Manifest encoding (MsSmoothManifestEncoding) to specify the encoding format for the server and client manifest. Valid options are utf8 and utf16.", + "smithy.api#jsonName": "manifestEncoding" + } } }, "traits": { @@ -12921,13 +12969,6 @@ "com.amazonaws.mediaconvert#NexGuardFileMarkerSettings": { "type": "structure", "members": { - "Preset": { - "target": "com.amazonaws.mediaconvert#__stringMin1Max256", - "traits": { - "smithy.api#documentation": "Enter one of the watermarking preset strings that Nagra provides you. Required when you include Nagra NexGuard File Marker watermarking (NexGuardWatermarkingSettings) in your job.", - "smithy.api#jsonName": "preset" - } - }, "License": { "target": "com.amazonaws.mediaconvert#__stringMin1Max100000", "traits": { @@ -12935,19 +12976,26 @@ "smithy.api#jsonName": "license" } }, - "Strength": { - "target": "com.amazonaws.mediaconvert#WatermarkingStrength", - "traits": { - "smithy.api#documentation": "Optional. Ignore this setting unless Nagra support directs you to specify a value. When you don't specify a value here, the Nagra NexGuard library uses its default value.", - "smithy.api#jsonName": "strength" - } - }, "Payload": { "target": "com.amazonaws.mediaconvert#__integerMin0Max4194303", "traits": { "smithy.api#documentation": "Specify the payload ID that you want associated with this output. Valid values vary depending on your Nagra NexGuard forensic watermarking workflow. Required when you include Nagra NexGuard File Marker watermarking (NexGuardWatermarkingSettings) in your job. For PreRelease Content (NGPR/G2), specify an integer from 1 through 4,194,303. You must generate a unique ID for each asset you watermark, and keep a record of which ID you have assigned to each asset. Neither Nagra nor MediaConvert keep track of the relationship between output files and your IDs. For OTT Streaming, create two adaptive bitrate (ABR) stacks for each asset. Do this by setting up two output groups. For one output group, set the value of Payload ID (payload) to 0 in every output. For the other output group, set Payload ID (payload) to 1 in every output.", "smithy.api#jsonName": "payload" } + }, + "Preset": { + "target": "com.amazonaws.mediaconvert#__stringMin1Max256", + "traits": { + "smithy.api#documentation": "Enter one of the watermarking preset strings that Nagra provides you. Required when you include Nagra NexGuard File Marker watermarking (NexGuardWatermarkingSettings) in your job.", + "smithy.api#jsonName": "preset" + } + }, + "Strength": { + "target": "com.amazonaws.mediaconvert#WatermarkingStrength", + "traits": { + "smithy.api#documentation": "Optional. Ignore this setting unless Nagra support directs you to specify a value. When you don't specify a value here, the Nagra NexGuard library uses its default value.", + "smithy.api#jsonName": "strength" + } } }, "traits": { @@ -12977,19 +13025,19 @@ "com.amazonaws.mediaconvert#NielsenConfiguration": { "type": "structure", "members": { - "DistributorId": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Use Distributor ID (DistributorID) to specify the distributor ID that is assigned to your organization by Neilsen.", - "smithy.api#jsonName": "distributorId" - } - }, "BreakoutCode": { "target": "com.amazonaws.mediaconvert#__integerMin0Max0", "traits": { "smithy.api#documentation": "Nielsen has discontinued the use of breakout code functionality. If you must include this property, set the value to zero.", "smithy.api#jsonName": "breakoutCode" } + }, + "DistributorId": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Use Distributor ID (DistributorID) to specify the distributor ID that is assigned to your organization by Neilsen.", + "smithy.api#jsonName": "distributorId" + } } }, "traits": { @@ -12999,25 +13047,32 @@ "com.amazonaws.mediaconvert#NielsenNonLinearWatermarkSettings": { "type": "structure", "members": { - "TicServerUrl": { - "target": "com.amazonaws.mediaconvert#__stringPatternHttps", + "ActiveWatermarkProcess": { + "target": "com.amazonaws.mediaconvert#NielsenActiveWatermarkProcessType", "traits": { - "smithy.api#documentation": "Specify the endpoint for the TIC server that you have deployed and configured in the AWS Cloud. Required for all Nielsen non-linear watermarking. MediaConvert can't connect directly to a TIC server. Instead, you must use API Gateway to provide a RESTful interface between MediaConvert and a TIC server that you deploy in your AWS account. For more information on deploying a TIC server in your AWS account and the required API Gateway, contact Nielsen support.", - "smithy.api#jsonName": "ticServerUrl" + "smithy.api#documentation": "Choose the type of Nielsen watermarks that you want in your outputs. When you choose NAES 2 and NW (NAES2_AND_NW), you must provide a value for the setting SID (sourceId). When you choose CBET (CBET), you must provide a value for the setting CSID (cbetSourceId). When you choose NAES 2, NW, and CBET (NAES2_AND_NW_AND_CBET), you must provide values for both of these settings.", + "smithy.api#jsonName": "activeWatermarkProcess" } }, - "SourceId": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max65534", + "AdiFilename": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3", "traits": { - "smithy.api#documentation": "Use the SID that Nielsen provides to you. This source ID should be unique to your Nielsen account but common to all of your output assets. Required for all Nielsen non-linear watermarking. This ID should be unique to your Nielsen account but common to all of your output assets. Required for all Nielsen non-linear watermarking.", - "smithy.api#jsonName": "sourceId" + "smithy.api#documentation": "Optional. Use this setting when you want the service to include an ADI file in the Nielsen metadata .zip file. To provide an ADI file, store it in Amazon S3 and provide a URL to it here. The URL should be in the following format: S3://bucket/path/ADI-file. For more information about the metadata .zip file, see the setting Metadata destination (metadataDestination).", + "smithy.api#jsonName": "adiFilename" } }, - "UniqueTicPerAudioTrack": { - "target": "com.amazonaws.mediaconvert#NielsenUniqueTicPerAudioTrackType", + "AssetId": { + "target": "com.amazonaws.mediaconvert#__stringMin1Max20", "traits": { - "smithy.api#documentation": "To create assets that have the same TIC values in each audio track, keep the default value Share TICs (SAME_TICS_PER_TRACK). To create assets that have unique TIC values for each audio track, choose Use unique TICs (RESERVE_UNIQUE_TICS_PER_TRACK).", - "smithy.api#jsonName": "uniqueTicPerAudioTrack" + "smithy.api#documentation": "Use the asset ID that you provide to Nielsen to uniquely identify this asset. Required for all Nielsen non-linear watermarking.", + "smithy.api#jsonName": "assetId" + } + }, + "AssetName": { + "target": "com.amazonaws.mediaconvert#__stringMin1Max50", + "traits": { + "smithy.api#documentation": "Use the asset name that you provide to Nielsen for this asset. Required for all Nielsen non-linear watermarking.", + "smithy.api#jsonName": "assetName" } }, "CbetSourceId": { @@ -13034,18 +13089,18 @@ "smithy.api#jsonName": "episodeId" } }, - "ActiveWatermarkProcess": { - "target": "com.amazonaws.mediaconvert#NielsenActiveWatermarkProcessType", + "MetadataDestination": { + "target": "com.amazonaws.mediaconvert#__stringPatternS3", "traits": { - "smithy.api#documentation": "Choose the type of Nielsen watermarks that you want in your outputs. When you choose NAES 2 and NW (NAES2_AND_NW), you must provide a value for the setting SID (sourceId). When you choose CBET (CBET), you must provide a value for the setting CSID (cbetSourceId). When you choose NAES 2, NW, and CBET (NAES2_AND_NW_AND_CBET), you must provide values for both of these settings.", - "smithy.api#jsonName": "activeWatermarkProcess" + "smithy.api#documentation": "Specify the Amazon S3 location where you want MediaConvert to save your Nielsen non-linear metadata .zip file. This Amazon S3 bucket must be in the same Region as the one where you do your MediaConvert transcoding. If you want to include an ADI file in this .zip file, use the setting ADI file (adiFilename) to specify it. MediaConvert delivers the Nielsen metadata .zip files only to your metadata destination Amazon S3 bucket. It doesn't deliver the .zip files to Nielsen. You are responsible for delivering the metadata .zip files to Nielsen.", + "smithy.api#jsonName": "metadataDestination" } }, - "AdiFilename": { - "target": "com.amazonaws.mediaconvert#__stringPatternS3", + "SourceId": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max65534", "traits": { - "smithy.api#documentation": "Optional. Use this setting when you want the service to include an ADI file in the Nielsen metadata .zip file. To provide an ADI file, store it in Amazon S3 and provide a URL to it here. The URL should be in the following format: S3://bucket/path/ADI-file. For more information about the metadata .zip file, see the setting Metadata destination (metadataDestination).", - "smithy.api#jsonName": "adiFilename" + "smithy.api#documentation": "Use the SID that Nielsen provides to you. This source ID should be unique to your Nielsen account but common to all of your output assets. Required for all Nielsen non-linear watermarking. This ID should be unique to your Nielsen account but common to all of your output assets. Required for all Nielsen non-linear watermarking.", + "smithy.api#jsonName": "sourceId" } }, "SourceWatermarkStatus": { @@ -13055,25 +13110,18 @@ "smithy.api#jsonName": "sourceWatermarkStatus" } }, - "MetadataDestination": { - "target": "com.amazonaws.mediaconvert#__stringPatternS3", - "traits": { - "smithy.api#documentation": "Specify the Amazon S3 location where you want MediaConvert to save your Nielsen non-linear metadata .zip file. This Amazon S3 bucket must be in the same Region as the one where you do your MediaConvert transcoding. If you want to include an ADI file in this .zip file, use the setting ADI file (adiFilename) to specify it. MediaConvert delivers the Nielsen metadata .zip files only to your metadata destination Amazon S3 bucket. It doesn't deliver the .zip files to Nielsen. You are responsible for delivering the metadata .zip files to Nielsen.", - "smithy.api#jsonName": "metadataDestination" - } - }, - "AssetName": { - "target": "com.amazonaws.mediaconvert#__stringMin1Max50", + "TicServerUrl": { + "target": "com.amazonaws.mediaconvert#__stringPatternHttps", "traits": { - "smithy.api#documentation": "Use the asset name that you provide to Nielsen for this asset. Required for all Nielsen non-linear watermarking.", - "smithy.api#jsonName": "assetName" + "smithy.api#documentation": "Specify the endpoint for the TIC server that you have deployed and configured in the AWS Cloud. Required for all Nielsen non-linear watermarking. MediaConvert can't connect directly to a TIC server. Instead, you must use API Gateway to provide a RESTful interface between MediaConvert and a TIC server that you deploy in your AWS account. For more information on deploying a TIC server in your AWS account and the required API Gateway, contact Nielsen support.", + "smithy.api#jsonName": "ticServerUrl" } }, - "AssetId": { - "target": "com.amazonaws.mediaconvert#__stringMin1Max20", + "UniqueTicPerAudioTrack": { + "target": "com.amazonaws.mediaconvert#NielsenUniqueTicPerAudioTrackType", "traits": { - "smithy.api#documentation": "Use the asset ID that you provide to Nielsen to uniquely identify this asset. Required for all Nielsen non-linear watermarking.", - "smithy.api#jsonName": "assetId" + "smithy.api#documentation": "To create assets that have the same TIC values in each audio track, keep the default value Share TICs (SAME_TICS_PER_TRACK). To create assets that have unique TIC values for each audio track, choose Use unique TICs (RESERVE_UNIQUE_TICS_PER_TRACK).", + "smithy.api#jsonName": "uniqueTicPerAudioTrack" } } }, @@ -13136,13 +13184,6 @@ "com.amazonaws.mediaconvert#NoiseReducer": { "type": "structure", "members": { - "SpatialFilterSettings": { - "target": "com.amazonaws.mediaconvert#NoiseReducerSpatialFilterSettings", - "traits": { - "smithy.api#documentation": "Noise reducer filter settings for spatial filter.", - "smithy.api#jsonName": "spatialFilterSettings" - } - }, "Filter": { "target": "com.amazonaws.mediaconvert#NoiseReducerFilter", "traits": { @@ -13157,6 +13198,13 @@ "smithy.api#jsonName": "filterSettings" } }, + "SpatialFilterSettings": { + "target": "com.amazonaws.mediaconvert#NoiseReducerSpatialFilterSettings", + "traits": { + "smithy.api#documentation": "Noise reducer filter settings for spatial filter.", + "smithy.api#jsonName": "spatialFilterSettings" + } + }, "TemporalFilterSettings": { "target": "com.amazonaws.mediaconvert#NoiseReducerTemporalFilterSettings", "traits": { @@ -13234,19 +13282,19 @@ "smithy.api#jsonName": "postFilterSharpenStrength" } }, - "Strength": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max16", - "traits": { - "smithy.api#documentation": "Relative strength of noise reducing filter. Higher values produce stronger filtering.", - "smithy.api#jsonName": "strength" - } - }, "Speed": { "target": "com.amazonaws.mediaconvert#__integerMinNegative2Max3", "traits": { "smithy.api#documentation": "The speed of the filter, from -2 (lower speed) to 3 (higher speed), with 0 being the nominal value.", "smithy.api#jsonName": "speed" } + }, + "Strength": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max16", + "traits": { + "smithy.api#documentation": "Relative strength of noise reducing filter. Higher values produce stronger filtering.", + "smithy.api#jsonName": "strength" + } } }, "traits": { @@ -13256,13 +13304,6 @@ "com.amazonaws.mediaconvert#NoiseReducerTemporalFilterSettings": { "type": "structure", "members": { - "Speed": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative1Max3", - "traits": { - "smithy.api#documentation": "The speed of the filter (higher number is faster). Low setting reduces bit rate at the cost of transcode time, high setting improves transcode time at the cost of bit rate.", - "smithy.api#jsonName": "speed" - } - }, "AggressiveMode": { "target": "com.amazonaws.mediaconvert#__integerMin0Max4", "traits": { @@ -13270,19 +13311,26 @@ "smithy.api#jsonName": "aggressiveMode" } }, - "Strength": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max16", - "traits": { - "smithy.api#documentation": "Specify the strength of the noise reducing filter on this output. Higher values produce stronger filtering. We recommend the following value ranges, depending on the result that you want: * 0-2 for complexity reduction with minimal sharpness loss * 2-8 for complexity reduction with image preservation * 8-16 for a high level of complexity reduction", - "smithy.api#jsonName": "strength" - } - }, "PostTemporalSharpening": { "target": "com.amazonaws.mediaconvert#NoiseFilterPostTemporalSharpening", "traits": { "smithy.api#documentation": "Optional. When you set Noise reducer (noiseReducer) to Temporal (TEMPORAL), you can use this setting to apply sharpening. The default behavior, Auto (AUTO), allows the transcoder to determine whether to apply filtering, depending on input type and quality. When you set Noise reducer to Temporal, your output bandwidth is reduced. When Post temporal sharpening is also enabled, that bandwidth reduction is smaller.", "smithy.api#jsonName": "postTemporalSharpening" } + }, + "Speed": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative1Max3", + "traits": { + "smithy.api#documentation": "The speed of the filter (higher number is faster). Low setting reduces bit rate at the cost of transcode time, high setting improves transcode time at the cost of bit rate.", + "smithy.api#jsonName": "speed" + } + }, + "Strength": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max16", + "traits": { + "smithy.api#documentation": "Specify the strength of the noise reducing filter on this output. Higher values produce stronger filtering. We recommend the following value ranges, depending on the result that you want: * 0-2 for complexity reduction with minimal sharpness loss * 2-8 for complexity reduction with image preservation * 8-16 for a high level of complexity reduction", + "smithy.api#jsonName": "strength" + } } }, "traits": { @@ -13353,11 +13401,11 @@ "com.amazonaws.mediaconvert#Output": { "type": "structure", "members": { - "VideoDescription": { - "target": "com.amazonaws.mediaconvert#VideoDescription", + "AudioDescriptions": { + "target": "com.amazonaws.mediaconvert#__listOfAudioDescription", "traits": { - "smithy.api#documentation": "(VideoDescription) contains a group of video encoding settings. The specific video settings depend on the video codec that you choose when you specify a value for Video codec (codec). Include one instance of (VideoDescription) per output.", - "smithy.api#jsonName": "videoDescription" + "smithy.api#documentation": "(AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings.", + "smithy.api#jsonName": "audioDescriptions" } }, "CaptionDescriptions": { @@ -13367,13 +13415,6 @@ "smithy.api#jsonName": "captionDescriptions" } }, - "Extension": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "Use Extension (Extension) to specify the file extension for outputs in File output groups. If you do not specify a value, the service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts * Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * WebM container, webm * No Container, the service will use codec extensions (e.g. AAC, H265, H265, AC3)", - "smithy.api#jsonName": "extension" - } - }, "ContainerSettings": { "target": "com.amazonaws.mediaconvert#ContainerSettings", "traits": { @@ -13381,18 +13422,11 @@ "smithy.api#jsonName": "containerSettings" } }, - "AudioDescriptions": { - "target": "com.amazonaws.mediaconvert#__listOfAudioDescription", - "traits": { - "smithy.api#documentation": "(AudioDescriptions) contains groups of audio encoding settings organized by audio codec. Include one instance of (AudioDescriptions) per output. (AudioDescriptions) can contain multiple groups of encoding settings.", - "smithy.api#jsonName": "audioDescriptions" - } - }, - "OutputSettings": { - "target": "com.amazonaws.mediaconvert#OutputSettings", + "Extension": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Specific settings for this type of output.", - "smithy.api#jsonName": "outputSettings" + "smithy.api#documentation": "Use Extension (Extension) to specify the file extension for outputs in File output groups. If you do not specify a value, the service will use default extensions by container type as follows * MPEG-2 transport stream, m2ts * Quicktime, mov * MXF container, mxf * MPEG-4 container, mp4 * WebM container, webm * No Container, the service will use codec extensions (e.g. AAC, H265, H265, AC3)", + "smithy.api#jsonName": "extension" } }, "NameModifier": { @@ -13402,12 +13436,26 @@ "smithy.api#jsonName": "nameModifier" } }, + "OutputSettings": { + "target": "com.amazonaws.mediaconvert#OutputSettings", + "traits": { + "smithy.api#documentation": "Specific settings for this type of output.", + "smithy.api#jsonName": "outputSettings" + } + }, "Preset": { "target": "com.amazonaws.mediaconvert#__stringMin0", "traits": { "smithy.api#documentation": "Use Preset (Preset) to specifiy a preset for your transcoding settings. Provide the system or custom preset name. You can specify either Preset (Preset) or Container settings (ContainerSettings), but not both.", "smithy.api#jsonName": "preset" } + }, + "VideoDescription": { + "target": "com.amazonaws.mediaconvert#VideoDescription", + "traits": { + "smithy.api#documentation": "(VideoDescription) contains a group of video encoding settings. The specific video settings depend on the video codec that you choose when you specify a value for Video codec (codec). Include one instance of (VideoDescription) per output.", + "smithy.api#jsonName": "videoDescription" + } } }, "traits": { @@ -13454,11 +13502,11 @@ "com.amazonaws.mediaconvert#OutputGroup": { "type": "structure", "members": { - "Outputs": { - "target": "com.amazonaws.mediaconvert#__listOfOutput", + "AutomatedEncodingSettings": { + "target": "com.amazonaws.mediaconvert#AutomatedEncodingSettings", "traits": { - "smithy.api#documentation": "This object holds groups of encoding settings, one group of settings per output.", - "smithy.api#jsonName": "outputs" + "smithy.api#documentation": "Use automated encoding to have MediaConvert choose your encoding settings for you, based on characteristics of your input video.", + "smithy.api#jsonName": "automatedEncodingSettings" } }, "CustomName": { @@ -13468,6 +13516,13 @@ "smithy.api#jsonName": "customName" } }, + "Name": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Name of the output group", + "smithy.api#jsonName": "name" + } + }, "OutputGroupSettings": { "target": "com.amazonaws.mediaconvert#OutputGroupSettings", "traits": { @@ -13475,11 +13530,11 @@ "smithy.api#jsonName": "outputGroupSettings" } }, - "Name": { - "target": "com.amazonaws.mediaconvert#__string", + "Outputs": { + "target": "com.amazonaws.mediaconvert#__listOfOutput", "traits": { - "smithy.api#documentation": "Name of the output group", - "smithy.api#jsonName": "name" + "smithy.api#documentation": "This object holds groups of encoding settings, one group of settings per output.", + "smithy.api#jsonName": "outputs" } } }, @@ -13505,13 +13560,6 @@ "com.amazonaws.mediaconvert#OutputGroupSettings": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.mediaconvert#OutputGroupType", - "traits": { - "smithy.api#documentation": "Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth Streaming, CMAF)", - "smithy.api#jsonName": "type" - } - }, "CmafGroupSettings": { "target": "com.amazonaws.mediaconvert#CmafGroupSettings", "traits": { @@ -13519,6 +13567,13 @@ "smithy.api#jsonName": "cmafGroupSettings" } }, + "DashIsoGroupSettings": { + "target": "com.amazonaws.mediaconvert#DashIsoGroupSettings", + "traits": { + "smithy.api#documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to DASH_ISO_GROUP_SETTINGS.", + "smithy.api#jsonName": "dashIsoGroupSettings" + } + }, "FileGroupSettings": { "target": "com.amazonaws.mediaconvert#FileGroupSettings", "traits": { @@ -13533,19 +13588,19 @@ "smithy.api#jsonName": "hlsGroupSettings" } }, - "DashIsoGroupSettings": { - "target": "com.amazonaws.mediaconvert#DashIsoGroupSettings", - "traits": { - "smithy.api#documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to DASH_ISO_GROUP_SETTINGS.", - "smithy.api#jsonName": "dashIsoGroupSettings" - } - }, "MsSmoothGroupSettings": { "target": "com.amazonaws.mediaconvert#MsSmoothGroupSettings", "traits": { "smithy.api#documentation": "Required when you set (Type) under (OutputGroups)>(OutputGroupSettings) to MS_SMOOTH_GROUP_SETTINGS.", "smithy.api#jsonName": "msSmoothGroupSettings" } + }, + "Type": { + "target": "com.amazonaws.mediaconvert#OutputGroupType", + "traits": { + "smithy.api#documentation": "Type of output group (File group, Apple HLS, DASH ISO, Microsoft Smooth Streaming, CMAF)", + "smithy.api#jsonName": "type" + } } }, "traits": { @@ -13644,6 +13699,27 @@ "smithy.api#jsonName": "arn" } }, + "Category": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "An optional category you create to organize your presets.", + "smithy.api#jsonName": "category" + } + }, + "CreatedAt": { + "target": "com.amazonaws.mediaconvert#__timestampUnix", + "traits": { + "smithy.api#documentation": "The timestamp in epoch seconds for preset creation.", + "smithy.api#jsonName": "createdAt" + } + }, + "Description": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "An optional description you create for each preset.", + "smithy.api#jsonName": "description" + } + }, "LastUpdated": { "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { @@ -13673,27 +13749,6 @@ "smithy.api#documentation": "A preset can be of two types: system or custom. System or built-in preset can't be modified or deleted by the user.", "smithy.api#jsonName": "type" } - }, - "CreatedAt": { - "target": "com.amazonaws.mediaconvert#__timestampUnix", - "traits": { - "smithy.api#documentation": "The timestamp in epoch seconds for preset creation.", - "smithy.api#jsonName": "createdAt" - } - }, - "Description": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "An optional description you create for each preset.", - "smithy.api#jsonName": "description" - } - }, - "Category": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "An optional category you create to organize your presets.", - "smithy.api#jsonName": "category" - } } }, "traits": { @@ -13730,11 +13785,11 @@ "smithy.api#jsonName": "audioDescriptions" } }, - "VideoDescription": { - "target": "com.amazonaws.mediaconvert#VideoDescription", + "CaptionDescriptions": { + "target": "com.amazonaws.mediaconvert#__listOfCaptionDescriptionPreset", "traits": { - "smithy.api#documentation": "(VideoDescription) contains a group of video encoding settings. The specific video settings depend on the video codec that you choose when you specify a value for Video codec (codec). Include one instance of (VideoDescription) per output.", - "smithy.api#jsonName": "videoDescription" + "smithy.api#documentation": "Caption settings for this preset. There can be multiple caption settings in a single output.", + "smithy.api#jsonName": "captionDescriptions" } }, "ContainerSettings": { @@ -13744,11 +13799,11 @@ "smithy.api#jsonName": "containerSettings" } }, - "CaptionDescriptions": { - "target": "com.amazonaws.mediaconvert#__listOfCaptionDescriptionPreset", + "VideoDescription": { + "target": "com.amazonaws.mediaconvert#VideoDescription", "traits": { - "smithy.api#documentation": "Caption settings for this preset. There can be multiple caption settings in a single output.", - "smithy.api#jsonName": "captionDescriptions" + "smithy.api#documentation": "(VideoDescription) contains a group of video encoding settings. The specific video settings depend on the video codec that you choose when you specify a value for Video codec (codec). Include one instance of (VideoDescription) per output.", + "smithy.api#jsonName": "videoDescription" } } }, @@ -13878,40 +13933,19 @@ }, "com.amazonaws.mediaconvert#ProresSettings": { "type": "structure", - "members": { - "ParControl": { - "target": "com.amazonaws.mediaconvert#ProresParControl", - "traits": { - "smithy.api#documentation": "Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses the PAR from your input video for your output. To specify a different PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.", - "smithy.api#jsonName": "parControl" - } - }, - "Telecine": { - "target": "com.amazonaws.mediaconvert#ProresTelecine", - "traits": { - "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine (HARD) to create a smoother picture. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", - "smithy.api#jsonName": "telecine" - } - }, - "SlowPal": { - "target": "com.amazonaws.mediaconvert#ProresSlowPal", - "traits": { - "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", - "smithy.api#jsonName": "slowPal" - } - }, - "InterlaceMode": { - "target": "com.amazonaws.mediaconvert#ProresInterlaceMode", + "members": { + "CodecProfile": { + "target": "com.amazonaws.mediaconvert#ProresCodecProfile", "traits": { - "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", - "smithy.api#jsonName": "interlaceMode" + "smithy.api#documentation": "Use Profile (ProResCodecProfile) to specifiy the type of Apple ProRes codec to use for this output.", + "smithy.api#jsonName": "codecProfile" } }, - "ParDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "FramerateControl": { + "target": "com.amazonaws.mediaconvert#ProresFramerateControl", "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", - "smithy.api#jsonName": "parDenominator" + "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#jsonName": "framerateControl" } }, "FramerateConversionAlgorithm": { @@ -13928,18 +13962,32 @@ "smithy.api#jsonName": "framerateDenominator" } }, - "CodecProfile": { - "target": "com.amazonaws.mediaconvert#ProresCodecProfile", + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Use Profile (ProResCodecProfile) to specifiy the type of Apple ProRes codec to use for this output.", - "smithy.api#jsonName": "codecProfile" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" } }, - "FramerateControl": { - "target": "com.amazonaws.mediaconvert#ProresFramerateControl", + "InterlaceMode": { + "target": "com.amazonaws.mediaconvert#ProresInterlaceMode", "traits": { - "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", - "smithy.api#jsonName": "framerateControl" + "smithy.api#documentation": "Choose the scan line type for the output. Keep the default value, Progressive (PROGRESSIVE) to create a progressive output, regardless of the scan type of your input. Use Top field first (TOP_FIELD) or Bottom field first (BOTTOM_FIELD) to create an output that's interlaced with the same field polarity throughout. Use Follow, default top (FOLLOW_TOP_FIELD) or Follow, default bottom (FOLLOW_BOTTOM_FIELD) to produce outputs with the same field polarity as the source. For jobs that have multiple inputs, the output field polarity might change over the course of the output. Follow behavior depends on the input scan type. If the source is interlaced, the output will be interlaced with the same polarity as the source. If the source is progressive, the output will be interlaced with top field bottom field first, depending on which of the Follow options you choose.", + "smithy.api#jsonName": "interlaceMode" + } + }, + "ParControl": { + "target": "com.amazonaws.mediaconvert#ProresParControl", + "traits": { + "smithy.api#documentation": "Optional. Specify how the service determines the pixel aspect ratio (PAR) for this output. The default behavior, Follow source (INITIALIZE_FROM_SOURCE), uses the PAR from your input video for your output. To specify a different PAR in the console, choose any value other than Follow source. To specify a different PAR by editing the JSON job specification, choose SPECIFIED. When you choose SPECIFIED for this setting, you must also specify values for the parNumerator and parDenominator settings.", + "smithy.api#jsonName": "parControl" + } + }, + "ParDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "traits": { + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", + "smithy.api#jsonName": "parDenominator" } }, "ParNumerator": { @@ -13949,11 +13997,18 @@ "smithy.api#jsonName": "parNumerator" } }, - "FramerateNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "SlowPal": { + "target": "com.amazonaws.mediaconvert#ProresSlowPal", "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateNumerator" + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output. When you enable slow PAL, MediaConvert relabels the video frames to 25 fps and resamples your audio to keep it synchronized with the video. Note that enabling this setting will slightly reduce the duration of your video. Required settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", + "smithy.api#jsonName": "slowPal" + } + }, + "Telecine": { + "target": "com.amazonaws.mediaconvert#ProresTelecine", + "traits": { + "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine (HARD) to create a smoother picture. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", + "smithy.api#jsonName": "telecine" } } }, @@ -13996,18 +14051,18 @@ "com.amazonaws.mediaconvert#Queue": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.mediaconvert#Type", + "Arn": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues.", - "smithy.api#jsonName": "type" + "smithy.api#documentation": "An identifier for this resource that is unique within all of AWS.", + "smithy.api#jsonName": "arn" } }, - "Status": { - "target": "com.amazonaws.mediaconvert#QueueStatus", + "CreatedAt": { + "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { - "smithy.api#documentation": "Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.", - "smithy.api#jsonName": "status" + "smithy.api#documentation": "The timestamp in epoch seconds for when you created the queue.", + "smithy.api#jsonName": "createdAt" } }, "Description": { @@ -14017,11 +14072,19 @@ "smithy.api#jsonName": "description" } }, - "CreatedAt": { + "LastUpdated": { "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { - "smithy.api#documentation": "The timestamp in epoch seconds for when you created the queue.", - "smithy.api#jsonName": "createdAt" + "smithy.api#documentation": "The timestamp in epoch seconds for when you most recently updated the queue.", + "smithy.api#jsonName": "lastUpdated" + } + }, + "Name": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "A name that you create for each queue. Each name must be unique within your account.", + "smithy.api#jsonName": "name", + "smithy.api#required": {} } }, "PricingPlan": { @@ -14031,11 +14094,11 @@ "smithy.api#jsonName": "pricingPlan" } }, - "LastUpdated": { - "target": "com.amazonaws.mediaconvert#__timestampUnix", + "ProgressingJobsCount": { + "target": "com.amazonaws.mediaconvert#__integer", "traits": { - "smithy.api#documentation": "The timestamp in epoch seconds for when you most recently updated the queue.", - "smithy.api#jsonName": "lastUpdated" + "smithy.api#documentation": "The estimated number of jobs with a PROGRESSING status.", + "smithy.api#jsonName": "progressingJobsCount" } }, "ReservationPlan": { @@ -14045,6 +14108,13 @@ "smithy.api#jsonName": "reservationPlan" } }, + "Status": { + "target": "com.amazonaws.mediaconvert#QueueStatus", + "traits": { + "smithy.api#documentation": "Queues can be ACTIVE or PAUSED. If you pause a queue, the service won't begin processing jobs in that queue. Jobs that are running when you pause the queue continue to run until they finish or result in an error.", + "smithy.api#jsonName": "status" + } + }, "SubmittedJobsCount": { "target": "com.amazonaws.mediaconvert#__integer", "traits": { @@ -14052,26 +14122,11 @@ "smithy.api#jsonName": "submittedJobsCount" } }, - "Arn": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "An identifier for this resource that is unique within all of AWS.", - "smithy.api#jsonName": "arn" - } - }, - "Name": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "A name that you create for each queue. Each name must be unique within your account.", - "smithy.api#jsonName": "name", - "smithy.api#required": {} - } - }, - "ProgressingJobsCount": { - "target": "com.amazonaws.mediaconvert#__integer", + "Type": { + "target": "com.amazonaws.mediaconvert#Type", "traits": { - "smithy.api#documentation": "The estimated number of jobs with a PROGRESSING status.", - "smithy.api#jsonName": "progressingJobsCount" + "smithy.api#documentation": "Specifies whether this on-demand queue is system or custom. System queues are built in. You can't modify or delete system queues. You can create and modify custom queues.", + "smithy.api#jsonName": "type" } } }, @@ -14114,11 +14169,11 @@ "com.amazonaws.mediaconvert#QueueTransition": { "type": "structure", "members": { - "Timestamp": { - "target": "com.amazonaws.mediaconvert#__timestampUnix", + "DestinationQueue": { + "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "The time, in Unix epoch format, that the job moved from the source queue to the destination queue.", - "smithy.api#jsonName": "timestamp" + "smithy.api#documentation": "The queue that the job was on after the transition.", + "smithy.api#jsonName": "destinationQueue" } }, "SourceQueue": { @@ -14128,11 +14183,11 @@ "smithy.api#jsonName": "sourceQueue" } }, - "DestinationQueue": { - "target": "com.amazonaws.mediaconvert#__string", + "Timestamp": { + "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { - "smithy.api#documentation": "The queue that the job was on after the transition.", - "smithy.api#jsonName": "destinationQueue" + "smithy.api#documentation": "The time, in Unix epoch format, that the job moved from the source queue to the destination queue.", + "smithy.api#jsonName": "timestamp" } } }, @@ -14143,11 +14198,11 @@ "com.amazonaws.mediaconvert#Rectangle": { "type": "structure", "members": { - "X": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", + "Height": { + "target": "com.amazonaws.mediaconvert#__integerMin2Max2147483647", "traits": { - "smithy.api#documentation": "The distance, in pixels, between the rectangle and the left edge of the video frame. Specify only even numbers.", - "smithy.api#jsonName": "x" + "smithy.api#documentation": "Height of rectangle in pixels. Specify only even numbers.", + "smithy.api#jsonName": "height" } }, "Width": { @@ -14157,18 +14212,18 @@ "smithy.api#jsonName": "width" } }, - "Y": { + "X": { "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "The distance, in pixels, between the rectangle and the top edge of the video frame. Specify only even numbers.", - "smithy.api#jsonName": "y" + "smithy.api#documentation": "The distance, in pixels, between the rectangle and the left edge of the video frame. Specify only even numbers.", + "smithy.api#jsonName": "x" } }, - "Height": { - "target": "com.amazonaws.mediaconvert#__integerMin2Max2147483647", + "Y": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max2147483647", "traits": { - "smithy.api#documentation": "Height of rectangle in pixels. Specify only even numbers.", - "smithy.api#jsonName": "height" + "smithy.api#documentation": "The distance, in pixels, between the rectangle and the top edge of the video frame. Specify only even numbers.", + "smithy.api#jsonName": "y" } } }, @@ -14179,6 +14234,13 @@ "com.amazonaws.mediaconvert#RemixSettings": { "type": "structure", "members": { + "ChannelMapping": { + "target": "com.amazonaws.mediaconvert#ChannelMapping", + "traits": { + "smithy.api#documentation": "Channel mapping (ChannelMapping) contains the group of fields that hold the remixing value for each channel. Units are in dB. Acceptable values are within the range from -60 (mute) through 6. A setting of 0 passes the input channel unchanged to the output channel (no attenuation or amplification).", + "smithy.api#jsonName": "channelMapping" + } + }, "ChannelsIn": { "target": "com.amazonaws.mediaconvert#__integerMin1Max64", "traits": { @@ -14192,13 +14254,6 @@ "smithy.api#documentation": "Specify the number of channels in this output after remixing. Valid values: 1, 2, 4, 6, 8... 64. (1 and even numbers to 64.)", "smithy.api#jsonName": "channelsOut" } - }, - "ChannelMapping": { - "target": "com.amazonaws.mediaconvert#ChannelMapping", - "traits": { - "smithy.api#documentation": "Channel mapping (ChannelMapping) contains the group of fields that hold the remixing value for each channel. Units are in dB. Acceptable values are within the range from -60 (mute) through 6. A setting of 0 passes the input channel unchanged to the output channel (no attenuation or amplification).", - "smithy.api#jsonName": "channelMapping" - } } }, "traits": { @@ -14224,25 +14279,25 @@ "com.amazonaws.mediaconvert#ReservationPlan": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.mediaconvert#ReservationPlanStatus", + "Commitment": { + "target": "com.amazonaws.mediaconvert#Commitment", "traits": { - "smithy.api#documentation": "Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.", - "smithy.api#jsonName": "status" + "smithy.api#documentation": "The length of the term of your reserved queue pricing plan commitment.", + "smithy.api#jsonName": "commitment" } }, - "PurchasedAt": { + "ExpiresAt": { "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { - "smithy.api#documentation": "The timestamp in epoch seconds for when you set up the current pricing plan for this reserved queue.", - "smithy.api#jsonName": "purchasedAt" + "smithy.api#documentation": "The timestamp in epoch seconds for when the current pricing plan term for this reserved queue expires.", + "smithy.api#jsonName": "expiresAt" } }, - "ExpiresAt": { + "PurchasedAt": { "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { - "smithy.api#documentation": "The timestamp in epoch seconds for when the current pricing plan term for this reserved queue expires.", - "smithy.api#jsonName": "expiresAt" + "smithy.api#documentation": "The timestamp in epoch seconds for when you set up the current pricing plan for this reserved queue.", + "smithy.api#jsonName": "purchasedAt" } }, "RenewalType": { @@ -14252,19 +14307,19 @@ "smithy.api#jsonName": "renewalType" } }, - "Commitment": { - "target": "com.amazonaws.mediaconvert#Commitment", - "traits": { - "smithy.api#documentation": "The length of the term of your reserved queue pricing plan commitment.", - "smithy.api#jsonName": "commitment" - } - }, "ReservedSlots": { "target": "com.amazonaws.mediaconvert#__integer", "traits": { "smithy.api#documentation": "Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. When you increase this number, you extend your existing commitment with a new 12-month commitment for a larger number of RTS. The new commitment begins when you purchase the additional capacity. You can't decrease the number of RTS in your reserved queue.", "smithy.api#jsonName": "reservedSlots" } + }, + "Status": { + "target": "com.amazonaws.mediaconvert#ReservationPlanStatus", + "traits": { + "smithy.api#documentation": "Specifies whether the pricing plan for your reserved queue is ACTIVE or EXPIRED.", + "smithy.api#jsonName": "status" + } } }, "traits": { @@ -14274,14 +14329,6 @@ "com.amazonaws.mediaconvert#ReservationPlanSettings": { "type": "structure", "members": { - "ReservedSlots": { - "target": "com.amazonaws.mediaconvert#__integer", - "traits": { - "smithy.api#documentation": "Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. You can't decrease the number of RTS in your reserved queue. You can increase the number of RTS by extending your existing commitment with a new 12-month commitment for the larger number. The new commitment begins when you purchase the additional capacity. You can't cancel your commitment or revert to your original commitment after you increase the capacity.", - "smithy.api#jsonName": "reservedSlots", - "smithy.api#required": {} - } - }, "Commitment": { "target": "com.amazonaws.mediaconvert#Commitment", "traits": { @@ -14297,6 +14344,14 @@ "smithy.api#jsonName": "renewalType", "smithy.api#required": {} } + }, + "ReservedSlots": { + "target": "com.amazonaws.mediaconvert#__integer", + "traits": { + "smithy.api#documentation": "Specifies the number of reserved transcode slots (RTS) for this queue. The number of RTS determines how many jobs the queue can process in parallel; each RTS can process one job at a time. You can't decrease the number of RTS in your reserved queue. You can increase the number of RTS by extending your existing commitment with a new 12-month commitment for the larger number. The new commitment begins when you purchase the additional capacity. You can't cancel your commitment or revert to your original commitment after you increase the capacity.", + "smithy.api#jsonName": "reservedSlots", + "smithy.api#required": {} + } } }, "traits": { @@ -14322,19 +14377,19 @@ "com.amazonaws.mediaconvert#ResourceTags": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.mediaconvert#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags for the resource.", - "smithy.api#jsonName": "tags" - } - }, "Arn": { "target": "com.amazonaws.mediaconvert#__string", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.", "smithy.api#jsonName": "arn" } + }, + "Tags": { + "target": "com.amazonaws.mediaconvert#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags for the resource.", + "smithy.api#jsonName": "tags" + } } }, "traits": { @@ -14374,24 +14429,24 @@ }, "traits": { "smithy.api#documentation": "Optional. Have MediaConvert automatically apply Amazon S3 access control for the outputs in this output group. When you don't use this setting, S3 automatically applies the default access control list PRIVATE." - } - }, - "com.amazonaws.mediaconvert#S3DestinationSettings": { - "type": "structure", - "members": { - "Encryption": { - "target": "com.amazonaws.mediaconvert#S3EncryptionSettings", - "traits": { - "smithy.api#documentation": "Settings for how your job outputs are encrypted as they are uploaded to Amazon S3.", - "smithy.api#jsonName": "encryption" - } - }, + } + }, + "com.amazonaws.mediaconvert#S3DestinationSettings": { + "type": "structure", + "members": { "AccessControl": { "target": "com.amazonaws.mediaconvert#S3DestinationAccessControl", "traits": { "smithy.api#documentation": "Optional. Have MediaConvert automatically apply Amazon S3 access control for the outputs in this output group. When you don't use this setting, S3 automatically applies the default access control list PRIVATE.", "smithy.api#jsonName": "accessControl" } + }, + "Encryption": { + "target": "com.amazonaws.mediaconvert#S3EncryptionSettings", + "traits": { + "smithy.api#documentation": "Settings for how your job outputs are encrypted as they are uploaded to Amazon S3.", + "smithy.api#jsonName": "encryption" + } } }, "traits": { @@ -14538,11 +14593,11 @@ "com.amazonaws.mediaconvert#SpekeKeyProvider": { "type": "structure", "members": { - "SystemIds": { - "target": "com.amazonaws.mediaconvert#__listOf__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12", + "CertificateArn": { + "target": "com.amazonaws.mediaconvert#__stringPatternArnAwsUsGovAcm", "traits": { - "smithy.api#documentation": "Relates to SPEKE implementation. DRM system identifiers. DASH output groups support a max of two system ids. Other group types support one system id. See\n https://dashif.org/identifiers/content_protection/ for more details.", - "smithy.api#jsonName": "systemIds" + "smithy.api#documentation": "If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here.", + "smithy.api#jsonName": "certificateArn" } }, "ResourceId": { @@ -14552,11 +14607,11 @@ "smithy.api#jsonName": "resourceId" } }, - "CertificateArn": { - "target": "com.amazonaws.mediaconvert#__stringPatternArnAwsUsGovAcm", + "SystemIds": { + "target": "com.amazonaws.mediaconvert#__listOf__stringPattern09aFAF809aFAF409aFAF409aFAF409aFAF12", "traits": { - "smithy.api#documentation": "If you want your key provider to encrypt the content keys that it provides to MediaConvert, set up a certificate with a master key using AWS Certificate Manager. Specify the certificate's Amazon Resource Name (ARN) here.", - "smithy.api#jsonName": "certificateArn" + "smithy.api#documentation": "Relates to SPEKE implementation. DRM system identifiers. DASH output groups support a max of two system ids. Other group types support one system id. See\n https://dashif.org/identifiers/content_protection/ for more details.", + "smithy.api#jsonName": "systemIds" } }, "Url": { @@ -14574,20 +14629,6 @@ "com.amazonaws.mediaconvert#SpekeKeyProviderCmaf": { "type": "structure", "members": { - "Url": { - "target": "com.amazonaws.mediaconvert#__stringPatternHttps", - "traits": { - "smithy.api#documentation": "Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content.", - "smithy.api#jsonName": "url" - } - }, - "ResourceId": { - "target": "com.amazonaws.mediaconvert#__stringPatternW", - "traits": { - "smithy.api#documentation": "Specify the resource ID that your SPEKE-compliant key provider uses to identify this content.", - "smithy.api#jsonName": "resourceId" - } - }, "CertificateArn": { "target": "com.amazonaws.mediaconvert#__stringPatternArnAwsUsGovAcm", "traits": { @@ -14608,6 +14649,20 @@ "smithy.api#documentation": "Specify the DRM system ID that you want signaled in the HLS manifest that MediaConvert creates as part of this CMAF package. The HLS manifest can currently signal only one system ID. For more information, see https://dashif.org/identifiers/content_protection/.", "smithy.api#jsonName": "hlsSignaledSystemIds" } + }, + "ResourceId": { + "target": "com.amazonaws.mediaconvert#__stringPatternW", + "traits": { + "smithy.api#documentation": "Specify the resource ID that your SPEKE-compliant key provider uses to identify this content.", + "smithy.api#jsonName": "resourceId" + } + }, + "Url": { + "target": "com.amazonaws.mediaconvert#__stringPatternHttps", + "traits": { + "smithy.api#documentation": "Specify the URL to the key server that your SPEKE-compliant DRM key provider uses to provide keys for encrypting your content.", + "smithy.api#jsonName": "url" + } } }, "traits": { @@ -14617,13 +14672,6 @@ "com.amazonaws.mediaconvert#StaticKeyProvider": { "type": "structure", "members": { - "KeyFormatVersions": { - "target": "com.amazonaws.mediaconvert#__stringPatternDD", - "traits": { - "smithy.api#documentation": "Relates to DRM implementation. Either a single positive integer version value or a slash delimited list of version values (1/2/3).", - "smithy.api#jsonName": "keyFormatVersions" - } - }, "KeyFormat": { "target": "com.amazonaws.mediaconvert#__stringPatternIdentityAZaZ26AZaZ09163", "traits": { @@ -14631,11 +14679,11 @@ "smithy.api#jsonName": "keyFormat" } }, - "Url": { - "target": "com.amazonaws.mediaconvert#__string", + "KeyFormatVersions": { + "target": "com.amazonaws.mediaconvert#__stringPatternDD", "traits": { - "smithy.api#documentation": "Relates to DRM implementation. The location of the license server used for protecting content.", - "smithy.api#jsonName": "url" + "smithy.api#documentation": "Relates to DRM implementation. Either a single positive integer version value or a slash delimited list of version values (1/2/3).", + "smithy.api#jsonName": "keyFormatVersions" } }, "StaticKeyValue": { @@ -14644,6 +14692,13 @@ "smithy.api#documentation": "Relates to DRM implementation. Use a 32-character hexidecimal string to specify Key Value (StaticKeyValue).", "smithy.api#jsonName": "staticKeyValue" } + }, + "Url": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "Relates to DRM implementation. The location of the license server used for protecting content.", + "smithy.api#jsonName": "url" + } } }, "traits": { @@ -14758,14 +14813,6 @@ "com.amazonaws.mediaconvert#TagResourceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.mediaconvert#__mapOf__string", - "traits": { - "smithy.api#documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.", - "smithy.api#jsonName": "tags", - "smithy.api#required": {} - } - }, "Arn": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -14773,6 +14820,14 @@ "smithy.api#jsonName": "arn", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.mediaconvert#__mapOf__string", + "traits": { + "smithy.api#documentation": "The tags that you want to add to the resource. You can tag resources with a key-value pair or with only a key.", + "smithy.api#jsonName": "tags", + "smithy.api#required": {} + } } } }, @@ -14848,11 +14903,11 @@ "com.amazonaws.mediaconvert#TimecodeBurnin": { "type": "structure", "members": { - "Prefix": { - "target": "com.amazonaws.mediaconvert#__stringPattern", + "FontSize": { + "target": "com.amazonaws.mediaconvert#__integerMin10Max48", "traits": { - "smithy.api#documentation": "Use Prefix (Prefix) to place ASCII characters before any burned-in timecode. For example, a prefix of \"EZ-\" will result in the timecode \"EZ-00:00:00:00\". Provide either the characters themselves or the ASCII code equivalents. The supported range of characters is 0x20 through 0x7e. This includes letters, numbers, and all special characters represented on a standard English keyboard.", - "smithy.api#jsonName": "prefix" + "smithy.api#documentation": "Use Font Size (FontSize) to set the font size of any burned-in timecode. Valid values are 10, 16, 32, 48.", + "smithy.api#jsonName": "fontSize" } }, "Position": { @@ -14862,11 +14917,11 @@ "smithy.api#jsonName": "position" } }, - "FontSize": { - "target": "com.amazonaws.mediaconvert#__integerMin10Max48", + "Prefix": { + "target": "com.amazonaws.mediaconvert#__stringPattern", "traits": { - "smithy.api#documentation": "Use Font Size (FontSize) to set the font size of any burned-in timecode. Valid values are 10, 16, 32, 48.", - "smithy.api#jsonName": "fontSize" + "smithy.api#documentation": "Use Prefix (Prefix) to place ASCII characters before any burned-in timecode. For example, a prefix of \"EZ-\" will result in the timecode \"EZ-00:00:00:00\". Provide either the characters themselves or the ASCII code equivalents. The supported range of characters is 0x20 through 0x7e. This includes letters, numbers, and all special characters represented on a standard English keyboard.", + "smithy.api#jsonName": "prefix" } } }, @@ -14921,20 +14976,6 @@ "com.amazonaws.mediaconvert#TimecodeConfig": { "type": "structure", "members": { - "Start": { - "target": "com.amazonaws.mediaconvert#__stringPattern010920405090509092", - "traits": { - "smithy.api#documentation": "Only use when you set Source (TimecodeSource) to Specified start (SPECIFIEDSTART). Use Start timecode (Start) to specify the timecode for the initial frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF).", - "smithy.api#jsonName": "start" - } - }, - "TimestampOffset": { - "target": "com.amazonaws.mediaconvert#__stringPattern0940191020191209301", - "traits": { - "smithy.api#documentation": "Only applies to outputs that support program-date-time stamp. Use Timestamp offset (TimestampOffset) to overwrite the timecode date without affecting the time and frame number. Provide the new date as a string in the format \"yyyy-mm-dd\". To use Time stamp offset, you must also enable Insert program-date-time (InsertProgramDateTime) in the output settings. For example, if the date part of your timecodes is 2002-1-25 and you want to change it to one year later, set Timestamp offset (TimestampOffset) to 2003-1-25.", - "smithy.api#jsonName": "timestampOffset" - } - }, "Anchor": { "target": "com.amazonaws.mediaconvert#__stringPattern010920405090509092", "traits": { @@ -14948,6 +14989,20 @@ "smithy.api#documentation": "Use Source (TimecodeSource) to set how timecodes are handled within this job. To make sure that your video, audio, captions, and markers are synchronized and that time-based features, such as image inserter, work correctly, choose the Timecode source option that matches your assets. All timecodes are in a 24-hour format with frame number (HH:MM:SS:FF). * Embedded (EMBEDDED) - Use the timecode that is in the input video. If no embedded timecode is in the source, the service will use Start at 0 (ZEROBASED) instead. * Start at 0 (ZEROBASED) - Set the timecode of the initial frame to 00:00:00:00. * Specified Start (SPECIFIEDSTART) - Set the timecode of the initial frame to a value other than zero. You use Start timecode (Start) to provide this value.", "smithy.api#jsonName": "source" } + }, + "Start": { + "target": "com.amazonaws.mediaconvert#__stringPattern010920405090509092", + "traits": { + "smithy.api#documentation": "Only use when you set Source (TimecodeSource) to Specified start (SPECIFIEDSTART). Use Start timecode (Start) to specify the timecode for the initial frame. Use 24-hour format with frame number, (HH:MM:SS:FF) or (HH:MM:SS;FF).", + "smithy.api#jsonName": "start" + } + }, + "TimestampOffset": { + "target": "com.amazonaws.mediaconvert#__stringPattern0940191020191209301", + "traits": { + "smithy.api#documentation": "Only applies to outputs that support program-date-time stamp. Use Timestamp offset (TimestampOffset) to overwrite the timecode date without affecting the time and frame number. Provide the new date as a string in the format \"yyyy-mm-dd\". To use Time stamp offset, you must also enable Insert program-date-time (InsertProgramDateTime) in the output settings. For example, if the date part of your timecodes is 2002-1-25 and you want to change it to one year later, set Timestamp offset (TimestampOffset) to 2003-1-25.", + "smithy.api#jsonName": "timestampOffset" + } } }, "traits": { @@ -15008,13 +15063,6 @@ "com.amazonaws.mediaconvert#Timing": { "type": "structure", "members": { - "SubmitTime": { - "target": "com.amazonaws.mediaconvert#__timestampUnix", - "traits": { - "smithy.api#documentation": "The time, in Unix epoch format, that you submitted the job.", - "smithy.api#jsonName": "submitTime" - } - }, "FinishTime": { "target": "com.amazonaws.mediaconvert#__timestampUnix", "traits": { @@ -15028,6 +15076,13 @@ "smithy.api#documentation": "The time, in Unix epoch format, that transcoding for the job began.", "smithy.api#jsonName": "startTime" } + }, + "SubmitTime": { + "target": "com.amazonaws.mediaconvert#__timestampUnix", + "traits": { + "smithy.api#documentation": "The time, in Unix epoch format, that you submitted the job.", + "smithy.api#jsonName": "submitTime" + } } }, "traits": { @@ -15151,13 +15206,6 @@ "com.amazonaws.mediaconvert#UntagResourceRequest": { "type": "structure", "members": { - "TagKeys": { - "target": "com.amazonaws.mediaconvert#__listOf__string", - "traits": { - "smithy.api#documentation": "The keys of the tags that you want to remove from the resource.", - "smithy.api#jsonName": "tagKeys" - } - }, "Arn": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -15165,6 +15213,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "TagKeys": { + "target": "com.amazonaws.mediaconvert#__listOf__string", + "traits": { + "smithy.api#documentation": "The keys of the tags that you want to remove from the resource.", + "smithy.api#jsonName": "tagKeys" + } } } }, @@ -15212,35 +15267,6 @@ "com.amazonaws.mediaconvert#UpdateJobTemplateRequest": { "type": "structure", "members": { - "StatusUpdateInterval": { - "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", - "traits": { - "smithy.api#documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", - "smithy.api#jsonName": "statusUpdateInterval" - } - }, - "Settings": { - "target": "com.amazonaws.mediaconvert#JobTemplateSettings", - "traits": { - "smithy.api#documentation": "JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.", - "smithy.api#jsonName": "settings" - } - }, - "Name": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "The name of the job template you are modifying", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Priority": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", - "traits": { - "smithy.api#documentation": "Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.", - "smithy.api#jsonName": "priority" - } - }, "AccelerationSettings": { "target": "com.amazonaws.mediaconvert#AccelerationSettings", "traits": { @@ -15248,6 +15274,13 @@ "smithy.api#jsonName": "accelerationSettings" } }, + "Category": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "The new category for the job template, if you are changing it.", + "smithy.api#jsonName": "category" + } + }, "Description": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -15262,11 +15295,19 @@ "smithy.api#jsonName": "hopDestinations" } }, - "Category": { + "Name": { "target": "com.amazonaws.mediaconvert#__string", "traits": { - "smithy.api#documentation": "The new category for the job template, if you are changing it.", - "smithy.api#jsonName": "category" + "smithy.api#documentation": "The name of the job template you are modifying", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Priority": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative50Max50", + "traits": { + "smithy.api#documentation": "Specify the relative priority for this job. In any given queue, the service begins processing the job with the highest value first. When more than one job has the same priority, the service begins processing the job that you submitted first. If you don't specify a priority, the service uses the default value 0.", + "smithy.api#jsonName": "priority" } }, "Queue": { @@ -15275,6 +15316,20 @@ "smithy.api#documentation": "The new queue for the job template, if you are changing it.", "smithy.api#jsonName": "queue" } + }, + "Settings": { + "target": "com.amazonaws.mediaconvert#JobTemplateSettings", + "traits": { + "smithy.api#documentation": "JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.", + "smithy.api#jsonName": "settings" + } + }, + "StatusUpdateInterval": { + "target": "com.amazonaws.mediaconvert#StatusUpdateInterval", + "traits": { + "smithy.api#documentation": "Specify how often MediaConvert sends STATUS_UPDATE events to Amazon CloudWatch Events. Set the interval, in seconds, between status updates. MediaConvert sends an update at this interval from the time the service begins processing your job to the time it completes the transcode or encounters an error.", + "smithy.api#jsonName": "statusUpdateInterval" + } } } }, @@ -15330,6 +15385,13 @@ "com.amazonaws.mediaconvert#UpdatePresetRequest": { "type": "structure", "members": { + "Category": { + "target": "com.amazonaws.mediaconvert#__string", + "traits": { + "smithy.api#documentation": "The new category for the preset, if you are changing it.", + "smithy.api#jsonName": "category" + } + }, "Description": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -15351,13 +15413,6 @@ "smithy.api#documentation": "Settings for preset", "smithy.api#jsonName": "settings" } - }, - "Category": { - "target": "com.amazonaws.mediaconvert#__string", - "traits": { - "smithy.api#documentation": "The new category for the preset, if you are changing it.", - "smithy.api#jsonName": "category" - } } } }, @@ -15413,13 +15468,6 @@ "com.amazonaws.mediaconvert#UpdateQueueRequest": { "type": "structure", "members": { - "ReservationPlanSettings": { - "target": "com.amazonaws.mediaconvert#ReservationPlanSettings", - "traits": { - "smithy.api#documentation": "The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make these commitments, you can't cancel them.", - "smithy.api#jsonName": "reservationPlanSettings" - } - }, "Description": { "target": "com.amazonaws.mediaconvert#__string", "traits": { @@ -15435,6 +15483,13 @@ "smithy.api#required": {} } }, + "ReservationPlanSettings": { + "target": "com.amazonaws.mediaconvert#ReservationPlanSettings", + "traits": { + "smithy.api#documentation": "The new details of your pricing plan for your reserved queue. When you set up a new pricing plan to replace an expired one, you enter into another 12-month commitment. When you add capacity to your queue by increasing the number of RTS, you extend the term of your commitment to 12 months from when you add capacity. After you make these commitments, you can't cancel them.", + "smithy.api#jsonName": "reservationPlanSettings" + } + }, "Status": { "target": "com.amazonaws.mediaconvert#QueueStatus", "traits": { @@ -15531,27 +15586,6 @@ "com.amazonaws.mediaconvert#Vc3Settings": { "type": "structure", "members": { - "FramerateNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin24Max60000", - "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateNumerator" - } - }, - "SlowPal": { - "target": "com.amazonaws.mediaconvert#Vc3SlowPal", - "traits": { - "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output by relabeling the video frames and resampling your audio. Note that enabling this setting will slightly reduce the duration of your video. Related settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", - "smithy.api#jsonName": "slowPal" - } - }, - "Telecine": { - "target": "com.amazonaws.mediaconvert#Vc3Telecine", - "traits": { - "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine (HARD) to create a smoother picture. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", - "smithy.api#jsonName": "telecine" - } - }, "FramerateControl": { "target": "com.amazonaws.mediaconvert#Vc3FramerateControl", "traits": { @@ -15573,11 +15607,11 @@ "smithy.api#jsonName": "framerateDenominator" } }, - "Vc3Class": { - "target": "com.amazonaws.mediaconvert#Vc3Class", + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin24Max60000", "traits": { - "smithy.api#documentation": "Specify the VC3 class to choose the quality characteristics for this output. VC3 class, together with the settings Framerate (framerateNumerator and framerateDenominator) and Resolution (height and width), determine your output bitrate. For example, say that your video resolution is 1920x1080 and your framerate is 29.97. Then Class 145 (CLASS_145) gives you an output with a bitrate of approximately 145 Mbps and Class 220 (CLASS_220) gives you and output with a bitrate of approximately 220 Mbps. VC3 class also specifies the color bit depth of your output.", - "smithy.api#jsonName": "vc3Class" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" } }, "InterlaceMode": { @@ -15586,6 +15620,27 @@ "smithy.api#documentation": "Optional. Choose the scan line type for this output. If you don't specify a value, MediaConvert will create a progressive output.", "smithy.api#jsonName": "interlaceMode" } + }, + "SlowPal": { + "target": "com.amazonaws.mediaconvert#Vc3SlowPal", + "traits": { + "smithy.api#documentation": "Ignore this setting unless your input frame rate is 23.976 or 24 frames per second (fps). Enable slow PAL to create a 25 fps output by relabeling the video frames and resampling your audio. Note that enabling this setting will slightly reduce the duration of your video. Related settings: You must also set Framerate to 25. In your JSON job specification, set (framerateControl) to (SPECIFIED), (framerateNumerator) to 25 and (framerateDenominator) to 1.", + "smithy.api#jsonName": "slowPal" + } + }, + "Telecine": { + "target": "com.amazonaws.mediaconvert#Vc3Telecine", + "traits": { + "smithy.api#documentation": "When you do frame rate conversion from 23.976 frames per second (fps) to 29.97 fps, and your output scan type is interlaced, you can optionally enable hard telecine (HARD) to create a smoother picture. When you keep the default value, None (NONE), MediaConvert does a standard frame rate conversion to 29.97 without doing anything with the field polarity to create a smoother picture.", + "smithy.api#jsonName": "telecine" + } + }, + "Vc3Class": { + "target": "com.amazonaws.mediaconvert#Vc3Class", + "traits": { + "smithy.api#documentation": "Specify the VC3 class to choose the quality characteristics for this output. VC3 class, together with the settings Framerate (framerateNumerator and framerateDenominator) and Resolution (height and width), determine your output bitrate. For example, say that your video resolution is 1920x1080 and your framerate is 29.97. Then Class 145 (CLASS_145) gives you an output with a bitrate of approximately 145 Mbps and Class 220 (CLASS_220) gives you and output with a bitrate of approximately 220 Mbps. VC3 class also specifies the color bit depth of your output.", + "smithy.api#jsonName": "vc3Class" + } } }, "traits": { @@ -15682,13 +15737,6 @@ "smithy.api#jsonName": "av1Settings" } }, - "Mpeg2Settings": { - "target": "com.amazonaws.mediaconvert#Mpeg2Settings", - "traits": { - "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value MPEG2.", - "smithy.api#jsonName": "mpeg2Settings" - } - }, "AvcIntraSettings": { "target": "com.amazonaws.mediaconvert#AvcIntraSettings", "traits": { @@ -15696,25 +15744,11 @@ "smithy.api#jsonName": "avcIntraSettings" } }, - "ProresSettings": { - "target": "com.amazonaws.mediaconvert#ProresSettings", - "traits": { - "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value PRORES.", - "smithy.api#jsonName": "proresSettings" - } - }, - "Vp9Settings": { - "target": "com.amazonaws.mediaconvert#Vp9Settings", - "traits": { - "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VP9.", - "smithy.api#jsonName": "vp9Settings" - } - }, - "Vc3Settings": { - "target": "com.amazonaws.mediaconvert#Vc3Settings", + "Codec": { + "target": "com.amazonaws.mediaconvert#VideoCodec", "traits": { - "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VC3", - "smithy.api#jsonName": "vc3Settings" + "smithy.api#documentation": "Specifies the video codec. This must be equal to one of the enum values defined by the object VideoCodec.", + "smithy.api#jsonName": "codec" } }, "FrameCaptureSettings": { @@ -15724,6 +15758,13 @@ "smithy.api#jsonName": "frameCaptureSettings" } }, + "H264Settings": { + "target": "com.amazonaws.mediaconvert#H264Settings", + "traits": { + "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value H_264.", + "smithy.api#jsonName": "h264Settings" + } + }, "H265Settings": { "target": "com.amazonaws.mediaconvert#H265Settings", "traits": { @@ -15731,6 +15772,27 @@ "smithy.api#jsonName": "h265Settings" } }, + "Mpeg2Settings": { + "target": "com.amazonaws.mediaconvert#Mpeg2Settings", + "traits": { + "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value MPEG2.", + "smithy.api#jsonName": "mpeg2Settings" + } + }, + "ProresSettings": { + "target": "com.amazonaws.mediaconvert#ProresSettings", + "traits": { + "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value PRORES.", + "smithy.api#jsonName": "proresSettings" + } + }, + "Vc3Settings": { + "target": "com.amazonaws.mediaconvert#Vc3Settings", + "traits": { + "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VC3", + "smithy.api#jsonName": "vc3Settings" + } + }, "Vp8Settings": { "target": "com.amazonaws.mediaconvert#Vp8Settings", "traits": { @@ -15738,18 +15800,11 @@ "smithy.api#jsonName": "vp8Settings" } }, - "H264Settings": { - "target": "com.amazonaws.mediaconvert#H264Settings", - "traits": { - "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value H_264.", - "smithy.api#jsonName": "h264Settings" - } - }, - "Codec": { - "target": "com.amazonaws.mediaconvert#VideoCodec", + "Vp9Settings": { + "target": "com.amazonaws.mediaconvert#Vp9Settings", "traits": { - "smithy.api#documentation": "Specifies the video codec. This must be equal to one of the enum values defined by the object VideoCodec.", - "smithy.api#jsonName": "codec" + "smithy.api#documentation": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value VP9.", + "smithy.api#jsonName": "vp9Settings" } } }, @@ -15760,18 +15815,11 @@ "com.amazonaws.mediaconvert#VideoDescription": { "type": "structure", "members": { - "Position": { - "target": "com.amazonaws.mediaconvert#Rectangle", - "traits": { - "smithy.api#documentation": "Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.", - "smithy.api#jsonName": "position" - } - }, - "FixedAfd": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max15", + "AfdSignaling": { + "target": "com.amazonaws.mediaconvert#AfdSignaling", "traits": { - "smithy.api#documentation": "Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.", - "smithy.api#jsonName": "fixedAfd" + "smithy.api#documentation": "This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.", + "smithy.api#jsonName": "afdSignaling" } }, "AntiAlias": { @@ -15788,18 +15836,11 @@ "smithy.api#jsonName": "codecSettings" } }, - "Sharpness": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max100", - "traits": { - "smithy.api#documentation": "Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.", - "smithy.api#jsonName": "sharpness" - } - }, - "AfdSignaling": { - "target": "com.amazonaws.mediaconvert#AfdSignaling", + "ColorMetadata": { + "target": "com.amazonaws.mediaconvert#ColorMetadata", "traits": { - "smithy.api#documentation": "This setting only applies to H.264, H.265, and MPEG2 outputs. Use Insert AFD signaling (AfdSignaling) to specify whether the service includes AFD values in the output video data and what those values are. * Choose None to remove all AFD values from this output. * Choose Fixed to ignore input AFD values and instead encode the value specified in the job. * Choose Auto to calculate output AFD values based on the input AFD scaler data.", - "smithy.api#jsonName": "afdSignaling" + "smithy.api#documentation": "Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.", + "smithy.api#jsonName": "colorMetadata" } }, "Crop": { @@ -15809,25 +15850,32 @@ "smithy.api#jsonName": "crop" } }, - "TimecodeInsertion": { - "target": "com.amazonaws.mediaconvert#VideoTimecodeInsertion", + "DropFrameTimecode": { + "target": "com.amazonaws.mediaconvert#DropFrameTimecode", "traits": { - "smithy.api#documentation": "Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.", - "smithy.api#jsonName": "timecodeInsertion" + "smithy.api#documentation": "Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.", + "smithy.api#jsonName": "dropFrameTimecode" } }, - "ColorMetadata": { - "target": "com.amazonaws.mediaconvert#ColorMetadata", + "FixedAfd": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max15", "traits": { - "smithy.api#documentation": "Choose Insert (INSERT) for this setting to include color metadata in this output. Choose Ignore (IGNORE) to exclude color metadata from this output. If you don't specify a value, the service sets this to Insert by default.", - "smithy.api#jsonName": "colorMetadata" + "smithy.api#documentation": "Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). Use Fixed (FixedAfd) to specify a four-bit AFD value which the service will write on all frames of this video output.", + "smithy.api#jsonName": "fixedAfd" } }, - "ScalingBehavior": { - "target": "com.amazonaws.mediaconvert#ScalingBehavior", + "Height": { + "target": "com.amazonaws.mediaconvert#__integerMin32Max8192", "traits": { - "smithy.api#documentation": "Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.", - "smithy.api#jsonName": "scalingBehavior" + "smithy.api#documentation": "Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.", + "smithy.api#jsonName": "height" + } + }, + "Position": { + "target": "com.amazonaws.mediaconvert#Rectangle", + "traits": { + "smithy.api#documentation": "Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black.", + "smithy.api#jsonName": "position" } }, "RespondToAfd": { @@ -15837,18 +15885,25 @@ "smithy.api#jsonName": "respondToAfd" } }, - "Height": { - "target": "com.amazonaws.mediaconvert#__integerMin32Max8192", + "ScalingBehavior": { + "target": "com.amazonaws.mediaconvert#ScalingBehavior", "traits": { - "smithy.api#documentation": "Use the Height (Height) setting to define the video resolution height for this output. Specify in pixels. If you don't provide a value here, the service will use the input height.", - "smithy.api#jsonName": "height" + "smithy.api#documentation": "Specify how the service handles outputs that have a different aspect ratio from the input aspect ratio. Choose Stretch to output (STRETCH_TO_OUTPUT) to have the service stretch your video image to fit. Keep the setting Default (DEFAULT) to have the service letterbox your video instead. This setting overrides any value that you specify for the setting Selection placement (position) in this output.", + "smithy.api#jsonName": "scalingBehavior" } }, - "DropFrameTimecode": { - "target": "com.amazonaws.mediaconvert#DropFrameTimecode", + "Sharpness": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max100", "traits": { - "smithy.api#documentation": "Applies only to 29.97 fps outputs. When this feature is enabled, the service will use drop-frame timecode on outputs. If it is not possible to use drop-frame timecode, the system will fall back to non-drop-frame. This setting is enabled by default when Timecode insertion (TimecodeInsertion) is enabled.", - "smithy.api#jsonName": "dropFrameTimecode" + "smithy.api#documentation": "Use Sharpness (Sharpness) setting to specify the strength of anti-aliasing. This setting changes the width of the anti-alias filter kernel used for scaling. Sharpness only applies if your output resolution is different from your input resolution. 0 is the softest setting, 100 the sharpest, and 50 recommended for most content.", + "smithy.api#jsonName": "sharpness" + } + }, + "TimecodeInsertion": { + "target": "com.amazonaws.mediaconvert#VideoTimecodeInsertion", + "traits": { + "smithy.api#documentation": "Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable Timecode insertion when the input frame rate is identical to the output frame rate. To include timecodes in this output, set Timecode insertion (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it to DISABLED. Default is DISABLED. When the service inserts timecodes in an output, by default, it uses any embedded timecodes from the input. If none are present, the service will set the timecode for the first output frame to zero. To change this default behavior, adjust the settings under Timecode configuration (TimecodeConfig). In the console, these settings are located under Job > Job settings > Timecode configuration. Note - Timecode source under input settings (InputTimecodeSource) does not affect the timecodes that are inserted in the output. Source under Job settings > Timecode configuration (TimecodeSource) does.", + "smithy.api#jsonName": "timecodeInsertion" } }, "VideoPreprocessors": { @@ -15895,53 +15950,53 @@ "com.amazonaws.mediaconvert#VideoPreprocessor": { "type": "structure", "members": { - "NoiseReducer": { - "target": "com.amazonaws.mediaconvert#NoiseReducer", + "ColorCorrector": { + "target": "com.amazonaws.mediaconvert#ColorCorrector", "traits": { - "smithy.api#documentation": "Enable the Noise reducer (NoiseReducer) feature to remove noise from your video output if necessary. Enable or disable this feature for each output individually. This setting is disabled by default.", - "smithy.api#jsonName": "noiseReducer" + "smithy.api#documentation": "Enable the Color corrector (ColorCorrector) feature if necessary. Enable or disable this feature for each output individually. This setting is disabled by default.", + "smithy.api#jsonName": "colorCorrector" } }, - "TimecodeBurnin": { - "target": "com.amazonaws.mediaconvert#TimecodeBurnin", + "Deinterlacer": { + "target": "com.amazonaws.mediaconvert#Deinterlacer", "traits": { - "smithy.api#documentation": "Timecode burn-in (TimecodeBurnIn)--Burns the output timecode and specified prefix into the output.", - "smithy.api#jsonName": "timecodeBurnin" + "smithy.api#documentation": "Use Deinterlacer (Deinterlacer) to produce smoother motion and a clearer picture.", + "smithy.api#jsonName": "deinterlacer" } }, - "PartnerWatermarking": { - "target": "com.amazonaws.mediaconvert#PartnerWatermarking", + "DolbyVision": { + "target": "com.amazonaws.mediaconvert#DolbyVision", "traits": { - "smithy.api#documentation": "If you work with a third party video watermarking partner, use the group of settings that correspond with your watermarking partner to include watermarks in your output.", - "smithy.api#jsonName": "partnerWatermarking" + "smithy.api#documentation": "Enable Dolby Vision feature to produce Dolby Vision compatible video output.", + "smithy.api#jsonName": "dolbyVision" } }, - "Deinterlacer": { - "target": "com.amazonaws.mediaconvert#Deinterlacer", + "ImageInserter": { + "target": "com.amazonaws.mediaconvert#ImageInserter", "traits": { - "smithy.api#documentation": "Use Deinterlacer (Deinterlacer) to produce smoother motion and a clearer picture.", - "smithy.api#jsonName": "deinterlacer" + "smithy.api#documentation": "Enable the Image inserter (ImageInserter) feature to include a graphic overlay on your video. Enable or disable this feature for each output individually. This setting is disabled by default.", + "smithy.api#jsonName": "imageInserter" } }, - "ColorCorrector": { - "target": "com.amazonaws.mediaconvert#ColorCorrector", + "NoiseReducer": { + "target": "com.amazonaws.mediaconvert#NoiseReducer", "traits": { - "smithy.api#documentation": "Enable the Color corrector (ColorCorrector) feature if necessary. Enable or disable this feature for each output individually. This setting is disabled by default.", - "smithy.api#jsonName": "colorCorrector" + "smithy.api#documentation": "Enable the Noise reducer (NoiseReducer) feature to remove noise from your video output if necessary. Enable or disable this feature for each output individually. This setting is disabled by default.", + "smithy.api#jsonName": "noiseReducer" } }, - "DolbyVision": { - "target": "com.amazonaws.mediaconvert#DolbyVision", + "PartnerWatermarking": { + "target": "com.amazonaws.mediaconvert#PartnerWatermarking", "traits": { - "smithy.api#documentation": "Enable Dolby Vision feature to produce Dolby Vision compatible video output.", - "smithy.api#jsonName": "dolbyVision" + "smithy.api#documentation": "If you work with a third party video watermarking partner, use the group of settings that correspond with your watermarking partner to include watermarks in your output.", + "smithy.api#jsonName": "partnerWatermarking" } }, - "ImageInserter": { - "target": "com.amazonaws.mediaconvert#ImageInserter", + "TimecodeBurnin": { + "target": "com.amazonaws.mediaconvert#TimecodeBurnin", "traits": { - "smithy.api#documentation": "Enable the Image inserter (ImageInserter) feature to include a graphic overlay on your video. Enable or disable this feature for each output individually. This setting is disabled by default.", - "smithy.api#jsonName": "imageInserter" + "smithy.api#documentation": "Timecode burn-in (TimecodeBurnIn)--Burns the output timecode and specified prefix into the output.", + "smithy.api#jsonName": "timecodeBurnin" } } }, @@ -15952,20 +16007,6 @@ "com.amazonaws.mediaconvert#VideoSelector": { "type": "structure", "members": { - "Hdr10Metadata": { - "target": "com.amazonaws.mediaconvert#Hdr10Metadata", - "traits": { - "smithy.api#documentation": "Use these settings to provide HDR 10 metadata that is missing or inaccurate in your input video. Appropriate values vary depending on the input video and must be provided by a color grader. The color grader generates these values during the HDR 10 mastering process. The valid range for each of these settings is 0 to 50,000. Each increment represents 0.00002 in CIE1931 color coordinate. Related settings - When you specify these values, you must also set Color space (ColorSpace) to HDR 10 (HDR10). To specify whether the the values you specify here take precedence over the values in the metadata of your input file, set Color space usage (ColorSpaceUsage). To specify whether color metadata is included in an output, set Color metadata (ColorMetadata). For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.", - "smithy.api#jsonName": "hdr10Metadata" - } - }, - "ProgramNumber": { - "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", - "traits": { - "smithy.api#documentation": "Selects a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported.", - "smithy.api#jsonName": "programNumber" - } - }, "AlphaBehavior": { "target": "com.amazonaws.mediaconvert#AlphaBehavior", "traits": { @@ -15973,6 +16014,13 @@ "smithy.api#jsonName": "alphaBehavior" } }, + "ColorSpace": { + "target": "com.amazonaws.mediaconvert#ColorSpace", + "traits": { + "smithy.api#documentation": "If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value Follow (FOLLOW). The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, specify the accurate color space here. If your input video is HDR 10 and the SMPTE ST 2086 Mastering Display Color Volume static metadata isn't present in your video stream, or if that metadata is present but not accurate, choose Force HDR 10 (FORCE_HDR10) here and specify correct values in the input HDR 10 metadata (Hdr10Metadata) settings. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.", + "smithy.api#jsonName": "colorSpace" + } + }, "ColorSpaceUsage": { "target": "com.amazonaws.mediaconvert#ColorSpaceUsage", "traits": { @@ -15980,11 +16028,11 @@ "smithy.api#jsonName": "colorSpaceUsage" } }, - "ColorSpace": { - "target": "com.amazonaws.mediaconvert#ColorSpace", + "Hdr10Metadata": { + "target": "com.amazonaws.mediaconvert#Hdr10Metadata", "traits": { - "smithy.api#documentation": "If your input video has accurate color space metadata, or if you don't know about color space, leave this set to the default value Follow (FOLLOW). The service will automatically detect your input color space. If your input video has metadata indicating the wrong color space, specify the accurate color space here. If your input video is HDR 10 and the SMPTE ST 2086 Mastering Display Color Volume static metadata isn't present in your video stream, or if that metadata is present but not accurate, choose Force HDR 10 (FORCE_HDR10) here and specify correct values in the input HDR 10 metadata (Hdr10Metadata) settings. For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.", - "smithy.api#jsonName": "colorSpace" + "smithy.api#documentation": "Use these settings to provide HDR 10 metadata that is missing or inaccurate in your input video. Appropriate values vary depending on the input video and must be provided by a color grader. The color grader generates these values during the HDR 10 mastering process. The valid range for each of these settings is 0 to 50,000. Each increment represents 0.00002 in CIE1931 color coordinate. Related settings - When you specify these values, you must also set Color space (ColorSpace) to HDR 10 (HDR10). To specify whether the the values you specify here take precedence over the values in the metadata of your input file, set Color space usage (ColorSpaceUsage). To specify whether color metadata is included in an output, set Color metadata (ColorMetadata). For more information about MediaConvert HDR jobs, see https://docs.aws.amazon.com/console/mediaconvert/hdr.", + "smithy.api#jsonName": "hdr10Metadata" } }, "Pid": { @@ -15994,6 +16042,13 @@ "smithy.api#jsonName": "pid" } }, + "ProgramNumber": { + "target": "com.amazonaws.mediaconvert#__integerMinNegative2147483648Max2147483647", + "traits": { + "smithy.api#documentation": "Selects a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported.", + "smithy.api#jsonName": "programNumber" + } + }, "Rotate": { "target": "com.amazonaws.mediaconvert#InputRotate", "traits": { @@ -16025,13 +16080,6 @@ "com.amazonaws.mediaconvert#VorbisSettings": { "type": "structure", "members": { - "SampleRate": { - "target": "com.amazonaws.mediaconvert#__integerMin22050Max48000", - "traits": { - "smithy.api#documentation": "Optional. Specify the audio sample rate in Hz. Valid values are 22050, 32000, 44100, and 48000. The default value is 48000.", - "smithy.api#jsonName": "sampleRate" - } - }, "Channels": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2", "traits": { @@ -16039,6 +16087,13 @@ "smithy.api#jsonName": "channels" } }, + "SampleRate": { + "target": "com.amazonaws.mediaconvert#__integerMin22050Max48000", + "traits": { + "smithy.api#documentation": "Optional. Specify the audio sample rate in Hz. Valid values are 22050, 32000, 44100, and 48000. The default value is 48000.", + "smithy.api#jsonName": "sampleRate" + } + }, "VbrQuality": { "target": "com.amazonaws.mediaconvert#__integerMinNegative1Max10", "traits": { @@ -16134,39 +16189,39 @@ "com.amazonaws.mediaconvert#Vp8Settings": { "type": "structure", "members": { - "FramerateDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "Bitrate": { + "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateDenominator" + "smithy.api#documentation": "Target bitrate in bits/second. For example, enter five megabits per second as 5000000.", + "smithy.api#jsonName": "bitrate" } }, - "ParNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", + "FramerateControl": { + "target": "com.amazonaws.mediaconvert#Vp8FramerateControl", "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", - "smithy.api#jsonName": "parNumerator" + "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", + "smithy.api#jsonName": "framerateControl" } }, - "RateControlMode": { - "target": "com.amazonaws.mediaconvert#Vp8RateControlMode", + "FramerateConversionAlgorithm": { + "target": "com.amazonaws.mediaconvert#Vp8FramerateConversionAlgorithm", "traits": { - "smithy.api#documentation": "With the VP8 codec, you can use only the variable bitrate (VBR) rate control mode.", - "smithy.api#jsonName": "rateControlMode" + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#jsonName": "framerateConversionAlgorithm" } }, - "Bitrate": { - "target": "com.amazonaws.mediaconvert#__integerMin1000Max1152000000", + "FramerateDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Target bitrate in bits/second. For example, enter five megabits per second as 5000000.", - "smithy.api#jsonName": "bitrate" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateDenominator to specify the denominator of this fraction. In this example, use 1001 for the value of FramerateDenominator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateDenominator" } }, - "QualityTuningLevel": { - "target": "com.amazonaws.mediaconvert#Vp8QualityTuningLevel", + "FramerateNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, multi-pass encoding.", - "smithy.api#jsonName": "qualityTuningLevel" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" } }, "GopSize": { @@ -16176,25 +16231,11 @@ "smithy.api#jsonName": "gopSize" } }, - "ParDenominator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", - "smithy.api#jsonName": "parDenominator" - } - }, - "FramerateControl": { - "target": "com.amazonaws.mediaconvert#Vp8FramerateControl", - "traits": { - "smithy.api#documentation": "If you are using the console, use the Framerate setting to specify the frame rate for this output. If you want to keep the same frame rate as the input video, choose Follow source. If you want to do frame rate conversion, choose a frame rate from the dropdown list or choose Custom. The framerates shown in the dropdown list are decimal approximations of fractions. If you choose Custom, specify your frame rate as a fraction. If you are creating your transcoding job specification as a JSON file without the console, use FramerateControl to specify which value the service uses for the frame rate for this output. Choose INITIALIZE_FROM_SOURCE if you want the service to use the frame rate from the input. Choose SPECIFIED if you want the service to use the frame rate you specify in the settings FramerateNumerator and FramerateDenominator.", - "smithy.api#jsonName": "framerateControl" - } - }, - "FramerateConversionAlgorithm": { - "target": "com.amazonaws.mediaconvert#Vp8FramerateConversionAlgorithm", + "HrdBufferSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max47185920", "traits": { - "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", - "smithy.api#jsonName": "framerateConversionAlgorithm" + "smithy.api#documentation": "Optional. Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", + "smithy.api#jsonName": "hrdBufferSize" } }, "MaxBitrate": { @@ -16211,18 +16252,32 @@ "smithy.api#jsonName": "parControl" } }, - "FramerateNumerator": { + "ParDenominator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateNumerator" + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", + "smithy.api#jsonName": "parDenominator" } }, - "HrdBufferSize": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max47185920", + "ParNumerator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Optional. Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", - "smithy.api#jsonName": "hrdBufferSize" + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parNumerator is 40.", + "smithy.api#jsonName": "parNumerator" + } + }, + "QualityTuningLevel": { + "target": "com.amazonaws.mediaconvert#Vp8QualityTuningLevel", + "traits": { + "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, multi-pass encoding.", + "smithy.api#jsonName": "qualityTuningLevel" + } + }, + "RateControlMode": { + "target": "com.amazonaws.mediaconvert#Vp8RateControlMode", + "traits": { + "smithy.api#documentation": "With the VP8 codec, you can use only the variable bitrate (VBR) rate control mode.", + "smithy.api#jsonName": "rateControlMode" } } }, @@ -16313,20 +16368,6 @@ "com.amazonaws.mediaconvert#Vp9Settings": { "type": "structure", "members": { - "FramerateNumerator": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", - "traits": { - "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", - "smithy.api#jsonName": "framerateNumerator" - } - }, - "ParControl": { - "target": "com.amazonaws.mediaconvert#Vp9ParControl", - "traits": { - "smithy.api#documentation": "Optional. Specify how the service determines the pixel aspect ratio for this output. The default behavior is to use the same pixel aspect ratio as your input video.", - "smithy.api#jsonName": "parControl" - } - }, "Bitrate": { "target": "com.amazonaws.mediaconvert#__integerMin1000Max480000000", "traits": { @@ -16341,6 +16382,13 @@ "smithy.api#jsonName": "framerateControl" } }, + "FramerateConversionAlgorithm": { + "target": "com.amazonaws.mediaconvert#Vp9FramerateConversionAlgorithm", + "traits": { + "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", + "smithy.api#jsonName": "framerateConversionAlgorithm" + } + }, "FramerateDenominator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { @@ -16348,11 +16396,25 @@ "smithy.api#jsonName": "framerateDenominator" } }, - "ParDenominator": { + "FramerateNumerator": { "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", - "smithy.api#jsonName": "parDenominator" + "smithy.api#documentation": "When you use the API for transcode jobs that use frame rate conversion, specify the frame rate as a fraction. For example, 24000 / 1001 = 23.976 fps. Use FramerateNumerator to specify the numerator of this fraction. In this example, use 24000 for the value of FramerateNumerator. When you use the console for transcode jobs that use frame rate conversion, provide the value as a decimal number for Framerate. In this example, specify 23.976.", + "smithy.api#jsonName": "framerateNumerator" + } + }, + "GopSize": { + "target": "com.amazonaws.mediaconvert#__doubleMin0", + "traits": { + "smithy.api#documentation": "GOP Length (keyframe interval) in frames. Must be greater than zero.", + "smithy.api#jsonName": "gopSize" + } + }, + "HrdBufferSize": { + "target": "com.amazonaws.mediaconvert#__integerMin0Max47185920", + "traits": { + "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", + "smithy.api#jsonName": "hrdBufferSize" } }, "MaxBitrate": { @@ -16362,18 +16424,18 @@ "smithy.api#jsonName": "maxBitrate" } }, - "QualityTuningLevel": { - "target": "com.amazonaws.mediaconvert#Vp9QualityTuningLevel", + "ParControl": { + "target": "com.amazonaws.mediaconvert#Vp9ParControl", "traits": { - "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, multi-pass encoding.", - "smithy.api#jsonName": "qualityTuningLevel" + "smithy.api#documentation": "Optional. Specify how the service determines the pixel aspect ratio for this output. The default behavior is to use the same pixel aspect ratio as your input video.", + "smithy.api#jsonName": "parControl" } }, - "GopSize": { - "target": "com.amazonaws.mediaconvert#__doubleMin0", + "ParDenominator": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max2147483647", "traits": { - "smithy.api#documentation": "GOP Length (keyframe interval) in frames. Must be greater than zero.", - "smithy.api#jsonName": "gopSize" + "smithy.api#documentation": "Required when you set Pixel aspect ratio (parControl) to SPECIFIED. On the console, this corresponds to any value other than Follow source. When you specify an output pixel aspect ratio (PAR) that is different from your input video PAR, provide your output PAR as a ratio. For example, for D1/DV NTSC widescreen, you would specify the ratio 40:33. In this example, the value for parDenominator is 33.", + "smithy.api#jsonName": "parDenominator" } }, "ParNumerator": { @@ -16383,26 +16445,19 @@ "smithy.api#jsonName": "parNumerator" } }, + "QualityTuningLevel": { + "target": "com.amazonaws.mediaconvert#Vp9QualityTuningLevel", + "traits": { + "smithy.api#documentation": "Optional. Use Quality tuning level (qualityTuningLevel) to choose how you want to trade off encoding speed for output video quality. The default behavior is faster, lower quality, multi-pass encoding.", + "smithy.api#jsonName": "qualityTuningLevel" + } + }, "RateControlMode": { "target": "com.amazonaws.mediaconvert#Vp9RateControlMode", "traits": { "smithy.api#documentation": "With the VP9 codec, you can use only the variable bitrate (VBR) rate control mode.", "smithy.api#jsonName": "rateControlMode" } - }, - "FramerateConversionAlgorithm": { - "target": "com.amazonaws.mediaconvert#Vp9FramerateConversionAlgorithm", - "traits": { - "smithy.api#documentation": "Choose the method that you want MediaConvert to use when increasing or decreasing the frame rate. We recommend using drop duplicate (DUPLICATE_DROP) for numerically simple conversions, such as 60 fps to 30 fps. For numerically complex conversions, you can use interpolate (INTERPOLATE) to avoid stutter. This results in a smooth picture, but might introduce undesirable video artifacts. For complex frame rate conversions, especially if your source video has already been converted from its original cadence, use FrameFormer (FRAMEFORMER) to do motion-compensated interpolation. FrameFormer chooses the best conversion method frame by frame. Note that using FrameFormer increases the transcoding time and incurs a significant add-on cost.", - "smithy.api#jsonName": "framerateConversionAlgorithm" - } - }, - "HrdBufferSize": { - "target": "com.amazonaws.mediaconvert#__integerMin0Max47185920", - "traits": { - "smithy.api#documentation": "Size of buffer (HRD buffer model) in bits. For example, enter five megabits as 5000000.", - "smithy.api#jsonName": "hrdBufferSize" - } } }, "traits": { @@ -16463,11 +16518,11 @@ "smithy.api#jsonName": "bitDepth" } }, - "SampleRate": { - "target": "com.amazonaws.mediaconvert#__integerMin8000Max192000", + "Channels": { + "target": "com.amazonaws.mediaconvert#__integerMin1Max64", "traits": { - "smithy.api#documentation": "Sample rate in Hz.", - "smithy.api#jsonName": "sampleRate" + "smithy.api#documentation": "Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For example, 1, 2, 4, 6, and so on, up to 64.", + "smithy.api#jsonName": "channels" } }, "Format": { @@ -16477,11 +16532,11 @@ "smithy.api#jsonName": "format" } }, - "Channels": { - "target": "com.amazonaws.mediaconvert#__integerMin1Max64", + "SampleRate": { + "target": "com.amazonaws.mediaconvert#__integerMin8000Max192000", "traits": { - "smithy.api#documentation": "Specify the number of channels in this output audio track. Valid values are 1 and even numbers up to 64. For example, 1, 2, 4, 6, and so on, up to 64.", - "smithy.api#jsonName": "channels" + "smithy.api#documentation": "Sample rate in Hz.", + "smithy.api#jsonName": "sampleRate" } } }, @@ -16774,6 +16829,15 @@ } } }, + "com.amazonaws.mediaconvert#__integerMin100000Max100000000": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 100000, + "max": 100000000 + } + } + }, "com.amazonaws.mediaconvert#__integerMin1000Max1152000000": { "type": "integer", "traits": { @@ -17107,6 +17171,15 @@ } } }, + "com.amazonaws.mediaconvert#__integerMin3Max15": { + "type": "integer", + "traits": { + "smithy.api#range": { + "min": 3, + "max": 15 + } + } + }, "com.amazonaws.mediaconvert#__integerMin48000Max48000": { "type": "integer", "traits": { diff --git a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json index a05a392aa42c..839dfb333e69 100644 --- a/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json +++ b/codegen/sdk-codegen/aws-models/quicksight.2018-04-01.json @@ -65,10 +65,10 @@ "com.amazonaws.quicksight#AccountSettings": { "type": "structure", "members": { - "DefaultNamespace": { - "target": "com.amazonaws.quicksight#Namespace", + "AccountName": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The default QuickSight namespace for your AWS account.
" + "smithy.api#documentation": "The \"account name\" you provided for the QuickSight subscription in your AWS account. \n You create this name when you sign up for QuickSight. It is unique in all of AWS and \n it appears only in the console when users sign in.
" } }, "Edition": { @@ -77,10 +77,10 @@ "smithy.api#documentation": "The edition of QuickSight that you're currently subscribed to:\n Enterprise edition or Standard edition.
" } }, - "AccountName": { - "target": "com.amazonaws.quicksight#String", + "DefaultNamespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "The \"account name\" you provided for the QuickSight subscription in your AWS account. \n You create this name when you sign up for QuickSight. It is unique in all of AWS and \n it appears only in the console when users sign in.
" + "smithy.api#documentation": "The default QuickSight namespace for your AWS account.
" } }, "NotificationEmail": { @@ -109,17 +109,17 @@ "com.amazonaws.quicksight#ActiveIAMPolicyAssignment": { "type": "structure", "members": { - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" - } - }, "AssignmentName": { "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { "smithy.api#documentation": "A name for the IAM policy assignment.
" } + }, + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" + } } }, "traits": { @@ -174,16 +174,22 @@ "com.amazonaws.quicksight#Analysis": { "type": "structure", "members": { + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The ID of the analysis.
" + } + }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the analysis.
" } }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", "traits": { - "smithy.api#documentation": "The time that the analysis was created.
" + "smithy.api#documentation": "The descriptive name of the analysis.
" } }, "Status": { @@ -192,6 +198,12 @@ "smithy.api#documentation": "Status associated with the analysis.
" } }, + "Errors": { + "target": "com.amazonaws.quicksight#AnalysisErrorList", + "traits": { + "smithy.api#documentation": "Errors associated with the analysis.
" + } + }, "DataSetArns": { "target": "com.amazonaws.quicksight#DataSetArnsList", "traits": { @@ -204,16 +216,10 @@ "smithy.api#documentation": "The ARN of the theme of the analysis.
" } }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "The ID of the analysis.
" - } - }, - "Errors": { - "target": "com.amazonaws.quicksight#AnalysisErrorList", + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "Errors associated with the analysis.
" + "smithy.api#documentation": "The time that the analysis was created.
" } }, "LastUpdatedTime": { @@ -227,12 +233,6 @@ "traits": { "smithy.api#documentation": "A list of the associated sheets with the unique identifier and name of each sheet.
" } - }, - "Name": { - "target": "com.amazonaws.quicksight#AnalysisName", - "traits": { - "smithy.api#documentation": "The descriptive name of the analysis.
" - } } }, "traits": { @@ -242,17 +242,17 @@ "com.amazonaws.quicksight#AnalysisError": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.quicksight#NonEmptyString", - "traits": { - "smithy.api#documentation": "The message associated with the analysis error.
" - } - }, "Type": { "target": "com.amazonaws.quicksight#AnalysisErrorType", "traits": { "smithy.api#documentation": "The type of the analysis error.
" } + }, + "Message": { + "target": "com.amazonaws.quicksight#NonEmptyString", + "traits": { + "smithy.api#documentation": "The message associated with the analysis error.
" + } } }, "traits": { @@ -347,17 +347,17 @@ "smithy.api#documentation": "The comparison operator that you want to use as a filter, for example\n \"Operator\": \"StringEquals\"
.
The value of the named item, in this case QUICKSIGHT_USER
, that you want\n to use as a filter, for example \"Value\"
. An example is\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"
.
The name of the value that you want to use as a filter, for example \"Name\":\n \"QUICKSIGHT_USER\"
.
The value of the named item, in this case QUICKSIGHT_USER
, that you want\n to use as a filter, for example \"Value\"
. An example is\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"
.
The Amazon Resource Name (ARN) for the analysis.
" + } + }, "AnalysisId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "The ID of the analysis. This ID displays in the URL.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", "traits": { - "smithy.api#documentation": "The last known status for the analysis.
" + "smithy.api#documentation": "The name of the analysis. This name is displayed in the QuickSight console.\n
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the analysis.
" + "smithy.api#documentation": "The last known status for the analysis.
" } }, "CreatedTime": { @@ -439,12 +445,6 @@ "smithy.api#documentation": "The time that the analysis was created.
" } }, - "Name": { - "target": "com.amazonaws.quicksight#AnalysisName", - "traits": { - "smithy.api#documentation": "The name of the analysis. This name is displayed in the QuickSight console.\n
" - } - }, "LastUpdatedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { @@ -507,6 +507,13 @@ "com.amazonaws.quicksight#AuroraParameters": { "type": "structure", "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "Host.
", + "smithy.api#required": {} + } + }, "Port": { "target": "com.amazonaws.quicksight#Port", "traits": { @@ -520,13 +527,6 @@ "smithy.api#documentation": "Database.
", "smithy.api#required": {} } - }, - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "Host.
", - "smithy.api#required": {} - } } }, "traits": { @@ -543,17 +543,17 @@ "smithy.api#required": {} } }, - "Database": { - "target": "com.amazonaws.quicksight#Database", + "Port": { + "target": "com.amazonaws.quicksight#Port", "traits": { - "smithy.api#documentation": "Database.
", + "smithy.api#documentation": "Port.
", "smithy.api#required": {} } }, - "Port": { - "target": "com.amazonaws.quicksight#Port", + "Database": { + "target": "com.amazonaws.quicksight#Database", "traits": { - "smithy.api#documentation": "Port.
", + "smithy.api#documentation": "Database.
", "smithy.api#required": {} } } @@ -614,17 +614,17 @@ "com.amazonaws.quicksight#CalculatedColumn": { "type": "structure", "members": { - "ColumnId": { - "target": "com.amazonaws.quicksight#ColumnId", + "ColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", "traits": { - "smithy.api#documentation": "A unique ID to identify a calculated column. During a dataset update, if the column ID\n of a calculated column matches that of an existing calculated column, Amazon QuickSight\n preserves the existing calculated column.
", + "smithy.api#documentation": "Column name.
", "smithy.api#required": {} } }, - "ColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", + "ColumnId": { + "target": "com.amazonaws.quicksight#ColumnId", "traits": { - "smithy.api#documentation": "Column name.
", + "smithy.api#documentation": "A unique ID to identify a calculated column. During a dataset update, if the column ID\n of a calculated column matches that of an existing calculated column, Amazon QuickSight\n preserves the existing calculated column.
", "smithy.api#required": {} } }, @@ -721,12 +721,6 @@ "com.amazonaws.quicksight#CancelIngestionResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } - }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -739,6 +733,12 @@ "smithy.api#documentation": "An ID for the ingestion.
" } }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -751,17 +751,17 @@ "com.amazonaws.quicksight#CastColumnTypeOperation": { "type": "structure", "members": { - "NewColumnType": { - "target": "com.amazonaws.quicksight#ColumnDataType", + "ColumnName": { + "target": "com.amazonaws.quicksight#ColumnName", "traits": { - "smithy.api#documentation": "New column data type.
", + "smithy.api#documentation": "Column name.
", "smithy.api#required": {} } }, - "ColumnName": { - "target": "com.amazonaws.quicksight#ColumnName", + "NewColumnType": { + "target": "com.amazonaws.quicksight#ColumnDataType", "traits": { - "smithy.api#documentation": "Column name.
", + "smithy.api#documentation": "New column data type.
", "smithy.api#required": {} } }, @@ -954,6 +954,37 @@ } } }, + "com.amazonaws.quicksight#ColumnLevelPermissionRule": { + "type": "structure", + "members": { + "Principals": { + "target": "com.amazonaws.quicksight#PrincipalList", + "traits": { + "smithy.api#documentation": "An array of Amazon Resource Names (ARNs) for QuickSight users or groups.
" + } + }, + "ColumnNames": { + "target": "com.amazonaws.quicksight#ColumnNameList", + "traits": { + "smithy.api#documentation": "An array of column names.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A rule defined to grant access on one or more restricted columns. \n Each dataset can have multiple rules. \n To create a restricted column, you add it to one or more rules. \n Each rule must contain at least one column and at least one user or group. \n To be able to see a restricted column, a user or group needs to be added \n to a rule for that column.
" + } + }, + "com.amazonaws.quicksight#ColumnLevelPermissionRuleList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#ColumnLevelPermissionRule" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.quicksight#ColumnList": { "type": "list", "member": { @@ -975,15 +1006,20 @@ } } }, + "com.amazonaws.quicksight#ColumnNameList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + }, + "traits": { + "smithy.api#length": { + "min": 1 + } + } + }, "com.amazonaws.quicksight#ColumnSchema": { "type": "structure", "members": { - "GeographicRole": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The geographic role of the column schema.
" - } - }, "Name": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -995,6 +1031,12 @@ "traits": { "smithy.api#documentation": "The data type of the column schema.
" } + }, + "GeographicRole": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The geographic role of the column schema.
" + } } }, "traits": { @@ -1048,10 +1090,10 @@ "com.amazonaws.quicksight#ConcurrentUpdatingException": { "type": "structure", "members": { - "RequestId": { + "Message": { "target": "com.amazonaws.quicksight#String" }, - "Message": { + "RequestId": { "target": "com.amazonaws.quicksight#String" } }, @@ -1168,11 +1210,16 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) for the customization that you created for this AWS account.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The ID for the AWS account that you want to customize QuickSight for.
" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The namespace associated with the customization you're creating.
" } }, "AccountCustomization": { @@ -1187,16 +1234,11 @@ "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "The ID for the AWS account that you want to customize QuickSight for.
" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The namespace associated with the customization you're creating.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -1244,58 +1286,58 @@ "com.amazonaws.quicksight#CreateAnalysisRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.quicksight#TagList", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "Contains a map of the key-value pairs for the resource tag or tags assigned to the\n analysis.
" + "smithy.api#documentation": "The ID of the AWS account where you are creating an analysis.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ARN for the theme to apply to the analysis that you're creating. To see the theme\n in the QuickSight console, make sure that you have access to it.
" + "smithy.api#documentation": "The ID for the analysis that you're creating. This ID displays in the URL of the\n analysis.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "SourceEntity": { - "target": "com.amazonaws.quicksight#AnalysisSourceEntity", + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", "traits": { - "smithy.api#documentation": "A source entity to use for the analysis that you're creating. This metadata structure\n contains details that describe a source template and one or more datasets.
", + "smithy.api#documentation": "A descriptive name for the analysis that you're creating. This name displays for the\n analysis in the QuickSight console.
", "smithy.api#required": {} } }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "Parameters": { + "target": "com.amazonaws.quicksight#Parameters", "traits": { - "smithy.api#documentation": "The ID for the analysis that you're creating. This ID displays in the URL of the\n analysis.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The parameter names and override values that you want to use. An analysis can have \n any parameter type, and some parameters might accept multiple values.
" } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "The ID of the AWS account where you are creating an analysis.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "A structure that describes the principals and the resource-level permissions on an\n analysis. You can use the Permissions
structure to grant permissions by\n providing a list of AWS Identity and Access Management (IAM) action information for each\n principal listed by Amazon Resource Name (ARN).
To specify no permissions, omit Permissions
.
A descriptive name for the analysis that you're creating. This name displays for the\n analysis in the QuickSight console.
", + "smithy.api#documentation": "A source entity to use for the analysis that you're creating. This metadata structure\n contains details that describe a source template and one or more datasets.
", "smithy.api#required": {} } }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "A structure that describes the principals and the resource-level permissions on an\n analysis. You can use the Permissions
structure to grant permissions by\n providing a list of AWS Identity and Access Management (IAM) action information for each\n principal listed by Amazon Resource Name (ARN).
To specify no permissions, omit Permissions
.
The ARN for the theme to apply to the analysis that you're creating. To see the theme\n in the QuickSight console, make sure that you have access to it.
" } }, - "Parameters": { - "target": "com.amazonaws.quicksight#Parameters", + "Tags": { + "target": "com.amazonaws.quicksight#TagList", "traits": { - "smithy.api#documentation": "The parameter names and override values that you want to use. An analysis can have \n any parameter type, and some parameters might accept multiple values.
" + "smithy.api#documentation": "Contains a map of the key-value pairs for the resource tag or tags assigned to the\n analysis.
" } } } @@ -1303,10 +1345,10 @@ "com.amazonaws.quicksight#CreateAnalysisResponse": { "type": "structure", "members": { - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The status of the creation of the analysis.
" + "smithy.api#documentation": "The ARN for the analysis.
" } }, "AnalysisId": { @@ -1315,6 +1357,12 @@ "smithy.api#documentation": "The ID of the analysis.
" } }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "The status of the creation of the analysis.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -1322,12 +1370,6 @@ "smithy.api#httpResponseCode": {} } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "The ARN for the analysis.
" - } - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -1394,20 +1436,6 @@ "com.amazonaws.quicksight#CreateDashboardRequest": { "type": "structure", "members": { - "DashboardId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "The ID for the dashboard, also added to the IAM policy.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "A description for the first version of the dashboard being created.
" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -1416,10 +1444,12 @@ "smithy.api#required": {} } }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "DashboardId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "A structure that contains the permissions of the dashboard. You can use this structure\n for granting permissions by providing a list of IAM action information for each\n principal ARN.
\n \nTo specify no permissions, omit the permissions list.
" + "smithy.api#documentation": "The ID for the dashboard, also added to the IAM policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "Name": { @@ -1435,10 +1465,10 @@ "smithy.api#documentation": "The parameters for the creation of the dashboard, which you want to use to override\n the default settings. A dashboard can have any type of parameters, and some parameters\n might accept multiple values.
" } }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "Contains a map of the key-value pairs for the resource tag or tags assigned to the\n dashboard.
" + "smithy.api#documentation": "A structure that contains the permissions of the dashboard. You can use this structure\n for granting permissions by providing a list of IAM action information for each\n principal ARN.
\n \nTo specify no permissions, omit the permissions list.
" } }, "SourceEntity": { @@ -1448,10 +1478,16 @@ "smithy.api#required": {} } }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", + "Tags": { + "target": "com.amazonaws.quicksight#TagList", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If\n you add a value for this field, it overrides the value that is used in the source\n entity. The theme ARN must exist in the same AWS account where you create the\n dashboard.
" + "smithy.api#documentation": "Contains a map of the key-value pairs for the resource tag or tags assigned to the\n dashboard.
" + } + }, + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "A description for the first version of the dashboard being created.
" } }, "DashboardPublishOptions": { @@ -1459,23 +1495,28 @@ "traits": { "smithy.api#documentation": "Options for publishing the dashboard when you create it:
\n\n AvailabilityStatus
for AdHocFilteringOption
- This\n status can be either ENABLED
or DISABLED
. When this is\n set to DISABLED
, QuickSight disables the left filter pane on the\n published dashboard, which can be used for ad hoc (one-time) filtering. This\n option is ENABLED
by default.
\n AvailabilityStatus
for ExportToCSVOption
- This\n status can be either ENABLED
or DISABLED
. The visual\n option to export data to .CSV format isn't enabled when this is set to\n DISABLED
. This option is ENABLED
by default.
\n VisibilityState
for SheetControlsOption
- This\n visibility state can be either COLLAPSED
or EXPANDED
.\n This option is COLLAPSED
by default.
The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If\n you add a value for this field, it overrides the value that is used in the source\n entity. The theme ARN must exist in the same AWS account where you create the\n dashboard.
" + } } } }, "com.amazonaws.quicksight#CreateDashboardResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The ARN of the dashboard.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The ARN of the dashboard, including the version number of the first version that is\n created.
" } }, "DashboardId": { @@ -1484,22 +1525,23 @@ "smithy.api#documentation": "The ID for the dashboard.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { - "smithy.api#documentation": "The ARN of the dashboard.
" + "smithy.api#documentation": "The status of the dashboard creation request.
" } }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The ARN of the dashboard, including the version number of the first version that is\n created.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The status of the dashboard creation request.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } } } @@ -1553,19 +1595,14 @@ "com.amazonaws.quicksight#CreateDataSetRequest": { "type": "structure", "members": { - "ImportMode": { - "target": "com.amazonaws.quicksight#DataSetImportMode", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "Indicates whether you want to import the data into SPICE.
", + "smithy.api#documentation": "The AWS account ID.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "RowLevelPermissionDataSet": { - "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", - "traits": { - "smithy.api#documentation": "The row-level security configuration for the data that you want to create.
" - } - }, "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { @@ -1573,10 +1610,11 @@ "smithy.api#required": {} } }, - "LogicalTableMap": { - "target": "com.amazonaws.quicksight#LogicalTableMap", + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", "traits": { - "smithy.api#documentation": "Configures the combination and transformation of the data from the physical tables.
" + "smithy.api#documentation": "The display name for the dataset.
", + "smithy.api#required": {} } }, "PhysicalTableMap": { @@ -1586,10 +1624,17 @@ "smithy.api#required": {} } }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "LogicalTableMap": { + "target": "com.amazonaws.quicksight#LogicalTableMap", "traits": { - "smithy.api#documentation": "A list of resource permissions on the dataset.
" + "smithy.api#documentation": "Configures the combination and transformation of the data from the physical tables.
" + } + }, + "ImportMode": { + "target": "com.amazonaws.quicksight#DataSetImportMode", + "traits": { + "smithy.api#documentation": "Indicates whether you want to import the data into SPICE.
", + "smithy.api#required": {} } }, "ColumnGroups": { @@ -1598,25 +1643,28 @@ "smithy.api#documentation": "Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
" } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "The AWS account ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "A list of resource permissions on the dataset.
" } }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", + "RowLevelPermissionDataSet": { + "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", "traits": { - "smithy.api#documentation": "Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
" + "smithy.api#documentation": "The row-level security configuration for the data that you want to create.
" } }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", + "ColumnLevelPermissionRules": { + "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", "traits": { - "smithy.api#documentation": "The display name for the dataset.
", - "smithy.api#required": {} + "smithy.api#documentation": "A set of one or more definitions of a \n ColumnLevelPermissionRule\n
.
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
" } } } @@ -1624,28 +1672,28 @@ "com.amazonaws.quicksight#CreateDataSetResponse": { "type": "structure", "members": { - "IngestionId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "The ID of the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.
" - } - }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" } }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
" + } + }, "IngestionArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "The ARN for the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.
" } }, - "DataSetId": { + "IngestionId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
" + "smithy.api#documentation": "The ID of the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.
" } }, "RequestId": { @@ -1709,22 +1757,26 @@ "com.amazonaws.quicksight#CreateDataSourceRequest": { "type": "structure", "members": { - "Credentials": { - "target": "com.amazonaws.quicksight#DataSourceCredentials", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The credentials QuickSight that uses to connect to your underlying source. Currently, only\n\t\t\tcredentials based on user name and password are supported.
" + "smithy.api#documentation": "The AWS account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "A list of resource permissions on the data source.
" + "smithy.api#documentation": "An ID for the data source. This ID is unique per AWS Region for each AWS account.
", + "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", "traits": { - "smithy.api#documentation": "Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
" + "smithy.api#documentation": "A display name for the data source.
", + "smithy.api#required": {} } }, "Type": { @@ -1734,10 +1786,22 @@ "smithy.api#required": {} } }, - "SslProperties": { - "target": "com.amazonaws.quicksight#SslProperties", + "DataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParameters", "traits": { - "smithy.api#documentation": "Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
" + "smithy.api#documentation": "The parameters that QuickSight uses to connect to your underlying source.
" + } + }, + "Credentials": { + "target": "com.amazonaws.quicksight#DataSourceCredentials", + "traits": { + "smithy.api#documentation": "The credentials QuickSight that uses to connect to your underlying source. Currently, only\n\t\t\tcredentials based on user name and password are supported.
" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "A list of resource permissions on the data source.
" } }, "VpcConnectionProperties": { @@ -1746,32 +1810,16 @@ "smithy.api#documentation": "Use this parameter only when you want QuickSight to use a VPC connection when connecting to\n\t\t\tyour underlying source.
" } }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", + "SslProperties": { + "target": "com.amazonaws.quicksight#SslProperties", "traits": { - "smithy.api#documentation": "A display name for the data source.
", - "smithy.api#required": {} - } - }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "An ID for the data source. This ID is unique per AWS Region for each AWS account.
", - "smithy.api#required": {} - } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "The AWS account ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying source.
" } }, - "DataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParameters", + "Tags": { + "target": "com.amazonaws.quicksight#TagList", "traits": { - "smithy.api#documentation": "The parameters that QuickSight uses to connect to your underlying source.
" + "smithy.api#documentation": "Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
" } } } @@ -1785,12 +1833,6 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data source.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } - }, "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { @@ -1803,6 +1845,12 @@ "smithy.api#documentation": "The status of creating the data source.
" } }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -1901,34 +1949,34 @@ "com.amazonaws.quicksight#CreateGroupMembershipRequest": { "type": "structure", "members": { - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "MemberName": { + "target": "com.amazonaws.quicksight#GroupMemberName", "traits": { - "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
The name of the user that you want to add to the group membership.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", "traits": { - "smithy.api#documentation": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The name of the group that you want to add the user to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The name of the group that you want to add the user to.
", + "smithy.api#documentation": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "MemberName": { - "target": "com.amazonaws.quicksight#GroupMemberName", + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "The name of the user that you want to add to the group membership.
", + "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
The group member.
" + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -1950,26 +2004,25 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "GroupMember": { - "target": "com.amazonaws.quicksight#GroupMember", - "traits": { - "smithy.api#documentation": "The group member.
" - } } } }, "com.amazonaws.quicksight#CreateGroupRequest": { "type": "structure", "members": { - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", "traits": { - "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
A name for the group that you want to create.
", "smithy.api#required": {} } }, + "Description": { + "target": "com.amazonaws.quicksight#GroupDescription", + "traits": { + "smithy.api#documentation": "A description for the group that you want to create.
" + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -1978,16 +2031,11 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.quicksight#GroupDescription", - "traits": { - "smithy.api#documentation": "A description for the group that you want to create.
" - } - }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "A name for the group that you want to create.
", + "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
The AWS request ID for this operation.
" - } - }, "Group": { "target": "com.amazonaws.quicksight#Group", "traits": { "smithy.api#documentation": "The name of the group.
" } }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -2055,7 +2103,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name\n\t\t\t(ARN). This policy will be assigned to specified groups or users of Amazon QuickSight.\n\t\t\tThe users and groups need to be in the same namespace.
", + "smithy.api#documentation": "Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name \n\t\t\t(ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight.\n\t\t\tAssignment names are unique per AWS account. To avoid overwriting rules in other namespaces, \n\t\t\tuse assignment names that are unique.
", "smithy.api#http": { "method": "POST", "uri": "/accounts/{AwsAccountId}/namespaces/{Namespace}/iam-policy-assignments", @@ -2066,19 +2114,6 @@ "com.amazonaws.quicksight#CreateIAMPolicyAssignmentRequest": { "type": "structure", "members": { - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "The name of the assignment. It must be unique within an AWS account.
", - "smithy.api#required": {} - } - }, - "Identities": { - "target": "com.amazonaws.quicksight#IdentityMap", - "traits": { - "smithy.api#documentation": "The QuickSight users, groups, or both that you want to assign the policy to.
" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -2087,11 +2122,10 @@ "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { - "smithy.api#documentation": "The namespace that contains the assignment.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The name of the assignment, also called a rule. It must be unique within an AWS account.
", "smithy.api#required": {} } }, @@ -2107,23 +2141,30 @@ "traits": { "smithy.api#documentation": "The ARN for the IAM policy to apply to the QuickSight users and groups\n\t\t\tspecified in this assignment.
" } + }, + "Identities": { + "target": "com.amazonaws.quicksight#IdentityMap", + "traits": { + "smithy.api#documentation": "The QuickSight users, groups, or both that you want to assign the policy to.
" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The namespace that contains the assignment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } } } }, "com.amazonaws.quicksight#CreateIAMPolicyAssignmentResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} - } - }, - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { - "smithy.api#documentation": "The ARN for the IAM policy that is applied to the QuickSight users and groups specified in this assignment.
" + "smithy.api#documentation": "The name of the assignment. This name must be unique within the AWS account.
" } }, "AssignmentId": { @@ -2132,10 +2173,16 @@ "smithy.api#documentation": "The ID for the assignment.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The status of the assignment. Possible values are as follows:
\n\t\t\n ENABLED
- Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.
\n DISABLED
- This assignment isn't used when creating the data source.
\n DRAFT
- This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.
The ARN for the IAM policy that is applied to the QuickSight users and groups specified in this assignment.
" } }, "Identities": { @@ -2144,16 +2191,17 @@ "smithy.api#documentation": "The QuickSight users, groups, or both that the IAM policy is assigned to.
" } }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The name of the assignment. This name must be unique within the AWS account.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The status of the assignment. Possible values are as follows:
\n\t\t\n ENABLED
- Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.
\n DISABLED
- This assignment isn't used when creating the data source.
\n DRAFT
- This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.
The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -2201,18 +2249,18 @@ "com.amazonaws.quicksight#CreateIngestionRequest": { "type": "structure", "members": { - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", + "DataSetId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "An ID for the ingestion.
", + "smithy.api#documentation": "The ID of the dataset used in the ingestion.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "DataSetId": { - "target": "com.amazonaws.quicksight#String", + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", "traits": { - "smithy.api#documentation": "The ID of the dataset used in the ingestion.
", + "smithy.api#documentation": "An ID for the ingestion.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2230,35 +2278,35 @@ "com.amazonaws.quicksight#CreateIngestionResponse": { "type": "structure", "members": { - "IngestionStatus": { - "target": "com.amazonaws.quicksight#IngestionStatus", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The ingestion status.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the data ingestion.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "An ID for the ingestion.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "IngestionStatus": { + "target": "com.amazonaws.quicksight#IngestionStatus", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The ingestion status.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the data ingestion.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "An ID for the ingestion.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -2315,10 +2363,12 @@ "com.amazonaws.quicksight#CreateNamespaceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.quicksight#TagList", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The tags that you want to associate with the namespace that you're creating.
" + "smithy.api#documentation": "The ID for the AWS account that you want to create the QuickSight namespace in.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "Namespace": { @@ -2335,12 +2385,10 @@ "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "Tags": { + "target": "com.amazonaws.quicksight#TagList", "traits": { - "smithy.api#documentation": "The ID for the AWS account that you want to create the QuickSight namespace in.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The tags that you want to associate with the namespace that you're creating.
" } } } @@ -2348,10 +2396,10 @@ "com.amazonaws.quicksight#CreateNamespaceResponse": { "type": "structure", "members": { - "IdentityStore": { - "target": "com.amazonaws.quicksight#IdentityStore", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "Specifies the type of your user identity directory. Currently, this supports users\n with an identity type of QUICKSIGHT
.
The ARN of the QuickSight namespace you created.
" } }, "Name": { @@ -2360,35 +2408,35 @@ "smithy.api#documentation": "The name of the new namespace that you created.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} - } - }, "CapacityRegion": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS Region that you want to use for the free SPICE capacity for the new namespace.\n This is set to the region that you run CreateNamespace in.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } - }, "CreationStatus": { "target": "com.amazonaws.quicksight#NamespaceStatus", "traits": { "smithy.api#documentation": "The status of the creation of the namespace. This is an asynchronous process. A status\n of CREATED
means that your namespace is ready to use. If an error occurs,\n it indicates if the process is retryable
or non-retryable
. In\n the case of a non-retryable error, refer to the error message for follow-up\n tasks.
The ARN of the QuickSight namespace you created.
" + "smithy.api#documentation": "Specifies the type of your user identity directory. Currently, this supports users\n with an identity type of QUICKSIGHT
.
The AWS request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -2490,10 +2538,11 @@ "smithy.api#required": {} } }, - "TemplateVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The version number of the template.
", + "smithy.api#documentation": "An ID for the template.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -2505,11 +2554,10 @@ "smithy.api#required": {} } }, - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "TemplateVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "An ID for the template.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The version number of the template.
", "smithy.api#required": {} } } @@ -2518,6 +2566,12 @@ "com.amazonaws.quicksight#CreateTemplateAliasResponse": { "type": "structure", "members": { + "TemplateAlias": { + "target": "com.amazonaws.quicksight#TemplateAlias", + "traits": { + "smithy.api#documentation": "Information about the template alias.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -2530,35 +2584,24 @@ "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } - }, - "TemplateAlias": { - "target": "com.amazonaws.quicksight#TemplateAlias", - "traits": { - "smithy.api#documentation": "Information about the template alias.
" - } } } }, "com.amazonaws.quicksight#CreateTemplateRequest": { "type": "structure", "members": { - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "A description of the current template version being created. This API operation creates the\n\t\t\tfirst version of the template. Every time UpdateTemplate
is called, a new\n\t\t\tversion is created. Each version of the template maintains a description of the version\n\t\t\tin the VersionDescription
field.
The entity that you are using as a source when you create the template. In\n\t\t\tSourceEntity
, you specify the type of object you're using as source:\n\t\t\tSourceTemplate
for a template or SourceAnalysis
for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate
, specify the ARN of the source template. For\n\t\t\tSourceAnalysis
, specify the ARN of the source analysis. The SourceTemplate
\n\t\t\tARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences
entity within SourceTemplate
or\n\t\t\tSourceAnalysis
to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.
The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "An ID for the template that you want to create. This template is unique per AWS Region in\n\t\t\teach AWS account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2569,24 +2612,29 @@ "smithy.api#documentation": "A display name for the template.
" } }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
" + "smithy.api#documentation": "A list of resource permissions to be set on the template.
" } }, - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "SourceEntity": { + "target": "com.amazonaws.quicksight#TemplateSourceEntity", "traits": { - "smithy.api#documentation": "An ID for the template that you want to create. This template is unique per AWS Region in\n\t\t\teach AWS account.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The entity that you are using as a source when you create the template. In\n\t\t\tSourceEntity
, you specify the type of object you're using as source:\n\t\t\tSourceTemplate
for a template or SourceAnalysis
for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate
, specify the ARN of the source template. For\n\t\t\tSourceAnalysis
, specify the ARN of the source analysis. The SourceTemplate
\n\t\t\tARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences
entity within SourceTemplate
or\n\t\t\tSourceAnalysis
to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.
A list of resource permissions to be set on the template.
" + "smithy.api#documentation": "Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
" + } + }, + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", + "traits": { + "smithy.api#documentation": "A description of the current template version being created. This API operation creates the\n\t\t\tfirst version of the template. Every time UpdateTemplate
is called, a new\n\t\t\tversion is created. Each version of the template maintains a description of the version\n\t\t\tin the VersionDescription
field.
The AWS request ID for this operation.
" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} - } - }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The template creation status.
" + "smithy.api#documentation": "The ARN for the template.
" } }, "VersionArn": { @@ -2625,10 +2660,23 @@ "smithy.api#documentation": "The ID of the template.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { - "smithy.api#documentation": "The ARN for the template.
" + "smithy.api#documentation": "The template creation status.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" } } } @@ -2722,6 +2770,14 @@ "com.amazonaws.quicksight#CreateThemeAliasRequest": { "type": "structure", "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the AWS account that contains the theme for the new theme alias.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { @@ -2738,14 +2794,6 @@ "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the theme for the new theme alias.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "ThemeVersionNumber": { "target": "com.amazonaws.quicksight#VersionNumber", "traits": { @@ -2758,10 +2806,10 @@ "com.amazonaws.quicksight#CreateThemeAliasResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "ThemeAlias": { + "target": "com.amazonaws.quicksight#ThemeAlias", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "Information about the theme alias.
" } }, "Status": { @@ -2771,10 +2819,10 @@ "smithy.api#httpResponseCode": {} } }, - "ThemeAlias": { - "target": "com.amazonaws.quicksight#ThemeAlias", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "Information about the theme alias.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } } } @@ -2782,6 +2830,14 @@ "com.amazonaws.quicksight#CreateThemeRequest": { "type": "structure", "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the AWS account where you want to store the new theme.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { @@ -2790,6 +2846,20 @@ "smithy.api#required": {} } }, + "Name": { + "target": "com.amazonaws.quicksight#ThemeName", + "traits": { + "smithy.api#documentation": "A display name for the theme.
", + "smithy.api#required": {} + } + }, + "BaseThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The ID of the theme that a custom theme will inherit from. All themes inherit from one of\n\t\t\tthe starting themes defined by Amazon QuickSight. For a list of the starting themes, use\n\t\t\t\tListThemes
or choose Themes from\n\t\t\twithin a QuickSight analysis.
The ID of the theme that a custom theme will inherit from. All themes inherit from one of\n\t\t\tthe starting themes defined by Amazon QuickSight. For a list of the starting themes, use\n\t\t\t\tListThemes
or choose Themes from\n\t\t\twithin a QuickSight analysis.
A valid grouping of resource permissions to apply to the new theme.\n\t\t\t
" } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "The ID of the AWS account where you want to store the new theme.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "Tags": { "target": "com.amazonaws.quicksight#TagList", "traits": { "smithy.api#documentation": "A map of the key-value pairs for the resource tag or tags that you want to add to the\n\t\t\tresource.
" } - }, - "Name": { - "target": "com.amazonaws.quicksight#ThemeName", - "traits": { - "smithy.api#documentation": "A display name for the theme.
", - "smithy.api#required": {} - } } } }, "com.amazonaws.quicksight#CreateThemeResponse": { "type": "structure", "members": { - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "The theme creation status.
" - } - }, - "ThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "The ID of the theme.
" - } - }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -2866,10 +2902,16 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) for the new theme.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "ThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The ID of the theme.
" + } + }, + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "The theme creation status.
" } }, "Status": { @@ -2878,6 +2920,12 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } } } }, @@ -2891,18 +2939,18 @@ "smithy.api#required": {} } }, - "AlternateDataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParametersList", - "traits": { - "smithy.api#documentation": "A set of alternate data source parameters that you want to share for these\n credentials. The credentials are applied in tandem with the data source parameters when\n you copy a data source by using a create or update request. The API operation compares\n the DataSourceParameters
structure that's in the request with the\n structures in the AlternateDataSourceParameters
allow list. If the\n structures are an exact match, the request is allowed to use the new data source with\n the existing credentials. If the AlternateDataSourceParameters
list is\n null, the DataSourceParameters
originally used with these\n Credentials
is automatically allowed.
Password.
", "smithy.api#required": {} } + }, + "AlternateDataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParametersList", + "traits": { + "smithy.api#documentation": "A set of alternate data source parameters that you want to share for these\n credentials. The credentials are applied in tandem with the data source parameters when\n you copy a data source by using a create or update request. The API operation compares\n the DataSourceParameters
structure that's in the request with the\n structures in the AlternateDataSourceParameters
allow list. If the\n structures are an exact match, the request is allowed to use the new data source with\n the existing credentials. If the AlternateDataSourceParameters
list is\n null, the DataSourceParameters
originally used with these\n Credentials
is automatically allowed.
The column schema from the SQL query result set.
" - } - }, - "SqlQuery": { - "target": "com.amazonaws.quicksight#SqlQuery", + "DataSourceArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The SQL query.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data source.
", "smithy.api#required": {} } }, @@ -2932,12 +2974,18 @@ "smithy.api#required": {} } }, - "DataSourceArn": { - "target": "com.amazonaws.quicksight#Arn", + "SqlQuery": { + "target": "com.amazonaws.quicksight#SqlQuery", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data source.
", + "smithy.api#documentation": "The SQL query.
", "smithy.api#required": {} } + }, + "Columns": { + "target": "com.amazonaws.quicksight#InputColumnList", + "traits": { + "smithy.api#documentation": "The column schema from the SQL query result set.
" + } } }, "traits": { @@ -2956,22 +3004,22 @@ "com.amazonaws.quicksight#Dashboard": { "type": "structure", "members": { - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "The time that this dataset was created.
" - } - }, "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "Dashboard ID.
" } }, - "LastPublishedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The last time that this dataset was published.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" + } + }, + "Name": { + "target": "com.amazonaws.quicksight#DashboardName", + "traits": { + "smithy.api#documentation": "A display name for the dashboard.
" } }, "Version": { @@ -2980,22 +3028,22 @@ "smithy.api#documentation": "Version.
" } }, - "Name": { - "target": "com.amazonaws.quicksight#DashboardName", + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "A display name for the dashboard.
" + "smithy.api#documentation": "The time that this dataset was created.
" } }, - "LastUpdatedTime": { + "LastPublishedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "The last time that this dataset was updated.
" + "smithy.api#documentation": "The last time that this dataset was published.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" + "smithy.api#documentation": "The last time that this dataset was updated.
" } } }, @@ -3126,17 +3174,17 @@ "smithy.api#documentation": "Ad hoc (one-time) filtering option.
" } }, - "SheetControlsOption": { - "target": "com.amazonaws.quicksight#SheetControlsOption", - "traits": { - "smithy.api#documentation": "Sheet controls option.
" - } - }, "ExportToCSVOption": { "target": "com.amazonaws.quicksight#ExportToCSVOption", "traits": { "smithy.api#documentation": "Export to .csv option.
" } + }, + "SheetControlsOption": { + "target": "com.amazonaws.quicksight#SheetControlsOption", + "traits": { + "smithy.api#documentation": "Sheet controls option.
" + } } }, "traits": { @@ -3153,17 +3201,17 @@ "smithy.api#required": {} } }, - "Value": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The value of the named item, in this case QUICKSIGHT_USER
, that you want\n to use as a filter, for example, \"Value\":\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"
.
The name of the value that you want to use as a filter, for example, \"Name\":\n \"QUICKSIGHT_USER\"
.
The value of the named item, in this case QUICKSIGHT_USER
, that you want\n to use as a filter, for example, \"Value\":\n \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\"
.
Published version number.
" - } - }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "The time that this dashboard was created.
" - } - }, - "LastPublishedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The last time that this dashboard was published.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" } }, "DashboardId": { @@ -3251,16 +3287,28 @@ "smithy.api#documentation": "A display name for the dashboard.
" } }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "The time that this dashboard was created.
" + } + }, "LastUpdatedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { "smithy.api#documentation": "The last time that this dashboard was updated.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "PublishedVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" + "smithy.api#documentation": "Published version number.
" + } + }, + "LastPublishedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "The last time that this dashboard was published.
" } } }, @@ -3298,34 +3346,34 @@ "com.amazonaws.quicksight#DashboardVersion": { "type": "structure", "members": { - "Sheets": { - "target": "com.amazonaws.quicksight#SheetList", + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "A list of the associated sheets with the unique identifier and name of each sheet.
" + "smithy.api#documentation": "The time that this dashboard version was created.
" } }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", + "Errors": { + "target": "com.amazonaws.quicksight#DashboardErrorList", "traits": { - "smithy.api#documentation": "Version number for this version of the dashboard.
" + "smithy.api#documentation": "Errors associated with this dashboard version.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" + "smithy.api#documentation": "Version number for this version of the dashboard.
" } }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { - "smithy.api#documentation": "Description.
" + "smithy.api#documentation": "The HTTP status of the request.
" } }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The time that this dashboard version was created.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" } }, "SourceEntityArn": { @@ -3334,28 +3382,28 @@ "smithy.api#documentation": "Source entity ARN.
" } }, - "Errors": { - "target": "com.amazonaws.quicksight#DashboardErrorList", + "DataSetArns": { + "target": "com.amazonaws.quicksight#DataSetArnsList", "traits": { - "smithy.api#documentation": "Errors associated with this dashboard version.
" + "smithy.api#documentation": "The Amazon Resource Numbers (ARNs) for the datasets that are associated with this\n version of the dashboard.
" } }, - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", "traits": { - "smithy.api#documentation": "The ARN of the theme associated with a version of the dashboard.
" + "smithy.api#documentation": "Description.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
" + "smithy.api#documentation": "The ARN of the theme associated with a version of the dashboard.
" } }, - "DataSetArns": { - "target": "com.amazonaws.quicksight#DataSetArnsList", + "Sheets": { + "target": "com.amazonaws.quicksight#SheetList", "traits": { - "smithy.api#documentation": "The Amazon Resource Numbers (ARNs) for the datasets that are associated with this\n version of the dashboard.
" + "smithy.api#documentation": "A list of the associated sheets with the unique identifier and name of each sheet.
" } } }, @@ -3366,16 +3414,16 @@ "com.amazonaws.quicksight#DashboardVersionSummary": { "type": "structure", "members": { - "SourceEntityArn": { + "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "Source entity ARN.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" + "smithy.api#documentation": "The time that this dashboard version was created.
" } }, "VersionNumber": { @@ -3390,16 +3438,16 @@ "smithy.api#documentation": "The HTTP status of the request.
" } }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", + "SourceEntityArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "Description.
" + "smithy.api#documentation": "Source entity ARN.
" } }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", "traits": { - "smithy.api#documentation": "The time that this dashboard version was created.
" + "smithy.api#documentation": "Description.
" } } }, @@ -3422,16 +3470,16 @@ "com.amazonaws.quicksight#DataColorPalette": { "type": "structure", "members": { - "MinMaxGradient": { + "Colors": { "target": "com.amazonaws.quicksight#ColorList", "traits": { - "smithy.api#documentation": "The minimum and maximum hexadecimal codes that describe a color gradient.
" + "smithy.api#documentation": "The hexadecimal codes for the colors.
" } }, - "Colors": { + "MinMaxGradient": { "target": "com.amazonaws.quicksight#ColorList", "traits": { - "smithy.api#documentation": "The hexadecimal codes for the colors.
" + "smithy.api#documentation": "The minimum and maximum hexadecimal codes that describe a color gradient.
" } }, "EmptyFillColor": { @@ -3448,76 +3496,82 @@ "com.amazonaws.quicksight#DataSet": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "A display name for the dataset.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" } }, - "OutputColumns": { - "target": "com.amazonaws.quicksight#OutputColumnList", + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The list of columns after all transforms. These columns are available in templates,\n analyses, and dashboards.
" + "smithy.api#documentation": "The ID of the dataset.
" } }, - "LogicalTableMap": { - "target": "com.amazonaws.quicksight#LogicalTableMap", + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", "traits": { - "smithy.api#documentation": "Configures the combination and transformation of the data from the physical\n tables.
" + "smithy.api#documentation": "A display name for the dataset.
" } }, - "RowLevelPermissionDataSet": { - "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "The row-level security configuration for the dataset.
" + "smithy.api#documentation": "The time that this dataset was created.
" } }, - "ConsumedSpiceCapacityInBytes": { - "target": "com.amazonaws.quicksight#Long", + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't\n imported into SPICE.
" + "smithy.api#documentation": "The last time that this dataset was updated.
" } }, - "ImportMode": { - "target": "com.amazonaws.quicksight#DataSetImportMode", + "PhysicalTableMap": { + "target": "com.amazonaws.quicksight#PhysicalTableMap", "traits": { - "smithy.api#documentation": "Indicates whether you want to import the data into SPICE.
" + "smithy.api#documentation": "Declares the physical tables that are available in the underlying data sources.
" } }, - "ColumnGroups": { - "target": "com.amazonaws.quicksight#ColumnGroupList", + "LogicalTableMap": { + "target": "com.amazonaws.quicksight#LogicalTableMap", "traits": { - "smithy.api#documentation": "Groupings of columns that work together in certain Amazon QuickSight features.\n Currently, only geospatial hierarchy is supported.
" + "smithy.api#documentation": "Configures the combination and transformation of the data from the physical\n tables.
" } }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "OutputColumns": { + "target": "com.amazonaws.quicksight#OutputColumnList", "traits": { - "smithy.api#documentation": "The time that this dataset was created.
" + "smithy.api#documentation": "The list of columns after all transforms. These columns are available in templates,\n analyses, and dashboards.
" } }, - "PhysicalTableMap": { - "target": "com.amazonaws.quicksight#PhysicalTableMap", + "ImportMode": { + "target": "com.amazonaws.quicksight#DataSetImportMode", "traits": { - "smithy.api#documentation": "Declares the physical tables that are available in the underlying data sources.
" + "smithy.api#documentation": "Indicates whether you want to import the data into SPICE.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "ConsumedSpiceCapacityInBytes": { + "target": "com.amazonaws.quicksight#Long", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" + "smithy.api#documentation": "The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't\n imported into SPICE.
" } }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", + "ColumnGroups": { + "target": "com.amazonaws.quicksight#ColumnGroupList", "traits": { - "smithy.api#documentation": "The ID of the dataset.
" + "smithy.api#documentation": "Groupings of columns that work together in certain Amazon QuickSight features.\n Currently, only geospatial hierarchy is supported.
" } }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "RowLevelPermissionDataSet": { + "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", "traits": { - "smithy.api#documentation": "The last time that this dataset was updated.
" + "smithy.api#documentation": "The row-level security configuration for the dataset.
" + } + }, + "ColumnLevelPermissionRules": { + "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", + "traits": { + "smithy.api#documentation": "A set of one or more definitions of a \n ColumnLevelPermissionRule\n
.
The time that this dataset was created.
" - } - }, - "ImportMode": { - "target": "com.amazonaws.quicksight#DataSetImportMode", - "traits": { - "smithy.api#documentation": "Indicates whether you want to import the data into SPICE.
" - } - }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" } }, - "RowLevelPermissionDataSet": { - "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The row-level security configuration for the dataset.
" + "smithy.api#documentation": "The ID of the dataset.
" } }, "Name": { @@ -3679,16 +3721,34 @@ "smithy.api#documentation": "A display name for the dataset.
" } }, + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "The time that this dataset was created.
" + } + }, "LastUpdatedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { "smithy.api#documentation": "The last time that this dataset was updated.
" } }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", + "ImportMode": { + "target": "com.amazonaws.quicksight#DataSetImportMode", "traits": { - "smithy.api#documentation": "The ID of the dataset.
" + "smithy.api#documentation": "Indicates whether you want to import the data into SPICE.
" + } + }, + "RowLevelPermissionDataSet": { + "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", + "traits": { + "smithy.api#documentation": "The row-level security configuration for the dataset.
" + } + }, + "ColumnLevelPermissionRulesApplied": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#documentation": "Indicates if the dataset has column level permission\n configured.
" } } }, @@ -3705,52 +3765,46 @@ "com.amazonaws.quicksight#DataSource": { "type": "structure", "members": { - "SslProperties": { - "target": "com.amazonaws.quicksight#SslProperties", - "traits": { - "smithy.api#documentation": "Secure Socket Layer (SSL) properties that apply when QuickSight connects to your\n underlying source.
" - } - }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data source.
" } }, - "AlternateDataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParametersList", + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "A set of alternate data source parameters that you want to share for the credentials\n stored with this data source. The credentials are applied in tandem with the data source\n parameters when you copy a data source by using a create or update request. The API\n operation compares the DataSourceParameters
structure that's in the request\n with the structures in the AlternateDataSourceParameters
allow list. If the\n structures are an exact match, the request is allowed to use the credentials from this\n existing data source. If the AlternateDataSourceParameters
list is null,\n the Credentials
originally used with this DataSourceParameters
\n are automatically allowed.
The ID of the data source. This ID is unique per AWS Region for each AWS\n account.
" } }, - "VpcConnectionProperties": { - "target": "com.amazonaws.quicksight#VpcConnectionProperties", + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", "traits": { - "smithy.api#documentation": "The VPC connection information. You need to use this parameter only when you want\n QuickSight to use a VPC connection when connecting to your underlying source.
" + "smithy.api#documentation": "A display name for the data source.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "Type": { + "target": "com.amazonaws.quicksight#DataSourceType", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
" + "smithy.api#documentation": "The type of the data source. This type indicates which database engine the data source\n connects to.
" } }, - "ErrorInfo": { - "target": "com.amazonaws.quicksight#DataSourceErrorInfo", + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { - "smithy.api#documentation": "Error information from the last update or the creation of the data source.
" + "smithy.api#documentation": "The HTTP status of the request.
" } }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "A display name for the data source.
" + "smithy.api#documentation": "The time that this data source was created.
" } }, - "Type": { - "target": "com.amazonaws.quicksight#DataSourceType", + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "The type of the data source. This type indicates which database engine the data source\n connects to.
" + "smithy.api#documentation": "The last time that this data source was updated.
" } }, "DataSourceParameters": { @@ -3759,22 +3813,28 @@ "smithy.api#documentation": "The parameters that Amazon QuickSight uses to connect to your underlying source. This\n is a variant type structure. For this structure to be valid, only one of the attributes\n can be non-null.
" } }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "AlternateDataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParametersList", "traits": { - "smithy.api#documentation": "The time that this data source was created.
" + "smithy.api#documentation": "A set of alternate data source parameters that you want to share for the credentials\n stored with this data source. The credentials are applied in tandem with the data source\n parameters when you copy a data source by using a create or update request. The API\n operation compares the DataSourceParameters
structure that's in the request\n with the structures in the AlternateDataSourceParameters
allow list. If the\n structures are an exact match, the request is allowed to use the credentials from this\n existing data source. If the AlternateDataSourceParameters
list is null,\n the Credentials
originally used with this DataSourceParameters
\n are automatically allowed.
The ID of the data source. This ID is unique per AWS Region for each AWS\n account.
" + "smithy.api#documentation": "The VPC connection information. You need to use this parameter only when you want\n QuickSight to use a VPC connection when connecting to your underlying source.
" } }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "SslProperties": { + "target": "com.amazonaws.quicksight#SslProperties", + "traits": { + "smithy.api#documentation": "Secure Socket Layer (SSL) properties that apply when QuickSight connects to your\n underlying source.
" + } + }, + "ErrorInfo": { + "target": "com.amazonaws.quicksight#DataSourceErrorInfo", "traits": { - "smithy.api#documentation": "The last time that this data source was updated.
" + "smithy.api#documentation": "Error information from the last update or the creation of the data source.
" } } }, @@ -3785,17 +3845,17 @@ "com.amazonaws.quicksight#DataSourceCredentials": { "type": "structure", "members": { - "CopySourceArn": { - "target": "com.amazonaws.quicksight#CopySourceArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a data source that has the credential pair that you\n want to use. When CopySourceArn
is not null, the credential pair from the\n data source in the ARN is used as the credentials for the\n DataSourceCredentials
structure.
Credential pair. For more information, see CredentialPair.
" } + }, + "CopySourceArn": { + "target": "com.amazonaws.quicksight#CopySourceArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of a data source that has the credential pair that you\n want to use. When CopySourceArn
is not null, the credential pair from the\n data source in the ARN is used as the credentials for the\n DataSourceCredentials
structure.
MySQL parameters.
" + "smithy.api#documentation": "Amazon Elasticsearch Service parameters.
" } }, - "AwsIotAnalyticsParameters": { - "target": "com.amazonaws.quicksight#AwsIotAnalyticsParameters", + "AthenaParameters": { + "target": "com.amazonaws.quicksight#AthenaParameters", "traits": { - "smithy.api#documentation": "AWS IoT Analytics parameters.
" + "smithy.api#documentation": "Amazon Athena parameters.
" } }, - "AmazonElasticsearchParameters": { - "target": "com.amazonaws.quicksight#AmazonElasticsearchParameters", + "AuroraParameters": { + "target": "com.amazonaws.quicksight#AuroraParameters", "traits": { - "smithy.api#documentation": "Amazon Elasticsearch Service parameters.
" + "smithy.api#documentation": "Amazon Aurora MySQL parameters.
" } }, - "RdsParameters": { - "target": "com.amazonaws.quicksight#RdsParameters", + "AuroraPostgreSqlParameters": { + "target": "com.amazonaws.quicksight#AuroraPostgreSqlParameters", "traits": { - "smithy.api#documentation": "Amazon RDS parameters.
" + "smithy.api#documentation": "Aurora PostgreSQL parameters.
" + } + }, + "AwsIotAnalyticsParameters": { + "target": "com.amazonaws.quicksight#AwsIotAnalyticsParameters", + "traits": { + "smithy.api#documentation": "AWS IoT Analytics parameters.
" } }, "JiraParameters": { @@ -3901,52 +3967,52 @@ "smithy.api#documentation": "Jira parameters.
" } }, - "RedshiftParameters": { - "target": "com.amazonaws.quicksight#RedshiftParameters", + "MariaDbParameters": { + "target": "com.amazonaws.quicksight#MariaDbParameters", "traits": { - "smithy.api#documentation": "Amazon Redshift parameters.
" + "smithy.api#documentation": "MariaDB parameters.
" } }, - "AthenaParameters": { - "target": "com.amazonaws.quicksight#AthenaParameters", + "MySqlParameters": { + "target": "com.amazonaws.quicksight#MySqlParameters", "traits": { - "smithy.api#documentation": "Amazon Athena parameters.
" + "smithy.api#documentation": "MySQL parameters.
" } }, - "S3Parameters": { - "target": "com.amazonaws.quicksight#S3Parameters", + "OracleParameters": { + "target": "com.amazonaws.quicksight#OracleParameters", "traits": { - "smithy.api#documentation": "S3 parameters.
" + "smithy.api#documentation": "Oracle parameters.
" } }, - "AuroraParameters": { - "target": "com.amazonaws.quicksight#AuroraParameters", + "PostgreSqlParameters": { + "target": "com.amazonaws.quicksight#PostgreSqlParameters", "traits": { - "smithy.api#documentation": "Amazon Aurora MySQL parameters.
" + "smithy.api#documentation": "PostgreSQL parameters.
" } }, - "MariaDbParameters": { - "target": "com.amazonaws.quicksight#MariaDbParameters", + "PrestoParameters": { + "target": "com.amazonaws.quicksight#PrestoParameters", "traits": { - "smithy.api#documentation": "MariaDB parameters.
" + "smithy.api#documentation": "Presto parameters.
" } }, - "SparkParameters": { - "target": "com.amazonaws.quicksight#SparkParameters", + "RdsParameters": { + "target": "com.amazonaws.quicksight#RdsParameters", "traits": { - "smithy.api#documentation": "Spark parameters.
" + "smithy.api#documentation": "Amazon RDS parameters.
" } }, - "AuroraPostgreSqlParameters": { - "target": "com.amazonaws.quicksight#AuroraPostgreSqlParameters", + "RedshiftParameters": { + "target": "com.amazonaws.quicksight#RedshiftParameters", "traits": { - "smithy.api#documentation": "Aurora PostgreSQL parameters.
" + "smithy.api#documentation": "Amazon Redshift parameters.
" } }, - "TwitterParameters": { - "target": "com.amazonaws.quicksight#TwitterParameters", + "S3Parameters": { + "target": "com.amazonaws.quicksight#S3Parameters", "traits": { - "smithy.api#documentation": "Twitter parameters.
" + "smithy.api#documentation": "S3 parameters.
" } }, "ServiceNowParameters": { @@ -3955,16 +4021,16 @@ "smithy.api#documentation": "ServiceNow parameters.
" } }, - "PrestoParameters": { - "target": "com.amazonaws.quicksight#PrestoParameters", + "SnowflakeParameters": { + "target": "com.amazonaws.quicksight#SnowflakeParameters", "traits": { - "smithy.api#documentation": "Presto parameters.
" + "smithy.api#documentation": "Snowflake parameters.
" } }, - "PostgreSqlParameters": { - "target": "com.amazonaws.quicksight#PostgreSqlParameters", + "SparkParameters": { + "target": "com.amazonaws.quicksight#SparkParameters", "traits": { - "smithy.api#documentation": "PostgreSQL parameters.
" + "smithy.api#documentation": "Spark parameters.
" } }, "SqlServerParameters": { @@ -3973,17 +4039,17 @@ "smithy.api#documentation": "SQL Server parameters.
" } }, - "SnowflakeParameters": { - "target": "com.amazonaws.quicksight#SnowflakeParameters", - "traits": { - "smithy.api#documentation": "Snowflake parameters.
" - } - }, "TeradataParameters": { "target": "com.amazonaws.quicksight#TeradataParameters", "traits": { "smithy.api#documentation": "Teradata parameters.
" } + }, + "TwitterParameters": { + "target": "com.amazonaws.quicksight#TwitterParameters", + "traits": { + "smithy.api#documentation": "Twitter parameters.
" + } } }, "traits": { @@ -4046,6 +4112,10 @@ "value": "MYSQL", "name": "MYSQL" }, + { + "value": "ORACLE", + "name": "ORACLE" + }, { "value": "POSTGRESQL", "name": "POSTGRESQL" @@ -4143,17 +4213,17 @@ "com.amazonaws.quicksight#DecimalParameter": { "type": "structure", "members": { - "Values": { - "target": "com.amazonaws.quicksight#DoubleList", + "Name": { + "target": "com.amazonaws.quicksight#NonEmptyString", "traits": { - "smithy.api#documentation": "The values for the decimal parameter.
", + "smithy.api#documentation": "A display name for the decimal parameter.
", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.quicksight#NonEmptyString", + "Values": { + "target": "com.amazonaws.quicksight#DoubleList", "traits": { - "smithy.api#documentation": "A display name for the decimal parameter.
", + "smithy.api#documentation": "The values for the decimal parameter.
", "smithy.api#required": {} } } @@ -4214,13 +4284,6 @@ "com.amazonaws.quicksight#DeleteAccountCustomizationRequest": { "type": "structure", "members": { - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "The QuickSight namespace that you're deleting the customizations from.
", - "smithy.api#httpQuery": "namespace" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -4228,24 +4291,31 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The QuickSight namespace that you're deleting the customizations from.
", + "smithy.api#httpQuery": "namespace" + } } } }, "com.amazonaws.quicksight#DeleteAccountCustomizationResponse": { "type": "structure", "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } } } }, @@ -4305,31 +4375,25 @@ "smithy.api#required": {} } }, - "ForceDeleteWithoutRecovery": { - "target": "com.amazonaws.quicksight#Boolean", - "traits": { - "smithy.api#documentation": "This option defaults to the value NoForceDeleteWithoutRecovery
. To\n immediately delete the analysis, add the ForceDeleteWithoutRecovery
option.\n You can't restore an analysis after it's deleted.
A value that specifies the number of days that QuickSight waits before it deletes the\n analysis. You can't use this parameter with the ForceDeleteWithoutRecovery
\n option in the same API call. The default value is 30.
This option defaults to the value NoForceDeleteWithoutRecovery
. To\n immediately delete the analysis, add the ForceDeleteWithoutRecovery
option.\n You can't restore an analysis after it's deleted.
The ID of the deleted analysis.
" - } - }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -4337,18 +4401,24 @@ "smithy.api#httpResponseCode": {} } }, - "DeletionTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "The date and time that the analysis is scheduled to be deleted.
" - } - }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the deleted analysis.
" } }, + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The ID of the deleted analysis.
" + } + }, + "DeletionTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "The date and time that the analysis is scheduled to be deleted.
" + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -4397,6 +4467,14 @@ "com.amazonaws.quicksight#DeleteDashboardRequest": { "type": "structure", "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the AWS account that contains the dashboard that you're\n deleting.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { @@ -4411,14 +4489,6 @@ "smithy.api#documentation": "The version number of the dashboard. If the version number property is provided, only\n the specified version of the dashboard is deleted.
", "smithy.api#httpQuery": "version-number" } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the dashboard that you're\n deleting.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -4432,10 +4502,10 @@ "smithy.api#httpResponseCode": {} } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The Secure Socket Layer (SSL) properties that apply for the resource.
" } }, "DashboardId": { @@ -4444,10 +4514,10 @@ "smithy.api#documentation": "The ID of the dashboard.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The Secure Socket Layer (SSL) properties that apply for the resource.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } } } @@ -4510,6 +4580,12 @@ "com.amazonaws.quicksight#DeleteDataSetResponse": { "type": "structure", "members": { + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" + } + }, "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { @@ -4528,12 +4604,6 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" - } } } }, @@ -4595,17 +4665,16 @@ "com.amazonaws.quicksight#DeleteDataSourceResponse": { "type": "structure", "members": { - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data source that you deleted.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
" } }, "RequestId": { @@ -4614,10 +4683,11 @@ "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data source that you deleted.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -4705,34 +4775,34 @@ "com.amazonaws.quicksight#DeleteGroupMembershipRequest": { "type": "structure", "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "MemberName": { + "target": "com.amazonaws.quicksight#GroupMemberName", "traits": { - "smithy.api#documentation": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The name of the user that you want to delete from the group membership.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", "traits": { - "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
The name of the group that you want to delete the user from.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The name of the group that you want to delete the user from.
", + "smithy.api#documentation": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "MemberName": { - "target": "com.amazonaws.quicksight#GroupMemberName", + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "The name of the user that you want to delete from the group membership.
", + "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
The AWS request ID for this operation.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } } } }, "com.amazonaws.quicksight#DeleteGroupRequest": { "type": "structure", "members": { + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", + "traits": { + "smithy.api#documentation": "The name of the group that you want to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -4775,14 +4853,6 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", - "traits": { - "smithy.api#documentation": "The name of the group that you want to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -4876,13 +4946,6 @@ "com.amazonaws.quicksight#DeleteIAMPolicyAssignmentResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} - } - }, "AssignmentName": { "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { @@ -4894,6 +4957,13 @@ "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } } } }, @@ -4961,18 +5031,18 @@ "com.amazonaws.quicksight#DeleteNamespaceResponse": { "type": "structure", "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } } } }, @@ -5053,18 +5123,18 @@ "com.amazonaws.quicksight#DeleteTemplateAliasRequest": { "type": "structure", "members": { - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the template that the specified alias is for.
", + "smithy.api#documentation": "The ID of the AWS account that contains the item to delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the item to delete.
", + "smithy.api#documentation": "The ID for the template that the specified alias is for.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5082,16 +5152,17 @@ "com.amazonaws.quicksight#DeleteTemplateAliasResponse": { "type": "structure", "members": { - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "An ID for the template associated with the deletion.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template you want to delete.
" + "smithy.api#documentation": "An ID for the template associated with the deletion.
" } }, "AliasName": { @@ -5100,17 +5171,16 @@ "smithy.api#documentation": "The name for the template alias.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template you want to delete.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The AWS request ID for this operation.
" } } } @@ -5146,30 +5216,30 @@ "com.amazonaws.quicksight#DeleteTemplateResponse": { "type": "structure", "members": { - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "An ID for the template.
" - } - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, + "Arn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "An ID for the template.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" - } } } }, @@ -5253,6 +5323,14 @@ "com.amazonaws.quicksight#DeleteThemeAliasRequest": { "type": "structure", "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the AWS account that contains the theme alias to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { @@ -5268,31 +5346,16 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the theme alias to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.quicksight#DeleteThemeAliasResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The name for the theme alias.
" } }, "Arn": { @@ -5301,10 +5364,17 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the theme resource using the deleted alias.
" } }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The name for the theme alias.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } }, "ThemeId": { @@ -5318,11 +5388,12 @@ "com.amazonaws.quicksight#DeleteThemeRequest": { "type": "structure", "members": { - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The version of the theme that you want to delete.
\n\t\t\n Note: If you don't provide a version number, you're\n\t\t\tusing this call to DeleteTheme
to delete all versions of the theme.
The ID of the AWS account that contains the theme that you're deleting.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "ThemeId": { @@ -5333,12 +5404,11 @@ "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the theme that you're deleting.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The version of the theme that you want to delete.
\n\t\t\n Note: If you don't provide a version number, you're\n\t\t\tusing this call to DeleteTheme
to delete all versions of the theme.
The Amazon Resource Name (ARN) of the resource.
" + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -5364,12 +5440,6 @@ "traits": { "smithy.api#documentation": "An ID for the theme.
" } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" - } } } }, @@ -5456,14 +5526,6 @@ "com.amazonaws.quicksight#DeleteUserByPrincipalIdRequest": { "type": "structure", "members": { - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
The namespace. Currently, you should set this to default
.
The QuickSight namespace that you want to describe QuickSight customizations\n for.
", - "smithy.api#httpQuery": "namespace" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -5614,23 +5677,41 @@ "smithy.api#required": {} } }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The QuickSight namespace that you want to describe QuickSight customizations\n for.
", + "smithy.api#httpQuery": "namespace" + } + }, "Resolved": { "target": "com.amazonaws.quicksight#Boolean", "traits": { "smithy.api#documentation": "The Resolved
flag works with the other parameters to determine which view\n of QuickSight customizations is returned. You can add this flag to your command to use\n the same view that QuickSight uses to identify which customizations to apply to the\n console. Omit this flag, or set it to no-resolved
, to reveal customizations\n that are configured at different levels.
The Amazon Resource Name (ARN) of the customization that's associated with this AWS account.
" + } + }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID for the AWS account that you're describing.
" + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The QuickSight namespace that you're describing.
" } }, "AccountCustomization": { @@ -5645,22 +5726,11 @@ "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "The ID for the AWS account that you're describing.
" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the customization that's associated with this AWS account.
" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The QuickSight namespace that you're describing.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -5718,13 +5788,6 @@ "com.amazonaws.quicksight#DescribeAccountSettingsResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} - } - }, "AccountSettings": { "target": "com.amazonaws.quicksight#AccountSettings", "traits": { @@ -5736,6 +5799,13 @@ "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } } } }, @@ -5813,18 +5883,18 @@ "com.amazonaws.quicksight#DescribeAnalysisPermissionsRequest": { "type": "structure", "members": { - "AnalysisId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the analysis whose permissions you're describing. The ID is part of the\n analysis URL.
", + "smithy.api#documentation": "The ID of the AWS account that contains the analysis whose permissions you're\n describing. You must be using the AWS account that the analysis is in.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the analysis whose permissions you're\n describing. You must be using the AWS account that the analysis is in.
", + "smithy.api#documentation": "The ID of the analysis whose permissions you're describing. The ID is part of the\n analysis URL.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -5834,6 +5904,12 @@ "com.amazonaws.quicksight#DescribeAnalysisPermissionsResponse": { "type": "structure", "members": { + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The ID of the analysis whose permissions you're describing.
" + } + }, "AnalysisArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -5846,24 +5922,18 @@ "smithy.api#documentation": "A structure that describes the principals and the resource-level permissions on an\n analysis.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } - }, - "AnalysisId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "The ID of the analysis whose permissions you're describing.
" - } - }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } } } }, @@ -5891,6 +5961,12 @@ "com.amazonaws.quicksight#DescribeAnalysisResponse": { "type": "structure", "members": { + "Analysis": { + "target": "com.amazonaws.quicksight#Analysis", + "traits": { + "smithy.api#documentation": "A metadata structure that contains summary information for the analysis that you're\n describing.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -5898,12 +5974,6 @@ "smithy.api#httpResponseCode": {} } }, - "Analysis": { - "target": "com.amazonaws.quicksight#Analysis", - "traits": { - "smithy.api#documentation": "A metadata structure that contains summary information for the analysis that you're\n describing.
" - } - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -6007,10 +6077,10 @@ "com.amazonaws.quicksight#DescribeDashboardPermissionsResponse": { "type": "structure", "members": { - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "DashboardId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "A structure that contains the permissions for the dashboard.
" + "smithy.api#documentation": "The ID for the dashboard.
" } }, "DashboardArn": { @@ -6019,16 +6089,10 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dashboard.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "The ID for the dashboard.
" + "smithy.api#documentation": "A structure that contains the permissions for the dashboard.
" } }, "Status": { @@ -6037,24 +6101,24 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } } } }, "com.amazonaws.quicksight#DescribeDashboardRequest": { "type": "structure", "members": { - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "The alias name.
", - "smithy.api#httpQuery": "alias-name" - } - }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The version number for the dashboard. If a version number isn't passed, the\n latest published dashboard version is described.
", - "smithy.api#httpQuery": "version-number" + "smithy.api#documentation": "The ID of the AWS account that contains the dashboard that you're\n describing.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "DashboardId": { @@ -6065,12 +6129,18 @@ "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the dashboard that you're\n describing.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The version number for the dashboard. If a version number isn't passed, the\n latest published dashboard version is described.
", + "smithy.api#httpQuery": "version-number" + } + }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "The alias name.
", + "smithy.api#httpQuery": "alias-name" } } } @@ -6078,6 +6148,12 @@ "com.amazonaws.quicksight#DescribeDashboardResponse": { "type": "structure", "members": { + "Dashboard": { + "target": "com.amazonaws.quicksight#Dashboard", + "traits": { + "smithy.api#documentation": "Information about the dashboard.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -6090,12 +6166,6 @@ "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } - }, - "Dashboard": { - "target": "com.amazonaws.quicksight#Dashboard", - "traits": { - "smithy.api#documentation": "Information about the dashboard.
" - } } } }, @@ -6170,18 +6240,18 @@ "com.amazonaws.quicksight#DescribeDataSetPermissionsRequest": { "type": "structure", "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
", + "smithy.api#documentation": "The AWS account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The AWS account ID.
", + "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6191,17 +6261,10 @@ "com.amazonaws.quicksight#DescribeDataSetPermissionsResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} - } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "DataSetArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" } }, "DataSetId": { @@ -6210,35 +6273,42 @@ "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
" } }, - "DataSetArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" - } - }, "Permissions": { "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { "smithy.api#documentation": "A list of resource permissions on the dataset.
" } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } } } }, "com.amazonaws.quicksight#DescribeDataSetRequest": { "type": "structure", "members": { - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
", + "smithy.api#documentation": "The AWS account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The AWS account ID.
", + "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6248,18 +6318,18 @@ "com.amazonaws.quicksight#DescribeDataSetResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } - }, "DataSet": { "target": "com.amazonaws.quicksight#DataSet", "traits": { "smithy.api#documentation": "Information on the dataset.
" } }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -6340,18 +6410,18 @@ "com.amazonaws.quicksight#DescribeDataSourcePermissionsRequest": { "type": "structure", "members": { - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
", + "smithy.api#documentation": "The AWS account ID.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The AWS account ID.
", + "smithy.api#documentation": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6361,12 +6431,6 @@ "com.amazonaws.quicksight#DescribeDataSourcePermissionsResponse": { "type": "structure", "members": { - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "A list of resource permissions on the data source.
" - } - }, "DataSourceArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -6376,7 +6440,13 @@ "DataSourceId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
" + "smithy.api#documentation": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
" + } + }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "A list of resource permissions on the data source.
" } }, "RequestId": { @@ -6418,11 +6488,10 @@ "com.amazonaws.quicksight#DescribeDataSourceResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "DataSource": { + "target": "com.amazonaws.quicksight#DataSource", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The information on the data source.
" } }, "RequestId": { @@ -6431,10 +6500,11 @@ "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "DataSource": { - "target": "com.amazonaws.quicksight#DataSource", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The information on the data source.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -6482,14 +6552,6 @@ "com.amazonaws.quicksight#DescribeGroupRequest": { "type": "structure", "members": { - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
The namespace. Currently, you should set this to default
.
The namespace that contains the assignment.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -6591,7 +6653,15 @@ "AssignmentName": { "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { - "smithy.api#documentation": "The name of the assignment.
", + "smithy.api#documentation": "The name of the assignment, also called a rule.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The namespace that contains the assignment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6601,18 +6671,18 @@ "com.amazonaws.quicksight#DescribeIAMPolicyAssignmentResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } - }, "IAMPolicyAssignment": { "target": "com.amazonaws.quicksight#IAMPolicyAssignment", "traits": { "smithy.api#documentation": "Information describing the IAM policy assignment.
" } }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -6691,11 +6761,10 @@ "com.amazonaws.quicksight#DescribeIngestionResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "Ingestion": { + "target": "com.amazonaws.quicksight#Ingestion", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "Information about the ingestion.
" } }, "RequestId": { @@ -6704,10 +6773,11 @@ "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "Ingestion": { - "target": "com.amazonaws.quicksight#Ingestion", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "Information about the ingestion.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -6779,18 +6849,18 @@ "smithy.api#documentation": "The information about the namespace that you're describing. The response includes \n the namespace ARN, name, AWS Region, creation status, and identity store. DescribeNamespace
also\n works for namespaces that are in the process of being created. For incomplete namespaces,\n this API operation lists the namespace error types and messages associated with the creation process.
The AWS request ID for this operation.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } } } }, @@ -6906,18 +6976,18 @@ "smithy.api#documentation": "Information about the template alias.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } - }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } } } }, @@ -6961,18 +7031,18 @@ "com.amazonaws.quicksight#DescribeTemplatePermissionsRequest": { "type": "structure", "members": { - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the template.
", + "smithy.api#documentation": "The ID of the AWS account that contains the template that you're describing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the template that you're describing.
", + "smithy.api#documentation": "The ID for the template.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -6982,54 +7052,54 @@ "com.amazonaws.quicksight#DescribeTemplatePermissionsResponse": { "type": "structure", "members": { - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "A list of resource permissions to be set on the template.
" - } - }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "The ID for the template.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} - } - }, "TemplateArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
" } }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "A list of resource permissions to be set on the template.
" + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } } } }, "com.amazonaws.quicksight#DescribeTemplateRequest": { "type": "structure", "members": { - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the template.
", + "smithy.api#documentation": "The ID of the AWS account that contains the template that you're describing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the template that you're describing.
", + "smithy.api#documentation": "The ID for the template.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7053,10 +7123,10 @@ "com.amazonaws.quicksight#DescribeTemplateResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "Template": { + "target": "com.amazonaws.quicksight#Template", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The template structure for the object you want to describe.
" } }, "Status": { @@ -7066,10 +7136,10 @@ "smithy.api#httpResponseCode": {} } }, - "Template": { - "target": "com.amazonaws.quicksight#Template", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The template structure for the object you want to describe.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } } } @@ -7154,6 +7224,14 @@ "com.amazonaws.quicksight#DescribeThemeAliasRequest": { "type": "structure", "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the AWS account that contains the theme alias that you're\n\t\t\tdescribing.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { @@ -7169,20 +7247,18 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the theme alias that you're\n\t\t\tdescribing.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.quicksight#DescribeThemeAliasResponse": { "type": "structure", "members": { + "ThemeAlias": { + "target": "com.amazonaws.quicksight#ThemeAlias", + "traits": { + "smithy.api#documentation": "Information about the theme alias.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -7195,12 +7271,6 @@ "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } - }, - "ThemeAlias": { - "target": "com.amazonaws.quicksight#ThemeAlias", - "traits": { - "smithy.api#documentation": "Information about the theme alias.
" - } } } }, @@ -7265,22 +7335,28 @@ "com.amazonaws.quicksight#DescribeThemePermissionsResponse": { "type": "structure", "members": { + "ThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The ID for the theme.
" + } + }, "ThemeArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the theme.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "A list of resource permissions set on the theme.
" } }, - "ThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The ID for the theme.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { @@ -7289,37 +7365,24 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "A list of resource permissions set on the theme.
" - } } } }, "com.amazonaws.quicksight#DescribeThemeRequest": { "type": "structure", "members": { - "ThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAndAccountId", "traits": { - "smithy.api#documentation": "The ID for the theme.
", + "smithy.api#documentation": "The ID of the AWS account that contains the theme that you're describing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", - "traits": { - "smithy.api#documentation": "The alias of the theme that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttheme by providing the keyword $LATEST
in the AliasName
\n\t\t\tparameter. The keyword $PUBLISHED
doesn't apply to themes.
The ID of the AWS account that contains the theme that you're describing.
", + "smithy.api#documentation": "The ID for the theme.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7330,12 +7393,25 @@ "smithy.api#documentation": "The version number for the version to describe. If a VersionNumber
parameter\n\t\t\tvalue isn't provided, the latest version of the theme is described.
The alias of the theme that you want to describe. If you name a specific alias, you\n\t\t\tdescribe the version that the alias points to. You can specify the latest version of the\n\t\t\ttheme by providing the keyword $LATEST
in the AliasName
\n\t\t\tparameter. The keyword $PUBLISHED
doesn't apply to themes.
The information about the theme that you are describing.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -7343,12 +7419,6 @@ "smithy.api#httpResponseCode": {} } }, - "Theme": { - "target": "com.amazonaws.quicksight#Theme", - "traits": { - "smithy.api#documentation": "The information about the theme that you are describing.
" - } - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -7400,6 +7470,14 @@ "com.amazonaws.quicksight#DescribeUserRequest": { "type": "structure", "members": { + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "The name of the user that you want to describe.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -7415,20 +7493,18 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } - }, - "UserName": { - "target": "com.amazonaws.quicksight#UserName", - "traits": { - "smithy.api#documentation": "The name of the user that you want to describe.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.quicksight#DescribeUserResponse": { "type": "structure", "members": { + "User": { + "target": "com.amazonaws.quicksight#User", + "traits": { + "smithy.api#documentation": "The user name.
" + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -7441,12 +7517,6 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "User": { - "target": "com.amazonaws.quicksight#User", - "traits": { - "smithy.api#documentation": "The user name.
" - } } } }, @@ -7520,17 +7590,17 @@ "com.amazonaws.quicksight#ErrorInfo": { "type": "structure", "members": { - "Message": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "Error message.
" - } - }, "Type": { "target": "com.amazonaws.quicksight#IngestionErrorType", "traits": { "smithy.api#documentation": "Error type.
" } + }, + "Message": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "Error message.
" + } } }, "traits": { @@ -7663,10 +7733,10 @@ "com.amazonaws.quicksight#GeoSpatialColumnGroup": { "type": "structure", "members": { - "Columns": { - "target": "com.amazonaws.quicksight#ColumnList", + "Name": { + "target": "com.amazonaws.quicksight#ColumnGroupName", "traits": { - "smithy.api#documentation": "Columns in this hierarchy.
", + "smithy.api#documentation": "A display name for the hierarchy.
", "smithy.api#required": {} } }, @@ -7677,10 +7747,10 @@ "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.quicksight#ColumnGroupName", + "Columns": { + "target": "com.amazonaws.quicksight#ColumnList", "traits": { - "smithy.api#documentation": "A display name for the hierarchy.
", + "smithy.api#documentation": "Columns in this hierarchy.
", "smithy.api#required": {} } } @@ -7790,18 +7860,28 @@ "com.amazonaws.quicksight#GetDashboardEmbedUrlRequest": { "type": "structure", "members": { - "UndoRedoDisabled": { - "target": "com.amazonaws.quicksight#Boolean", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables\n\t\t\tthe undo/redo button.
", - "smithy.api#httpQuery": "undo-redo-disabled" + "smithy.api#documentation": "The ID for the AWS account that contains the dashboard that you're embedding.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "ResetDisabled": { - "target": "com.amazonaws.quicksight#Boolean", + "DashboardId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "Remove the reset button on the embedded dashboard. The default is FALSE, which enables the\n\t\t\treset button.
", - "smithy.api#httpQuery": "reset-disabled" + "smithy.api#documentation": "The ID for the dashboard, also added to the IAM policy.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "IdentityType": { + "target": "com.amazonaws.quicksight#IdentityType", + "traits": { + "smithy.api#documentation": "The authentication method that the user uses to sign in.
", + "smithy.api#httpQuery": "creds-type", + "smithy.api#required": {} } }, "SessionLifetimeInMinutes": { @@ -7811,20 +7891,18 @@ "smithy.api#httpQuery": "session-lifetime" } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "UndoRedoDisabled": { + "target": "com.amazonaws.quicksight#Boolean", "traits": { - "smithy.api#documentation": "The ID for the AWS account that contains the dashboard that you're embedding.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables\n\t\t\tthe undo/redo button.
", + "smithy.api#httpQuery": "undo-redo-disabled" } }, - "IdentityType": { - "target": "com.amazonaws.quicksight#IdentityType", + "ResetDisabled": { + "target": "com.amazonaws.quicksight#Boolean", "traits": { - "smithy.api#documentation": "The authentication method that the user uses to sign in.
", - "smithy.api#httpQuery": "creds-type", - "smithy.api#required": {} + "smithy.api#documentation": "Remove the reset button on the embedded dashboard. The default is FALSE, which enables the\n\t\t\treset button.
", + "smithy.api#httpQuery": "reset-disabled" } }, "UserArn": { @@ -7833,24 +7911,16 @@ "smithy.api#documentation": "The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT
identity type.\n\t\t\tYou can use this for any Amazon QuickSight users in your account (readers, authors, or\n\t\t\tadmins) authenticated as one of the following:
Active Directory (AD) users or group members
\n\t\t\tInvited nonfederated users
\n\t\t\tIAM users and IAM role-based sessions authenticated through Federated Single Sign-On using\n\t\t\t\t\tSAML, OpenID Connect, or IAM federation.
\n\t\t\tOmit this parameter for users in the third group – IAM users and IAM\n role-based sessions.
", "smithy.api#httpQuery": "user-arn" } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "The ID for the dashboard, also added to the IAM policy.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.quicksight#GetDashboardEmbedUrlResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "EmbedUrl": { + "target": "com.amazonaws.quicksight#EmbeddingUrl", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "A single-use URL that you can put into your server-side webpage to embed your\n\t\t\tdashboard. This URL is valid for 5 minutes. The API operation provides the URL with an\n\t\t\tauth_code
value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.
A single-use URL that you can put into your server-side webpage to embed your\n\t\t\tdashboard. This URL is valid for 5 minutes. The API operation provides the URL with an\n\t\t\tauth_code
value that enables one (and only one) sign-on to a user session\n\t\t\tthat is valid for 10 hours.
The AWS request ID for this operation.
" } } } @@ -7917,6 +7987,14 @@ "com.amazonaws.quicksight#GetSessionEmbedUrlRequest": { "type": "structure", "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID for the AWS account associated with your QuickSight subscription.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "EntryPoint": { "target": "com.amazonaws.quicksight#EntryPoint", "traits": { @@ -7931,14 +8009,6 @@ "smithy.api#httpQuery": "session-lifetime" } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "The ID for the AWS account associated with your QuickSight subscription.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "UserArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -7951,12 +8021,6 @@ "com.amazonaws.quicksight#GetSessionEmbedUrlResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } - }, "EmbedUrl": { "target": "com.amazonaws.quicksight#EmbeddingUrl", "traits": { @@ -7969,24 +8033,18 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } } } }, "com.amazonaws.quicksight#Group": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.quicksight#GroupDescription", - "traits": { - "smithy.api#documentation": "The group description.
" - } - }, - "PrincipalId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The principal ID of the group.
" - } - }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -7998,6 +8056,18 @@ "traits": { "smithy.api#documentation": "The name of the group.
" } + }, + "Description": { + "target": "com.amazonaws.quicksight#GroupDescription", + "traits": { + "smithy.api#documentation": "The group description.
" + } + }, + "PrincipalId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The principal ID of the group.
" + } } }, "traits": { @@ -8022,17 +8092,17 @@ "com.amazonaws.quicksight#GroupMember": { "type": "structure", "members": { - "MemberName": { - "target": "com.amazonaws.quicksight#GroupMemberName", - "traits": { - "smithy.api#documentation": "The name of the group member (user).
" - } - }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) for the group member (user).
" } + }, + "MemberName": { + "target": "com.amazonaws.quicksight#GroupMemberName", + "traits": { + "smithy.api#documentation": "The name of the group member (user).
" + } } }, "traits": { @@ -8109,10 +8179,10 @@ "smithy.api#documentation": "Assignment ID.
" } }, - "Identities": { - "target": "com.amazonaws.quicksight#IdentityMap", + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { - "smithy.api#documentation": "Identities.
" + "smithy.api#documentation": "Assignment name.
" } }, "PolicyArn": { @@ -8121,16 +8191,16 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) for the IAM policy.
" } }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", + "Identities": { + "target": "com.amazonaws.quicksight#IdentityMap", "traits": { - "smithy.api#documentation": "Assignment status.
" + "smithy.api#documentation": "Identities.
" } }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", "traits": { - "smithy.api#documentation": "Assignment name.
" + "smithy.api#documentation": "Assignment status.
" } } }, @@ -8226,14 +8296,14 @@ "com.amazonaws.quicksight#IdentityTypeNotSupportedException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this request.
" } - }, - "Message": { - "target": "com.amazonaws.quicksight#String" } }, "traits": { @@ -8252,24 +8322,17 @@ "smithy.api#required": {} } }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", - "traits": { - "smithy.api#documentation": "The time that this ingestion started.
", - "smithy.api#required": {} - } - }, - "IngestionSizeInBytes": { - "target": "com.amazonaws.quicksight#Long", + "IngestionId": { + "target": "com.amazonaws.quicksight#IngestionId", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "The size of the data ingested, in bytes.
" + "smithy.api#documentation": "Ingestion ID.
" } }, - "RequestSource": { - "target": "com.amazonaws.quicksight#IngestionRequestSource", + "IngestionStatus": { + "target": "com.amazonaws.quicksight#IngestionStatus", "traits": { - "smithy.api#documentation": "Event source for this ingestion.
" + "smithy.api#documentation": "Ingestion status.
", + "smithy.api#required": {} } }, "ErrorInfo": { @@ -8278,36 +8341,43 @@ "smithy.api#documentation": "Error information for this ingestion.
" } }, - "IngestionStatus": { - "target": "com.amazonaws.quicksight#IngestionStatus", - "traits": { - "smithy.api#documentation": "Ingestion status.
", - "smithy.api#required": {} - } + "RowInfo": { + "target": "com.amazonaws.quicksight#RowInfo" }, "QueueInfo": { "target": "com.amazonaws.quicksight#QueueInfo" }, - "RowInfo": { - "target": "com.amazonaws.quicksight#RowInfo" + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", + "traits": { + "smithy.api#documentation": "The time that this ingestion started.
", + "smithy.api#required": {} + } }, - "RequestType": { - "target": "com.amazonaws.quicksight#IngestionRequestType", + "IngestionTimeInSeconds": { + "target": "com.amazonaws.quicksight#Long", "traits": { - "smithy.api#documentation": "Type of this ingestion.
" + "smithy.api#box": {}, + "smithy.api#documentation": "The time that this ingestion took, measured in seconds.
" } }, - "IngestionId": { - "target": "com.amazonaws.quicksight#IngestionId", + "IngestionSizeInBytes": { + "target": "com.amazonaws.quicksight#Long", "traits": { - "smithy.api#documentation": "Ingestion ID.
" + "smithy.api#box": {}, + "smithy.api#documentation": "The size of the data ingested, in bytes.
" + } + }, + "RequestSource": { + "target": "com.amazonaws.quicksight#IngestionRequestSource", + "traits": { + "smithy.api#documentation": "Event source for this ingestion.
" } }, - "IngestionTimeInSeconds": { - "target": "com.amazonaws.quicksight#Long", + "RequestType": { + "target": "com.amazonaws.quicksight#IngestionRequestType", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "The time that this ingestion took, measured in seconds.
" + "smithy.api#documentation": "Type of this ingestion.
" } } }, @@ -8657,17 +8727,17 @@ "com.amazonaws.quicksight#IntegerParameter": { "type": "structure", "members": { - "Values": { - "target": "com.amazonaws.quicksight#LongList", + "Name": { + "target": "com.amazonaws.quicksight#NonEmptyString", "traits": { - "smithy.api#documentation": "The values for the integer parameter.
", + "smithy.api#documentation": "The name of the integer parameter.
", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.quicksight#NonEmptyString", + "Values": { + "target": "com.amazonaws.quicksight#LongList", "traits": { - "smithy.api#documentation": "The name of the integer parameter.
", + "smithy.api#documentation": "The values for the integer parameter.
", "smithy.api#required": {} } } @@ -8710,14 +8780,14 @@ "com.amazonaws.quicksight#InvalidNextTokenException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this request.
" } - }, - "Message": { - "target": "com.amazonaws.quicksight#String" } }, "traits": { @@ -8763,31 +8833,31 @@ "com.amazonaws.quicksight#JoinInstruction": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.quicksight#JoinType", + "LeftOperand": { + "target": "com.amazonaws.quicksight#LogicalTableId", "traits": { - "smithy.api#documentation": "Type.
", + "smithy.api#documentation": "Left operand.
", "smithy.api#required": {} } }, - "OnClause": { - "target": "com.amazonaws.quicksight#OnClause", + "RightOperand": { + "target": "com.amazonaws.quicksight#LogicalTableId", "traits": { - "smithy.api#documentation": "On Clause.
", + "smithy.api#documentation": "Right operand.
", "smithy.api#required": {} } }, - "RightOperand": { - "target": "com.amazonaws.quicksight#LogicalTableId", + "Type": { + "target": "com.amazonaws.quicksight#JoinType", "traits": { - "smithy.api#documentation": "Right operand.
", + "smithy.api#documentation": "Type.
", "smithy.api#required": {} } }, - "LeftOperand": { - "target": "com.amazonaws.quicksight#LogicalTableId", + "OnClause": { + "target": "com.amazonaws.quicksight#OnClause", "traits": { - "smithy.api#documentation": "Left operand.
", + "smithy.api#documentation": "On Clause.
", "smithy.api#required": {} } } @@ -8883,14 +8953,6 @@ "com.amazonaws.quicksight#ListAnalysesRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "The maximum number of results to return.
", - "smithy.api#httpQuery": "max-results" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -8905,16 +8967,24 @@ "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
", "smithy.api#httpQuery": "next-token" } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results to return.
", + "smithy.api#httpQuery": "max-results" + } } } }, "com.amazonaws.quicksight#ListAnalysesResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "AnalysisSummaryList": { + "target": "com.amazonaws.quicksight#AnalysisSummaryList", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "Metadata describing each of the analyses that are listed.
" } }, "NextToken": { @@ -8930,10 +9000,10 @@ "smithy.api#httpResponseCode": {} } }, - "AnalysisSummaryList": { - "target": "com.amazonaws.quicksight#AnalysisSummaryList", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "Metadata describing each of the analyses that are listed.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } } } @@ -8999,6 +9069,13 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", + "smithy.api#httpQuery": "next-token" + } + }, "MaxResults": { "target": "com.amazonaws.quicksight#MaxResults", "traits": { @@ -9006,19 +9083,18 @@ "smithy.api#documentation": "The maximum number of results to be returned per request.
", "smithy.api#httpQuery": "max-results" } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", - "smithy.api#httpQuery": "next-token" - } } } }, "com.amazonaws.quicksight#ListDashboardVersionsResponse": { "type": "structure", "members": { + "DashboardVersionSummaryList": { + "target": "com.amazonaws.quicksight#DashboardVersionSummaryList", + "traits": { + "smithy.api#documentation": "A structure that contains information about each version of the dashboard.
" + } + }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -9032,12 +9108,6 @@ "smithy.api#httpResponseCode": {} } }, - "DashboardVersionSummaryList": { - "target": "com.amazonaws.quicksight#DashboardVersionSummaryList", - "traits": { - "smithy.api#documentation": "A structure that contains information about each version of the dashboard.
" - } - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -9093,6 +9163,13 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", + "smithy.api#httpQuery": "next-token" + } + }, "MaxResults": { "target": "com.amazonaws.quicksight#MaxResults", "traits": { @@ -9100,31 +9177,24 @@ "smithy.api#documentation": "The maximum number of results to be returned per request.
", "smithy.api#httpQuery": "max-results" } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", - "smithy.api#httpQuery": "next-token" - } } } }, "com.amazonaws.quicksight#ListDashboardsResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } - }, "DashboardSummaryList": { "target": "com.amazonaws.quicksight#DashboardSummaryList", "traits": { "smithy.api#documentation": "A structure that contains all of the dashboards in your AWS account. This structure\n provides basic information about the dashboards.
" } }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -9132,10 +9202,10 @@ "smithy.api#httpResponseCode": {} } }, - "NextToken": { + "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } } } @@ -9182,14 +9252,6 @@ "com.amazonaws.quicksight#ListDataSetsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "The maximum number of results to be returned per request.
", - "smithy.api#httpQuery": "max-results" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -9204,23 +9266,30 @@ "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", "smithy.api#httpQuery": "next-token" } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results to be returned per request.
", + "smithy.api#httpQuery": "max-results" + } } } }, "com.amazonaws.quicksight#ListDataSetsResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.quicksight#String", + "DataSetSummaries": { + "target": "com.amazonaws.quicksight#DataSetSummaryList", "traits": { - "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + "smithy.api#documentation": "The list of dataset summaries.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "NextToken": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" } }, "RequestId": { @@ -9229,10 +9298,11 @@ "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "DataSetSummaries": { - "target": "com.amazonaws.quicksight#DataSetSummaryList", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The list of dataset summaries.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -9313,13 +9383,6 @@ "smithy.api#documentation": "A list of data sources.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} - } - }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -9331,6 +9394,13 @@ "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } } } }, @@ -9380,12 +9450,12 @@ "com.amazonaws.quicksight#ListGroupMembershipsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "The maximum number of results to return from this request.
", - "smithy.api#httpQuery": "max-results" + "smithy.api#documentation": "The name of the group that you want to see a membership list of.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "NextToken": { @@ -9395,18 +9465,18 @@ "smithy.api#httpQuery": "next-token" } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", "traits": { - "smithy.api#documentation": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results to return from this request.
", + "smithy.api#httpQuery": "max-results" } }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The name of the group that you want to see a membership list of.
", + "smithy.api#documentation": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9424,29 +9494,29 @@ "com.amazonaws.quicksight#ListGroupMembershipsResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} - } - }, "GroupMemberList": { "target": "com.amazonaws.quicksight#GroupMemberList", "traits": { "smithy.api#documentation": "The list of the members of the group.
" } }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
" + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -9497,21 +9567,6 @@ "com.amazonaws.quicksight#ListGroupsRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
", - "smithy.api#httpQuery": "next-token" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
A pagination token that can be used in a subsequent request.
", + "smithy.api#httpQuery": "next-token" + } + }, "MaxResults": { "target": "com.amazonaws.quicksight#MaxResults", "traits": { @@ -9527,16 +9589,24 @@ "smithy.api#documentation": "The maximum number of results to return.
", "smithy.api#httpQuery": "max-results" } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
The AWS request ID for this operation.
" + "smithy.api#documentation": "The list of the groups.
" } }, "NextToken": { @@ -9545,10 +9615,10 @@ "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
" } }, - "GroupList": { - "target": "com.amazonaws.quicksight#GroupList", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The list of the groups.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { @@ -9648,10 +9718,10 @@ "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "UserName": { + "target": "com.amazonaws.quicksight#UserName", "traits": { - "smithy.api#documentation": "The namespace of the assignment.
", + "smithy.api#documentation": "The name of the user.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9671,10 +9741,10 @@ "smithy.api#httpQuery": "max-results" } }, - "UserName": { - "target": "com.amazonaws.quicksight#UserName", + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "The name of the user.
", + "smithy.api#documentation": "The namespace of the assignment.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9684,16 +9754,22 @@ "com.amazonaws.quicksight#ListIAMPolicyAssignmentsForUserResponse": { "type": "structure", "members": { - "NextToken": { + "ActiveAssignments": { + "target": "com.amazonaws.quicksight#ActiveIAMPolicyAssignmentList", + "traits": { + "smithy.api#documentation": "The active assignments for this user.
" + } + }, + "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "ActiveAssignments": { - "target": "com.amazonaws.quicksight#ActiveIAMPolicyAssignmentList", + "NextToken": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The active assignments for this user.
" + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" } }, "Status": { @@ -9702,32 +9778,12 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } } } }, "com.amazonaws.quicksight#ListIAMPolicyAssignmentsRequest": { "type": "structure", "members": { - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", - "traits": { - "smithy.api#documentation": "The status of the assignments.
" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "The maximum number of results to be returned per request.
", - "smithy.api#httpQuery": "max-results" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -9736,6 +9792,12 @@ "smithy.api#required": {} } }, + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", + "traits": { + "smithy.api#documentation": "The status of the assignments.
" + } + }, "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { @@ -9750,35 +9812,43 @@ "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", "smithy.api#httpQuery": "next-token" } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results to be returned per request.
", + "smithy.api#httpQuery": "max-results" + } } } }, "com.amazonaws.quicksight#ListIAMPolicyAssignmentsResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "IAMPolicyAssignments": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentSummaryList", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "Information describing the IAM policy assignments.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "NextToken": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" } }, - "NextToken": { + "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "IAMPolicyAssignments": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentSummaryList", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "Information describing the IAM policy assignments.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -9831,14 +9901,6 @@ "com.amazonaws.quicksight#ListIngestionsRequest": { "type": "structure", "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "The AWS account ID.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "DataSetId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -9854,6 +9916,14 @@ "smithy.api#httpQuery": "next-token" } }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The AWS account ID.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "MaxResults": { "target": "com.amazonaws.quicksight#IngestionMaxResults", "traits": { @@ -9867,6 +9937,12 @@ "com.amazonaws.quicksight#ListIngestionsResponse": { "type": "structure", "members": { + "Ingestions": { + "target": "com.amazonaws.quicksight#Ingestions", + "traits": { + "smithy.api#documentation": "A list of the ingestions.
" + } + }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -9879,12 +9955,6 @@ "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "Ingestions": { - "target": "com.amazonaws.quicksight#Ingestions", - "traits": { - "smithy.api#documentation": "A list of the ingestions.
" - } - }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -9945,14 +10015,6 @@ "com.amazonaws.quicksight#ListNamespacesRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "The maximum number of results to return.
", - "smithy.api#httpQuery": "max-results" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -9967,12 +10029,26 @@ "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
", "smithy.api#httpQuery": "next-token" } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results to return.
", + "smithy.api#httpQuery": "max-results" + } } } }, "com.amazonaws.quicksight#ListNamespacesResponse": { "type": "structure", "members": { + "Namespaces": { + "target": "com.amazonaws.quicksight#Namespaces", + "traits": { + "smithy.api#documentation": "The information about the namespaces in this AWS account. The response includes \n the namespace ARN, name, AWS Region, notification email address, creation status, and \n identity store.
" + } + }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -9985,12 +10061,6 @@ "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "Namespaces": { - "target": "com.amazonaws.quicksight#Namespaces", - "traits": { - "smithy.api#documentation": "The information about the namespaces in this AWS account. The response includes \n the namespace ARN, name, AWS Region, notification email address, creation status, and \n identity store.
" - } - }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -10050,11 +10120,10 @@ "com.amazonaws.quicksight#ListTagsForResourceResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "Tags": { + "target": "com.amazonaws.quicksight#TagList", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "Contains a map of the key-value pairs for the resource tag or tags assigned to the\n\t\t\tresource.
" } }, "RequestId": { @@ -10063,10 +10132,11 @@ "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "Tags": { - "target": "com.amazonaws.quicksight#TagList", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "Contains a map of the key-value pairs for the resource tag or tags assigned to the\n\t\t\tresource.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -10113,21 +10183,6 @@ "com.amazonaws.quicksight#ListTemplateAliasesRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", - "smithy.api#httpQuery": "next-token" - } - }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "The maximum number of results to be returned per request.
", - "smithy.api#httpQuery": "max-result" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -10143,18 +10198,27 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", + "smithy.api#httpQuery": "next-token" + } + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results to be returned per request.
", + "smithy.api#httpQuery": "max-result" + } } } }, "com.amazonaws.quicksight#ListTemplateAliasesResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } - }, "TemplateAliasList": { "target": "com.amazonaws.quicksight#TemplateAliasList", "traits": { @@ -10168,6 +10232,12 @@ "smithy.api#httpResponseCode": {} } }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } + }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -10221,19 +10291,12 @@ "com.amazonaws.quicksight#ListTemplateVersionsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "The maximum number of results to be returned per request.
", - "smithy.api#httpQuery": "max-results" - } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", - "smithy.api#httpQuery": "next-token" + "smithy.api#documentation": "The ID of the AWS account that contains the templates that you're listing.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "TemplateId": { @@ -10244,26 +10307,26 @@ "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "NextToken": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the templates that you're listing.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", + "smithy.api#httpQuery": "next-token" } - } - } - }, - "com.amazonaws.quicksight#ListTemplateVersionsResponse": { - "type": "structure", - "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + }, + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results to be returned per request.
", + "smithy.api#httpQuery": "max-results" } - }, + } + } + }, + "com.amazonaws.quicksight#ListTemplateVersionsResponse": { + "type": "structure", + "members": { "TemplateVersionSummaryList": { "target": "com.amazonaws.quicksight#TemplateVersionSummaryList", "traits": { @@ -10276,6 +10339,13 @@ "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" } }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -10357,16 +10427,16 @@ "com.amazonaws.quicksight#ListTemplatesResponse": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.quicksight#String", + "TemplateSummaryList": { + "target": "com.amazonaws.quicksight#TemplateSummaryList", "traits": { - "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + "smithy.api#documentation": "A structure containing information about the templates in the list.
" } }, - "RequestId": { + "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" } }, "Status": { @@ -10376,10 +10446,10 @@ "smithy.api#httpResponseCode": {} } }, - "TemplateSummaryList": { - "target": "com.amazonaws.quicksight#TemplateSummaryList", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "A structure containing information about the templates in the list.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } } } @@ -10427,12 +10497,12 @@ "com.amazonaws.quicksight#ListThemeAliasesRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "The maximum number of results to be returned per request.
", - "smithy.api#httpQuery": "max-result" + "smithy.api#documentation": "The ID of the AWS account that contains the theme aliases that you're listing.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "ThemeId": { @@ -10450,12 +10520,12 @@ "smithy.api#httpQuery": "next-token" } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the theme aliases that you're listing.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results to be returned per request.
", + "smithy.api#httpQuery": "max-result" } } } @@ -10463,10 +10533,10 @@ "com.amazonaws.quicksight#ListThemeAliasesResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "ThemeAliasList": { + "target": "com.amazonaws.quicksight#ThemeAliasList", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "A structure containing the list of the theme's aliases.
" } }, "Status": { @@ -10476,10 +10546,10 @@ "smithy.api#httpResponseCode": {} } }, - "ThemeAliasList": { - "target": "com.amazonaws.quicksight#ThemeAliasList", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "A structure containing the list of the theme's aliases.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "NextToken": { @@ -10533,20 +10603,20 @@ "com.amazonaws.quicksight#ListThemeVersionsRequest": { "type": "structure", "members": { - "ThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the theme.
", + "smithy.api#documentation": "The ID of the AWS account that contains the themes that you're listing.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", + "ThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "The maximum number of results to be returned per request.
", - "smithy.api#httpQuery": "max-results" + "smithy.api#documentation": "The ID for the theme.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "NextToken": { @@ -10556,12 +10626,12 @@ "smithy.api#httpQuery": "next-token" } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the themes that you're listing.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results to be returned per request.
", + "smithy.api#httpQuery": "max-results" } } } @@ -10575,6 +10645,12 @@ "smithy.api#documentation": "A structure containing a list of all the versions of the specified theme.
" } }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -10587,12 +10663,6 @@ "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" - } } } }, @@ -10639,13 +10709,6 @@ "com.amazonaws.quicksight#ListThemesRequest": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.quicksight#ThemeType", - "traits": { - "smithy.api#documentation": "The type of themes that you want to list. Valid options include the following:
\n \t\n ALL (default)
- Display all existing themes.
\n CUSTOM
- Display only the themes created by people using Amazon QuickSight.
\n QUICKSIGHT
- Display only the starting themes defined by QuickSight.
The token for the next set of results, or null if there are no more results.
", + "smithy.api#httpQuery": "next-token" + } + }, "MaxResults": { "target": "com.amazonaws.quicksight#MaxResults", "traits": { @@ -10662,11 +10732,11 @@ "smithy.api#httpQuery": "max-results" } }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", + "Type": { + "target": "com.amazonaws.quicksight#ThemeType", "traits": { - "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
", - "smithy.api#httpQuery": "next-token" + "smithy.api#documentation": "The type of themes that you want to list. Valid options include the following:
\n \t\n ALL (default)
- Display all existing themes.
\n CUSTOM
- Display only the themes created by people using Amazon QuickSight.
\n QUICKSIGHT
- Display only the starting themes defined by QuickSight.
The AWS request ID for this operation.
" - } - }, "ThemeSummaryList": { "target": "com.amazonaws.quicksight#ThemeSummaryList", "traits": { "smithy.api#documentation": "Information about the themes in the list.
" } }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -10693,10 +10763,10 @@ "smithy.api#httpResponseCode": {} } }, - "NextToken": { + "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The token for the next set of results, or null if there are no more results.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } } } @@ -10752,6 +10822,22 @@ "smithy.api#required": {} } }, + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The AWS account ID that the user is in. Currently, you use the ID for the AWS account\n\t\t\tthat contains your Amazon QuickSight account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
The maximum number of results to return from this request.
", "smithy.api#httpQuery": "max-results" } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
The AWS account ID that the user is in. Currently, you use the ID for the AWS account\n\t\t\tthat contains your Amazon QuickSight account.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.quicksight#ListUserGroupsResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "GroupList": { + "target": "com.amazonaws.quicksight#GroupList", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The list of groups the user is a member of.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "NextToken": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
" } }, - "NextToken": { + "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "GroupList": { - "target": "com.amazonaws.quicksight#GroupList", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The list of groups the user is a member of.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -10861,21 +10931,6 @@ "com.amazonaws.quicksight#ListUsersRequest": { "type": "structure", "members": { - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
", - "smithy.api#httpQuery": "next-token" - } - }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", - "traits": { - "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
A pagination token that can be used in a subsequent request.
", + "smithy.api#httpQuery": "next-token" + } + }, "MaxResults": { "target": "com.amazonaws.quicksight#MaxResults", "traits": { @@ -10891,23 +10953,30 @@ "smithy.api#documentation": "The maximum number of results to return from this request.
", "smithy.api#httpQuery": "max-results" } + }, + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
A pagination token that can be used in a subsequent request.
" + "smithy.api#documentation": "The list of users.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "NextToken": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
" } }, "RequestId": { @@ -10916,24 +10985,18 @@ "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "UserList": { - "target": "com.amazonaws.quicksight#UserList", - "traits": { - "smithy.api#documentation": "The list of users.
" - } - } - } - }, - "com.amazonaws.quicksight#LogicalTable": { - "type": "structure", - "members": { - "Source": { - "target": "com.amazonaws.quicksight#LogicalTableSource", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "Source of this logical table.
", - "smithy.api#required": {} + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } - }, + } + } + }, + "com.amazonaws.quicksight#LogicalTable": { + "type": "structure", + "members": { "Alias": { "target": "com.amazonaws.quicksight#LogicalTableAlias", "traits": { @@ -10946,6 +11009,13 @@ "traits": { "smithy.api#documentation": "Transform operations that act on this logical table.
" } + }, + "Source": { + "target": "com.amazonaws.quicksight#LogicalTableSource", + "traits": { + "smithy.api#documentation": "Source of this logical table.
", + "smithy.api#required": {} + } } }, "traits": { @@ -11055,13 +11125,6 @@ "com.amazonaws.quicksight#MariaDbParameters": { "type": "structure", "members": { - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "Database.
", - "smithy.api#required": {} - } - }, "Host": { "target": "com.amazonaws.quicksight#Host", "traits": { @@ -11075,6 +11138,13 @@ "smithy.api#documentation": "Port.
", "smithy.api#required": {} } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "Database.
", + "smithy.api#required": {} + } } }, "traits": { @@ -11093,17 +11163,17 @@ "com.amazonaws.quicksight#MySqlParameters": { "type": "structure", "members": { - "Port": { - "target": "com.amazonaws.quicksight#Port", + "Host": { + "target": "com.amazonaws.quicksight#Host", "traits": { - "smithy.api#documentation": "Port.
", + "smithy.api#documentation": "Host.
", "smithy.api#required": {} } }, - "Host": { - "target": "com.amazonaws.quicksight#Host", + "Port": { + "target": "com.amazonaws.quicksight#Port", "traits": { - "smithy.api#documentation": "Host.
", + "smithy.api#documentation": "Port.
", "smithy.api#required": {} } }, @@ -11167,6 +11237,12 @@ "com.amazonaws.quicksight#NamespaceInfoV2": { "type": "structure", "members": { + "Name": { + "target": "com.amazonaws.quicksight#Namespace", + "traits": { + "smithy.api#documentation": "The name of the error.
" + } + }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -11185,10 +11261,10 @@ "smithy.api#documentation": "The creation status of a namespace that is not yet completely created.
" } }, - "Name": { - "target": "com.amazonaws.quicksight#Namespace", + "IdentityStore": { + "target": "com.amazonaws.quicksight#IdentityStore", "traits": { - "smithy.api#documentation": "The name of the error.
" + "smithy.api#documentation": "The identity store used for the namespace.
" } }, "NamespaceError": { @@ -11196,12 +11272,6 @@ "traits": { "smithy.api#documentation": "An error that occurred when the namespace was created.
" } - }, - "IdentityStore": { - "target": "com.amazonaws.quicksight#IdentityStore", - "traits": { - "smithy.api#documentation": "The identity store used for the namespace.
" - } } }, "traits": { @@ -11265,6 +11335,32 @@ } } }, + "com.amazonaws.quicksight#OracleParameters": { + "type": "structure", + "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "An Oracle host.
", + "smithy.api#required": {} + } + }, + "Port": { + "target": "com.amazonaws.quicksight#Port", + "traits": { + "smithy.api#documentation": "Port.
", + "smithy.api#required": {} + } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "Database.
", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.quicksight#OutputColumn": { "type": "structure", "members": { @@ -11306,6 +11402,12 @@ "smithy.api#documentation": "String parameters.
" } }, + "IntegerParameters": { + "target": "com.amazonaws.quicksight#IntegerParameterList", + "traits": { + "smithy.api#documentation": "Integer parameters.
" + } + }, "DecimalParameters": { "target": "com.amazonaws.quicksight#DecimalParameterList", "traits": { @@ -11317,12 +11419,6 @@ "traits": { "smithy.api#documentation": "Date-time parameters.
" } - }, - "IntegerParameters": { - "target": "com.amazonaws.quicksight#IntegerParameterList", - "traits": { - "smithy.api#documentation": "Integer parameters.
" - } } }, "traits": { @@ -11409,13 +11505,6 @@ "com.amazonaws.quicksight#PostgreSqlParameters": { "type": "structure", "members": { - "Database": { - "target": "com.amazonaws.quicksight#Database", - "traits": { - "smithy.api#documentation": "Database.
", - "smithy.api#required": {} - } - }, "Host": { "target": "com.amazonaws.quicksight#Host", "traits": { @@ -11429,6 +11518,13 @@ "smithy.api#documentation": "Port.
", "smithy.api#required": {} } + }, + "Database": { + "target": "com.amazonaws.quicksight#Database", + "traits": { + "smithy.api#documentation": "Database.
", + "smithy.api#required": {} + } } }, "traits": { @@ -11438,14 +11534,14 @@ "com.amazonaws.quicksight#PreconditionNotMetException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this request.
" } - }, - "Message": { - "target": "com.amazonaws.quicksight#String" } }, "traits": { @@ -11457,6 +11553,13 @@ "com.amazonaws.quicksight#PrestoParameters": { "type": "structure", "members": { + "Host": { + "target": "com.amazonaws.quicksight#Host", + "traits": { + "smithy.api#documentation": "Host.
", + "smithy.api#required": {} + } + }, "Port": { "target": "com.amazonaws.quicksight#Port", "traits": { @@ -11470,13 +11573,6 @@ "smithy.api#documentation": "Catalog.
", "smithy.api#required": {} } - }, - "Host": { - "target": "com.amazonaws.quicksight#Host", - "traits": { - "smithy.api#documentation": "Host.
", - "smithy.api#required": {} - } } }, "traits": { @@ -11492,6 +11588,18 @@ } } }, + "com.amazonaws.quicksight#PrincipalList": { + "type": "list", + "member": { + "target": "com.amazonaws.quicksight#String" + }, + "traits": { + "smithy.api#length": { + "min": 1, + "max": 100 + } + } + }, "com.amazonaws.quicksight#ProjectOperation": { "type": "structure", "members": { @@ -11531,17 +11639,17 @@ "com.amazonaws.quicksight#QueueInfo": { "type": "structure", "members": { - "QueuedIngestion": { + "WaitingOnIngestion": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing\n ingestion to complete.
", + "smithy.api#documentation": "The ID of the queued ingestion.
", "smithy.api#required": {} } }, - "WaitingOnIngestion": { + "QueuedIngestion": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The ID of the queued ingestion.
", + "smithy.api#documentation": "The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing\n ingestion to complete.
", "smithy.api#required": {} } } @@ -11889,17 +11997,17 @@ "com.amazonaws.quicksight#RdsParameters": { "type": "structure", "members": { - "Database": { - "target": "com.amazonaws.quicksight#Database", + "InstanceId": { + "target": "com.amazonaws.quicksight#InstanceId", "traits": { - "smithy.api#documentation": "Database.
", + "smithy.api#documentation": "Instance ID.
", "smithy.api#required": {} } }, - "InstanceId": { - "target": "com.amazonaws.quicksight#InstanceId", + "Database": { + "target": "com.amazonaws.quicksight#Database", "traits": { - "smithy.api#documentation": "Instance ID.
", + "smithy.api#documentation": "Database.
", "smithy.api#required": {} } } @@ -11921,18 +12029,18 @@ "com.amazonaws.quicksight#RedshiftParameters": { "type": "structure", "members": { - "ClusterId": { - "target": "com.amazonaws.quicksight#ClusterId", - "traits": { - "smithy.api#documentation": "Cluster ID. This field can be blank if the Host
and Port
are\n provided.
Host. This field can be blank if ClusterId
is provided.
Port. This field can be blank if the ClusterId
is provided.
Port. This field can be blank if the ClusterId
is provided.
Cluster ID. This field can be blank if the Host
and Port
are\n provided.
You need to use this parameter only when you register one or more users using an assumed\n\t\t\tIAM role. You don't need to provide the session name for other scenarios, for example when\n\t\t\tyou are registering an IAM user or an Amazon QuickSight user. You can register multiple\n\t\t\tusers using the same IAM role if each user has a different session name. For more\n\t\t\tinformation on assuming IAM roles, see \n assume-role
\n in the AWS CLI Reference.\n
(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:
\nCreate and update data sources
\nCreate and update datasets
\nCreate and update email reports
\nSubscribe to email reports
\nTo add custom permissions to an existing user, use \n UpdateUser\n
instead.
A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the QuickSight\n console. Then, you use the RegisterUser
API operation to assign the named set of\n permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning QuickSight users to one of the\n default security cohorts in QuickSight (admin, author, reader).
\nThis feature is available only to QuickSight Enterprise edition subscriptions that use\n SAML 2.0-Based Federation for Single Sign-On (SSO).
" + "smithy.api#documentation": "Amazon QuickSight supports several ways of managing the identity of users. This\n\t\t\tparameter accepts two values:
\n\t\t\n IAM
: A user whose identity maps to an existing IAM user or role.\n\t\t\t\t
\n QUICKSIGHT
: A user whose identity is owned and managed internally by\n\t\t\t\t\tAmazon QuickSight.
The Amazon QuickSight user name that you want to create for the user you are\n\t\t\tregistering.
" + "smithy.api#documentation": "The email address of the user that you want to register.
", + "smithy.api#required": {} } }, "UserRole": { @@ -12025,17 +12129,24 @@ "smithy.api#required": {} } }, - "Email": { + "IamArn": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The email address of the user that you want to register.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ARN of the IAM user or role that you are registering with Amazon QuickSight.
" } }, - "IamArn": { - "target": "com.amazonaws.quicksight#String", + "SessionName": { + "target": "com.amazonaws.quicksight#RoleSessionName", "traits": { - "smithy.api#documentation": "The ARN of the IAM user or role that you are registering with Amazon QuickSight.
" + "smithy.api#documentation": "You need to use this parameter only when you register one or more users using an assumed\n\t\t\tIAM role. You don't need to provide the session name for other scenarios, for example when\n\t\t\tyou are registering an IAM user or an Amazon QuickSight user. You can register multiple\n\t\t\tusers using the same IAM role if each user has a different session name. For more\n\t\t\tinformation on assuming IAM roles, see \n assume-role
\n in the AWS CLI Reference.\n
The ID for the AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "Namespace": { @@ -12046,19 +12157,16 @@ "smithy.api#required": {} } }, - "IdentityType": { - "target": "com.amazonaws.quicksight#IdentityType", + "UserName": { + "target": "com.amazonaws.quicksight#UserName", "traits": { - "smithy.api#documentation": "Amazon QuickSight supports several ways of managing the identity of users. This\n\t\t\tparameter accepts two values:
\n\t\t\n IAM
: A user whose identity maps to an existing IAM user or role.\n\t\t\t\t
\n QUICKSIGHT
: A user whose identity is owned and managed internally by\n\t\t\t\t\tAmazon QuickSight.
The Amazon QuickSight user name that you want to create for the user you are\n\t\t\tregistering.
" } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", "traits": { - "smithy.api#documentation": "The ID for the AWS account that the user is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:
\nCreate and update data sources
\nCreate and update datasets
\nCreate and update email reports
\nSubscribe to email reports
\nTo add custom permissions to an existing user, use \n UpdateUser\n
instead.
A set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the QuickSight\n console. Then, you use the RegisterUser
API operation to assign the named set of\n permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning QuickSight users to one of the\n default security cohorts in QuickSight (admin, author, reader).
\nThis feature is available only to QuickSight Enterprise edition subscriptions that use\n SAML 2.0-Based Federation for Single Sign-On (SSO).
" } } } @@ -12066,11 +12174,10 @@ "com.amazonaws.quicksight#RegisterUserResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "User": { + "target": "com.amazonaws.quicksight#User", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The user's user name.
" } }, "UserInvitationUrl": { @@ -12079,17 +12186,18 @@ "smithy.api#documentation": "The URL the user visits to complete registration and provide a password. This is\n\t\t\treturned only for users with an identity type of QUICKSIGHT
.
The user's user name.
" - } - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } } } }, @@ -12103,6 +12211,12 @@ "smithy.api#required": {} } }, + "Schema": { + "target": "com.amazonaws.quicksight#RelationalTableSchema", + "traits": { + "smithy.api#documentation": "The schema name. This name applies to certain relational database engines.
" + } + }, "Name": { "target": "com.amazonaws.quicksight#RelationalTableName", "traits": { @@ -12116,12 +12230,6 @@ "smithy.api#documentation": "The column schema of the table.
", "smithy.api#required": {} } - }, - "Schema": { - "target": "com.amazonaws.quicksight#RelationalTableSchema", - "traits": { - "smithy.api#documentation": "The schema name. This name applies to certain relational database engines.
" - } } }, "traits": { @@ -12171,15 +12279,15 @@ "com.amazonaws.quicksight#ResourceExistsException": { "type": "structure", "members": { + "Message": { + "target": "com.amazonaws.quicksight#String" + }, "ResourceType": { "target": "com.amazonaws.quicksight#ExceptionResourceType", "traits": { "smithy.api#documentation": "The resource type for this request.
" } }, - "Message": { - "target": "com.amazonaws.quicksight#String" - }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -12243,7 +12351,7 @@ "Actions": { "target": "com.amazonaws.quicksight#ActionList", "traits": { - "smithy.api#documentation": "The IAM action to grant or revoke permissions on, for example\n \"quicksight:DescribeDashboard\"
.
The IAM action to grant or revoke permissions on.
", "smithy.api#required": {} } } @@ -12302,11 +12410,8 @@ "com.amazonaws.quicksight#ResourceUnavailableException": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this request.
" - } + "Message": { + "target": "com.amazonaws.quicksight#String" }, "ResourceType": { "target": "com.amazonaws.quicksight#ExceptionResourceType", @@ -12314,8 +12419,11 @@ "smithy.api#documentation": "The resource type for this request.
" } }, - "Message": { - "target": "com.amazonaws.quicksight#String" + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this request.
" + } } }, "traits": { @@ -12385,10 +12493,11 @@ "com.amazonaws.quicksight#RestoreAnalysisResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } }, "Arn": { @@ -12403,11 +12512,10 @@ "smithy.api#documentation": "The ID of the analysis that you're restoring.\n
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The AWS request ID for this operation.
" } } } @@ -12473,17 +12581,17 @@ "smithy.api#documentation": "The namespace associated with the row-level permissions dataset.
" } }, - "PermissionPolicy": { - "target": "com.amazonaws.quicksight#RowLevelPermissionPolicy", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "Permission policy.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the permission dataset.
", "smithy.api#required": {} } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "PermissionPolicy": { + "target": "com.amazonaws.quicksight#RowLevelPermissionPolicy", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the permission dataset.
", + "smithy.api#documentation": "Permission policy.
", "smithy.api#required": {} } } @@ -12543,12 +12651,6 @@ "com.amazonaws.quicksight#S3Source": { "type": "structure", "members": { - "UploadSettings": { - "target": "com.amazonaws.quicksight#UploadSettings", - "traits": { - "smithy.api#documentation": "Information about the format for the S3 source file or files.
" - } - }, "DataSourceArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -12556,6 +12658,12 @@ "smithy.api#required": {} } }, + "UploadSettings": { + "target": "com.amazonaws.quicksight#UploadSettings", + "traits": { + "smithy.api#documentation": "Information about the format for the S3 source file or files.
" + } + }, "InputColumns": { "target": "com.amazonaws.quicksight#InputColumnList", "traits": { @@ -12628,47 +12736,47 @@ "smithy.api#required": {} } }, + "NextToken": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
" + } + }, "MaxResults": { "target": "com.amazonaws.quicksight#MaxResults", "traits": { "smithy.api#box": {}, "smithy.api#documentation": "The maximum number of results to return.
" } - }, - "NextToken": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "A pagination token that can be used in a subsequent request.
" - } } } }, "com.amazonaws.quicksight#SearchAnalysesResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} - } - }, "AnalysisSummaryList": { "target": "com.amazonaws.quicksight#AnalysisSummaryList", "traits": { "smithy.api#documentation": "Metadata describing the analyses that you searched for.
" } }, - "RequestId": { + "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "A pagination token that can be used in a subsequent request.\n
" } }, - "NextToken": { + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "A pagination token that can be used in a subsequent request.\n
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } } } @@ -12718,13 +12826,6 @@ "com.amazonaws.quicksight#SearchDashboardsRequest": { "type": "structure", "members": { - "MaxResults": { - "target": "com.amazonaws.quicksight#MaxResults", - "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "The maximum number of results to be returned per request.
" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -12733,17 +12834,24 @@ "smithy.api#required": {} } }, + "Filters": { + "target": "com.amazonaws.quicksight#DashboardSearchFilterList", + "traits": { + "smithy.api#documentation": "The filters to apply to the search. Currently, you can search only by user name, for\n example, \"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\",\n \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]
\n
The token for the next set of results, or null if there are no more results.
" } }, - "Filters": { - "target": "com.amazonaws.quicksight#DashboardSearchFilterList", + "MaxResults": { + "target": "com.amazonaws.quicksight#MaxResults", "traits": { - "smithy.api#documentation": "The filters to apply to the search. Currently, you can search only by user name, for\n example, \"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\",\n \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]
\n
The maximum number of results to be returned per request.
" } } } @@ -12757,12 +12865,6 @@ "smithy.api#documentation": "The list of dashboards owned by the user specified in Filters
in your\n request.
The AWS request ID for this operation.
" - } - }, "NextToken": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -12775,6 +12877,12 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } } } }, @@ -12900,17 +13008,17 @@ "com.amazonaws.quicksight#SnowflakeParameters": { "type": "structure", "members": { - "Database": { - "target": "com.amazonaws.quicksight#Database", + "Host": { + "target": "com.amazonaws.quicksight#Host", "traits": { - "smithy.api#documentation": "Database.
", + "smithy.api#documentation": "Host.
", "smithy.api#required": {} } }, - "Host": { - "target": "com.amazonaws.quicksight#Host", + "Database": { + "target": "com.amazonaws.quicksight#Database", "traits": { - "smithy.api#documentation": "Host.
", + "smithy.api#documentation": "Database.
", "smithy.api#required": {} } }, @@ -12929,17 +13037,17 @@ "com.amazonaws.quicksight#SparkParameters": { "type": "structure", "members": { - "Port": { - "target": "com.amazonaws.quicksight#Port", + "Host": { + "target": "com.amazonaws.quicksight#Host", "traits": { - "smithy.api#documentation": "Port.
", + "smithy.api#documentation": "Host.
", "smithy.api#required": {} } }, - "Host": { - "target": "com.amazonaws.quicksight#Host", + "Port": { + "target": "com.amazonaws.quicksight#Port", "traits": { - "smithy.api#documentation": "Host.
", + "smithy.api#documentation": "Port.
", "smithy.api#required": {} } } @@ -12967,17 +13075,17 @@ "smithy.api#required": {} } }, - "Database": { - "target": "com.amazonaws.quicksight#Database", + "Port": { + "target": "com.amazonaws.quicksight#Port", "traits": { - "smithy.api#documentation": "Database.
", + "smithy.api#documentation": "Port.
", "smithy.api#required": {} } }, - "Port": { - "target": "com.amazonaws.quicksight#Port", + "Database": { + "target": "com.amazonaws.quicksight#Database", "traits": { - "smithy.api#documentation": "Port.
", + "smithy.api#documentation": "Database.
", "smithy.api#required": {} } } @@ -13015,17 +13123,17 @@ "com.amazonaws.quicksight#StringParameter": { "type": "structure", "members": { - "Values": { - "target": "com.amazonaws.quicksight#StringList", + "Name": { + "target": "com.amazonaws.quicksight#NonEmptyString", "traits": { - "smithy.api#documentation": "The values of a string parameter.
", + "smithy.api#documentation": "A display name for a string parameter.
", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.quicksight#NonEmptyString", + "Values": { + "target": "com.amazonaws.quicksight#StringList", "traits": { - "smithy.api#documentation": "A display name for a string parameter.
", + "smithy.api#documentation": "The values of a string parameter.
", "smithy.api#required": {} } } @@ -13163,13 +13271,6 @@ "com.amazonaws.quicksight#TagResourceRequest": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.quicksight#TagList", - "traits": { - "smithy.api#documentation": "Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
", - "smithy.api#required": {} - } - }, "ResourceArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -13177,24 +13278,31 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.quicksight#TagList", + "traits": { + "smithy.api#documentation": "Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
", + "smithy.api#required": {} + } } } }, "com.amazonaws.quicksight#TagResourceResponse": { "type": "structure", "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } } } }, @@ -13210,16 +13318,10 @@ "com.amazonaws.quicksight#Template": { "type": "structure", "members": { - "Version": { - "target": "com.amazonaws.quicksight#TemplateVersion", - "traits": { - "smithy.api#documentation": "A structure describing the versions of the template.
" - } - }, - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The ID for the template. This is unique per AWS Region for each AWS account.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
" } }, "Name": { @@ -13228,10 +13330,16 @@ "smithy.api#documentation": "The display name of the template.
" } }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "Version": { + "target": "com.amazonaws.quicksight#TemplateVersion", "traits": { - "smithy.api#documentation": "Time when this was created.
" + "smithy.api#documentation": "A structure describing the versions of the template.
" + } + }, + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The ID for the template. This is unique per AWS Region for each AWS account.
" } }, "LastUpdatedTime": { @@ -13240,10 +13348,10 @@ "smithy.api#documentation": "Time when this was last updated.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
" + "smithy.api#documentation": "Time when this was created.
" } } }, @@ -13254,10 +13362,10 @@ "com.amazonaws.quicksight#TemplateAlias": { "type": "structure", "members": { - "TemplateVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", "traits": { - "smithy.api#documentation": "The version number of the template alias.
" + "smithy.api#documentation": "The display name of the template alias.
" } }, "Arn": { @@ -13266,10 +13374,10 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template alias.
" } }, - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", + "TemplateVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "The display name of the template alias.
" + "smithy.api#documentation": "The version number of the template alias.
" } } }, @@ -13413,10 +13521,10 @@ "com.amazonaws.quicksight#TemplateSummary": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.quicksight#TemplateName", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "A display name for the template.
" + "smithy.api#documentation": "A summary of a template.
" } }, "TemplateId": { @@ -13425,16 +13533,16 @@ "smithy.api#documentation": "The ID of the template. This ID is unique per AWS Region for each AWS account.
" } }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "Name": { + "target": "com.amazonaws.quicksight#TemplateName", "traits": { - "smithy.api#documentation": "The last time that this template was updated.
" + "smithy.api#documentation": "A display name for the template.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "LatestVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "A summary of a template.
" + "smithy.api#documentation": "A structure containing a list of version numbers for the template summary.
" } }, "CreatedTime": { @@ -13443,10 +13551,10 @@ "smithy.api#documentation": "The last time that this template was created.
" } }, - "LatestVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "A structure containing a list of version numbers for the template summary.
" + "smithy.api#documentation": "The last time that this template was updated.
" } } }, @@ -13469,40 +13577,28 @@ "com.amazonaws.quicksight#TemplateVersion": { "type": "structure", "members": { - "ThemeArn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "The ARN of the theme associated with this version of the template.
" - } - }, "CreatedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { "smithy.api#documentation": "The time that this template version was created.
" } }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", - "traits": { - "smithy.api#documentation": "The description of the template.
" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "Errors": { + "target": "com.amazonaws.quicksight#TemplateErrorList", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
" + "smithy.api#documentation": "Errors associated with this template version.
" } }, - "Sheets": { - "target": "com.amazonaws.quicksight#SheetList", + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "A list of the associated sheets with the unique identifier and name of each sheet.
" + "smithy.api#documentation": "The version number of the template version.
" } }, - "Errors": { - "target": "com.amazonaws.quicksight#TemplateErrorList", + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { - "smithy.api#documentation": "Errors associated with this template version.
" + "smithy.api#documentation": "The HTTP status of the request.
" } }, "DataSetConfigurations": { @@ -13511,10 +13607,10 @@ "smithy.api#documentation": "Schema of the dataset identified by the placeholder. Any dashboard created from this\n template should be bound to new datasets matching the same schema described through this\n API operation.
" } }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", "traits": { - "smithy.api#documentation": "The version number of the template version.
" + "smithy.api#documentation": "The description of the template.
" } }, "SourceEntityArn": { @@ -13522,6 +13618,18 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of an analysis or template that was used to create this\n template.
" } + }, + "ThemeArn": { + "target": "com.amazonaws.quicksight#Arn", + "traits": { + "smithy.api#documentation": "The ARN of the theme associated with this version of the template.
" + } + }, + "Sheets": { + "target": "com.amazonaws.quicksight#SheetList", + "traits": { + "smithy.api#documentation": "A list of the associated sheets with the unique identifier and name of each sheet.
" + } } }, "traits": { @@ -13531,10 +13639,10 @@ "com.amazonaws.quicksight#TemplateVersionSummary": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The status of the template version.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template version.
" } }, "VersionNumber": { @@ -13543,22 +13651,22 @@ "smithy.api#documentation": "The version number of the template version.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template version.
" + "smithy.api#documentation": "The time that this template version was created.
" } }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { - "smithy.api#documentation": "The description of the template version.
" + "smithy.api#documentation": "The status of the template version.
" } }, - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", "traits": { - "smithy.api#documentation": "The time that this template version was created.
" + "smithy.api#documentation": "The description of the template version.
" } } }, @@ -13581,10 +13689,10 @@ "com.amazonaws.quicksight#TeradataParameters": { "type": "structure", "members": { - "Database": { - "target": "com.amazonaws.quicksight#Database", + "Host": { + "target": "com.amazonaws.quicksight#Host", "traits": { - "smithy.api#documentation": "Database.
", + "smithy.api#documentation": "Host.
", "smithy.api#required": {} } }, @@ -13595,10 +13703,10 @@ "smithy.api#required": {} } }, - "Host": { - "target": "com.amazonaws.quicksight#Host", + "Database": { + "target": "com.amazonaws.quicksight#Database", "traits": { - "smithy.api#documentation": "Host.
", + "smithy.api#documentation": "Database.
", "smithy.api#required": {} } } @@ -13625,14 +13733,17 @@ "com.amazonaws.quicksight#Theme": { "type": "structure", "members": { - "Type": { - "target": "com.amazonaws.quicksight#ThemeType", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The type of theme, based on how it was created. Valid values include:\n QUICKSIGHT
and CUSTOM
.
The Amazon Resource Name (ARN) of the theme.
" } }, - "Version": { - "target": "com.amazonaws.quicksight#ThemeVersion" + "Name": { + "target": "com.amazonaws.quicksight#ThemeName", + "traits": { + "smithy.api#documentation": "The name that the user gives to the theme.
" + } }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", @@ -13640,6 +13751,9 @@ "smithy.api#documentation": "The identifier that the user gives to the theme.
" } }, + "Version": { + "target": "com.amazonaws.quicksight#ThemeVersion" + }, "CreatedTime": { "target": "com.amazonaws.quicksight#Timestamp", "traits": { @@ -13652,16 +13766,10 @@ "smithy.api#documentation": "The date and time that the theme was last updated.
" } }, - "Name": { - "target": "com.amazonaws.quicksight#ThemeName", - "traits": { - "smithy.api#documentation": "The name that the user gives to the theme.
" - } - }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "Type": { + "target": "com.amazonaws.quicksight#ThemeType", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the theme.
" + "smithy.api#documentation": "The type of theme, based on how it was created. Valid values include:\n QUICKSIGHT
and CUSTOM
.
The display name of the theme alias.
" - } - }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the theme alias.
" } }, + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", + "traits": { + "smithy.api#documentation": "The display name of the theme alias.
" + } + }, "ThemeVersionNumber": { "target": "com.amazonaws.quicksight#VersionNumber", "traits": { @@ -13710,18 +13818,18 @@ "com.amazonaws.quicksight#ThemeConfiguration": { "type": "structure", "members": { - "UIColorPalette": { - "target": "com.amazonaws.quicksight#UIColorPalette", - "traits": { - "smithy.api#documentation": "Color properties that apply to the UI and to charts, excluding the colors that apply\n to data.
" - } - }, "DataColorPalette": { "target": "com.amazonaws.quicksight#DataColorPalette", "traits": { "smithy.api#documentation": "Color properties that apply to chart data colors.
" } }, + "UIColorPalette": { + "target": "com.amazonaws.quicksight#UIColorPalette", + "traits": { + "smithy.api#documentation": "Color properties that apply to the UI and to charts, excluding the colors that apply\n to data.
" + } + }, "Sheet": { "target": "com.amazonaws.quicksight#SheetStyle", "traits": { @@ -13787,16 +13895,16 @@ "com.amazonaws.quicksight#ThemeSummary": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.quicksight#ThemeName", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "the display name for the theme.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" } }, - "LastUpdatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "Name": { + "target": "com.amazonaws.quicksight#ThemeName", "traits": { - "smithy.api#documentation": "The last date and time that this theme was updated.
" + "smithy.api#documentation": "the display name for the theme.
" } }, "ThemeId": { @@ -13817,10 +13925,10 @@ "smithy.api#documentation": "The date and time that this theme was created.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "LastUpdatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" + "smithy.api#documentation": "The last date and time that this theme was updated.
" } } }, @@ -13862,34 +13970,28 @@ "com.amazonaws.quicksight#ThemeVersion": { "type": "structure", "members": { - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "The status of the theme version.
" + "smithy.api#documentation": "The version number of the theme.
" } }, - "Configuration": { - "target": "com.amazonaws.quicksight#ThemeConfiguration", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The theme configuration, which contains all the theme display properties.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" } }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", + "Description": { + "target": "com.amazonaws.quicksight#VersionDescription", "traits": { - "smithy.api#documentation": "The version number of the theme.
" + "smithy.api#documentation": "The description of the theme.
" } }, - "Errors": { - "target": "com.amazonaws.quicksight#ThemeErrorList", + "BaseThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "Errors associated with the theme.
" + "smithy.api#documentation": "The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All\n themes initially inherit from a default QuickSight theme.
" } }, "CreatedTime": { @@ -13898,16 +14000,22 @@ "smithy.api#documentation": "The date and time that this theme version was created.
" } }, - "BaseThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "Configuration": { + "target": "com.amazonaws.quicksight#ThemeConfiguration", "traits": { - "smithy.api#documentation": "The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All\n themes initially inherit from a default QuickSight theme.
" + "smithy.api#documentation": "The theme configuration, which contains all the theme display properties.
" } }, - "Description": { - "target": "com.amazonaws.quicksight#VersionDescription", + "Errors": { + "target": "com.amazonaws.quicksight#ThemeErrorList", "traits": { - "smithy.api#documentation": "The description of the theme.
" + "smithy.api#documentation": "Errors associated with the theme.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "The status of the theme version.
" } } }, @@ -13918,10 +14026,10 @@ "com.amazonaws.quicksight#ThemeVersionSummary": { "type": "structure", "members": { - "CreatedTime": { - "target": "com.amazonaws.quicksight#Timestamp", + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "The date and time that this theme version was created.
" + "smithy.api#documentation": "The version number of the theme version.
" } }, "Arn": { @@ -13936,16 +14044,16 @@ "smithy.api#documentation": "The description of the theme version.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "CreatedTime": { + "target": "com.amazonaws.quicksight#Timestamp", "traits": { - "smithy.api#documentation": "The status of the theme version.
" + "smithy.api#documentation": "The date and time that this theme version was created.
" } }, - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", + "Status": { + "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { - "smithy.api#documentation": "The version number of the theme version.
" + "smithy.api#documentation": "The status of the theme version.
" } } }, @@ -14030,16 +14138,16 @@ "com.amazonaws.quicksight#TransformOperation": { "type": "structure", "members": { - "RenameColumnOperation": { - "target": "com.amazonaws.quicksight#RenameColumnOperation", + "ProjectOperation": { + "target": "com.amazonaws.quicksight#ProjectOperation", "traits": { - "smithy.api#documentation": "An operation that renames a column.
" + "smithy.api#documentation": "An operation that projects columns. Operations that come after a projection can only\n refer to projected columns.
" } }, - "TagColumnOperation": { - "target": "com.amazonaws.quicksight#TagColumnOperation", + "FilterOperation": { + "target": "com.amazonaws.quicksight#FilterOperation", "traits": { - "smithy.api#documentation": "An operation that tags a column with additional information.
" + "smithy.api#documentation": "An operation that filters rows based on some condition.
" } }, "CreateColumnsOperation": { @@ -14048,16 +14156,10 @@ "smithy.api#documentation": "An operation that creates calculated columns. Columns created in one such operation\n form a lexical closure.
" } }, - "ProjectOperation": { - "target": "com.amazonaws.quicksight#ProjectOperation", - "traits": { - "smithy.api#documentation": "An operation that projects columns. Operations that come after a projection can only\n refer to projected columns.
" - } - }, - "FilterOperation": { - "target": "com.amazonaws.quicksight#FilterOperation", + "RenameColumnOperation": { + "target": "com.amazonaws.quicksight#RenameColumnOperation", "traits": { - "smithy.api#documentation": "An operation that filters rows based on some condition.
" + "smithy.api#documentation": "An operation that renames a column.
" } }, "CastColumnTypeOperation": { @@ -14065,6 +14167,12 @@ "traits": { "smithy.api#documentation": "A transform operation that casts a column to a different type.
" } + }, + "TagColumnOperation": { + "target": "com.amazonaws.quicksight#TagColumnOperation", + "traits": { + "smithy.api#documentation": "An operation that tags a column with additional information.
" + } } }, "traits": { @@ -14117,88 +14225,88 @@ "com.amazonaws.quicksight#UIColorPalette": { "type": "structure", "members": { - "Danger": { + "PrimaryForeground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "The color that applies to error messages.
" + "smithy.api#documentation": "The color of text and other foreground elements that appear over the primary\n background regions, such as grid lines, borders, table banding, icons, and so on.
" } }, - "Success": { + "PrimaryBackground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "The color that applies to success messages, for example the check mark for a\n successful download.
" + "smithy.api#documentation": "The background color that applies to visuals and other high emphasis UI.
" } }, - "WarningForeground": { + "SecondaryForeground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "The foreground color that applies to any text or other elements that appear over the\n warning color.
" + "smithy.api#documentation": "The foreground color that applies to any sheet title, sheet control text, or UI that\n appears over the secondary background.
" } }, - "Dimension": { + "SecondaryBackground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "The color that applies to the names of fields that are identified as\n dimensions.
" + "smithy.api#documentation": "The background color that applies to the sheet background and sheet controls.
" } }, - "DangerForeground": { + "Accent": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "The foreground color that applies to any text or other elements that appear over the\n error color.
" + "smithy.api#documentation": "This color is that applies to selected states and buttons.
" } }, - "Accent": { + "AccentForeground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "This color is that applies to selected states and buttons.
" + "smithy.api#documentation": "The foreground color that applies to any text or other elements that appear over the\n accent color.
" } }, - "Warning": { + "Danger": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "This color that applies to warning and informational messages.
" + "smithy.api#documentation": "The color that applies to error messages.
" } }, - "MeasureForeground": { + "DangerForeground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "The foreground color that applies to any text or other elements that appear over the\n measure color.
" + "smithy.api#documentation": "The foreground color that applies to any text or other elements that appear over the\n error color.
" } }, - "SuccessForeground": { + "Warning": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "The foreground color that applies to any text or other elements that appear over the\n success color.
" + "smithy.api#documentation": "This color that applies to warning and informational messages.
" } }, - "AccentForeground": { + "WarningForeground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "The foreground color that applies to any text or other elements that appear over the\n accent color.
" + "smithy.api#documentation": "The foreground color that applies to any text or other elements that appear over the\n warning color.
" } }, - "DimensionForeground": { + "Success": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "The foreground color that applies to any text or other elements that appear over the\n dimension color.
" + "smithy.api#documentation": "The color that applies to success messages, for example the check mark for a\n successful download.
" } }, - "SecondaryForeground": { + "SuccessForeground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "The foreground color that applies to any sheet title, sheet control text, or UI that\n appears over the secondary background.
" + "smithy.api#documentation": "The foreground color that applies to any text or other elements that appear over the\n success color.
" } }, - "PrimaryForeground": { + "Dimension": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "The color of text and other foreground elements that appear over the primary\n background regions, such as grid lines, borders, table banding, icons, and so on.
" + "smithy.api#documentation": "The color that applies to the names of fields that are identified as\n dimensions.
" } }, - "SecondaryBackground": { + "DimensionForeground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "The background color that applies to the sheet background and sheet controls.
" + "smithy.api#documentation": "The foreground color that applies to any text or other elements that appear over the\n dimension color.
" } }, "Measure": { @@ -14207,10 +14315,10 @@ "smithy.api#documentation": "The color that applies to the names of fields that are identified as measures.
" } }, - "PrimaryBackground": { + "MeasureForeground": { "target": "com.amazonaws.quicksight#HexColor", "traits": { - "smithy.api#documentation": "The background color that applies to visuals and other high emphasis UI.
" + "smithy.api#documentation": "The foreground color that applies to any text or other elements that appear over the\n measure color.
" } } }, @@ -14350,6 +14458,14 @@ "com.amazonaws.quicksight#UpdateAccountCustomizationRequest": { "type": "structure", "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID for the AWS account that you want to update QuickSight customizations\n for.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { @@ -14363,24 +14479,16 @@ "smithy.api#documentation": "The QuickSight customizations you're updating in the current AWS Region.
", "smithy.api#required": {} } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "The ID for the AWS account that you want to update QuickSight customizations\n for.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.quicksight#UpdateAccountCustomizationResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the updated customization for this AWS account.
" } }, "AwsAccountId": { @@ -14389,12 +14497,6 @@ "smithy.api#documentation": "The ID for the AWS account that you want to update QuickSight customizations\n for.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the updated customization for this AWS account.
" - } - }, "Namespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { @@ -14407,6 +14509,12 @@ "smithy.api#documentation": "The QuickSight customizations you're updating in the current AWS Region.
" } }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -14456,6 +14564,14 @@ "com.amazonaws.quicksight#UpdateAccountSettingsRequest": { "type": "structure", "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID for the AWS account that contains the QuickSight settings that you want to\n list.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "DefaultNamespace": { "target": "com.amazonaws.quicksight#Namespace", "traits": { @@ -14468,32 +14584,24 @@ "traits": { "smithy.api#documentation": "The email address that you want QuickSight to send notifications to regarding your AWS\n account or QuickSight subscription.
" } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "The ID for the AWS account that contains the QuickSight settings that you want to\n list.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.quicksight#UpdateAccountSettingsResponse": { "type": "structure", "members": { + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } } } }, @@ -14577,18 +14685,18 @@ "com.amazonaws.quicksight#UpdateAnalysisPermissionsRequest": { "type": "structure", "members": { - "AnalysisId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID of the analysis whose permissions you're updating. The ID is part of the\n analysis URL.
", + "smithy.api#documentation": "The ID of the AWS account that contains the analysis whose permissions you're\n updating. You must be using the AWS account that the analysis is in.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "AnalysisId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the analysis whose permissions you're\n updating. You must be using the AWS account that the analysis is in.
", + "smithy.api#documentation": "The ID of the analysis whose permissions you're updating. The ID is part of the\n analysis URL.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -14610,10 +14718,10 @@ "com.amazonaws.quicksight#UpdateAnalysisPermissionsResponse": { "type": "structure", "members": { - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "AnalysisArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "A structure that describes the principals and the resource-level permissions on an\n analysis.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the analysis that you updated.
" } }, "AnalysisId": { @@ -14622,11 +14730,10 @@ "smithy.api#documentation": "The ID of the analysis that you updated permissions for.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "A structure that describes the principals and the resource-level permissions on an\n analysis.
" } }, "RequestId": { @@ -14635,10 +14742,11 @@ "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "AnalysisArn": { - "target": "com.amazonaws.quicksight#Arn", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the analysis that you updated.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -14646,17 +14754,11 @@ "com.amazonaws.quicksight#UpdateAnalysisRequest": { "type": "structure", "members": { - "SourceEntity": { - "target": "com.amazonaws.quicksight#AnalysisSourceEntity", - "traits": { - "smithy.api#documentation": "A source entity to use for the analysis that you're updating. This metadata structure\n contains details that describe a source template and one or more datasets.
", - "smithy.api#required": {} - } - }, - "Name": { - "target": "com.amazonaws.quicksight#AnalysisName", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "A descriptive name for the analysis that you're updating. This name displays for the\n analysis in the QuickSight console.
", + "smithy.api#documentation": "The ID of the AWS account that contains the analysis that you're updating.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -14668,11 +14770,10 @@ "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "Name": { + "target": "com.amazonaws.quicksight#AnalysisName", "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the analysis that you're updating.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "A descriptive name for the analysis that you're updating. This name displays for the\n analysis in the QuickSight console.
", "smithy.api#required": {} } }, @@ -14682,6 +14783,13 @@ "smithy.api#documentation": "The parameter names and override values that you want to use. An analysis can have \n any parameter type, and some parameters might accept multiple values.
" } }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#AnalysisSourceEntity", + "traits": { + "smithy.api#documentation": "A source entity to use for the analysis that you're updating. This metadata structure\n contains details that describe a source template and one or more datasets.
", + "smithy.api#required": {} + } + }, "ThemeArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { @@ -14693,36 +14801,36 @@ "com.amazonaws.quicksight#UpdateAnalysisResponse": { "type": "structure", "members": { - "UpdateStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "The update status of the last update that was made to the analysis.
" - } - }, "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "The ARN of the analysis that you're updating.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } - }, "AnalysisId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "The ID of the analysis.
" } }, + "UpdateStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", + "traits": { + "smithy.api#documentation": "The update status of the last update that was made to the analysis.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } } } }, @@ -14806,6 +14914,14 @@ "com.amazonaws.quicksight#UpdateDashboardPermissionsRequest": { "type": "structure", "members": { + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", + "traits": { + "smithy.api#documentation": "The ID of the AWS account that contains the dashboard whose permissions you're\n updating.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "DashboardId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { @@ -14825,31 +14941,16 @@ "traits": { "smithy.api#documentation": "The permissions that you want to revoke from this resource.
" } - }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", - "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the dashboard whose permissions you're\n updating.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, "com.amazonaws.quicksight#UpdateDashboardPermissionsResponse": { "type": "structure", "members": { - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "Information about the permissions on the dashboard.
" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "DashboardArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dashboard.
" } }, "DashboardId": { @@ -14858,16 +14959,23 @@ "smithy.api#documentation": "The ID for the dashboard.
" } }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "Information about the permissions on the dashboard.
" + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "DashboardArn": { - "target": "com.amazonaws.quicksight#Arn", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dashboard.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -14912,10 +15020,10 @@ "com.amazonaws.quicksight#UpdateDashboardPublishedVersionRequest": { "type": "structure", "members": { - "VersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The version number of the dashboard.
", + "smithy.api#documentation": "The ID of the AWS account that contains the dashboard that you're\n updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -14928,10 +15036,10 @@ "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "VersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the dashboard that you're\n updating.
", + "smithy.api#documentation": "The version number of the dashboard.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -14947,10 +15055,10 @@ "smithy.api#documentation": "The ID for the dashboard.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "DashboardArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dashboard.
" } }, "Status": { @@ -14960,10 +15068,10 @@ "smithy.api#httpResponseCode": {} } }, - "DashboardArn": { - "target": "com.amazonaws.quicksight#Arn", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dashboard.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } } } @@ -14979,10 +15087,11 @@ "smithy.api#required": {} } }, - "SourceEntity": { - "target": "com.amazonaws.quicksight#DashboardSourceEntity", + "DashboardId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The entity that you are using as a source when you update the dashboard. In\n SourceEntity
, you specify the type of object you're using as source. You\n can only update a dashboard from a template, so you use a SourceTemplate
\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the CreateTemplate API operation. For\n SourceTemplate
, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate
ARN can contain any AWS Account and any\n QuickSight-supported AWS Region.
Use the DataSetReferences
entity within SourceTemplate
to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.
The ID for the dashboard.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -14993,6 +15102,19 @@ "smithy.api#required": {} } }, + "SourceEntity": { + "target": "com.amazonaws.quicksight#DashboardSourceEntity", + "traits": { + "smithy.api#documentation": "The entity that you are using as a source when you update the dashboard. In\n SourceEntity
, you specify the type of object you're using as source. You\n can only update a dashboard from a template, so you use a SourceTemplate
\n entity. If you need to update a dashboard from an analysis, first convert the analysis\n to a template by using the CreateTemplate API operation. For\n SourceTemplate
, specify the Amazon Resource Name (ARN) of the source\n template. The SourceTemplate
ARN can contain any AWS Account and any\n QuickSight-supported AWS Region.
Use the DataSetReferences
entity within SourceTemplate
to\n list the replacement datasets for the placeholders listed in the original. The schema in\n each dataset must match its placeholder.
A structure that contains the parameters of the dashboard. These are parameter\n overrides for a dashboard. A dashboard can have any type of parameters, and some\n parameters might accept multiple values.
" + } + }, "VersionDescription": { "target": "com.amazonaws.quicksight#VersionDescription", "traits": { @@ -15010,36 +15132,22 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If\n you add a value for this field, it overrides the value that was originally associated\n with the entity. The theme ARN must exist in the same AWS account where you create the\n dashboard.
" } - }, - "DashboardId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "The ID for the dashboard.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Parameters": { - "target": "com.amazonaws.quicksight#Parameters", - "traits": { - "smithy.api#documentation": "A structure that contains the parameters of the dashboard. These are parameter\n overrides for a dashboard. A dashboard can have any type of parameters, and some\n parameters might accept multiple values.
" - } } } }, "com.amazonaws.quicksight#UpdateDashboardResponse": { "type": "structure", "members": { - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" } }, - "Arn": { + "VersionArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource.
" + "smithy.api#documentation": "The ARN of the dashboard, including the version number.
" } }, "DashboardId": { @@ -15048,22 +15156,22 @@ "smithy.api#documentation": "The ID for the dashboard.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
" + "smithy.api#documentation": "The creation status of the request.
" } }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The ARN of the dashboard, including the version number.
" + "smithy.api#documentation": "The HTTP status of the request.
" } }, - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The creation status of the request.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } } } @@ -15151,18 +15259,6 @@ "com.amazonaws.quicksight#UpdateDataSetPermissionsRequest": { "type": "structure", "members": { - "RevokePermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "The resource permissions that you want to revoke from the dataset.
" - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "The resource permissions that you want to grant to the dataset.
" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -15178,6 +15274,18 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "The resource permissions that you want to grant to the dataset.
" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "The resource permissions that you want to revoke from the dataset.
" + } } } }, @@ -15190,6 +15298,12 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" } }, + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID for the dataset whose permissions you want to update. This ID is unique per AWS\n\t\t\tRegion for each AWS account.
" + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -15202,31 +15316,20 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "The ID for the dataset whose permissions you want to update. This ID is unique per AWS\n\t\t\tRegion for each AWS account.
" - } } } }, "com.amazonaws.quicksight#UpdateDataSetRequest": { "type": "structure", "members": { - "PhysicalTableMap": { - "target": "com.amazonaws.quicksight#PhysicalTableMap", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "Declares the physical tables that are available in the underlying data sources.
", + "smithy.api#documentation": "The AWS account ID.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ColumnGroups": { - "target": "com.amazonaws.quicksight#ColumnGroupList", - "traits": { - "smithy.api#documentation": "Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
" - } - }, "DataSetId": { "target": "com.amazonaws.quicksight#ResourceId", "traits": { @@ -15235,12 +15338,6 @@ "smithy.api#required": {} } }, - "LogicalTableMap": { - "target": "com.amazonaws.quicksight#LogicalTableMap", - "traits": { - "smithy.api#documentation": "Configures the combination and transformation of the data from the physical tables.
" - } - }, "Name": { "target": "com.amazonaws.quicksight#ResourceName", "traits": { @@ -15248,14 +15345,19 @@ "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "PhysicalTableMap": { + "target": "com.amazonaws.quicksight#PhysicalTableMap", "traits": { - "smithy.api#documentation": "The AWS account ID.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "Declares the physical tables that are available in the underlying data sources.
", "smithy.api#required": {} } }, + "LogicalTableMap": { + "target": "com.amazonaws.quicksight#LogicalTableMap", + "traits": { + "smithy.api#documentation": "Configures the combination and transformation of the data from the physical tables.
" + } + }, "ImportMode": { "target": "com.amazonaws.quicksight#DataSetImportMode", "traits": { @@ -15263,40 +15365,45 @@ "smithy.api#required": {} } }, + "ColumnGroups": { + "target": "com.amazonaws.quicksight#ColumnGroupList", + "traits": { + "smithy.api#documentation": "Groupings of columns that work together in certain QuickSight features. Currently, only geospatial hierarchy is supported.
" + } + }, "RowLevelPermissionDataSet": { "target": "com.amazonaws.quicksight#RowLevelPermissionDataSet", "traits": { "smithy.api#documentation": "The row-level security configuration for the data you want to create.
" } + }, + "ColumnLevelPermissionRules": { + "target": "com.amazonaws.quicksight#ColumnLevelPermissionRuleList", + "traits": { + "smithy.api#documentation": "A set of one or more definitions of a \n ColumnLevelPermissionRule\n
.
The ARN for the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.
" - } - }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "DataSetId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
" } }, - "Arn": { + "IngestionArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the dataset.
" + "smithy.api#documentation": "The ARN for the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.
" } }, "IngestionId": { @@ -15305,10 +15412,17 @@ "smithy.api#documentation": "The ID of the ingestion, which is triggered as a result of dataset creation if the import\n\t\t\tmode is SPICE.
" } }, - "DataSetId": { - "target": "com.amazonaws.quicksight#ResourceId", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" + } + }, + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", + "traits": { + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -15390,18 +15504,6 @@ "com.amazonaws.quicksight#UpdateDataSourcePermissionsRequest": { "type": "structure", "members": { - "RevokePermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "A list of resource permissions that you want to revoke on the data source.
" - } - }, - "GrantPermissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "A list of resource permissions that you want to grant on the data source.
" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -15417,24 +15519,36 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "GrantPermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "A list of resource permissions that you want to grant on the data source.
" + } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "A list of resource permissions that you want to revoke on the data source.
" + } } } }, "com.amazonaws.quicksight#UpdateDataSourcePermissionsResponse": { "type": "structure", "members": { - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
" - } - }, "DataSourceArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data source.
" } }, + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", + "traits": { + "smithy.api#documentation": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
" + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -15461,23 +15575,31 @@ "smithy.api#required": {} } }, - "Credentials": { - "target": "com.amazonaws.quicksight#DataSourceCredentials", + "DataSourceId": { + "target": "com.amazonaws.quicksight#ResourceId", "traits": { - "smithy.api#documentation": "The credentials that QuickSight that uses to connect to your underlying source. Currently,\n\t\t\tonly credentials based on user name and password are supported.
" + "smithy.api#documentation": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "SslProperties": { - "target": "com.amazonaws.quicksight#SslProperties", + "Name": { + "target": "com.amazonaws.quicksight#ResourceName", "traits": { - "smithy.api#documentation": "Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying\n\t\t\tsource.
" + "smithy.api#documentation": "A display name for the data source.
", + "smithy.api#required": {} + } + }, + "DataSourceParameters": { + "target": "com.amazonaws.quicksight#DataSourceParameters", + "traits": { + "smithy.api#documentation": "The parameters that QuickSight uses to connect to your underlying source.
" } }, - "Name": { - "target": "com.amazonaws.quicksight#ResourceName", + "Credentials": { + "target": "com.amazonaws.quicksight#DataSourceCredentials", "traits": { - "smithy.api#documentation": "A display name for the data source.
", - "smithy.api#required": {} + "smithy.api#documentation": "The credentials that QuickSight that uses to connect to your underlying source. Currently,\n\t\t\tonly credentials based on user name and password are supported.
" } }, "VpcConnectionProperties": { @@ -15486,18 +15608,10 @@ "smithy.api#documentation": "Use this parameter only when you want QuickSight to use a VPC connection when connecting to\n\t\t\tyour underlying source.
" } }, - "DataSourceId": { - "target": "com.amazonaws.quicksight#ResourceId", - "traits": { - "smithy.api#documentation": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "DataSourceParameters": { - "target": "com.amazonaws.quicksight#DataSourceParameters", + "SslProperties": { + "target": "com.amazonaws.quicksight#SslProperties", "traits": { - "smithy.api#documentation": "The parameters that QuickSight uses to connect to your underlying source.
" + "smithy.api#documentation": "Secure Socket Layer (SSL) properties that apply when QuickSight connects to your underlying\n\t\t\tsource.
" } } } @@ -15505,10 +15619,10 @@ "com.amazonaws.quicksight#UpdateDataSourceResponse": { "type": "structure", "members": { - "UpdateStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The update status of the data source's last update.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data source.
" } }, "DataSourceId": { @@ -15517,16 +15631,16 @@ "smithy.api#documentation": "The ID of the data source. This ID is unique per AWS Region for each AWS account.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "UpdateStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The update status of the data source's last update.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "RequestId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the data source.
" + "smithy.api#documentation": "The AWS request ID for this operation.
" } }, "Status": { @@ -15581,34 +15695,34 @@ "com.amazonaws.quicksight#UpdateGroupRequest": { "type": "structure", "members": { - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "GroupName": { + "target": "com.amazonaws.quicksight#GroupName", "traits": { - "smithy.api#documentation": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.
", + "smithy.api#documentation": "The name of the group that you want to update.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Namespace": { - "target": "com.amazonaws.quicksight#Namespace", + "Description": { + "target": "com.amazonaws.quicksight#GroupDescription", "traits": { - "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
The description for the group that you want to update.
" } }, - "GroupName": { - "target": "com.amazonaws.quicksight#GroupName", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The name of the group that you want to update.
", + "smithy.api#documentation": "The ID for the AWS account that the group is in. Currently, you use the ID for the AWS\n\t\t\taccount that contains your Amazon QuickSight account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.quicksight#GroupDescription", + "Namespace": { + "target": "com.amazonaws.quicksight#Namespace", "traits": { - "smithy.api#documentation": "The description for the group that you want to update.
" + "smithy.api#documentation": "The namespace. Currently, you should set this to default
.
The name of the group.
" + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -15628,12 +15748,6 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "Group": { - "target": "com.amazonaws.quicksight#Group", - "traits": { - "smithy.api#documentation": "The name of the group.
" - } } } }, @@ -15669,7 +15783,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates an existing IAM policy assignment. This operation updates only the optional\n\t\t\tparameter or parameters that are specified in the request.
", + "smithy.api#documentation": "Updates an existing IAM policy assignment. This operation updates only the optional\n\t\t\tparameter or parameters that are specified in the request. \n\t\t This overwrites all of the users included in Identities
. \n\t\t
The ID of the AWS account that contains the IAM policy assignment.
", + "smithy.api#documentation": "The ID of the AWS account that contains the IAM policy assignment.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "traits": { + "smithy.api#documentation": "The name of the assignment, also called a rule. This name must be unique within an AWS account.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -15696,10 +15818,10 @@ "smithy.api#required": {} } }, - "Identities": { - "target": "com.amazonaws.quicksight#IdentityMap", + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", "traits": { - "smithy.api#documentation": "The QuickSight users, groups, or both that you want to assign the policy to.
" + "smithy.api#documentation": "The status of the assignment. Possible values are as follows:
\n\t\t\n ENABLED
- Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.
\n DISABLED
- This assignment isn't used when creating the data source.
\n DRAFT
- This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.
The ARN for the IAM policy to apply to the QuickSight users and groups\n\t\t\tspecified in this assignment.
" } }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", - "traits": { - "smithy.api#documentation": "The name of the assignment. This name must be unique within an AWS account.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", + "Identities": { + "target": "com.amazonaws.quicksight#IdentityMap", "traits": { - "smithy.api#documentation": "The status of the assignment. Possible values are as follows:
\n\t\t\n ENABLED
- Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.
\n DISABLED
- This assignment isn't used when creating the data source.
\n DRAFT
- This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.
The QuickSight users, groups, or both that you want to assign the policy to.
" } } } @@ -15727,35 +15841,34 @@ "com.amazonaws.quicksight#UpdateIAMPolicyAssignmentResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "AssignmentName": { + "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "The name of the assignment or rule.
" } }, - "PolicyArn": { - "target": "com.amazonaws.quicksight#Arn", + "AssignmentId": { + "target": "com.amazonaws.quicksight#String", "traits": { - "smithy.api#documentation": "The ARN for the IAM policy applied to the QuickSight users and groups specified in this\n\t\t\tassignment.
" + "smithy.api#documentation": "The ID of the assignment.
" } }, - "AssignmentStatus": { - "target": "com.amazonaws.quicksight#AssignmentStatus", + "PolicyArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The status of the assignment. Possible values are as follows:
\n\t\t\n ENABLED
- Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.
\n DISABLED
- This assignment isn't used when creating the data source.
\n DRAFT
- This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.
The ARN for the IAM policy applied to the QuickSight users and groups specified in this\n\t\t\tassignment.
" } }, - "AssignmentName": { - "target": "com.amazonaws.quicksight#IAMPolicyAssignmentName", + "Identities": { + "target": "com.amazonaws.quicksight#IdentityMap", "traits": { - "smithy.api#documentation": "The name of the assignment.
" + "smithy.api#documentation": "The QuickSight users, groups, or both that the IAM policy is assigned to.
" } }, - "AssignmentId": { - "target": "com.amazonaws.quicksight#String", + "AssignmentStatus": { + "target": "com.amazonaws.quicksight#AssignmentStatus", "traits": { - "smithy.api#documentation": "The ID of the assignment.
" + "smithy.api#documentation": "The status of the assignment. Possible values are as follows:
\n\t\t\n ENABLED
- Anything specified in this assignment is used when creating the data\n\t\t\t\tsource.
\n DISABLED
- This assignment isn't used when creating the data source.
\n DRAFT
- This assignment is an unfinished draft and isn't used when creating the\n\t\t\t\tdata source.
The AWS request ID for this operation.
" } }, - "Identities": { - "target": "com.amazonaws.quicksight#IdentityMap", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The QuickSight users, groups, or both that the IAM policy is assigned to.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -15864,14 +15978,6 @@ "com.amazonaws.quicksight#UpdateTemplateAliasRequest": { "type": "structure", "members": { - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "The ID for the template.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -15880,10 +15986,11 @@ "smithy.api#required": {} } }, - "TemplateVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The version number of the template.
", + "smithy.api#documentation": "The ID for the template.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -15894,6 +16001,13 @@ "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "TemplateVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", + "traits": { + "smithy.api#documentation": "The version number of the template.
", + "smithy.api#required": {} + } } } }, @@ -15906,18 +16020,18 @@ "smithy.api#documentation": "The template alias.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } - }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } } } }, @@ -15961,12 +16075,6 @@ "com.amazonaws.quicksight#UpdateTemplatePermissionsRequest": { "type": "structure", "members": { - "RevokePermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "A list of resource permissions to be revoked from the template.
" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -15988,23 +16096,34 @@ "traits": { "smithy.api#documentation": "A list of resource permissions to be granted on the template.
" } + }, + "RevokePermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", + "traits": { + "smithy.api#documentation": "A list of resource permissions to be revoked from the template.
" + } } } }, "com.amazonaws.quicksight#UpdateTemplatePermissionsResponse": { "type": "structure", "members": { + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The ID for the template.
" + } + }, "TemplateArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the template.
" } }, - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} + "smithy.api#documentation": "A list of resource permissions to be set on the template.
" } }, "RequestId": { @@ -16013,16 +16132,11 @@ "smithy.api#documentation": "The AWS request ID for this operation.
" } }, - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", - "traits": { - "smithy.api#documentation": "The ID for the template.
" - } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "A list of resource permissions to be set on the template.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} } } } @@ -16030,25 +16144,26 @@ "com.amazonaws.quicksight#UpdateTemplateRequest": { "type": "structure", "members": { - "TemplateId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The ID for the template.
", + "smithy.api#documentation": "The ID of the AWS account that contains the template that you're updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.quicksight#TemplateName", + "TemplateId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The name for the template.
" + "smithy.api#documentation": "The ID for the template.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "SourceEntity": { + "target": "com.amazonaws.quicksight#TemplateSourceEntity", "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the template that you're updating.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The entity that you are using as a source when you update the template. In\n\t\t\tSourceEntity
, you specify the type of object you're using as source:\n\t\t\tSourceTemplate
for a template or SourceAnalysis
for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate
, specify the ARN of the source template. For\n\t\t\tSourceAnalysis
, specify the ARN of the source analysis. The SourceTemplate
\n\t\t\tARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences
entity within SourceTemplate
or\n\t\t\tSourceAnalysis
to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.
A description of the current template version that is being updated. Every time you call\n\t\t\t\tUpdateTemplate
, you create a new version of the template. Each version\n\t\t\tof the template maintains a description of the version in the\n\t\t\t\tVersionDescription
field.
The entity that you are using as a source when you update the template. In\n\t\t\tSourceEntity
, you specify the type of object you're using as source:\n\t\t\tSourceTemplate
for a template or SourceAnalysis
for an\n\t\t\tanalysis. Both of these require an Amazon Resource Name (ARN). For\n\t\t\tSourceTemplate
, specify the ARN of the source template. For\n\t\t\tSourceAnalysis
, specify the ARN of the source analysis. The SourceTemplate
\n\t\t\tARN can contain any AWS Account and any QuickSight-supported AWS Region.
Use the DataSetReferences
entity within SourceTemplate
or\n\t\t\tSourceAnalysis
to list the replacement datasets for the placeholders listed\n\t\t\tin the original. The schema in each dataset must match its placeholder.
The name for the template.
" } } } @@ -16070,34 +16184,28 @@ "com.amazonaws.quicksight#UpdateTemplateResponse": { "type": "structure", "members": { - "CreationStatus": { - "target": "com.amazonaws.quicksight#ResourceStatus", - "traits": { - "smithy.api#documentation": "The creation status of the template.
" - } - }, "TemplateId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "The ID for the template.
" } }, - "VersionArn": { + "Arn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The ARN for the template, including the version information of the first version.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the template.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "VersionArn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The ARN for the template, including the version information of the first version.
" } }, - "Arn": { - "target": "com.amazonaws.quicksight#Arn", + "CreationStatus": { + "target": "com.amazonaws.quicksight#ResourceStatus", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the template.
" + "smithy.api#documentation": "The creation status of the template.
" } }, "Status": { @@ -16106,6 +16214,12 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } } } }, @@ -16195,10 +16309,10 @@ "com.amazonaws.quicksight#UpdateThemeAliasRequest": { "type": "structure", "members": { - "AliasName": { - "target": "com.amazonaws.quicksight#AliasName", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The name of the theme alias that you want to update.
", + "smithy.api#documentation": "The ID of the AWS account that contains the theme alias that you're updating.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -16211,18 +16325,18 @@ "smithy.api#required": {} } }, - "ThemeVersionNumber": { - "target": "com.amazonaws.quicksight#VersionNumber", + "AliasName": { + "target": "com.amazonaws.quicksight#AliasName", "traits": { - "smithy.api#documentation": "The version number of the theme that the alias should reference.
", + "smithy.api#documentation": "The name of the theme alias that you want to update.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "ThemeVersionNumber": { + "target": "com.amazonaws.quicksight#VersionNumber", "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the theme alias that you're updating.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The version number of the theme that the alias should reference.
", "smithy.api#required": {} } } @@ -16231,6 +16345,12 @@ "com.amazonaws.quicksight#UpdateThemeAliasResponse": { "type": "structure", "members": { + "ThemeAlias": { + "target": "com.amazonaws.quicksight#ThemeAlias", + "traits": { + "smithy.api#documentation": "Information about the theme alias.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { @@ -16243,12 +16363,6 @@ "traits": { "smithy.api#documentation": "The AWS request ID for this operation.
" } - }, - "ThemeAlias": { - "target": "com.amazonaws.quicksight#ThemeAlias", - "traits": { - "smithy.api#documentation": "Information about the theme alias.
" - } } } }, @@ -16292,12 +16406,6 @@ "com.amazonaws.quicksight#UpdateThemePermissionsRequest": { "type": "structure", "members": { - "RevokePermissions": { - "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", - "traits": { - "smithy.api#documentation": "A list of resource permissions to be revoked from the theme.
" - } - }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -16306,18 +16414,24 @@ "smithy.api#required": {} } }, + "ThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "traits": { + "smithy.api#documentation": "The ID for the theme.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "GrantPermissions": { "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", "traits": { "smithy.api#documentation": "A list of resource permissions to be granted for the theme.
" } }, - "ThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "RevokePermissions": { + "target": "com.amazonaws.quicksight#UpdateResourcePermissionList", "traits": { - "smithy.api#documentation": "The ID for the theme.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "A list of resource permissions to be revoked from the theme.
" } } } @@ -16331,46 +16445,41 @@ "smithy.api#documentation": "The ID for the theme.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", - "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" - } - }, "ThemeArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the theme.
" } }, + "Permissions": { + "target": "com.amazonaws.quicksight#ResourcePermissionList", + "traits": { + "smithy.api#documentation": "The resulting list of resource permissions for the theme.
" + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" + } + }, "Status": { "target": "com.amazonaws.quicksight#StatusCode", "traits": { "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "Permissions": { - "target": "com.amazonaws.quicksight#ResourcePermissionList", - "traits": { - "smithy.api#documentation": "The resulting list of resource permissions for the theme.
" - } } } }, "com.amazonaws.quicksight#UpdateThemeRequest": { "type": "structure", "members": { - "Configuration": { - "target": "com.amazonaws.quicksight#ThemeConfiguration", - "traits": { - "smithy.api#documentation": "The theme configuration, which contains the theme display properties.
" - } - }, - "BaseThemeId": { - "target": "com.amazonaws.quicksight#RestrictiveResourceId", + "AwsAccountId": { + "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { - "smithy.api#documentation": "The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.\n\t\tAll themes initially inherit from a default QuickSight theme.
", + "smithy.api#documentation": "The ID of the AWS account that contains the theme that you're updating.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -16382,24 +16491,29 @@ "smithy.api#required": {} } }, - "VersionDescription": { - "target": "com.amazonaws.quicksight#VersionDescription", + "Name": { + "target": "com.amazonaws.quicksight#ThemeName", "traits": { - "smithy.api#documentation": "A description of the theme version that you're updating Every time that you call\n\t\t\t\tUpdateTheme
, you create a new version of the theme. Each version of the\n\t\t\ttheme maintains a description of the version in VersionDescription
.
The name for the theme.
" } }, - "AwsAccountId": { - "target": "com.amazonaws.quicksight#AwsAccountId", + "BaseThemeId": { + "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { - "smithy.api#documentation": "The ID of the AWS account that contains the theme that you're updating.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The theme ID, defined by Amazon QuickSight, that a custom theme inherits from.\n\t\tAll themes initially inherit from a default QuickSight theme.
", "smithy.api#required": {} } }, - "Name": { - "target": "com.amazonaws.quicksight#ThemeName", + "VersionDescription": { + "target": "com.amazonaws.quicksight#VersionDescription", "traits": { - "smithy.api#documentation": "The name for the theme.
" + "smithy.api#documentation": "A description of the theme version that you're updating Every time that you call\n\t\t\t\tUpdateTheme
, you create a new version of the theme. Each version of the\n\t\t\ttheme maintains a description of the version in VersionDescription
.
The theme configuration, which contains the theme display properties.
" } } } @@ -16407,29 +16521,22 @@ "com.amazonaws.quicksight#UpdateThemeResponse": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.quicksight#StatusCode", - "traits": { - "smithy.api#documentation": "The HTTP status of the request.
", - "smithy.api#httpResponseCode": {} - } - }, "ThemeId": { "target": "com.amazonaws.quicksight#RestrictiveResourceId", "traits": { "smithy.api#documentation": "The ID for the theme.
" } }, - "RequestId": { - "target": "com.amazonaws.quicksight#String", + "Arn": { + "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The AWS request ID for this operation.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the theme.
" } }, - "Arn": { + "VersionArn": { "target": "com.amazonaws.quicksight#Arn", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the theme.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the new version of the theme.
" } }, "CreationStatus": { @@ -16438,10 +16545,17 @@ "smithy.api#documentation": "The creation status of the theme.
" } }, - "VersionArn": { - "target": "com.amazonaws.quicksight#Arn", + "Status": { + "target": "com.amazonaws.quicksight#StatusCode", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the new version of the theme.
" + "smithy.api#documentation": "The HTTP status of the request.
", + "smithy.api#httpResponseCode": {} + } + }, + "RequestId": { + "target": "com.amazonaws.quicksight#String", + "traits": { + "smithy.api#documentation": "The AWS request ID for this operation.
" } } } @@ -16489,6 +16603,14 @@ "com.amazonaws.quicksight#UpdateUserRequest": { "type": "structure", "members": { + "UserName": { + "target": "com.amazonaws.quicksight#UserName", + "traits": { + "smithy.api#documentation": "The Amazon QuickSight user name that you want to update.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "AwsAccountId": { "target": "com.amazonaws.quicksight#AwsAccountId", "traits": { @@ -16519,12 +16641,10 @@ "smithy.api#required": {} } }, - "UserName": { - "target": "com.amazonaws.quicksight#UserName", + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", "traits": { - "smithy.api#documentation": "The Amazon QuickSight user name that you want to update.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:
\nCreate and update data sources
\nCreate and update datasets
\nCreate and update email reports
\nSubscribe to email reports
\nA set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the QuickSight\n console. Then, you use the RegisterUser
API operation to assign the named set of\n permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning QuickSight users to one of the\n default security cohorts in QuickSight (admin, author, reader).
\nThis feature is available only to QuickSight Enterprise edition subscriptions that use\n SAML 2.0-Based Federation for Single Sign-On (SSO).
" } }, "UnapplyCustomPermissions": { @@ -16532,18 +16652,18 @@ "traits": { "smithy.api#documentation": "A flag that you use to indicate that you want to remove all custom permissions\n from this user. Using this parameter resets the user to the state\n it was in before a custom permissions profile was applied. This parameter defaults to\n NULL and it doesn't accept any other value.
" } - }, - "CustomPermissionsName": { - "target": "com.amazonaws.quicksight#RoleName", - "traits": { - "smithy.api#documentation": "(Enterprise edition only) The name of the custom permissions profile that you want to\n assign to this user. Customized permissions allows you to control a user's access by\n restricting access the following operations:
\nCreate and update data sources
\nCreate and update datasets
\nCreate and update email reports
\nSubscribe to email reports
\nA set of custom permissions includes any combination of these restrictions. Currently,\n you need to create the profile names for custom permission sets by using the QuickSight\n console. Then, you use the RegisterUser
API operation to assign the named set of\n permissions to a QuickSight user.
QuickSight custom permissions are applied through IAM policies. Therefore, they\n override the permissions typically granted by assigning QuickSight users to one of the\n default security cohorts in QuickSight (admin, author, reader).
\nThis feature is available only to QuickSight Enterprise edition subscriptions that use\n SAML 2.0-Based Federation for Single Sign-On (SSO).
" - } } } }, "com.amazonaws.quicksight#UpdateUserResponse": { "type": "structure", "members": { + "User": { + "target": "com.amazonaws.quicksight#User", + "traits": { + "smithy.api#documentation": "The Amazon QuickSight user.
" + } + }, "RequestId": { "target": "com.amazonaws.quicksight#String", "traits": { @@ -16556,18 +16676,18 @@ "smithy.api#documentation": "The HTTP status of the request.
", "smithy.api#httpResponseCode": {} } - }, - "User": { - "target": "com.amazonaws.quicksight#User", - "traits": { - "smithy.api#documentation": "The Amazon QuickSight user.
" - } } } }, "com.amazonaws.quicksight#UploadSettings": { "type": "structure", "members": { + "Format": { + "target": "com.amazonaws.quicksight#FileFormat", + "traits": { + "smithy.api#documentation": "File format.
" + } + }, "StartFromRow": { "target": "com.amazonaws.quicksight#PositiveInteger", "traits": { @@ -16575,16 +16695,11 @@ "smithy.api#documentation": "A row number to start reading data from.
" } }, - "Format": { - "target": "com.amazonaws.quicksight#FileFormat", - "traits": { - "smithy.api#documentation": "File format.
" - } - }, - "Delimiter": { - "target": "com.amazonaws.quicksight#Delimiter", + "ContainsHeader": { + "target": "com.amazonaws.quicksight#Boolean", "traits": { - "smithy.api#documentation": "The delimiter between values in the file.
" + "smithy.api#box": {}, + "smithy.api#documentation": "Whether the file has a header row, or the files each have a header row.
" } }, "TextQualifier": { @@ -16593,11 +16708,10 @@ "smithy.api#documentation": "Text qualifier.
" } }, - "ContainsHeader": { - "target": "com.amazonaws.quicksight#Boolean", + "Delimiter": { + "target": "com.amazonaws.quicksight#Delimiter", "traits": { - "smithy.api#box": {}, - "smithy.api#documentation": "Whether the file has a header row, or the files each have a header row.
" + "smithy.api#documentation": "The delimiter between values in the file.
" } } }, @@ -16614,18 +16728,6 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) for the user.
" } }, - "IdentityType": { - "target": "com.amazonaws.quicksight#IdentityType", - "traits": { - "smithy.api#documentation": "The type of identity authentication used by the user.
" - } - }, - "Role": { - "target": "com.amazonaws.quicksight#UserRole", - "traits": { - "smithy.api#documentation": "The Amazon QuickSight role for the user. The user role can be one of the\n following:.
\n\n READER
: A user who has read-only access to dashboards.
\n AUTHOR
: A user who can create data sources, datasets, analyses,\n and dashboards.
\n ADMIN
: A user who is an author, who can also manage Amazon\n QuickSight settings.
\n RESTRICTED_READER
: This role isn't currently available for\n use.
\n RESTRICTED_AUTHOR
: This role isn't currently available for\n use.
The user's email address.
" } }, - "Active": { - "target": "com.amazonaws.quicksight#Boolean", + "Role": { + "target": "com.amazonaws.quicksight#UserRole", "traits": { - "smithy.api#documentation": "The active status of user. When you create an Amazon QuickSight user that’s not an IAM\n user or an Active Directory user, that user is inactive until they sign in and provide a\n password.
" + "smithy.api#documentation": "The Amazon QuickSight role for the user. The user role can be one of the\n following:.
\n\n READER
: A user who has read-only access to dashboards.
\n AUTHOR
: A user who can create data sources, datasets, analyses,\n and dashboards.
\n ADMIN
: A user who is an author, who can also manage Amazon\n QuickSight settings.
\n RESTRICTED_READER
: This role isn't currently available for\n use.
\n RESTRICTED_AUTHOR
: This role isn't currently available for\n use.
The custom permissions profile associated with this user.
" + "smithy.api#documentation": "The type of identity authentication used by the user.
" + } + }, + "Active": { + "target": "com.amazonaws.quicksight#Boolean", + "traits": { + "smithy.api#documentation": "The active status of user. When you create an Amazon QuickSight user that’s not an IAM\n user or an Active Directory user, that user is inactive until they sign in and provide a\n password.
" } }, "PrincipalId": { @@ -16655,6 +16763,12 @@ "traits": { "smithy.api#documentation": "The principal ID of the user.
" } + }, + "CustomPermissionsName": { + "target": "com.amazonaws.quicksight#RoleName", + "traits": { + "smithy.api#documentation": "The custom permissions profile associated with this user.
" + } } }, "traits": { diff --git a/codegen/sdk-codegen/aws-models/s3.2006-03-01.json b/codegen/sdk-codegen/aws-models/s3.2006-03-01.json index 7c85157b085f..cf0cfbfa3a2f 100644 --- a/codegen/sdk-codegen/aws-models/s3.2006-03-01.json +++ b/codegen/sdk-codegen/aws-models/s3.2006-03-01.json @@ -38,12 +38,12 @@ "DaysAfterInitiation": { "target": "com.amazonaws.s3#DaysAfterInitiation", "traits": { - "smithy.api#documentation": "Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.
" + "smithy.api#documentation": "Specifies the number of days after which Amazon S3 aborts an incomplete multipart\n upload.
" } } }, "traits": { - "smithy.api#documentation": "Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy \n in the Amazon Simple Storage Service Developer Guide.
" + "smithy.api#documentation": "Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will\n wait before permanently removing all parts of the upload. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy in the\n Amazon Simple Storage Service Developer Guide.
" } }, "com.amazonaws.s3#AbortMultipartUpload": { @@ -60,7 +60,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.
\nTo verify that all parts have been removed, so you don't get charged for the part storage, you\n should call the ListParts operation and ensure that the parts list is\n empty.
\nFor information about permissions required to use the multipart upload API, see Multipart\n Upload API and Permissions.
\nThe following operations are related to AbortMultipartUpload
:
\n UploadPart\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nThis operation aborts a multipart upload. After a multipart upload is aborted, no\n additional parts can be uploaded using that upload ID. The storage consumed by any\n previously uploaded parts will be freed. However, if any part uploads are currently in\n progress, those part uploads might or might not succeed. As a result, it might be necessary\n to abort a given multipart upload multiple times in order to completely free all storage\n consumed by all parts.
\nTo verify that all parts have been removed, so you don't get charged for the part\n storage, you should call the ListParts operation and ensure that\n the parts list is empty.
\nFor information about permissions required to use the multipart upload API, see Multipart Upload API and\n Permissions.
\nThe following operations are related to AbortMultipartUpload
:
\n UploadPart\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nThe bucket name to which the upload was taking place.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "Key of the object for which the multipart upload was initiated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "UploadId": { "target": "com.amazonaws.s3#MultipartUploadId", "traits": { @@ -102,22 +118,6 @@ "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Key of the object for which the multipart upload was initiated.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "The bucket name to which the upload was taking place.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -135,7 +135,7 @@ } }, "traits": { - "smithy.api#documentation": "Configures the transfer acceleration state for an Amazon S3 bucket. \n For more information, see Amazon S3 Transfer Acceleration in the\n Amazon Simple Storage Service Developer Guide.
" + "smithy.api#documentation": "Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see\n Amazon S3\n Transfer Acceleration in the Amazon Simple Storage Service Developer\n Guide.
" } }, "com.amazonaws.s3#AcceptRanges": { @@ -168,7 +168,7 @@ "Owner": { "target": "com.amazonaws.s3#OwnerOverride", "traits": { - "smithy.api#documentation": "Specifies the replica ownership. For default and valid values, see PUT bucket\n replication in the Amazon Simple Storage Service API Reference.
", + "smithy.api#documentation": "Specifies the replica ownership. For default and valid values, see PUT bucket\n replication in the Amazon Simple Storage Service API Reference.
", "smithy.api#required": {} } } @@ -241,6 +241,9 @@ { "target": "com.amazonaws.s3#DeleteBucketEncryption" }, + { + "target": "com.amazonaws.s3#DeleteBucketIntelligentTieringConfiguration" + }, { "target": "com.amazonaws.s3#DeleteBucketInventoryConfiguration" }, @@ -292,6 +295,9 @@ { "target": "com.amazonaws.s3#GetBucketEncryption" }, + { + "target": "com.amazonaws.s3#GetBucketIntelligentTieringConfiguration" + }, { "target": "com.amazonaws.s3#GetBucketInventoryConfiguration" }, @@ -367,6 +373,9 @@ { "target": "com.amazonaws.s3#ListBucketAnalyticsConfigurations" }, + { + "target": "com.amazonaws.s3#ListBucketIntelligentTieringConfigurations" + }, { "target": "com.amazonaws.s3#ListBucketInventoryConfigurations" }, @@ -406,6 +415,9 @@ { "target": "com.amazonaws.s3#PutBucketEncryption" }, + { + "target": "com.amazonaws.s3#PutBucketIntelligentTieringConfiguration" + }, { "target": "com.amazonaws.s3#PutBucketInventoryConfiguration" }, @@ -502,7 +514,7 @@ "Prefix": { "target": "com.amazonaws.s3#Prefix", "traits": { - "smithy.api#documentation": "The prefix to use when evaluating an AND predicate: The prefix that an object must have to be included in the metrics results.
" + "smithy.api#documentation": "The prefix to use when evaluating an AND predicate: The prefix that an object must have\n to be included in the metrics results.
" } }, "Tags": { @@ -515,35 +527,35 @@ } }, "traits": { - "smithy.api#documentation": "A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates in any combination, and an object must match all of the predicates for the filter to apply.
" + "smithy.api#documentation": "A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates in any combination, and an object must match\n all of the predicates for the filter to apply.
" } }, "com.amazonaws.s3#AnalyticsConfiguration": { "type": "structure", "members": { - "StorageClassAnalysis": { - "target": "com.amazonaws.s3#StorageClassAnalysis", + "Id": { + "target": "com.amazonaws.s3#AnalyticsId", "traits": { - "smithy.api#documentation": "\n Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.\n
", + "smithy.api#documentation": "The ID that identifies the analytics configuration.
", "smithy.api#required": {} } }, "Filter": { "target": "com.amazonaws.s3#AnalyticsFilter", "traits": { - "smithy.api#documentation": "The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.
" + "smithy.api#documentation": "The filter used to describe a set of objects for analyses. A filter must have exactly\n one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided,\n all objects will be considered in any analysis.
" } }, - "Id": { - "target": "com.amazonaws.s3#AnalyticsId", + "StorageClassAnalysis": { + "target": "com.amazonaws.s3#StorageClassAnalysis", "traits": { - "smithy.api#documentation": "The ID that identifies the analytics configuration.
", + "smithy.api#documentation": "Contains data related to access patterns to be collected and made available to analyze\n the tradeoffs between different storage classes.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "\n Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.
" + "smithy.api#documentation": "Specifies the configuration and any analyses for the analytics filter of an Amazon S3\n bucket.
" } }, "com.amazonaws.s3#AnalyticsConfigurationList": { @@ -585,12 +597,12 @@ "And": { "target": "com.amazonaws.s3#AnalyticsAndOperator", "traits": { - "smithy.api#documentation": "A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.
" + "smithy.api#documentation": "A conjunction (logical AND) of predicates, which is used in evaluating an analytics\n filter. The operator must have at least two predicates.
" } } }, "traits": { - "smithy.api#documentation": "The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.
" + "smithy.api#documentation": "The filter used to describe a set of objects for analyses. A filter must have exactly\n one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided,\n all objects will be considered in any analysis.
" } }, "com.amazonaws.s3#AnalyticsId": { @@ -599,16 +611,17 @@ "com.amazonaws.s3#AnalyticsS3BucketDestination": { "type": "structure", "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", + "Format": { + "target": "com.amazonaws.s3#AnalyticsS3ExportFileFormat", "traits": { - "smithy.api#documentation": "The prefix to use when exporting data. The prefix is prepended to all results.
" + "smithy.api#documentation": "Specifies the file format used when exporting data to Amazon S3.
", + "smithy.api#required": {} } }, "BucketAccountId": { "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "The account ID that owns the destination S3 bucket. \n If no account ID is provided, the owner is not validated before exporting data.
\n\n Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket \n ownership changes.\n
\nThe account ID that owns the destination S3 bucket. If no account ID is provided, the\n owner is not validated before exporting data.
\nAlthough this value is optional, we strongly recommend that you set it to help\n prevent problems if the destination bucket ownership changes.
\nSpecifies the file format used when exporting data to Amazon S3.
", - "smithy.api#required": {} + "smithy.api#documentation": "The prefix to use when exporting data. The prefix is prepended to all results.
" } } }, @@ -640,27 +652,40 @@ ] } }, + "com.amazonaws.s3#ArchiveStatus": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ARCHIVE_ACCESS" + }, + { + "value": "DEEP_ARCHIVE_ACCESS" + } + ] + } + }, "com.amazonaws.s3#Body": { "type": "blob" }, "com.amazonaws.s3#Bucket": { "type": "structure", "members": { - "CreationDate": { - "target": "com.amazonaws.s3#CreationDate", - "traits": { - "smithy.api#documentation": "Date the bucket was created.
" - } - }, "Name": { "target": "com.amazonaws.s3#BucketName", "traits": { "smithy.api#documentation": "The name of the bucket.
" } + }, + "CreationDate": { + "target": "com.amazonaws.s3#CreationDate", + "traits": { + "smithy.api#documentation": "Date the bucket was created.
" + } } }, "traits": { - "smithy.api#documentation": "In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is\n globally unique, and the namespace is shared by all AWS accounts.
" + "smithy.api#documentation": "In terms of implementation, a Bucket is a resource. An Amazon S3 bucket name is globally\n unique, and the namespace is shared by all AWS accounts.
" } }, "com.amazonaws.s3#BucketAccelerateStatus": { @@ -680,7 +705,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "The requested bucket name is not available. The bucket namespace is shared by all users of the\n system. Select a different name and try again.
", + "smithy.api#documentation": "The requested bucket name is not available. The bucket namespace is shared by all users\n of the system. Select a different name and try again.
", "smithy.api#error": "client" } }, @@ -725,7 +750,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more\n information, see Object\n Lifecycle Management in the Amazon Simple Storage Service Developer Guide.
" + "smithy.api#documentation": "Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more\n information, see Object Lifecycle Management\n in the Amazon Simple Storage Service Developer Guide.
" } }, "com.amazonaws.s3#BucketLocationConstraint": { @@ -880,7 +905,7 @@ "CORSRules": { "target": "com.amazonaws.s3#CORSRules", "traits": { - "smithy.api#documentation": "A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.
", + "smithy.api#documentation": "A set of origins and methods (cross-origin access that you want to allow). You can add\n up to 100 rules to the configuration.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "CORSRule" @@ -888,7 +913,7 @@ } }, "traits": { - "smithy.api#documentation": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling\n Cross-Origin Resource Sharing in the\n Amazon Simple Storage Service Developer Guide.
" + "smithy.api#documentation": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more\n information, see Enabling\n Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer\n Guide.
" } }, "com.amazonaws.s3#CORSRule": { @@ -897,11 +922,20 @@ "AllowedHeaders": { "target": "com.amazonaws.s3#AllowedHeaders", "traits": { - "smithy.api#documentation": "Headers that are specified in the Access-Control-Request-Headers
\n header. These headers are allowed in a preflight OPTIONS request. In response to\n any preflight OPTIONS request, Amazon S3 returns any requested headers that are\n allowed.
Headers that are specified in the Access-Control-Request-Headers
header.\n These headers are allowed in a preflight OPTIONS request. In response to any preflight\n OPTIONS request, Amazon S3 returns any requested headers that are allowed.
An HTTP method that you allow the origin to execute. Valid values are GET
,\n PUT
, HEAD
, POST
, and DELETE
.
The time in seconds that your browser is to cache the preflight response for the specified resource.
" - } - }, "ExposeHeaders": { "target": "com.amazonaws.s3#ExposeHeaders", "traits": { - "smithy.api#documentation": "One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest
object).
One or more headers in the response that you want customers to be able to access from\n their applications (for example, from a JavaScript XMLHttpRequest
\n object).
An HTTP method that you allow the origin to execute. Valid values are\n GET
, PUT
, HEAD
, POST
, and\n DELETE
.
The time in seconds that your browser is to cache the preflight response for the\n specified resource.
" } } }, @@ -948,46 +973,46 @@ "com.amazonaws.s3#CSVInput": { "type": "structure", "members": { - "FieldDelimiter": { - "target": "com.amazonaws.s3#FieldDelimiter", - "traits": { - "smithy.api#documentation": "A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.
" - } - }, - "AllowQuotedRecordDelimiter": { - "target": "com.amazonaws.s3#AllowQuotedRecordDelimiter", - "traits": { - "smithy.api#documentation": "Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.
" - } - }, "FileHeaderInfo": { "target": "com.amazonaws.s3#FileHeaderInfo", "traits": { - "smithy.api#documentation": "Describes the first line of input. Valid values are:
\n\n NONE
: First line is not a header.
\n IGNORE
: First line is a header, but you can't use the header values to\n indicate the column in an expression. You can use column\n position (such as _1, _2, …) to indicate the column\n (SELECT s._1 FROM OBJECT s
).
\n Use
: First line is a header, and you can use the header value to\n identify a column in an expression (SELECT \"name\"\n FROM OBJECT
).
Describes the first line of input. Valid values are:
\n\n NONE
: First line is not a header.
\n IGNORE
: First line is a header, but you can't use the header values\n to indicate the column in an expression. You can use column position (such as _1, _2,\n …) to indicate the column (SELECT s._1 FROM OBJECT s
).
\n Use
: First line is a header, and you can use the header value to\n identify a column in an expression (SELECT \"name\" FROM OBJECT
).
A single character used for escaping when the field delimiter is part of the value.\n For example, if the value is a, b
, Amazon S3 wraps this\n field value in quotation marks, as follows: \" a , b\n \"
.
Type: String
\nDefault: \"
\n
Ancestors: CSV
\n
A single character used to indicate that a row should be ignored when the character is\n present at the start of that row. You can specify any character to indicate a comment\n line.
" } }, "QuoteEscapeCharacter": { "target": "com.amazonaws.s3#QuoteEscapeCharacter", "traits": { - "smithy.api#documentation": "A single character used for escaping the quotation mark character inside an already escaped value. For example, the value \"\"\" a , b \"\"\" is parsed as \" a , b \".
" + "smithy.api#documentation": "A single character used for escaping the quotation mark character inside an already\n escaped value. For example, the value \"\"\" a , b \"\"\" is parsed as \" a , b \".
" } }, "RecordDelimiter": { "target": "com.amazonaws.s3#RecordDelimiter", "traits": { - "smithy.api#documentation": "A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.
" + "smithy.api#documentation": "A single character used to separate individual records in the input. Instead of the\n default value, you can specify an arbitrary delimiter.
" } }, - "Comments": { - "target": "com.amazonaws.s3#Comments", + "FieldDelimiter": { + "target": "com.amazonaws.s3#FieldDelimiter", + "traits": { + "smithy.api#documentation": "A single character used to separate individual fields in a record. You can specify an\n arbitrary delimiter.
" + } + }, + "QuoteCharacter": { + "target": "com.amazonaws.s3#QuoteCharacter", + "traits": { + "smithy.api#documentation": "A single character used for escaping when the field delimiter is part of the value. For\n example, if the value is a, b
, Amazon S3 wraps this field value in quotation marks,\n as follows: \" a , b \"
.
Type: String
\nDefault: \"
\n
Ancestors: CSV
\n
A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line.
" + "smithy.api#documentation": "Specifies that CSV field values may contain quoted record delimiters and such records\n should be allowed. Default value is FALSE. Setting this value to TRUE may lower\n performance.
" } } }, @@ -998,39 +1023,39 @@ "com.amazonaws.s3#CSVOutput": { "type": "structure", "members": { - "FieldDelimiter": { - "target": "com.amazonaws.s3#FieldDelimiter", - "traits": { - "smithy.api#documentation": "The value used to separate individual fields in a record. You can specify an arbitrary delimiter.
" - } - }, "QuoteFields": { "target": "com.amazonaws.s3#QuoteFields", "traits": { "smithy.api#documentation": "Indicates whether to use quotation marks around output fields.
\n\n ALWAYS
: Always use quotation marks for output fields.
\n ASNEEDED
: Use quotation marks for output fields when needed.
A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b
, Amazon S3 wraps this\n field value in quotation marks, as follows: \" a , b\n \"
.
The single character used for escaping the quote character inside an already escaped\n value.
" } }, "RecordDelimiter": { "target": "com.amazonaws.s3#RecordDelimiter", "traits": { - "smithy.api#documentation": "A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.
" + "smithy.api#documentation": "A single character used to separate individual records in the output. Instead of the\n default value, you can specify an arbitrary delimiter.
" } }, - "QuoteEscapeCharacter": { - "target": "com.amazonaws.s3#QuoteEscapeCharacter", + "FieldDelimiter": { + "target": "com.amazonaws.s3#FieldDelimiter", + "traits": { + "smithy.api#documentation": "The value used to separate individual fields in a record. You can specify an arbitrary\n delimiter.
" + } + }, + "QuoteCharacter": { + "target": "com.amazonaws.s3#QuoteCharacter", "traits": { - "smithy.api#documentation": "The single character used for escaping the quote character inside an already escaped\n value.
" + "smithy.api#documentation": "A single character used for escaping when the field delimiter is part of the value. For\n example, if the value is a, b
, Amazon S3 wraps this field value in quotation marks,\n as follows: \" a , b \"
.
Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.
" + "smithy.api#documentation": "Describes how uncompressed comma-separated values (CSV)-formatted results are\n formatted.
" } }, "com.amazonaws.s3#CacheControl": { @@ -1053,7 +1078,7 @@ } }, "traits": { - "smithy.api#documentation": "Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. \n CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.\n For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is \n notes/summer/. \n
" + "smithy.api#documentation": "Container for all (if there are any) keys between Prefix and the next occurrence of the\n string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in\n the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter\n is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.
" } }, "com.amazonaws.s3#CommonPrefixList": { @@ -1071,7 +1096,7 @@ "target": "com.amazonaws.s3#CompleteMultipartUploadOutput" }, "traits": { - "smithy.api#documentation": "Completes a multipart upload by assembling previously uploaded parts.
\nYou first initiate the multipart upload and then upload all parts using the \n UploadPart operation. After successfully uploading all relevant parts of an\n upload, you call this operation to complete the upload. Upon receiving this request, Amazon\n S3 concatenates all the parts in ascending order by part number to create a new object. In\n the Complete Multipart Upload request, you must provide the parts list. You must ensure\n that the parts list is complete. This operation concatenates the parts that you provide in\n the list. For each part in the list, you must provide the part number and the\n ETag
value, returned after that part was uploaded.
Processing of a Complete Multipart Upload request could take several minutes to complete.\n After Amazon S3 begins processing the request, it sends an HTTP response header that\n specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends\n white space characters to keep the connection from timing out. Because a request could fail\n after the initial 200 OK response has been sent, it is important that you check the\n response body to determine whether the request succeeded.
\nNote that if CompleteMultipartUpload
fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.
For more information about multipart uploads, see Uploading\n Objects Using Multipart Upload.
\nFor information about permissions required to use the multipart upload API, see Multipart\n Upload API and Permissions.
\n \n \n\n CompleteMultipartUpload
has the following special errors:
Error code: EntityTooSmall
\n
Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.
\n400 Bad Request
\nError code: InvalidPart
\n
Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.
\n400 Bad Request
\nError code: InvalidPartOrder
\n
Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.
\n400 Bad Request
\nError code: NoSuchUpload
\n
Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
\n404 Not Found
\nThe following operations are related to CompleteMultipartUpload
:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nCompletes a multipart upload by assembling previously uploaded parts.
\nYou first initiate the multipart upload and then upload all parts using the UploadPart\n operation. After successfully uploading all relevant parts of an upload, you call this\n operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all\n the parts in ascending order by part number to create a new object. In the Complete\n Multipart Upload request, you must provide the parts list. You must ensure that the parts\n list is complete. This operation concatenates the parts that you provide in the list. For\n each part in the list, you must provide the part number and the ETag
value,\n returned after that part was uploaded.
Processing of a Complete Multipart Upload request could take several minutes to\n complete. After Amazon S3 begins processing the request, it sends an HTTP response header that\n specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white\n space characters to keep the connection from timing out. Because a request could fail after\n the initial 200 OK response has been sent, it is important that you check the response body\n to determine whether the request succeeded.
\nNote that if CompleteMultipartUpload
fails, applications should be prepared\n to retry the failed requests. For more information, see Amazon S3 Error Best Practices.
For more information about multipart uploads, see Uploading Objects Using Multipart\n Upload.
\nFor information about permissions required to use the multipart upload API, see Multipart Upload API and\n Permissions.
\n\n\n\n CompleteMultipartUpload
has the following special errors:
Error code: EntityTooSmall
\n
Description: Your proposed upload is smaller than the minimum allowed object\n size. Each part must be at least 5 MB in size, except the last part.
\n400 Bad Request
\nError code: InvalidPart
\n
Description: One or more of the specified parts could not be found. The part\n might not have been uploaded, or the specified entity tag might not have\n matched the part's entity tag.
\n400 Bad Request
\nError code: InvalidPartOrder
\n
Description: The list of parts was not in ascending order. The parts list\n must be specified in order by part number.
\n400 Bad Request
\nError code: NoSuchUpload
\n
Description: The specified multipart upload does not exist. The upload ID\n might be invalid, or the multipart upload might have been aborted or\n completed.
\n404 Not Found
\nThe following operations are related to CompleteMultipartUpload
:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nIf the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.
", - "smithy.api#httpHeader": "x-amz-expiration" + "smithy.api#documentation": "The URI that identifies the newly created object.
" } }, "Bucket": { @@ -1095,49 +1119,50 @@ "smithy.api#documentation": "The name of the bucket that contains the newly created object.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
" } }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "If you specified server-side encryption either with an Amazon S3-managed encryption key or an AWS KMS customer master key (CMK) in your initiate multipart upload request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption" + "smithy.api#documentation": "The object key of the newly created object.
" } }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", + "Expiration": { + "target": "com.amazonaws.s3#Expiration", "traits": { - "smithy.api#documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key\n (CMK) that was used for the object.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + "smithy.api#documentation": "If the object expiration is configured, this will contain the expiration date\n (expiry-date) and rule ID (rule-id). The value of rule-id is URL encoded.
", + "smithy.api#httpHeader": "x-amz-expiration" } }, - "Location": { - "target": "com.amazonaws.s3#Location", + "ETag": { + "target": "com.amazonaws.s3#ETag", "traits": { - "smithy.api#documentation": "The URI that identifies the newly created object.
" + "smithy.api#documentation": "Entity tag that identifies the newly created object's data. Objects with different\n object data will have different entity tags. The entity tag is an opaque string. The entity\n tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5\n digest of the object data, it will contain one or more nonhexadecimal characters and/or\n will consist of less than 32 or more than 32 hexadecimal digits.
" } }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "Version ID of the newly created object, in case the bucket has versioning turned on.
", - "smithy.api#httpHeader": "x-amz-version-id" + "smithy.api#documentation": "If you specified server-side encryption either with an Amazon S3-managed encryption key or an\n AWS KMS customer master key (CMK) in your initiate multipart upload request, the response\n includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the\n object.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" + "smithy.api#documentation": "Version ID of the newly created object, in case the bucket has versioning turned\n on.
", + "smithy.api#httpHeader": "x-amz-version-id" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "The object key of the newly created object.
" + "smithy.api#documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, - "ETag": { - "target": "com.amazonaws.s3#ETag", + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", "traits": { - "smithy.api#documentation": "Entity tag that identifies the newly created object's data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits.
" + "smithy.api#httpHeader": "x-amz-request-charged" } } } @@ -1145,17 +1170,12 @@ "com.amazonaws.s3#CompleteMultipartUploadRequest": { "type": "structure", "members": { - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Name of the bucket to which the multipart upload was initiated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "Key": { @@ -1166,12 +1186,12 @@ "smithy.api#required": {} } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "MultipartUpload": { + "target": "com.amazonaws.s3#CompletedMultipartUpload", "traits": { - "smithy.api#documentation": "Name of the bucket to which the multipart upload was initiated.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The container for the multipart upload request information.
", + "smithy.api#httpPayload": {}, + "smithy.api#xmlName": "CompleteMultipartUpload" } }, "UploadId": { @@ -1182,12 +1202,17 @@ "smithy.api#required": {} } }, - "MultipartUpload": { - "target": "com.amazonaws.s3#CompletedMultipartUpload", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "The container for the multipart upload request information.
", - "smithy.api#httpPayload": {}, - "smithy.api#xmlName": "CompleteMultipartUpload" + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Part number that identifies the part. This is a positive integer between 1 and 10,000.
" + "smithy.api#documentation": "Part number that identifies the part. This is a positive integer between 1 and\n 10,000.
" } } }, @@ -1253,21 +1278,21 @@ "com.amazonaws.s3#Condition": { "type": "structure", "members": { - "KeyPrefixEquals": { - "target": "com.amazonaws.s3#KeyPrefixEquals", + "HttpErrorCodeReturnedEquals": { + "target": "com.amazonaws.s3#HttpErrorCodeReturnedEquals", "traits": { - "smithy.api#documentation": "The object key name prefix when the redirect is applied. For example, to redirect requests for\n ExamplePage.html
, the key prefix will be ExamplePage.html
. To\n redirect request for all pages with the prefix docs/
, the key prefix will be\n /docs
, which identifies all objects in the docs/
folder.\n Required when the parent element Condition
is specified and sibling\n HttpErrorCodeReturnedEquals
is not specified. If both conditions are\n specified, both must be true for the redirect to be applied.
The HTTP error code when the redirect is applied. In the event of an error, if the error\n code equals this value, then the specified redirect is applied. Required when parent\n element Condition
is specified and sibling KeyPrefixEquals
is not\n specified. If both are specified, then both must be true for the redirect to be\n applied.
The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition
is specified and sibling KeyPrefixEquals
is not specified. If both are specified, then both must be true for the redirect to be applied.
The object key name prefix when the redirect is applied. For example, to redirect\n requests for ExamplePage.html
, the key prefix will be\n ExamplePage.html
. To redirect request for all pages with the prefix\n docs/
, the key prefix will be /docs
, which identifies all\n objects in the docs/
folder. Required when the parent element\n Condition
is specified and sibling HttpErrorCodeReturnedEquals
\n is not specified. If both conditions are specified, both must be true for the redirect to\n be applied.
A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs
folder, redirect to the /documents
folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.
A container for describing a condition that must be met for the specified redirect to\n apply. For example, 1. If request is for pages in the /docs
folder, redirect\n to the /documents
folder. 2. If request results in HTTP error 4xx, redirect\n request to another host where you might process the error.
Creates a copy of an object that is already stored in Amazon S3.
\nYou can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object\n up to 5 GB in size in a single atomic operation using this API. However, to copy an\n object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For\n more information, see Copy\n Object Using the REST Multipart Upload API.
\nAll copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.
\nA copy request might return an error when Amazon S3 receives the copy request or while\n Amazon S3 is copying the files. If the error occurs before the copy operation starts, you\n receive a standard Amazon S3 error. If the error occurs during the copy operation, the\n\n error response is embedded in the 200 OK
response. This means that a 200\n OK
response can contain either a success or an error. Design your application to\n parse the contents of the response and handle it appropriately.
If the copy is successful, you receive a response with information about the copied\n object.
\nIf the request is an HTTP 1.1 request, the response is chunk encoded. If it were not,\n it would not contain the content-length, and you would need to read the entire\n body.
\nThe copy request charge is based on the storage class and Region that you specify for\n the destination object. For pricing information, see Amazon S3 pricing.
\nAmazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request
error. For more information, see Transfer Acceleration.
\n Metadata\n
\nWhen copying an object, you can preserve all metadata (default) or specify new metadata.\n However, the ACL is not preserved and is set to private for the user making the request. To\n override the default ACL setting, specify a new ACL when generating a copy request. For\n more information, see Using ACLs.
\nTo specify whether you want the object metadata copied from the source object or\n replaced with metadata provided in the request, you can optionally add the\n x-amz-metadata-directive
header. When you grant permissions, you can use\n the s3:x-amz-metadata-directive
condition key to enforce certain metadata\n behavior when objects are uploaded. For more information, see Specifying Conditions in a\n Policy in the Amazon S3 Developer Guide. For a complete list of\n Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for\n Amazon S3.
\n \n x-amz-copy-source-if
Headers\n
To only copy an object under certain conditions, such as whether the Etag
\n matches or whether the object was modified before or after a specified date, use the\n following request parameters:
\n x-amz-copy-source-if-match
\n
\n x-amz-copy-source-if-none-match
\n
\n x-amz-copy-source-if-unmodified-since
\n
\n x-amz-copy-source-if-modified-since
\n
If both the x-amz-copy-source-if-match
and\n x-amz-copy-source-if-unmodified-since
headers are present in the\n\n request and evaluate as follows, Amazon S3 returns 200 OK
and copies the\n data:
\n x-amz-copy-source-if-match
condition evaluates to true
\n x-amz-copy-source-if-unmodified-since
condition evaluates to false
If both the x-amz-copy-source-if-none-match
and\n\n x-amz-copy-source-if-modified-since
headers are present in the\n request and evaluate as follows, Amazon S3 returns the 412 Precondition\n Failed
response code:
\n x-amz-copy-source-if-none-match
condition evaluates to false
\n x-amz-copy-source-if-modified-since
condition evaluates to true
All headers with the x-amz-
prefix, including x-amz-copy-source
,\n must be signed.
\n Encryption\n
\nThe source object that you are copying can be encrypted or unencrypted. The source object\n can be encrypted with server-side encryption using AWS managed encryption keys (SSE-S3 or\n SSE-KMS) or by using a customer-provided encryption key. With server-side encryption, Amazon S3\n encrypts your data as it writes it to disks in its data centers and decrypts the data when\n you access it.
\nYou can optionally use the appropriate encryption-related headers to request server-side\n encryption for the target object. You have the option to provide your own encryption key or\n use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that was used to\n encrypt the source object. You can even request encryption if the source object was not\n encrypted. For more information about server-side encryption, see Using\n Server-Side Encryption.
\n\n Access Control List (ACL)-Specific Request Headers\n
\nWhen copying an object, you can optionally use headers to grant ACL-based permissions. By\n default, all objects are private. Only the owner has full access control. When adding a new\n object, you can grant permissions to individual AWS accounts or to predefined groups\n defined by Amazon S3. These permissions are then added to the ACL on the object. For more\n information, see Access Control List (ACL) Overview and Managing ACLs Using the REST\n API.
\n \n\n Storage Class Options\n
\nYou can use the CopyObject
operation to change the storage class of an\n object that is already stored in Amazon S3 using the StorageClass
parameter.\n For more information, see Storage\n Classes in the Amazon S3 Service Developer Guide.
\n Versioning\n
\nBy default, x-amz-copy-source
identifies the current version of an object\n to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was\n deleted. To copy a different version, use the versionId
subresource.
If you enable versioning on the target bucket, Amazon S3 generates a unique version ID\n for the object being copied. This version ID is different from the version ID of the source\n object. Amazon S3 returns the version ID of the copied object in the\n x-amz-version-id
response header in the response.
If you do not enable versioning or suspend it on the target bucket, the version ID that\n Amazon S3 generates is always null.
\nIf the source object's storage class is GLACIER, you must restore a copy of this object\n before you can use it as a source object for the copy operation. For more information, see\n RestoreObject.
\nThe following operations are related to CopyObject
:
For more information, see Copying Objects.
", + "smithy.api#documentation": "Creates a copy of an object that is already stored in Amazon S3.
\nYou can store individual objects of up to 5 TB in Amazon S3. You create a copy of your\n object up to 5 GB in size in a single atomic operation using this API. However, to copy\n an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API.\n For more information, see Copy Object Using the REST Multipart Upload API.
\nAll copy requests must be authenticated. Additionally, you must have\n read access to the source object and write\n access to the destination bucket. For more information, see REST Authentication. Both the Region\n that you want to copy the object from and the Region that you want to copy the object to\n must be enabled for your account.
\nA copy request might return an error when Amazon S3 receives the copy request or while Amazon S3\n is copying the files. If the error occurs before the copy operation starts, you receive a\n standard Amazon S3 error. If the error occurs during the copy operation, the error response is\n embedded in the 200 OK
response. This means that a 200 OK
\n response can contain either a success or an error. Design your application to parse the\n contents of the response and handle it appropriately.
If the copy is successful, you receive a response with information about the copied\n object.
\nIf the request is an HTTP 1.1 request, the response is chunk encoded. If it were not,\n it would not contain the content-length, and you would need to read the entire\n body.
\nThe copy request charge is based on the storage class and Region that you specify for\n the destination object. For pricing information, see Amazon S3 pricing.
\nAmazon S3 transfer acceleration does not support cross-Region copies. If you request a\n cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad\n Request
error. For more information, see Transfer Acceleration.
\n Metadata\n
\nWhen copying an object, you can preserve all metadata (default) or specify new metadata.\n However, the ACL is not preserved and is set to private for the user making the request. To\n override the default ACL setting, specify a new ACL when generating a copy request. For\n more information, see Using ACLs.
\nTo specify whether you want the object metadata copied from the source object or\n replaced with metadata provided in the request, you can optionally add the\n x-amz-metadata-directive
header. When you grant permissions, you can use\n the s3:x-amz-metadata-directive
condition key to enforce certain metadata\n behavior when objects are uploaded. For more information, see Specifying Conditions in a\n Policy in the Amazon S3 Developer Guide. For a complete list of\n Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for\n Amazon S3.
\n \n x-amz-copy-source-if
Headers\n
To only copy an object under certain conditions, such as whether the Etag
\n matches or whether the object was modified before or after a specified date, use the\n following request parameters:
\n x-amz-copy-source-if-match
\n
\n x-amz-copy-source-if-none-match
\n
\n x-amz-copy-source-if-unmodified-since
\n
\n x-amz-copy-source-if-modified-since
\n
If both the x-amz-copy-source-if-match
and\n x-amz-copy-source-if-unmodified-since
headers are present in the request\n and evaluate as follows, Amazon S3 returns 200 OK
and copies the data:
\n x-amz-copy-source-if-match
condition evaluates to true
\n x-amz-copy-source-if-unmodified-since
condition evaluates to\n false
If both the x-amz-copy-source-if-none-match
and\n x-amz-copy-source-if-modified-since
headers are present in the request and\n evaluate as follows, Amazon S3 returns the 412 Precondition Failed
response\n code:
\n x-amz-copy-source-if-none-match
condition evaluates to false
\n x-amz-copy-source-if-modified-since
condition evaluates to\n true
All headers with the x-amz-
prefix, including\n x-amz-copy-source
, must be signed.
\n Encryption\n
\nThe source object that you are copying can be encrypted or unencrypted. The source\n object can be encrypted with server-side encryption using AWS managed encryption keys\n (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side\n encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and\n decrypts the data when you access it.
\nYou can optionally use the appropriate encryption-related headers to request server-side\n encryption for the target object. You have the option to provide your own encryption key or\n use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that was used to\n encrypt the source object. You can even request encryption if the source object was not\n encrypted. For more information about server-side encryption, see Using\n Server-Side Encryption.
\n\n Access Control List (ACL)-Specific Request\n Headers\n
\nWhen copying an object, you can optionally use headers to grant ACL-based permissions.\n By default, all objects are private. Only the owner has full access control. When adding a\n new object, you can grant permissions to individual AWS accounts or to predefined groups\n defined by Amazon S3. These permissions are then added to the ACL on the object. For more\n information, see Access Control List (ACL) Overview and Managing ACLs Using the REST\n API.
\n\n\n Storage Class Options\n
\nYou can use the CopyObject
operation to change the storage class of an\n object that is already stored in Amazon S3 using the StorageClass
parameter. For\n more information, see Storage\n Classes in the Amazon S3 Service Developer Guide.
\n Versioning\n
\nBy default, x-amz-copy-source
identifies the current version of an object\n to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was\n deleted. To copy a different version, use the versionId
subresource.
If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for\n the object being copied. This version ID is different from the version ID of the source\n object. Amazon S3 returns the version ID of the copied object in the\n x-amz-version-id
response header in the response.
If you do not enable versioning or suspend it on the target bucket, the version ID that\n Amazon S3 generates is always null.
\nIf the source object's storage class is GLACIER, you must restore a copy of this object\n before you can use it as a source object for the copy operation. For more information, see\n RestoreObject.
\nThe following operations are related to CopyObject
:
For more information, see Copying\n Objects.
", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}/{Key+}?x-id=CopyObject", @@ -1326,11 +1351,11 @@ "com.amazonaws.s3#CopyObjectOutput": { "type": "structure", "members": { - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "CopyObjectResult": { + "target": "com.amazonaws.s3#CopyObjectResult", "traits": { - "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + "smithy.api#documentation": "Container for all response elements.
", + "smithy.api#httpPayload": {} } }, "Expiration": { @@ -1340,80 +1365,66 @@ "smithy.api#httpHeader": "x-amz-expiration" } }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { + "CopySourceVersionId": { + "target": "com.amazonaws.s3#CopySourceVersionId", + "traits": { + "smithy.api#documentation": "Version of the copied object in the destination bucket.
", + "smithy.api#httpHeader": "x-amz-copy-source-version-id" + } + }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { "smithy.api#documentation": "Version ID of the newly created copy.
", "smithy.api#httpHeader": "x-amz-version-id" } }, + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", + "smithy.api#httpHeader": "x-amz-server-side-encryption" + } + }, "SSECustomerAlgorithm": { "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
", + "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "CopySourceVersionId": { - "target": "com.amazonaws.s3#CopySourceVersionId", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "Version of the copied object in the destination bucket.
", - "smithy.api#httpHeader": "x-amz-copy-source-version-id" + "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, - "CopyObjectResult": { - "target": "com.amazonaws.s3#CopyObjectResult", + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "Container for all response elements.
", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, "SSEKMSEncryptionContext": { "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { - "smithy.api#documentation": "If present, specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
", + "smithy.api#documentation": "If present, specifies the AWS KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", - "traits": { - "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", - "smithy.api#httpHeader": "x-amz-server-side-encryption" - } - }, "RequestCharged": { "target": "com.amazonaws.s3#RequestCharged", "traits": { "smithy.api#httpHeader": "x-amz-request-charged" } - }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key\n (CMK) that was used for the object.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" - } } } }, "com.amazonaws.s3#CopyObjectRequest": { "type": "structure", "members": { - "Tagging": { - "target": "com.amazonaws.s3#TaggingHeader", - "traits": { - "smithy.api#documentation": "The tag-set for the object destination object this value must be used in conjunction with the\n TaggingDirective
. The tag-set must be encoded as URL Query\n parameters.
Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-context" - } - }, "ACL": { "target": "com.amazonaws.s3#ObjectCannedACL", "traits": { @@ -1421,25 +1432,19 @@ "smithy.api#httpHeader": "x-amz-acl" } }, - "Expires": { - "target": "com.amazonaws.s3#Expires", - "traits": { - "smithy.api#documentation": "The date and time at which the object is no longer cacheable.
", - "smithy.api#httpHeader": "Expires" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "The account id of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The name of the destination bucket.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "CopySourceIfModifiedSince": { - "target": "com.amazonaws.s3#CopySourceIfModifiedSince", + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", "traits": { - "smithy.api#documentation": "Copies the object if it has been modified since the specified time.
", - "smithy.api#httpHeader": "x-amz-copy-source-if-modified-since" + "smithy.api#documentation": "Specifies caching behavior along the request/reply chain.
", + "smithy.api#httpHeader": "Cache-Control" } }, "ContentDisposition": { @@ -1449,25 +1454,11 @@ "smithy.api#httpHeader": "Content-Disposition" } }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", - "traits": { - "smithy.api#documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm
header.
If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
", - "smithy.api#httpHeader": "x-amz-website-redirect-location" - } - }, - "ObjectLockRetainUntilDate": { - "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", "traits": { - "smithy.api#documentation": "The date and time when you want the copied object's Object Lock to expire.
", - "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + "smithy.api#documentation": "Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.
", + "smithy.api#httpHeader": "Content-Encoding" } }, "ContentLanguage": { @@ -1477,69 +1468,68 @@ "smithy.api#httpHeader": "Content-Language" } }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", + "ContentType": { + "target": "com.amazonaws.s3#ContentType", "traits": { - "smithy.api#documentation": "Allows grantee to read the object data and its metadata.
\nThis action is not supported by Amazon S3 on Outposts.
", - "smithy.api#httpHeader": "x-amz-grant-read" + "smithy.api#documentation": "A standard MIME type describing the format of the object data.
", + "smithy.api#httpHeader": "Content-Type" } }, - "ObjectLockLegalHoldStatus": { - "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "CopySource": { + "target": "com.amazonaws.s3#CopySource", "traits": { - "smithy.api#documentation": "Specifies whether you want to apply a Legal Hold to the copied object.
", - "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + "smithy.api#documentation": "Specifies the source object for the copy operation. You specify the value in one of two\n formats, depending on whether you want to access the source object through an access\n point:
\nFor objects not accessed through an access point, specify the name of the source\n bucket and the key of the source object, separated by a slash (/). For example, to\n copy the object reports/january.pdf
from the bucket\n awsexamplebucket
, use\n awsexamplebucket/reports/january.pdf
. The value must be URL\n encoded.
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:
. For example, to copy the object reports/january.pdf
through access point my-access-point
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.
Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.
\nAlternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:
. For example, to copy the object reports/january.pdf
through outpost my-outpost
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL encoded.
To copy a specific version of an object, append ?versionId=
\n to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.
The key of the destination object.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Copies the object if its entity tag (ETag) matches the specified tag.
", + "smithy.api#httpHeader": "x-amz-copy-source-if-match" } }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", + "CopySourceIfModifiedSince": { + "target": "com.amazonaws.s3#CopySourceIfModifiedSince", "traits": { - "smithy.api#documentation": "Allows grantee to write the ACL for the applicable object.
\nThis action is not supported by Amazon S3 on Outposts.
", - "smithy.api#httpHeader": "x-amz-grant-write-acp" + "smithy.api#documentation": "Copies the object if it has been modified since the specified time.
", + "smithy.api#httpHeader": "x-amz-copy-source-if-modified-since" } }, - "CopySource": { - "target": "com.amazonaws.s3#CopySource", + "CopySourceIfNoneMatch": { + "target": "com.amazonaws.s3#CopySourceIfNoneMatch", "traits": { - "smithy.api#documentation": "Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want \n to access the source object through an access point:
\nFor objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). \n For example, to copy the object reports/january.pdf
from the bucket awsexamplebucket
, use awsexamplebucket/reports/january.pdf
. The value must be URL encoded.
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:
. For example, to copy the object reports/january.pdf
through access point my-access-point
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.
Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.
\nAlternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:
. For example, to copy the object reports/january.pdf
through outpost my-outpost
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL encoded.
To copy a specific version of an object, append ?versionId=
\n to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.
Copies the object if its entity tag (ETag) is different than the specified ETag.
", + "smithy.api#httpHeader": "x-amz-copy-source-if-none-match" } }, - "CopySourceSSECustomerAlgorithm": { - "target": "com.amazonaws.s3#CopySourceSSECustomerAlgorithm", + "CopySourceIfUnmodifiedSince": { + "target": "com.amazonaws.s3#CopySourceIfUnmodifiedSince", "traits": { - "smithy.api#documentation": "Specifies the algorithm to use when decrypting the source object (for example, AES256).
", - "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-algorithm" + "smithy.api#documentation": "Copies the object if it hasn't been modified since the specified time.
", + "smithy.api#httpHeader": "x-amz-copy-source-if-unmodified-since" } }, - "CopySourceSSECustomerKey": { - "target": "com.amazonaws.s3#CopySourceSSECustomerKey", + "Expires": { + "target": "com.amazonaws.s3#Expires", "traits": { - "smithy.api#documentation": "Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.
", - "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key" + "smithy.api#documentation": "The date and time at which the object is no longer cacheable.
", + "smithy.api#httpHeader": "Expires" } }, - "CopySourceSSECustomerKeyMD5": { - "target": "com.amazonaws.s3#CopySourceSSECustomerKeyMD5", + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", "traits": { - "smithy.api#documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
", - "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key-MD5" + "smithy.api#documentation": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the\n object.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#httpHeader": "x-amz-grant-full-control" } }, - "CacheControl": { - "target": "com.amazonaws.s3#CacheControl", + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", "traits": { - "smithy.api#documentation": "Specifies caching behavior along the request/reply chain.
", - "smithy.api#httpHeader": "Cache-Control" + "smithy.api#documentation": "Allows grantee to read the object data and its\n metadata.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#httpHeader": "x-amz-grant-read" } }, "GrantReadACP": { @@ -1549,10 +1539,19 @@ "smithy.api#httpHeader": "x-amz-grant-read-acp" } }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "smithy.api#documentation": "Allows grantee to write the ACL for the applicable\n object.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } + }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "The key of the destination object.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "Metadata": { @@ -1562,117 +1561,143 @@ "smithy.api#httpPrefixHeaders": "x-amz-meta-" } }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "MetadataDirective": { + "target": "com.amazonaws.s3#MetadataDirective", "traits": { - "smithy.api#documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + "smithy.api#documentation": "Specifies whether the metadata is copied from the source object or replaced with\n metadata provided in the request.
", + "smithy.api#httpHeader": "x-amz-metadata-directive" } }, "TaggingDirective": { "target": "com.amazonaws.s3#TaggingDirective", "traits": { - "smithy.api#documentation": "Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
", + "smithy.api#documentation": "Specifies whether the object tag-set are copied from the source object or replaced with\n tag-set provided in the request.
", "smithy.api#httpHeader": "x-amz-tagging-directive" } }, - "ContentEncoding": { - "target": "com.amazonaws.s3#ContentEncoding", + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
", - "smithy.api#httpHeader": "Content-Encoding" + "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", + "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, - "CopySourceIfUnmodifiedSince": { - "target": "com.amazonaws.s3#CopySourceIfUnmodifiedSince", + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "Copies the object if it hasn't been modified since the specified time.
", - "smithy.api#httpHeader": "x-amz-copy-source-if-unmodified-since" + "smithy.api#documentation": "By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3\n Service Developer Guide.
", + "smithy.api#httpHeader": "x-amz-storage-class" } }, - "ContentType": { - "target": "com.amazonaws.s3#ContentType", + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", "traits": { - "smithy.api#documentation": "A standard MIME type describing the format of the object data.
", - "smithy.api#httpHeader": "Content-Type" + "smithy.api#documentation": "If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.
", + "smithy.api#httpHeader": "x-amz-website-redirect-location" } }, "SSECustomerAlgorithm": { "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "Specifies the algorithm to use to when encrypting the object (for example, AES256).
", + "smithy.api#documentation": "Specifies the algorithm to use to when encrypting the object (for example,\n AES256).
", "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "CopySourceIfMatch": { - "target": "com.amazonaws.s3#CopySourceIfMatch", - "traits": { - "smithy.api#documentation": "Copies the object if its entity tag (ETag) matches the specified tag.
", - "smithy.api#httpHeader": "x-amz-copy-source-if-match" - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", "traits": { - "smithy.api#documentation": "The name of the destination bucket.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm
header.
The Object Lock mode that you want to apply to the copied object.
", - "smithy.api#httpHeader": "x-amz-object-lock-mode" + "smithy.api#documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an\n object protected by AWS KMS will fail if not made via SSL or using SigV4. For information\n about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication\n in the Amazon S3 Developer Guide.
", + "smithy.api#documentation": "Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for\n an object protected by AWS KMS will fail if not made via SSL or using SigV4. For\n information about configuring using any of the officially supported AWS SDKs and AWS CLI,\n see Specifying the\n Signature Version in Request Authentication in the Amazon S3 Developer\n Guide.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, - "ExpectedSourceBucketOwner": { - "target": "com.amazonaws.s3#AccountId", + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { - "smithy.api#documentation": "The account id of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Specifies the AWS KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", + "CopySourceSSECustomerAlgorithm": { + "target": "com.amazonaws.s3#CopySourceSSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", - "smithy.api#httpHeader": "x-amz-server-side-encryption" + "smithy.api#documentation": "Specifies the algorithm to use when decrypting the source object (for example,\n AES256).
", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-algorithm" } }, - "MetadataDirective": { - "target": "com.amazonaws.s3#MetadataDirective", + "CopySourceSSECustomerKey": { + "target": "com.amazonaws.s3#CopySourceSSECustomerKey", "traits": { - "smithy.api#documentation": "Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
", - "smithy.api#httpHeader": "x-amz-metadata-directive" + "smithy.api#documentation": "Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source\n object. The encryption key provided in this header must be one that was used when the\n source object was created.
", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key" } }, - "GrantFullControl": { - "target": "com.amazonaws.s3#GrantFullControl", + "CopySourceSSECustomerKeyMD5": { + "target": "com.amazonaws.s3#CopySourceSSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
\nThis action is not supported by Amazon S3 on Outposts.
", - "smithy.api#httpHeader": "x-amz-grant-full-control" + "smithy.api#documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key-MD5" } }, - "CopySourceIfNoneMatch": { - "target": "com.amazonaws.s3#CopySourceIfNoneMatch", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "Copies the object if its entity tag (ETag) is different than the specified ETag.
", - "smithy.api#httpHeader": "x-amz-copy-source-if-none-match" + "smithy.api#httpHeader": "x-amz-request-payer" } }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", + "Tagging": { + "target": "com.amazonaws.s3#TaggingHeader", "traits": { - "smithy.api#documentation": "By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.\n The STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only \n uses the OUTPOSTS Storage Class. For more information, see\n Storage Classes in the\n Amazon S3 Service Developer Guide.
", - "smithy.api#httpHeader": "x-amz-storage-class" + "smithy.api#documentation": "The tag-set for the object destination object this value must be used in conjunction\n with the TaggingDirective
. The tag-set must be encoded as URL Query\n parameters.
The Object Lock mode that you want to apply to the copied object.
", + "smithy.api#httpHeader": "x-amz-object-lock-mode" + } + }, + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "traits": { + "smithy.api#documentation": "The date and time when you want the copied object's Object Lock to expire.
", + "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + } + }, + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "traits": { + "smithy.api#documentation": "Specifies whether you want to apply a Legal Hold to the copied object.
", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "The account id of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata. The source and destination ETag is identical for a successfully copied object.
" + "smithy.api#documentation": "Returns the ETag of the new object. The ETag reflects only changes to the contents of an\n object, not its metadata. The source and destination ETag is identical for a successfully\n copied object.
" } }, "LastModified": { @@ -1770,7 +1795,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.
\nNot every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Working with Amazon S3\n buckets.
\nIf you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
\nBy default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.
\nIf you send your create bucket request to the s3.amazonaws.com
endpoint, the\n request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of buckets.
When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.
\nSpecify a canned ACL using the x-amz-acl
request header. Amazon S3 supports a set\n of predefined ACLs, known as canned ACLs. Each canned ACL has a\n predefined set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly using the x-amz-grant-read
,\n x-amz-grant-write
, x-amz-grant-read-acp
,\n x-amz-grant-write-acp
, and x-amz-grant-full-control
\n headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For\n more information, see Access control list\n (ACL) overview.
You specify each grantee as a type=value pair, where the type is one of the following:
\n\n id
– if the value specified is the canonical user ID of an AWS account
\n uri
– if you are granting permissions to a predefined group
\n emailAddress
– if the value specified is the email address of an AWS\n account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
\nFor example, the following x-amz-grant-read
header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"
\n
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
\nThe following operations are related to CreateBucket
:
\n PutObject\n
\n\n DeleteBucket\n
\nCreates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a\n valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to\n create buckets. By creating the bucket, you become the bucket owner.
\nNot every string is an acceptable bucket name. For information about bucket naming\n restrictions, see Working with Amazon S3\n buckets.
\nIf you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
\nBy default, the bucket is created in the US East (N. Virginia) Region. You can\n optionally specify a Region in the request body. You might choose a Region to optimize\n latency, minimize costs, or address regulatory requirements. For example, if you reside in\n Europe, you will probably find it advantageous to create buckets in the Europe (Ireland)\n Region. For more information, see Accessing a\n bucket.
\nIf you send your create bucket request to the s3.amazonaws.com
endpoint,\n the request goes to the us-east-1 Region. Accordingly, the signature calculations in\n Signature Version 4 must use us-east-1 as the Region, even if the location constraint in\n the request specifies another Region where the bucket is to be created. If you create a\n bucket in a Region other than US East (N. Virginia), your application must be able to\n handle 307 redirect. For more information, see Virtual hosting of buckets.
When creating a bucket using this operation, you can optionally specify the accounts or\n groups that should be granted specific permissions on the bucket. There are two ways to\n grant the appropriate permissions using the request headers.
\nSpecify a canned ACL using the x-amz-acl
request header. Amazon S3\n supports a set of predefined ACLs, known as canned ACLs. Each\n canned ACL has a predefined set of grantees and permissions. For more information,\n see Canned ACL.
Specify access permissions explicitly using the x-amz-grant-read
,\n x-amz-grant-write
, x-amz-grant-read-acp
,\n x-amz-grant-write-acp
, and x-amz-grant-full-control
\n headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For\n more information, see Access control list\n (ACL) overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id
– if the value specified is the canonical user ID of an AWS\n account
\n uri
– if you are granting permissions to a predefined\n group
\n emailAddress
– if the value specified is the email address of\n an AWS account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
\nFor example, the following x-amz-grant-read
header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"
\n
You can use either a canned ACL or specify access permissions explicitly. You cannot\n do both.
\nThe following operations are related to CreateBucket
:
\n PutObject\n
\n\n DeleteBucket\n
\nSpecifies the Region where the bucket will be created. If you don't specify a Region, the\n bucket is created in the US East (N. Virginia) Region (us-east-1).
" + "smithy.api#documentation": "Specifies the Region where the bucket will be created. If you don't specify a Region,\n the bucket is created in the US East (N. Virginia) Region (us-east-1).
" } } }, @@ -1807,32 +1832,11 @@ "com.amazonaws.s3#CreateBucketRequest": { "type": "structure", "members": { - "GrantReadACP": { - "target": "com.amazonaws.s3#GrantReadACP", - "traits": { - "smithy.api#documentation": "Allows grantee to read the bucket ACL.
", - "smithy.api#httpHeader": "x-amz-grant-read-acp" - } - }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", - "traits": { - "smithy.api#documentation": "Allows grantee to list the objects in the bucket.
", - "smithy.api#httpHeader": "x-amz-grant-read" - } - }, "ACL": { "target": "com.amazonaws.s3#BucketCannedACL", "traits": { "smithy.api#documentation": "The canned ACL to apply to the bucket.
", - "smithy.api#httpHeader": "x-amz-acl" - } - }, - "GrantWrite": { - "target": "com.amazonaws.s3#GrantWrite", - "traits": { - "smithy.api#documentation": "Allows grantee to create, overwrite, and delete any object in the bucket.
", - "smithy.api#httpHeader": "x-amz-grant-write" + "smithy.api#httpHeader": "x-amz-acl" } }, "Bucket": { @@ -1843,18 +1847,39 @@ "smithy.api#required": {} } }, + "CreateBucketConfiguration": { + "target": "com.amazonaws.s3#CreateBucketConfiguration", + "traits": { + "smithy.api#documentation": "The configuration information for the bucket.
", + "smithy.api#httpPayload": {} + } + }, "GrantFullControl": { "target": "com.amazonaws.s3#GrantFullControl", "traits": { - "smithy.api#documentation": "Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
", + "smithy.api#documentation": "Allows grantee the read, write, read ACP, and write ACP permissions on the\n bucket.
", "smithy.api#httpHeader": "x-amz-grant-full-control" } }, - "ObjectLockEnabledForBucket": { - "target": "com.amazonaws.s3#ObjectLockEnabledForBucket", + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", "traits": { - "smithy.api#documentation": "Specifies whether you want S3 Object Lock to be enabled for the new bucket.
", - "smithy.api#httpHeader": "x-amz-bucket-object-lock-enabled" + "smithy.api#documentation": "Allows grantee to list the objects in the bucket.
", + "smithy.api#httpHeader": "x-amz-grant-read" + } + }, + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", + "traits": { + "smithy.api#documentation": "Allows grantee to read the bucket ACL.
", + "smithy.api#httpHeader": "x-amz-grant-read-acp" + } + }, + "GrantWrite": { + "target": "com.amazonaws.s3#GrantWrite", + "traits": { + "smithy.api#documentation": "Allows grantee to create, overwrite, and delete any object in the bucket.
", + "smithy.api#httpHeader": "x-amz-grant-write" } }, "GrantWriteACP": { @@ -1864,11 +1889,11 @@ "smithy.api#httpHeader": "x-amz-grant-write-acp" } }, - "CreateBucketConfiguration": { - "target": "com.amazonaws.s3#CreateBucketConfiguration", + "ObjectLockEnabledForBucket": { + "target": "com.amazonaws.s3#ObjectLockEnabledForBucket", "traits": { - "smithy.api#documentation": "The configuration information for the bucket.
", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "Specifies whether you want S3 Object Lock to be enabled for the new bucket.
", + "smithy.api#httpHeader": "x-amz-bucket-object-lock-enabled" } } } @@ -1882,7 +1907,7 @@ "target": "com.amazonaws.s3#CreateMultipartUploadOutput" }, "traits": { - "smithy.api#documentation": "This operation initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.
\n \nFor more information about multipart uploads, see Multipart Upload Overview.
\n \nIf you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
\n \nFor information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
\n \nFor request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (AWS Signature Version 4).
\n \nAfter you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.\n
\nYou can optionally request server-side encryption. For server-side encryption, Amazon S3\n encrypts your data as it writes it to disks in its data centers and decrypts it when you\n access it. You can provide your own encryption key, or use AWS Key Management Service (AWS\n KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide\n your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to\n initiate the upload by using CreateMultipartUpload
.
To perform a multipart upload with encryption using an AWS KMS CMK, the requester must have permission to the kms:Encrypt
, kms:Decrypt
, kms:ReEncrypt*
, kms:GenerateDataKey*
, and kms:DescribeKey
actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload.
If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.
\n \n \nFor more information, see Protecting Data Using Server-Side Encryption.
\n \nWhen copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:
\nSpecify a canned ACL with the x-amz-acl
request header. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
\nYou can optionally tell Amazon S3 to encrypt data at rest using server-side encryption.\n Server-side encryption is for data encryption at rest. Amazon S3 encrypts your\n data as it writes it to disks in its data centers and decrypts it when you access\n it. The option you use depends on whether you want to use AWS managed encryption\n keys or provide your own encryption key.
\nUse encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key\n Management Service (AWS KMS) – If you want AWS to manage the keys used to\n encrypt data, specify the following headers in the request.
\nx-amz-server-side-encryption
\nx-amz-server-side-encryption-aws-kms-key-id
\nx-amz-server-side-encryption-context
\nIf you specify x-amz-server-side-encryption:aws:kms
, but don't provide\n x-amz-server-side-encryption-aws-kms-key-id
, Amazon S3\n uses the AWS managed CMK in AWS KMS to protect the data.
All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.
\nFor more information about server-side encryption with CMKs stored in AWS\n KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS\n KMS.
\nUse customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\nFor more information about server-side encryption with CMKs stored in AWS\n KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS\n KMS.
\nYou also can use the following access control–related headers with this operation. By default,\n all objects are private. Only the owner has full access control. When adding a new\n object, you can grant permissions to individual AWS accounts or to predefined\n groups defined by Amazon S3. These permissions are then added to the access\n control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions\n using one of the following two methods:
\nSpecify a canned ACL (x-amz-acl
) — Amazon S3 supports a set of predefined ACLs,\n known as canned ACLs. Each canned ACL has a predefined\n set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly — To explicitly grant access permissions to specific AWS\n accounts or groups, use the following headers. Each header maps to specific\n permissions that Amazon S3 supports in an ACL. For more information, see\n Access Control List (ACL) Overview. In the header, you specify a\n list of grantees who get the specific permission. To grant permissions\n explicitly, use:
\nx-amz-grant-read
\nx-amz-grant-write
\nx-amz-grant-read-acp
\nx-amz-grant-write-acp
\nx-amz-grant-full-control
\nYou specify each grantee as a type=value pair, where the type is one of the following:
\n\n id
– if the value specified is the canonical user ID of an AWS account
\n uri
– if you are granting permissions to a predefined group
\n emailAddress
– if the value specified is the email address of an AWS\n account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
\nFor example, the following x-amz-grant-read
header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"
\n
The following operations are related to CreateMultipartUpload
:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nThis operation initiates a multipart upload and returns an upload ID. This upload ID is\n used to associate all of the parts in the specific multipart upload. You specify this\n upload ID in each of your subsequent upload part requests (see UploadPart). You also include this\n upload ID in the final request to either complete or abort the multipart upload\n request.
\n\nFor more information about multipart uploads, see Multipart Upload Overview.
\n\nIf you have configured a lifecycle rule to abort incomplete multipart uploads, the\n upload must complete within the number of days specified in the bucket lifecycle\n configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort\n operation and Amazon S3 aborts the multipart upload. For more information, see Aborting\n Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
\n\nFor information about the permissions required to use the multipart upload API, see\n Multipart Upload API and\n Permissions.
\n\nFor request signing, multipart upload is just a series of regular requests. You initiate\n a multipart upload, send one or more requests to upload parts, and then complete the\n multipart upload process. You sign each request individually. There is nothing special\n about signing multipart upload requests. For more information about signing, see Authenticating\n Requests (AWS Signature Version 4).
\n\nAfter you initiate a multipart upload and upload one or more parts, to stop being\n charged for storing the uploaded parts, you must either complete or abort the multipart\n upload. Amazon S3 frees up the space used to store the parts and stop charging you for\n storing them only after you either complete or abort a multipart upload.
\nYou can optionally request server-side encryption. For server-side encryption, Amazon S3\n encrypts your data as it writes it to disks in its data centers and decrypts it when you\n access it. You can provide your own encryption key, or use AWS Key Management Service (AWS\n KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide\n your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must match the headers you used in the request to\n initiate the upload by using CreateMultipartUpload
.
To perform a multipart upload with encryption using an AWS KMS CMK, the requester must\n have permission to the kms:Encrypt
, kms:Decrypt
,\n kms:ReEncrypt*
, kms:GenerateDataKey*
, and\n kms:DescribeKey
actions on the key. These permissions are required because\n Amazon S3 must decrypt and read data from the encrypted file parts before it completes the\n multipart upload.
If your AWS Identity and Access Management (IAM) user or role is in the same AWS account\n as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM\n user or role belongs to a different account than the key, then you must have the\n permissions on both the key policy and your IAM user or role.
\n\n\nFor more information, see Protecting\n Data Using Server-Side Encryption.
\n\nWhen copying an object, you can optionally specify the accounts or groups that\n should be granted specific permissions on the new object. There are two ways to\n grant the permissions using the request headers:
\nSpecify a canned ACL with the x-amz-acl
request header. For\n more information, see Canned ACL.
Specify access permissions explicitly with the\n x-amz-grant-read
, x-amz-grant-read-acp
,\n x-amz-grant-write-acp
, and\n x-amz-grant-full-control
headers. These parameters map to\n the set of permissions that Amazon S3 supports in an ACL. For more information,\n see Access Control List (ACL)\n Overview.
You can use either a canned ACL or specify access permissions explicitly. You\n cannot do both.
\nYou can optionally tell Amazon S3 to encrypt data at rest using server-side\n encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts\n your data as it writes it to disks in its data centers and decrypts it when you\n access it. The option you use depends on whether you want to use AWS managed\n encryption keys or provide your own encryption key.
\nUse encryption keys managed by Amazon S3 or customer master keys (CMKs) stored\n in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys\n used to encrypt data, specify the following headers in the request.
\nx-amz-server-side-encryption
\nx-amz-server-side-encryption-aws-kms-key-id
\nx-amz-server-side-encryption-context
\nIf you specify x-amz-server-side-encryption:aws:kms
, but\n don't provide x-amz-server-side-encryption-aws-kms-key-id
,\n Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data.
All GET and PUT requests for an object protected by AWS KMS fail if\n you don't make them with SSL or by using SigV4.
\nFor more information about server-side encryption with CMKs stored in AWS\n KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS\n KMS.
\nUse customer-provided encryption keys – If you want to manage your own\n encryption keys, provide all the following headers in the request.
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\nFor more information about server-side encryption with CMKs stored in AWS\n KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS\n KMS.
\nYou also can use the following access control–related headers with this\n operation. By default, all objects are private. Only the owner has full access\n control. When adding a new object, you can grant permissions to individual AWS\n accounts or to predefined groups defined by Amazon S3. These permissions are then added\n to the access control list (ACL) on the object. For more information, see Using ACLs. With this\n operation, you can grant access permissions using one of the following two\n methods:
\nSpecify a canned ACL (x-amz-acl
) — Amazon S3 supports a set of\n predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. For more information, see\n Canned\n ACL.
Specify access permissions explicitly — To explicitly grant access\n permissions to specific AWS accounts or groups, use the following headers.\n Each header maps to specific permissions that Amazon S3 supports in an ACL. For\n more information, see Access\n Control List (ACL) Overview. In the header, you specify a list of\n grantees who get the specific permission. To grant permissions explicitly,\n use:
\nx-amz-grant-read
\nx-amz-grant-write
\nx-amz-grant-read-acp
\nx-amz-grant-write-acp
\nx-amz-grant-full-control
\nYou specify each grantee as a type=value pair, where the type is one of\n the following:
\n\n id
– if the value specified is the canonical user ID\n of an AWS account
\n uri
– if you are granting permissions to a predefined\n group
\n emailAddress
– if the value specified is the email\n address of an AWS account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
\nFor example, the following x-amz-grant-read
header grants the AWS accounts identified by account IDs permissions to read object data and its metadata:
\n x-amz-grant-read: id=\"11112222333\", id=\"444455556666\"
\n
The following operations are related to CreateMultipartUpload
:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nIf present, specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + "smithy.api#documentation": "If the bucket has a lifecycle rule configured with an action to abort incomplete\n multipart uploads and the prefix in the lifecycle rule matches the object name in the\n request, the response includes this header. The header indicates when the initiated\n multipart upload becomes eligible for an abort operation. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
\n\nThe response also includes the x-amz-abort-rule-id
header that provides the\n ID of the lifecycle configuration rule that defines this action.
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", - "smithy.api#httpHeader": "x-amz-server-side-encryption" + "smithy.api#documentation": "This header is returned along with the x-amz-abort-date
header. It\n identifies the applicable lifecycle configuration rule that defines the action to abort\n incomplete multipart uploads.
The name of the bucket to which the multipart upload was initiated.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#xmlName": "Bucket" } }, "Key": { @@ -1913,58 +1945,51 @@ "smithy.api#documentation": "Object key for which the multipart upload was initiated.
" } }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" + "smithy.api#documentation": "ID for the initiated multipart upload.
" } }, - "AbortDate": { - "target": "com.amazonaws.s3#AbortDate", + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see \n Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
\n \nThe response also includes the x-amz-abort-rule-id
header that provides the\n ID of the lifecycle configuration rule that defines this action.
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", + "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, "SSECustomerAlgorithm": { "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
", + "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "The name of the bucket to which the multipart upload was initiated.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", - "smithy.api#xmlName": "Bucket" + "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key\n (CMK) that was used for the object.
", + "smithy.api#documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, - "AbortRuleId": { - "target": "com.amazonaws.s3#AbortRuleId", - "traits": { - "smithy.api#documentation": "This header is returned along with the x-amz-abort-date
header. It identifies the\n applicable lifecycle configuration rule that defines the action to abort incomplete\n multipart uploads.
If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + "smithy.api#documentation": "If present, specifies the AWS KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", "traits": { - "smithy.api#documentation": "ID for the initiated multipart upload.
" + "smithy.api#httpHeader": "x-amz-request-charged" } } } @@ -1972,11 +1997,11 @@ "com.amazonaws.s3#CreateMultipartUploadRequest": { "type": "structure", "members": { - "Metadata": { - "target": "com.amazonaws.s3#Metadata", + "ACL": { + "target": "com.amazonaws.s3#ObjectCannedACL", "traits": { - "smithy.api#documentation": "A map of metadata to store with the object in S3.
", - "smithy.api#httpPrefixHeaders": "x-amz-meta-" + "smithy.api#documentation": "The canned ACL to apply to the object.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#httpHeader": "x-amz-acl" } }, "Bucket": { @@ -1987,123 +2012,117 @@ "smithy.api#required": {} } }, - "GrantFullControl": { - "target": "com.amazonaws.s3#GrantFullControl", + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", "traits": { - "smithy.api#documentation": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
\nThis action is not supported by Amazon S3 on Outposts.
", - "smithy.api#httpHeader": "x-amz-grant-full-control" + "smithy.api#documentation": "Specifies caching behavior along the request/reply chain.
", + "smithy.api#httpHeader": "Cache-Control" } }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", "traits": { - "smithy.api#documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + "smithy.api#documentation": "Specifies presentational information for the object.
", + "smithy.api#httpHeader": "Content-Disposition" } }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", "traits": { - "smithy.api#documentation": "Specifies the algorithm to use to when encrypting the object (for example, AES256).
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + "smithy.api#documentation": "Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.
", + "smithy.api#httpHeader": "Content-Encoding" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", "traits": { - "smithy.api#documentation": "Object key for which the multipart upload is to be initiated.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The language the content is in.
", + "smithy.api#httpHeader": "Content-Language" } }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", + "ContentType": { + "target": "com.amazonaws.s3#ContentType", "traits": { - "smithy.api#documentation": "Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object encryption. All GET and PUT requests for an\n object protected by AWS KMS will fail if not made via SSL or using SigV4. For information\n about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication\n in the Amazon S3 Developer Guide.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + "smithy.api#documentation": "A standard MIME type describing the format of the object data.
", + "smithy.api#httpHeader": "Content-Type" } }, - "ObjectLockLegalHoldStatus": { - "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "Expires": { + "target": "com.amazonaws.s3#Expires", "traits": { - "smithy.api#documentation": "Specifies whether you want to apply a Legal Hold to the uploaded object.
", - "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + "smithy.api#documentation": "The date and time at which the object is no longer cacheable.
", + "smithy.api#httpHeader": "Expires" } }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "smithy.api#documentation": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the\n object.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#httpHeader": "x-amz-grant-full-control" } }, "GrantRead": { "target": "com.amazonaws.s3#GrantRead", "traits": { - "smithy.api#documentation": "Allows grantee to read the object data and its metadata.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "Allows grantee to read the object data and its\n metadata.
\nThis action is not supported by Amazon S3 on Outposts.
", "smithy.api#httpHeader": "x-amz-grant-read" } }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", - "traits": { - "smithy.api#documentation": "Allows grantee to write the ACL for the applicable object.
\nThis action is not supported by Amazon S3 on Outposts.
", - "smithy.api#httpHeader": "x-amz-grant-write-acp" - } - }, - "WebsiteRedirectLocation": { - "target": "com.amazonaws.s3#WebsiteRedirectLocation", + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", "traits": { - "smithy.api#documentation": "If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
", - "smithy.api#httpHeader": "x-amz-website-redirect-location" + "smithy.api#documentation": "Allows grantee to read the object ACL.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#httpHeader": "x-amz-grant-read-acp" } }, - "ContentType": { - "target": "com.amazonaws.s3#ContentType", + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", "traits": { - "smithy.api#documentation": "A standard MIME type describing the format of the object data.
", - "smithy.api#httpHeader": "Content-Type" + "smithy.api#documentation": "Allows grantee to write the ACL for the applicable\n object.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#httpHeader": "x-amz-grant-write-acp" } }, - "ContentLanguage": { - "target": "com.amazonaws.s3#ContentLanguage", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "The language the content is in.
", - "smithy.api#httpHeader": "Content-Language" + "smithy.api#documentation": "Object key for which the multipart upload is to be initiated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "CacheControl": { - "target": "com.amazonaws.s3#CacheControl", + "Metadata": { + "target": "com.amazonaws.s3#Metadata", "traits": { - "smithy.api#documentation": "Specifies caching behavior along the request/reply chain.
", - "smithy.api#httpHeader": "Cache-Control" + "smithy.api#documentation": "A map of metadata to store with the object in S3.
", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" } }, - "GrantReadACP": { - "target": "com.amazonaws.s3#GrantReadACP", + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "Allows grantee to read the object ACL.
\nThis action is not supported by Amazon S3 on Outposts.
", - "smithy.api#httpHeader": "x-amz-grant-read-acp" + "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", + "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, - "Tagging": { - "target": "com.amazonaws.s3#TaggingHeader", + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "The tag-set for the object. The tag-set must be encoded as URL Query parameters.
", - "smithy.api#httpHeader": "x-amz-tagging" + "smithy.api#documentation": "By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3\n Service Developer Guide.
", + "smithy.api#httpHeader": "x-amz-storage-class" } }, - "SSEKMSEncryptionContext": { - "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", "traits": { - "smithy.api#documentation": "Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + "smithy.api#documentation": "If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.
", + "smithy.api#httpHeader": "x-amz-website-redirect-location" } }, - "ACL": { - "target": "com.amazonaws.s3#ObjectCannedACL", + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "The canned ACL to apply to the object.
\nThis action is not supported by Amazon S3 on Outposts.
", - "smithy.api#httpHeader": "x-amz-acl" + "smithy.api#documentation": "Specifies the algorithm to use to when encrypting the object (for example,\n AES256).
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, "SSECustomerKey": { @@ -2113,39 +2132,38 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" } }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, - "Expires": { - "target": "com.amazonaws.s3#Expires", + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "The date and time at which the object is no longer cacheable.
", - "smithy.api#httpHeader": "Expires" + "smithy.api#documentation": "Specifies the ID of the symmetric customer managed AWS KMS CMK to use for object\n encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not\n made via SSL or using SigV4. For information about configuring using any of the officially\n supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication\n in the Amazon S3 Developer Guide.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, - "ObjectLockRetainUntilDate": { - "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "SSEKMSEncryptionContext": { + "target": "com.amazonaws.s3#SSEKMSEncryptionContext", "traits": { - "smithy.api#documentation": "Specifies the date and time when you want the Object Lock to expire.
", - "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + "smithy.api#documentation": "Specifies the AWS KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", - "smithy.api#httpHeader": "x-amz-server-side-encryption" + "smithy.api#httpHeader": "x-amz-request-payer" } }, - "ContentDisposition": { - "target": "com.amazonaws.s3#ContentDisposition", - "traits": { - "smithy.api#documentation": "Specifies presentational information for the object.
", - "smithy.api#httpHeader": "Content-Disposition" + "Tagging": { + "target": "com.amazonaws.s3#TaggingHeader", + "traits": { + "smithy.api#documentation": "The tag-set for the object. The tag-set must be encoded as URL Query parameters.
", + "smithy.api#httpHeader": "x-amz-tagging" } }, "ObjectLockMode": { @@ -2155,18 +2173,25 @@ "smithy.api#httpHeader": "x-amz-object-lock-mode" } }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", "traits": { - "smithy.api#documentation": "By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.\n The STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only \n uses the OUTPOSTS Storage Class. For more information, see\n Storage Classes in the\n Amazon S3 Service Developer Guide.
", - "smithy.api#httpHeader": "x-amz-storage-class" + "smithy.api#documentation": "Specifies the date and time when you want the Object Lock to expire.
", + "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" } }, - "ContentEncoding": { - "target": "com.amazonaws.s3#ContentEncoding", + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", "traits": { - "smithy.api#documentation": "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
", - "smithy.api#httpHeader": "Content-Encoding" + "smithy.api#documentation": "Specifies whether you want to apply a Legal Hold to the uploaded object.
", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The number of days that you want to specify for the default retention period.
" + "smithy.api#documentation": "The default Object Lock retention mode you want to apply to new objects placed in the\n specified bucket.
" } }, - "Mode": { - "target": "com.amazonaws.s3#ObjectLockRetentionMode", + "Days": { + "target": "com.amazonaws.s3#Days", "traits": { - "smithy.api#documentation": "The default Object Lock retention mode you want to apply to new objects placed in the specified bucket.
" + "smithy.api#documentation": "The number of days that you want to specify for the default retention period.
" } }, "Years": { @@ -2209,7 +2234,7 @@ } }, "traits": { - "smithy.api#documentation": "The container element for specifying the default Object Lock retention settings for new objects placed in the specified bucket.
" + "smithy.api#documentation": "The container element for specifying the default Object Lock retention settings for new\n objects placed in the specified bucket.
" } }, "com.amazonaws.s3#Delete": { @@ -2227,7 +2252,7 @@ "Quiet": { "target": "com.amazonaws.s3#Quiet", "traits": { - "smithy.api#documentation": "Element to enable quiet mode for the request. When you add this element, you must set its value to true.
" + "smithy.api#documentation": "Element to enable quiet mode for the request. When you add this element, you must set\n its value to true.
" } } }, @@ -2241,7 +2266,7 @@ "target": "com.amazonaws.s3#DeleteBucketRequest" }, "traits": { - "smithy.api#documentation": "Deletes the S3 bucket. All objects (including all object versions and delete markers) in the\n bucket must be deleted before the bucket itself can be deleted.
\n \n\n Related Resources\n
\n\n CreateBucket\n
\n\n DeleteObject\n
\nDeletes the S3 bucket. All objects (including all object versions and delete markers) in\n the bucket must be deleted before the bucket itself can be deleted.
\n \n\n Related Resources\n
\n\n CreateBucket\n
\n\n DeleteObject\n
\nDeletes an analytics configuration for the bucket (specified by the analytics configuration ID).
\nTo use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
\n \nThe following operations are related to DeleteBucketAnalyticsConfiguration
:
Deletes an analytics configuration for the bucket (specified by the analytics\n configuration ID).
\nTo use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.
\n\nThe following operations are related to\n DeleteBucketAnalyticsConfiguration
:
The name of the bucket from which an analytics configuration is deleted.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "Id": { "target": "com.amazonaws.s3#AnalyticsId", "traits": { @@ -2280,14 +2313,6 @@ "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The name of the bucket from which an analytics configuration is deleted.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -2297,7 +2322,7 @@ "target": "com.amazonaws.s3#DeleteBucketCorsRequest" }, "traits": { - "smithy.api#documentation": "Deletes the cors
configuration information set for the bucket.
To use this operation, you must have permission to perform the s3:PutBucketCORS
action. \n The bucket owner has this permission by default and can grant this permission to others.
For information about cors
, see Enabling\n Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.
\n Related Resources:\n
\n\n PutBucketCors\n
\n\n RESTOPTIONSobject\n
\nDeletes the cors
configuration information set for the bucket.
To use this operation, you must have permission to perform the\n s3:PutBucketCORS
action. The bucket owner has this permission by default\n and can grant this permission to others.
For information about cors
, see Enabling\n Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.
\n Related Resources:\n
\n\n PutBucketCors\n
\n\n RESTOPTIONSobject\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
This implementation of the DELETE operation removes default encryption from the bucket. For information about the Amazon S3 \n default encryption feature, see Amazon S3 Default Bucket Encryption in the \n Amazon Simple Storage Service Developer Guide.
\nTo use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration
action. The bucket owner \n has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see \n Permissions Related to \n Bucket Subresource Operations and Managing Access Permissions to your Amazon S3 \n Resources in the Amazon Simple Storage Service Developer Guide.
\n Related Resources\n
\n\n PutBucketEncryption\n
\n\n GetBucketEncryption\n
\nThis implementation of the DELETE operation removes default encryption from the bucket.\n For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the\n Amazon Simple Storage Service Developer Guide.
\nTo use this operation, you must have permissions to perform the\n s3:PutEncryptionConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.
\n Related Resources\n
\n\n PutBucketEncryption\n
\n\n GetBucketEncryption\n
\nThe name of the bucket containing the server-side encryption configuration to delete.
", + "smithy.api#documentation": "The name of the bucket containing the server-side encryption configuration to\n delete.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2359,13 +2384,48 @@ } } }, + "com.amazonaws.s3#DeleteBucketIntelligentTieringConfiguration": { + "type": "operation", + "input": { + "target": "com.amazonaws.s3#DeleteBucketIntelligentTieringConfigurationRequest" + }, + "traits": { + "smithy.api#documentation": "Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
\nThe S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
\nIf you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n DeleteBucketIntelligentTieringConfiguration
include:
The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Id": { + "target": "com.amazonaws.s3#IntelligentTieringId", + "traits": { + "smithy.api#documentation": "The ID used to identify the S3 Intelligent-Tiering configuration.
", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + } + } + }, "com.amazonaws.s3#DeleteBucketInventoryConfiguration": { "type": "operation", "input": { "target": "com.amazonaws.s3#DeleteBucketInventoryConfigurationRequest" }, "traits": { - "smithy.api#documentation": "Deletes an inventory configuration (identified by the inventory ID) from the bucket.
\nTo use this operation, you must have permissions to perform the s3:PutInventoryConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
\nOperations related to DeleteBucketInventoryConfiguration
include:
Deletes an inventory configuration (identified by the inventory ID) from the\n bucket.
\nTo use this operation, you must have permissions to perform the\n s3:PutInventoryConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
\nOperations related to DeleteBucketInventoryConfiguration
include:
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.
\nTo use this operation, you must have permission to perform the s3:PutLifecycleConfiguration
action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others.
There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.
\n \nFor more information about the object expiration, see Elements to Describe Lifecycle Actions.
\nRelated actions include:
\nDeletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the\n lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your\n objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of\n rules contained in the deleted lifecycle configuration.
\nTo use this operation, you must have permission to perform the\n s3:PutLifecycleConfiguration
action. By default, the bucket owner has this\n permission and the bucket owner can grant this permission to others.
There is usually some time lag before lifecycle configuration deletion is fully\n propagated to all the Amazon S3 systems.
\n\nFor more information about the object expiration, see Elements to\n Describe Lifecycle Actions.
\nRelated actions include:
\nDeletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.
\n \n To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.\n
\nThe following operations are related to\n DeleteBucketMetricsConfiguration
:
Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the\n metrics configuration ID) from the bucket. Note that this doesn't include the daily storage\n metrics.
\n\n To use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration
action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
\nThe following operations are related to\n DeleteBucketMetricsConfiguration
:
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The name of the bucket containing the metrics configuration to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "Id": { @@ -2467,12 +2528,11 @@ "smithy.api#required": {} } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "The name of the bucket containing the metrics configuration to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
This implementation of the DELETE operation uses the policy subresource to delete the policy\n of a specified bucket. If you are using an identity other than the root user of the AWS\n account that owns the bucket, the calling identity must have the\n DeleteBucketPolicy
permissions on the specified bucket and belong to the\n bucket owner's account to use this operation.
If you don't have DeleteBucketPolicy
permissions, Amazon S3 returns a\n 403 Access Denied
error. If you have the correct permissions, but you're\n not using an identity that belongs to the bucket owner's account, Amazon S3 returns a\n 405 Method Not Allowed
error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and UserPolicies.\n
\nThe following operations are related to DeleteBucketPolicy
\n
\n CreateBucket\n
\n\n DeleteObject\n
\nThis implementation of the DELETE operation uses the policy subresource to delete the\n policy of a specified bucket. If you are using an identity other than the root user of the\n AWS account that owns the bucket, the calling identity must have the\n DeleteBucketPolicy
permissions on the specified bucket and belong to the\n bucket owner's account to use this operation.
If you don't have DeleteBucketPolicy
permissions, Amazon S3 returns a 403\n Access Denied
error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed
error.
As a security precaution, the root user of the AWS account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and\n UserPolicies.
\nThe following operations are related to DeleteBucketPolicy
\n
\n CreateBucket\n
\n\n DeleteObject\n
\n\n Deletes the replication configuration from the bucket.
\nTo use this operation, you must have permissions to perform the s3:PutReplicationConfiguration
action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
It can take a while for the deletion of a replication configuration to fully propagate.
\nFor information about replication configuration, see Replication in the Amazon S3 Developer Guide. \n
\n \nThe following operations are related to DeleteBucketReplication
:
\n PutBucketReplication\n
\n\n GetBucketReplication\n
\nDeletes the replication configuration from the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:PutReplicationConfiguration
action. The bucket owner has these\n permissions by default and can grant it to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
It can take a while for the deletion of a replication configuration to fully\n propagate.
\nFor information about replication configuration, see Replication in the Amazon S3 Developer\n Guide.
\n\nThe following operations are related to DeleteBucketReplication
:
\n PutBucketReplication\n
\n\n GetBucketReplication\n
\n\n The bucket name. \n
", + "smithy.api#documentation": "The bucket name.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -2581,13 +2642,6 @@ "com.amazonaws.s3#DeleteBucketRequest": { "type": "structure", "members": { - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Deletes the tags from the bucket.
\n \nTo use this operation, you must have permission to perform the s3:PutBucketTagging
action. By default, the bucket owner has this permission and can grant this permission to others. \n
The following operations are related to DeleteBucketTagging
:
\n GetBucketTagging\n
\n\n PutBucketTagging\n
\nDeletes the tags from the bucket.
\n\nTo use this operation, you must have permission to perform the\n s3:PutBucketTagging
action. By default, the bucket owner has this\n permission and can grant this permission to others.
The following operations are related to DeleteBucketTagging
:
\n GetBucketTagging\n
\n\n PutBucketTagging\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
This operation removes the website configuration for a bucket. Amazon S3 returns a 200 OK
response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK
response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404
response if the bucket specified in the request does not exist.
This DELETE operation requires the S3:DeleteBucketWebsite
permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite
permission.
For more information about hosting websites, see Hosting Websites on Amazon S3.\n
\n \nThe following operations are related to DeleteBucketWebsite
:
\n GetBucketWebsite\n
\n\n PutBucketWebsite\n
\nThis operation removes the website configuration for a bucket. Amazon S3 returns a 200\n OK
response upon successfully deleting a website configuration on the specified\n bucket. You will get a 200 OK
response if the website configuration you are\n trying to delete does not exist on the bucket. Amazon S3 returns a 404
response if\n the bucket specified in the request does not exist.
This DELETE operation requires the S3:DeleteBucketWebsite
permission. By\n default, only the bucket owner can delete the website configuration attached to a bucket.\n However, bucket owners can grant other users permission to delete the website configuration\n by writing a bucket policy granting them the S3:DeleteBucketWebsite
\n permission.
For more information about hosting websites, see Hosting Websites on Amazon S3.
\n\nThe following operations are related to DeleteBucketWebsite
:
\n GetBucketWebsite\n
\n\n PutBucketWebsite\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Version ID of an object.
" - } - }, - "LastModified": { - "target": "com.amazonaws.s3#LastModified", + "Owner": { + "target": "com.amazonaws.s3#Owner", "traits": { - "smithy.api#documentation": "Date and time the object was last modified.
" + "smithy.api#documentation": "The account that created the delete marker.>
" } }, "Key": { @@ -2690,16 +2745,22 @@ "smithy.api#documentation": "The object key.
" } }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "Version ID of an object.
" + } + }, "IsLatest": { "target": "com.amazonaws.s3#IsLatest", "traits": { - "smithy.api#documentation": "Specifies whether the object is (true) or is not (false) the latest version of an object.
" + "smithy.api#documentation": "Specifies whether the object is (true) or is not (false) the latest version of an\n object.
" } }, - "Owner": { - "target": "com.amazonaws.s3#Owner", + "LastModified": { + "target": "com.amazonaws.s3#LastModified", "traits": { - "smithy.api#documentation": "The account that created the delete marker.>
" + "smithy.api#documentation": "Date and time the object was last modified.
" } } }, @@ -2713,12 +2774,12 @@ "Status": { "target": "com.amazonaws.s3#DeleteMarkerReplicationStatus", "traits": { - "smithy.api#documentation": "Indicates whether to replicate delete markers.
\n In the current implementation, Amazon S3 doesn't replicate the delete markers. The status\n must be Disabled
.
Indicates whether to replicate delete markers.
\nIndicates whether to replicate delete markers.
\nSpecifies whether Amazon S3 replicates the delete markers. If you specify a Filter
, you must specify this element. However, in the latest version of replication configuration (when Filter
is specified), Amazon S3 doesn't replicate delete markers. Therefore, the DeleteMarkerReplication
element can contain only
If you don't specify the Filter
element, Amazon S3 assumes that the replication\n configuration is the earlier version, V1. In the earlier version, Amazon S3 handled\n replication of delete markers differently. For more information, see Backward Compatibility.
Specifies whether Amazon S3 replicates delete markers. If you specify a Filter
\n in your replication configuration, you must also include a\n DeleteMarkerReplication
element. If your Filter
includes a\n Tag
element, the DeleteMarkerReplication
\n Status
must be set to Disabled, because Amazon S3 does not support replicating\n delete markers for tag-based rules. For an example configuration, see Basic\n Rule Configuration.
For more information about delete marker replication, see Basic Rule Configuration.
\nIf you are using an earlier version of the replication configuration, Amazon S3 handles\n replication of delete markers differently. For more information, see Backward Compatibility.
\nRemoves the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.
\n \nTo remove a specific version, you must be the bucket owner and you must use the version\n Id subresource. Using this subresource permanently deletes the version. If the object\n deleted is a delete marker, Amazon S3 sets the response header,\n x-amz-delete-marker
, to true.
If the object you want to delete is in a bucket where the bucket versioning\n configuration is MFA Delete enabled, you must include the x-amz-mfa
request\n header in the DELETE versionId
request. Requests that include\n x-amz-mfa
must use HTTPS.
For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.
\n \nYou can delete objects by explicitly calling the DELETE Object API or configure its\n lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for\n you. If you want to block users or accounts from removing or deleting objects from your\n bucket, you must deny them the s3:DeleteObject
,\n s3:DeleteObjectVersion
, and s3:PutLifeCycleConfiguration
\n actions.
The following operation is related to DeleteObject
:
\n PutObject\n
\nRemoves the null version (if there is one) of an object and inserts a delete marker,\n which becomes the latest version of the object. If there isn't a null version, Amazon S3 does\n not remove any objects.
\n\nTo remove a specific version, you must be the bucket owner and you must use the version\n Id subresource. Using this subresource permanently deletes the version. If the object\n deleted is a delete marker, Amazon S3 sets the response header,\n x-amz-delete-marker
, to true.
If the object you want to delete is in a bucket where the bucket versioning\n configuration is MFA Delete enabled, you must include the x-amz-mfa
request\n header in the DELETE versionId
request. Requests that include\n x-amz-mfa
must use HTTPS.
For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.
\n\nYou can delete objects by explicitly calling the DELETE Object API or configure its\n lifecycle (PutBucketLifecycle) to\n enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or\n deleting objects from your bucket, you must deny them the s3:DeleteObject
,\n s3:DeleteObjectVersion
, and s3:PutLifeCycleConfiguration
\n actions.
The following operation is related to DeleteObject
:
\n PutObject\n
\nSpecifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker.
", + "smithy.api#documentation": "Specifies whether the versioned object that was permanently deleted was (true) or was\n not (false) a delete marker.
", "smithy.api#httpHeader": "x-amz-delete-marker" } }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - }, "VersionId": { "target": "com.amazonaws.s3#ObjectVersionId", "traits": { - "smithy.api#documentation": "Returns the version ID of the delete marker created as a result of the DELETE operation.
", + "smithy.api#documentation": "Returns the version ID of the delete marker created as a result of the DELETE\n operation.
", "smithy.api#httpHeader": "x-amz-version-id" } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" + } } } }, @@ -2796,18 +2857,19 @@ "smithy.api#required": {} } }, - "MFA": { - "target": "com.amazonaws.s3#MFA", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "The concatenation of the authentication device's serial number, a space, and the value that is\n displayed on your authentication device. Required to permanently delete a versioned object\n if versioning is configured with MFA delete enabled.
", - "smithy.api#httpHeader": "x-amz-mfa" + "smithy.api#documentation": "Key name of the object to delete.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", + "MFA": { + "target": "com.amazonaws.s3#MFA", "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device. Required to permanently delete a versioned\n object if versioning is configured with MFA delete enabled.
", + "smithy.api#httpHeader": "x-amz-mfa" } }, "VersionId": { @@ -2817,25 +2879,24 @@ "smithy.api#httpQuery": "versionId" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "Key name of the object to delete.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#httpHeader": "x-amz-request-payer" } }, "BypassGovernanceRetention": { "target": "com.amazonaws.s3#BypassGovernanceRetention", "traits": { - "smithy.api#documentation": "Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation.
", + "smithy.api#documentation": "Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process\n this operation.
", "smithy.api#httpHeader": "x-amz-bypass-governance-retention" } }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Removes the entire tag set from the specified object. For more information about \n managing object tags, see \n Object Tagging.
\n \nTo use this operation, you must have permission to perform the\n s3:DeleteObjectTagging
action.
To delete tags of a specific object version, add the versionId
query\n parameter in the request. You will need permission for the\n s3:DeleteObjectVersionTagging
action.
The following operations are related to\n DeleteBucketMetricsConfiguration
:
\n PutObjectTagging\n
\n\n GetObjectTagging\n
\nRemoves the entire tag set from the specified object. For more information about\n managing object tags, see Object\n Tagging.
\n\nTo use this operation, you must have permission to perform the\n s3:DeleteObjectTagging
action.
To delete tags of a specific object version, add the versionId
query\n parameter in the request. You will need permission for the\n s3:DeleteObjectVersionTagging
action.
The following operations are related to\n DeleteBucketMetricsConfiguration
:
\n PutObjectTagging\n
\n\n GetObjectTagging\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The versionId of the object that the tag-set will be removed from.
", "smithy.api#httpQuery": "versionId" } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.
\n \nThe request contains a list of up to 1000 keys that you want to delete. In the XML, you\n provide the object key names, and optionally, version IDs if you want to delete a specific\n version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a\n delete operation and returns the result of that delete, success, or failure, in the\n response. Note that if the object specified in the request is not found, Amazon S3 returns\n the result as deleted.
\n \nThe operation supports two modes for the response: verbose and quiet. By default, the\n operation uses verbose mode in which the response includes the result of deletion of each\n key in your request. In quiet mode the response includes only keys where the delete\n operation encountered an error. For a successful deletion, the operation does not return\n any information about the delete in the response body.
\n \nWhen performing this operation on an MFA Delete enabled bucket, that attempts to delete\n any versioned objects, you must include an MFA token. If you do not provide one, the entire\n request will fail, even if there are non-versioned objects you are trying to delete. If you\n provide an invalid token, whether there are versioned keys in the request or not, the\n entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete.
\n \nFinally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon\n S3 uses the header value to ensure that your request body has not been altered in\n transit.
\n \nThe following operations are related to DeleteObjects
:
\n UploadPart\n
\n\n ListParts\n
\n\n AbortMultipartUpload\n
\nThis operation enables you to delete multiple objects from a bucket using a single HTTP\n request. If you know the object keys that you want to delete, then this operation provides\n a suitable alternative to sending individual delete requests, reducing per-request\n overhead.
\n\nThe request contains a list of up to 1000 keys that you want to delete. In the XML, you\n provide the object key names, and optionally, version IDs if you want to delete a specific\n version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a\n delete operation and returns the result of that delete, success, or failure, in the\n response. Note that if the object specified in the request is not found, Amazon S3 returns the\n result as deleted.
\n\nThe operation supports two modes for the response: verbose and quiet. By default, the\n operation uses verbose mode in which the response includes the result of deletion of each\n key in your request. In quiet mode the response includes only keys where the delete\n operation encountered an error. For a successful deletion, the operation does not return\n any information about the delete in the response body.
\n\nWhen performing this operation on an MFA Delete enabled bucket, that attempts to delete\n any versioned objects, you must include an MFA token. If you do not provide one, the entire\n request will fail, even if there are non-versioned objects you are trying to delete. If you\n provide an invalid token, whether there are versioned keys in the request or not, the\n entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA\n Delete.
\n\nFinally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon\n S3 uses the header value to ensure that your request body has not been altered in\n transit.
\n\nThe following operations are related to DeleteObjects
:
\n UploadPart\n
\n\n ListParts\n
\n\n AbortMultipartUpload\n
\nContainer for a failed delete operation that describes the object that Amazon S3 attempted to delete and the error it encountered.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Error" - } - }, "Deleted": { "target": "com.amazonaws.s3#DeletedObjects", "traits": { - "smithy.api#documentation": "Container element for a successful delete. It identifies the object that was successfully deleted.
", + "smithy.api#documentation": "Container element for a successful delete. It identifies the object that was\n successfully deleted.
", "smithy.api#xmlFlattened": {} } }, @@ -2945,23 +2998,53 @@ "traits": { "smithy.api#httpHeader": "x-amz-request-charged" } + }, + "Errors": { + "target": "com.amazonaws.s3#Errors", + "traits": { + "smithy.api#documentation": "Container for a failed delete operation that describes the object that Amazon S3 attempted to\n delete and the error it encountered.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Error" + } } } }, "com.amazonaws.s3#DeleteObjectsRequest": { "type": "structure", "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "The bucket name containing the objects to delete.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "Delete": { + "target": "com.amazonaws.s3#Delete", + "traits": { + "smithy.api#documentation": "Container for the request.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, "MFA": { "target": "com.amazonaws.s3#MFA", "traits": { - "smithy.api#documentation": "The concatenation of the authentication device's serial number, a space, and the value that is\n displayed on your authentication device. Required to permanently delete a versioned object\n if versioning is configured with MFA delete enabled.
", + "smithy.api#documentation": "The concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device. Required to permanently delete a versioned\n object if versioning is configured with MFA delete enabled.
", "smithy.api#httpHeader": "x-amz-mfa" } }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, "BypassGovernanceRetention": { "target": "com.amazonaws.s3#BypassGovernanceRetention", "traits": { - "smithy.api#documentation": "Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. You must have sufficient permissions to perform this operation.
", + "smithy.api#documentation": "Specifies whether you want to delete this object even if it has a Governance-type Object\n Lock in place. You must have sufficient permissions to perform this operation.
", "smithy.api#httpHeader": "x-amz-bypass-governance-retention" } }, @@ -2971,28 +3054,6 @@ "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The bucket name containing the objects to delete.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "Delete": { - "target": "com.amazonaws.s3#Delete", - "traits": { - "smithy.api#documentation": "Container for the request.
", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } } } }, @@ -3002,7 +3063,7 @@ "target": "com.amazonaws.s3#DeletePublicAccessBlockRequest" }, "traits": { - "smithy.api#documentation": "Removes the PublicAccessBlock
configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock
permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
The following operations are related to DeletePublicAccessBlock
:
\n GetPublicAccessBlock\n
\n\n PutPublicAccessBlock\n
\nRemoves the PublicAccessBlock
configuration for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketPublicAccessBlock
permission. For\n more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
The following operations are related to DeletePublicAccessBlock
:
\n GetPublicAccessBlock\n
\n\n PutPublicAccessBlock\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The Amazon S3 bucket whose PublicAccessBlock
configuration you want to\n delete.
The Amazon S3 bucket whose PublicAccessBlock
configuration you want to delete.\n
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Specifies whether the versioned object that was permanently deleted was (true) or was not (false) a delete marker. In a simple DELETE, this header indicates whether (true) or not (false) a delete marker was created.
" - } - }, "Key": { "target": "com.amazonaws.s3#ObjectKey", "traits": { @@ -3051,10 +3106,16 @@ "smithy.api#documentation": "The version ID of the deleted object.
" } }, + "DeleteMarker": { + "target": "com.amazonaws.s3#DeleteMarker", + "traits": { + "smithy.api#documentation": "Specifies whether the versioned object that was permanently deleted was (true) or was\n not (false) a delete marker. In a simple DELETE, this header indicates whether (true) or\n not (false) a delete marker was created.
" + } + }, "DeleteMarkerVersionId": { "target": "com.amazonaws.s3#DeleteMarkerVersionId", "traits": { - "smithy.api#documentation": "The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object version, the value returned by this header is the version ID of the object version deleted.
" + "smithy.api#documentation": "The version ID of the delete marker created as a result of the DELETE operation. If you\n delete a specific object version, the value returned by this header is the version ID of\n the object version deleted.
" } } }, @@ -3077,52 +3138,52 @@ "com.amazonaws.s3#Destination": { "type": "structure", "members": { - "EncryptionConfiguration": { - "target": "com.amazonaws.s3#EncryptionConfiguration", - "traits": { - "smithy.api#documentation": "A container that provides information about encryption. If\n SourceSelectionCriteria
is specified, you must specify this element.
The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the\n results.
", "smithy.api#required": {} } }, "Account": { "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3\n to change replica ownership to the AWS account that owns the destination bucket by\n specifying the AccessControlTranslation
property, this is the account ID of\n the destination bucket owner. For more information, see Replication Additional\n Configuration: Changing the Replica Owner in the Amazon Simple Storage\n Service Developer Guide.
Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to\n change replica ownership to the AWS account that owns the destination bucket by specifying\n the AccessControlTranslation
property, this is the account ID of the\n destination bucket owner. For more information, see Replication Additional\n Configuration: Changing the Replica Owner in the Amazon Simple Storage\n Service Developer Guide.
\n The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica.\n
\nFor valid values, see the StorageClass
element of the\n PUT Bucket\n replication action in the Amazon Simple Storage Service API Reference.
The storage class to use when replicating objects, such as S3 Standard or reduced\n redundancy. By default, Amazon S3 uses the storage class of the source object to create the\n object replica.
\nFor valid values, see the StorageClass
element of the PUT Bucket\n replication action in the Amazon Simple Storage Service API Reference.
\n A container specifying replication metrics-related settings enabling metrics and Amazon S3 events for S3 Replication Time Control (S3 RTC). \n Must be specified together with a ReplicationTime
block.\n
Specify this only in a cross-account scenario (where source and destination bucket\n owners are not the same), and you want to change replica ownership to the AWS account that\n owns the destination bucket. If this is not specified in the replication configuration, the\n replicas are owned by same AWS account that owns the source object.
" } }, - "AccessControlTranslation": { - "target": "com.amazonaws.s3#AccessControlTranslation", + "EncryptionConfiguration": { + "target": "com.amazonaws.s3#EncryptionConfiguration", "traits": { - "smithy.api#documentation": "Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the AWS account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same AWS account that owns the source object.
" + "smithy.api#documentation": "A container that provides information about encryption. If\n SourceSelectionCriteria
is specified, you must specify this element.
\n A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. \n Must be specified together with a Metrics
block.\n
A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time\n when all objects and operations on objects must be replicated. Must be specified together\n with a Metrics
block.
A container specifying replication metrics-related settings enabling replication\n metrics and events.
" } } }, "traits": { - "smithy.api#documentation": "Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket\n and S3 Replication Time Control (S3 RTC).
" + "smithy.api#documentation": "Specifies information about where to publish analysis or configuration results for an\n Amazon S3 bucket and S3 Replication Time Control (S3 RTC).
" } }, "com.amazonaws.s3#DisplayName": { @@ -3140,7 +3201,7 @@ "com.amazonaws.s3#EncodingType": { "type": "string", "traits": { - "smithy.api#documentation": "Requests Amazon S3 to encode the object keys in the response and specifies the encoding method to use. An object key may contain any Unicode character; however, XML 1.0 parser cannot parse some characters, such as characters with an ASCII value from 0 to 10. For characters that are not supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response.
", + "smithy.api#documentation": "Requests Amazon S3 to encode the object keys in the response and specifies the encoding\n method to use. An object key may contain any Unicode character; however, XML 1.0 parser\n cannot parse some characters, such as characters with an ASCII value from 0 to 10. For\n characters that are not supported in XML 1.0, you can add this parameter to request that\n Amazon S3 encode the keys in the response.
", "smithy.api#enum": [ { "value": "url" @@ -3151,23 +3212,23 @@ "com.amazonaws.s3#Encryption": { "type": "structure", "members": { + "EncryptionType": { + "target": "com.amazonaws.s3#ServerSideEncryption", + "traits": { + "smithy.api#documentation": "The server-side encryption algorithm used when storing job results in Amazon S3 (for example,\n AES256, aws:kms).
", + "smithy.api#required": {} + } + }, "KMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "If the encryption type is aws:kms
, this optional value specifies the ID of the symmetric customer managed AWS KMS CMK\n to use for encryption of job results. Amazon S3 only supports symmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.
If the encryption type is aws:kms
, this optional value specifies the ID of\n the symmetric customer managed AWS KMS CMK to use for encryption of job results. Amazon S3 only\n supports symmetric CMKs. For more information, see Using Symmetric and\n Asymmetric Keys in the AWS Key Management Service Developer\n Guide.
If the encryption type is aws:kms
, this optional value can be used to specify the\n encryption context for the restore results.
The server-side encryption algorithm used when storing job results in Amazon S3 (for example,\n AES256, aws:kms).
", - "smithy.api#required": {} + "smithy.api#documentation": "If the encryption type is aws:kms
, this optional value can be used to\n specify the encryption context for the restore results.
Specifies the ID (Key ARN or Alias ARN) of the customer managed customer master key (CMK) stored in AWS Key Management Service (KMS) for the destination bucket. Amazon\n S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric customer managed CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.
" + "smithy.api#documentation": "Specifies the ID (Key ARN or Alias ARN) of the customer managed customer master key\n (CMK) stored in AWS Key Management Service (KMS) for the destination bucket. Amazon S3 uses\n this key to encrypt replica objects. Amazon S3 only supports symmetric customer managed CMKs.\n For more information, see Using Symmetric and\n Asymmetric Keys in the AWS Key Management Service Developer\n Guide.
" } } }, "traits": { - "smithy.api#documentation": "Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.
" + "smithy.api#documentation": "Specifies encryption-related information for an Amazon S3 bucket that is a destination for\n replicated objects.
" } }, "com.amazonaws.s3#End": { @@ -3196,24 +3257,12 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "A message that indicates the request is complete and no more messages will be sent. You should not assume that the request is complete until the client receives an EndEvent
.
A message that indicates the request is complete and no more messages will be sent. You\n should not assume that the request is complete until the client receives an\n EndEvent
.
The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don't know how or don't care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.
" - } - }, - "Code": { - "target": "com.amazonaws.s3#Code", - "traits": { - "smithy.api#documentation": "The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
\n\n Amazon S3 error codes\n
\n\n Code: AccessDenied
\n\n Description: Access Denied
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AccountProblem
\n\n Description: There is a problem with your AWS account that prevents the operation\n\t\t\t\t\t\t\tfrom completing successfully. \n\t\t\t\t\t\t\tContact AWS Support for further assistance.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AllAccessDisabled
\n\n Description: All access to this Amazon S3 resource has been disabled. \n\t\t\t\t\t\t\tContact AWS Support for further assistance.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AmbiguousGrantByEmailAddress
\n\n Description: The email address you provided is associated with more than one\n\t\t\t\t\t\t\taccount.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AuthorizationHeaderMalformed
\n\t\t\t\t\t\t\n Description: The authorization header you provided is invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n HTTP Status Code: N/A
\n\n Code: BadDigest
\n\n Description: The Content-MD5 you specified did not match what we received.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: BucketAlreadyExists
\n\n Description: The requested bucket name is not available. The bucket namespace is\n\t\t\t\t\t\t\tshared by all users of the system. Please select a different name and\n\t\t\t\t\t\t\ttry again.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: BucketAlreadyOwnedByYou
\n\n Description: The bucket you tried to create already exists, and you own\n it. Amazon S3 returns this error in all AWS Regions except in the North Virginia\n Region. For legacy compatibility, if you re-create an existing bucket that you\n already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the\n bucket access control lists (ACLs).
\n\n Code: 409 Conflict (in all Regions except the North Virginia Region)
\n\n SOAP Fault Code Prefix: Client
\n\n Code: BucketNotEmpty
\n\n Description: The bucket you tried to delete is not empty.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: CredentialsNotSupported
\n\n Description: This request does not support credentials.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: CrossLocationLoggingProhibited
\n\n Description: Cross-location logging not allowed. Buckets in one geographic\n\t\t\t\t\t\t\tlocation cannot log information to a bucket in another location.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: EntityTooSmall
\n\n Description: Your proposed upload is smaller than the minimum allowed object\n\t\t\t\t\t\t\tsize.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: EntityTooLarge
\n\n Description: Your proposed upload exceeds the maximum allowed object size.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: ExpiredToken
\n\n Description: The provided token has expired.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: IllegalVersioningConfigurationException
\n\n Description: Indicates that the versioning configuration specified in the request\n\t\t\t\t\t\t\tis invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: IncompleteBody
\n\n Description: You did not provide the number of bytes specified by the\n\t\t\t\t\t\t\tContent-Length HTTP header
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: IncorrectNumberOfFilesInPostRequest
\n\n Description: POST requires exactly one file upload per request.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InlineDataTooLarge
\n\n Description: Inline data exceeds the maximum allowed size.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InternalError
\n\n Description: We encountered an internal error. Please try again.
\n\n HTTP Status Code: 500 Internal Server Error
\n\n SOAP Fault Code Prefix: Server
\n\n Code: InvalidAccessKeyId
\n\n Description: The AWS access key ID you provided does not exist in our records.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidAddressingHeader
\n\n Description: You must specify the Anonymous role.
\n\n HTTP Status Code: N/A
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidArgument
\n\n Description: Invalid Argument
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidBucketName
\n\n Description: The specified bucket is not valid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidBucketState
\n\n Description: The request is not valid with the current state of the bucket.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidDigest
\n\n Description: The Content-MD5 you specified is not valid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidEncryptionAlgorithmError
\n\n Description: The encryption request you specified is not valid. The valid value is AES256.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidLocationConstraint
\n\n Description: The specified location constraint is not valid. For more information about Regions, see\n\t\t\t\t\t\t\t\tHow to\n\t\t\t\t\t\t\t\tSelect a Region for Your Buckets.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidObjectState
\n\n Description: The operation is not valid for the current state of the object.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPart
\n\n Description: One or more of the specified parts could not be found. The part might not have been\n\t\t\t\t\t\t\tuploaded, or the specified entity tag might not have matched the part's\n\t\t\t\t\t\t\tentity tag.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPartOrder
\n\n Description: The list of parts was not in ascending order. Parts list must be specified in order by\n\t\t\t\t\t\t\tpart number.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPayer
\n\n Description: All access to this object has been disabled. \n\t\t\t\t\t\t\tPlease contact AWS Support for further assistance.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPolicyDocument
\n\n Description: The content of the form does not meet the conditions specified in the\n\t\t\t\t\t\t\tpolicy document.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidRange
\n\n Description: The requested range cannot be satisfied.
\n\n HTTP Status Code: 416 Requested Range Not Satisfiable
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidRequest
\n\n Description: Please use AWS4-HMAC-SHA256.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: SOAP requests must be made over an HTTPS connection.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration is not supported for buckets with non-DNS compliant\n\t\t\t\t\t\t\tnames.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration is not supported for buckets with periods (.) in their\n\t\t\t\t\t\t\tnames.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Accelerate endpoint only supports virtual style requests.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Accelerate is not configured on this bucket.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Accelerate is disabled on this bucket.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration is not supported on this bucket. Contact AWS Support for\n\t\t\t\t\t\t\tmore information.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration cannot be enabled on this bucket. Contact AWS Support for\n\t\t\t\t\t\t\tmore information.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidSecurity
\n\n Description: The provided security credentials are not valid.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidSOAPRequest
\n\n Description: The SOAP request body is invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidStorageClass
\n\n Description: The storage class you specified is not valid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidTargetBucketForLogging
\n\n Description: The target bucket for logging does not exist, is not owned by you, or\n\t\t\t\t\t\t\tdoes not have the appropriate grants for the log-delivery group.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidToken
\n\n Description: The provided token is malformed or otherwise invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidURI
\n\n Description: Couldn't parse the specified URI.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: KeyTooLongError
\n\n Description: Your key is too long.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MalformedACLError
\n\n Description: The XML you provided was not well-formed or did not validate against\n\t\t\t\t\t\t\tour published schema.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MalformedPOSTRequest
\n\n Description: The body of your POST request is not well-formed\n\t\t\t\t\t\t\tmultipart/form-data.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MalformedXML
\n\n Description: This happens when the user sends malformed XML (XML that doesn't conform to the\n\t\t\t\t\t\t\tpublished XSD) for the configuration. The error message is, \"The XML you\n\t\t\t\t\t\t\tprovided was not well-formed or did not validate against our published\n\t\t\t\t\t\t\tschema.\"
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MaxMessageLengthExceeded
\n\n Description: Your request was too big.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MaxPostPreDataLengthExceededError
\n\n Description: Your POST request fields preceding the upload file were too\n\t\t\t\t\t\t\tlarge.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MetadataTooLarge
\n\n Description: Your metadata headers exceed the maximum allowed metadata\n\t\t\t\t\t\t\tsize.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MethodNotAllowed
\n\n Description: The specified method is not allowed against this resource.
\n\n HTTP Status Code: 405 Method Not Allowed
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingAttachment
\n\n Description: A SOAP attachment was expected, but none were found.
\n\n HTTP Status Code: N/A
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingContentLength
\n\n Description: You must provide the Content-Length HTTP header.
\n\n HTTP Status Code: 411 Length Required
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingRequestBodyError
\n\n Description: This happens when the user sends an empty XML document as a request. The error message\n\t\t\t\t\t\t\tis, \"Request body is empty.\"
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingSecurityElement
\n\n Description: The SOAP 1.1 request is missing a security element.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingSecurityHeader
\n\n Description: Your request is missing a required header.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoLoggingStatusForKey
\n\n Description: There is no such thing as a logging status subresource for a\n\t\t\t\t\t\t\tkey.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchBucket
\n\n Description: The specified bucket does not exist.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchBucketPolicy
\n\n Description: The specified bucket does not have a bucket policy.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchKey
\n\n Description: The specified key does not exist.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchLifecycleConfiguration
\n\n Description: The lifecycle configuration does not exist.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchUpload
\n\n Description: The specified multipart upload does not exist. The upload ID might be invalid, or the\n\t\t\t\t\t\t\tmultipart upload might have been aborted or completed.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchVersion
\n\n Description: Indicates that the version ID specified in the request does not match\n\t\t\t\t\t\t\tan existing version.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NotImplemented
\n\n Description: A header you provided implies functionality that is not\n\t\t\t\t\t\t\timplemented.
\n\n HTTP Status Code: 501 Not Implemented
\n\n SOAP Fault Code Prefix: Server
\n\n Code: NotSignedUp
\n\n Description: Your account is not signed up for the Amazon S3 service. You must sign up\n\t\t\t\t\t\t\tbefore you can use Amazon S3. You can sign up at the following URL:\n\t\t\t\t\t\t\thttps://aws.amazon.com/s3
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: OperationAborted
\n\n Description: A conflicting conditional operation is currently in progress against\n\t\t\t\t\t\t\tthis resource. Try again.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: PermanentRedirect
\n\n Description: The bucket you are attempting to access must be addressed using the\n\t\t\t\t\t\t\tspecified endpoint. Send all future requests to this\n\t\t\t\t\t\t\tendpoint.
\n\n HTTP Status Code: 301 Moved Permanently
\n\n SOAP Fault Code Prefix: Client
\n\n Code: PreconditionFailed
\n\n Description: At least one of the preconditions you specified did not hold.
\n\n HTTP Status Code: 412 Precondition Failed
\n\n SOAP Fault Code Prefix: Client
\n\n Code: Redirect
\n\n Description: Temporary redirect.
\n\n HTTP Status Code: 307 Moved Temporarily
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RestoreAlreadyInProgress
\n\n Description: Object restore is already in progress.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestIsNotMultiPartContent
\n\n Description: Bucket POST must be of the enclosure-type\n\t\t\t\t\t\t\tmultipart/form-data.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestTimeout
\n\n Description: Your socket connection to the server was not read from or written to\n\t\t\t\t\t\t\twithin the timeout period.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestTimeTooSkewed
\n\n Description: The difference between the request time and the server's time is too\n\t\t\t\t\t\t\tlarge.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestTorrentOfBucketError
\n\n Description: Requesting the torrent file of a bucket is not permitted.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: SignatureDoesNotMatch
\n\n Description: The request signature we calculated does not match the signature you\n\t\t\t\t\t\t\tprovided. Check your AWS secret access key and signing method. For more\n\t\t\t\t\t\t\tinformation, see REST Authentication and SOAP Authentication for details.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: ServiceUnavailable
\n\n Description: Reduce your request rate.
\n\n HTTP Status Code: 503 Service Unavailable
\n\n SOAP Fault Code Prefix: Server
\n\n Code: SlowDown
\n\n Description: Reduce your request rate.
\n\n HTTP Status Code: 503 Slow Down
\n\n SOAP Fault Code Prefix: Server
\n\n Code: TemporaryRedirect
\n\n Description: You are being redirected to the bucket while DNS updates.
\n\n HTTP Status Code: 307 Moved Temporarily
\n\n SOAP Fault Code Prefix: Client
\n\n Code: TokenRefreshRequired
\n\n Description: The provided token must be refreshed.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: TooManyBuckets
\n\n Description: You have attempted to create more buckets than allowed.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: UnexpectedContent
\n\n Description: This request does not support content.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: UnresolvableGrantByEmailAddress
\n\n Description: The email address you provided does not match any account on\n\t\t\t\t\t\t\trecord.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: UserKeyMustBeSpecified
\n\n Description: The bucket POST must contain the specified field name. If it is\n\t\t\t\t\t\t\tspecified, check the order of the fields.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\nThe version ID of the error.
" } + }, + "Code": { + "target": "com.amazonaws.s3#Code", + "traits": { + "smithy.api#documentation": "The error code is a string that uniquely identifies an error condition. It is meant to\n be read and understood by programs that detect and handle errors by type.
\n\n Amazon S3 error codes\n
\n\n Code: AccessDenied
\n\n Description: Access Denied
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AccountProblem
\n\n Description: There is a problem with your AWS account\n that prevents the operation from completing successfully. Contact AWS Support\n for further assistance.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AllAccessDisabled
\n\n Description: All access to this Amazon S3 resource has been\n disabled. Contact AWS Support for further assistance.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AmbiguousGrantByEmailAddress
\n\n Description: The email address you provided is\n associated with more than one account.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: AuthorizationHeaderMalformed
\n\n Description: The authorization header you provided is\n invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n HTTP Status Code: N/A
\n\n Code: BadDigest
\n\n Description: The Content-MD5 you specified did not\n match what we received.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: BucketAlreadyExists
\n\n Description: The requested bucket name is not\n available. The bucket namespace is shared by all users of the system. Please\n select a different name and try again.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: BucketAlreadyOwnedByYou
\n\n Description: The bucket you tried to create already\n exists, and you own it. Amazon S3 returns this error in all AWS Regions except in\n the North Virginia Region. For legacy compatibility, if you re-create an\n existing bucket that you already own in the North Virginia Region, Amazon S3 returns\n 200 OK and resets the bucket access control lists (ACLs).
\n\n Code: 409 Conflict (in all Regions except the North\n Virginia Region)
\n\n SOAP Fault Code Prefix: Client
\n\n Code: BucketNotEmpty
\n\n Description: The bucket you tried to delete is not\n empty.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: CredentialsNotSupported
\n\n Description: This request does not support\n credentials.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: CrossLocationLoggingProhibited
\n\n Description: Cross-location logging not allowed.\n Buckets in one geographic location cannot log information to a bucket in\n another location.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: EntityTooSmall
\n\n Description: Your proposed upload is smaller than the\n minimum allowed object size.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: EntityTooLarge
\n\n Description: Your proposed upload exceeds the maximum\n allowed object size.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: ExpiredToken
\n\n Description: The provided token has expired.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: IllegalVersioningConfigurationException
\n\n Description: Indicates that the versioning\n configuration specified in the request is invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: IncompleteBody
\n\n Description: You did not provide the number of bytes\n specified by the Content-Length HTTP header
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: IncorrectNumberOfFilesInPostRequest
\n\n Description: POST requires exactly one file upload per\n request.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InlineDataTooLarge
\n\n Description: Inline data exceeds the maximum allowed\n size.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InternalError
\n\n Description: We encountered an internal error. Please\n try again.
\n\n HTTP Status Code: 500 Internal Server Error
\n\n SOAP Fault Code Prefix: Server
\n\n Code: InvalidAccessKeyId
\n\n Description: The AWS access key ID you provided does\n not exist in our records.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidAddressingHeader
\n\n Description: You must specify the Anonymous\n role.
\n\n HTTP Status Code: N/A
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidArgument
\n\n Description: Invalid Argument
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidBucketName
\n\n Description: The specified bucket is not valid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidBucketState
\n\n Description: The request is not valid with the current\n state of the bucket.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidDigest
\n\n Description: The Content-MD5 you specified is not\n valid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidEncryptionAlgorithmError
\n\n Description: The encryption request you specified is\n not valid. The valid value is AES256.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidLocationConstraint
\n\n Description: The specified location constraint is not\n valid. For more information about Regions, see How to Select a\n Region for Your Buckets.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidObjectState
\n\n Description: The operation is not valid for the current\n state of the object.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPart
\n\n Description: One or more of the specified parts could\n not be found. The part might not have been uploaded, or the specified entity\n tag might not have matched the part's entity tag.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPartOrder
\n\n Description: The list of parts was not in ascending\n order. Parts list must be specified in order by part number.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPayer
\n\n Description: All access to this object has been\n disabled. Please contact AWS Support for further assistance.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidPolicyDocument
\n\n Description: The content of the form does not meet the\n conditions specified in the policy document.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidRange
\n\n Description: The requested range cannot be\n satisfied.
\n\n HTTP Status Code: 416 Requested Range Not\n Satisfiable
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidRequest
\n\n Description: Please use AWS4-HMAC-SHA256.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: SOAP requests must be made over an HTTPS\n connection.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration is not\n supported for buckets with non-DNS compliant names.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration is not\n supported for buckets with periods (.) in their names.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Accelerate endpoint only\n supports virtual style requests.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Accelerate is not configured\n on this bucket.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Accelerate is disabled on\n this bucket.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration is not\n supported on this bucket. Contact AWS Support for more information.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidRequest
\n\n Description: Amazon S3 Transfer Acceleration cannot be\n enabled on this bucket. Contact AWS Support for more information.
\n\n HTTP Status Code: 400 Bad Request
\n\n Code: N/A
\n\n Code: InvalidSecurity
\n\n Description: The provided security credentials are not\n valid.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidSOAPRequest
\n\n Description: The SOAP request body is invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidStorageClass
\n\n Description: The storage class you specified is not\n valid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidTargetBucketForLogging
\n\n Description: The target bucket for logging does not\n exist, is not owned by you, or does not have the appropriate grants for the\n log-delivery group.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidToken
\n\n Description: The provided token is malformed or\n otherwise invalid.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: InvalidURI
\n\n Description: Couldn't parse the specified URI.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: KeyTooLongError
\n\n Description: Your key is too long.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MalformedACLError
\n\n Description: The XML you provided was not well-formed\n or did not validate against our published schema.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MalformedPOSTRequest
\n\n Description: The body of your POST request is not\n well-formed multipart/form-data.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MalformedXML
\n\n Description: This happens when the user sends malformed\n XML (XML that doesn't conform to the published XSD) for the configuration. The\n error message is, \"The XML you provided was not well-formed or did not validate\n against our published schema.\"
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MaxMessageLengthExceeded
\n\n Description: Your request was too big.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MaxPostPreDataLengthExceededError
\n\n Description: Your POST request fields preceding the\n upload file were too large.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MetadataTooLarge
\n\n Description: Your metadata headers exceed the maximum\n allowed metadata size.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MethodNotAllowed
\n\n Description: The specified method is not allowed\n against this resource.
\n\n HTTP Status Code: 405 Method Not Allowed
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingAttachment
\n\n Description: A SOAP attachment was expected, but none\n were found.
\n\n HTTP Status Code: N/A
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingContentLength
\n\n Description: You must provide the Content-Length HTTP\n header.
\n\n HTTP Status Code: 411 Length Required
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingRequestBodyError
\n\n Description: This happens when the user sends an empty\n XML document as a request. The error message is, \"Request body is empty.\"\n
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingSecurityElement
\n\n Description: The SOAP 1.1 request is missing a security\n element.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: MissingSecurityHeader
\n\n Description: Your request is missing a required\n header.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoLoggingStatusForKey
\n\n Description: There is no such thing as a logging status\n subresource for a key.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchBucket
\n\n Description: The specified bucket does not\n exist.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchBucketPolicy
\n\n Description: The specified bucket does not have a\n bucket policy.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchKey
\n\n Description: The specified key does not exist.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchLifecycleConfiguration
\n\n Description: The lifecycle configuration does not\n exist.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchUpload
\n\n Description: The specified multipart upload does not\n exist. The upload ID might be invalid, or the multipart upload might have been\n aborted or completed.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NoSuchVersion
\n\n Description: Indicates that the version ID specified in\n the request does not match an existing version.
\n\n HTTP Status Code: 404 Not Found
\n\n SOAP Fault Code Prefix: Client
\n\n Code: NotImplemented
\n\n Description: A header you provided implies\n functionality that is not implemented.
\n\n HTTP Status Code: 501 Not Implemented
\n\n SOAP Fault Code Prefix: Server
\n\n Code: NotSignedUp
\n\n Description: Your account is not signed up for the Amazon S3\n service. You must sign up before you can use Amazon S3. You can sign up at the\n following URL: https://aws.amazon.com/s3
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: OperationAborted
\n\n Description: A conflicting conditional operation is\n currently in progress against this resource. Try again.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: PermanentRedirect
\n\n Description: The bucket you are attempting to access\n must be addressed using the specified endpoint. Send all future requests to\n this endpoint.
\n\n HTTP Status Code: 301 Moved Permanently
\n\n SOAP Fault Code Prefix: Client
\n\n Code: PreconditionFailed
\n\n Description: At least one of the preconditions you\n specified did not hold.
\n\n HTTP Status Code: 412 Precondition Failed
\n\n SOAP Fault Code Prefix: Client
\n\n Code: Redirect
\n\n Description: Temporary redirect.
\n\n HTTP Status Code: 307 Moved Temporarily
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RestoreAlreadyInProgress
\n\n Description: Object restore is already in\n progress.
\n\n HTTP Status Code: 409 Conflict
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestIsNotMultiPartContent
\n\n Description: Bucket POST must be of the enclosure-type\n multipart/form-data.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestTimeout
\n\n Description: Your socket connection to the server was\n not read from or written to within the timeout period.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestTimeTooSkewed
\n\n Description: The difference between the request time\n and the server's time is too large.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: RequestTorrentOfBucketError
\n\n Description: Requesting the torrent file of a bucket is\n not permitted.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: SignatureDoesNotMatch
\n\n Description: The request signature we calculated does\n not match the signature you provided. Check your AWS secret access key and\n signing method. For more information, see REST Authentication and\n SOAP Authentication\n for details.
\n\n HTTP Status Code: 403 Forbidden
\n\n SOAP Fault Code Prefix: Client
\n\n Code: ServiceUnavailable
\n\n Description: Reduce your request rate.
\n\n HTTP Status Code: 503 Service Unavailable
\n\n SOAP Fault Code Prefix: Server
\n\n Code: SlowDown
\n\n Description: Reduce your request rate.
\n\n HTTP Status Code: 503 Slow Down
\n\n SOAP Fault Code Prefix: Server
\n\n Code: TemporaryRedirect
\n\n Description: You are being redirected to the bucket\n while DNS updates.
\n\n HTTP Status Code: 307 Moved Temporarily
\n\n SOAP Fault Code Prefix: Client
\n\n Code: TokenRefreshRequired
\n\n Description: The provided token must be\n refreshed.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: TooManyBuckets
\n\n Description: You have attempted to create more buckets\n than allowed.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: UnexpectedContent
\n\n Description: This request does not support\n content.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: UnresolvableGrantByEmailAddress
\n\n Description: The email address you provided does not\n match any account on record.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\n\n Code: UserKeyMustBeSpecified
\n\n Description: The bucket POST must contain the specified\n field name. If it is specified, check the order of the fields.
\n\n HTTP Status Code: 400 Bad Request
\n\n SOAP Fault Code Prefix: Client
\nThe error message contains a generic description of the error condition in English. It\n is intended for a human audience. Simple programs display the message directly to the end\n user if they encounter an error condition they don't know how or don't care to handle.\n Sophisticated programs with more exhaustive error handling and proper internationalization\n are more likely to ignore the error message.
" + } } }, "traits": { @@ -3329,7 +3390,7 @@ } }, "traits": { - "smithy.api#documentation": "Optional configuration to replicate existing source bucket objects. For more\n information, see Replicating Existing Objects in the Amazon S3 Developer\n Guide.
" + "smithy.api#documentation": "Optional configuration to replicate existing source bucket objects. For more\n information, see Replicating Existing Objects in the Amazon S3 Developer Guide.\n
" } }, "com.amazonaws.s3#ExistingObjectReplicationStatus": { @@ -3420,7 +3481,7 @@ "Name": { "target": "com.amazonaws.s3#FilterRuleName", "traits": { - "smithy.api#documentation": "The object key name prefix or suffix identifying one or more objects to which the filtering\n rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes\n are not supported. For more information, see Configuring Event Notifications in\n the Amazon Simple Storage Service Developer Guide.
" + "smithy.api#documentation": "The object key name prefix or suffix identifying one or more objects to which the\n filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and\n suffixes are not supported. For more information, see Configuring Event Notifications\n in the Amazon Simple Storage Service Developer Guide.
" } }, "Value": { @@ -3431,7 +3492,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or prefix of the key name.
" + "smithy.api#documentation": "Specifies the Amazon S3 object key name to filter on and whether to filter on the suffix or\n prefix of the key name.
" } }, "com.amazonaws.s3#FilterRuleList": { @@ -3468,7 +3529,7 @@ "target": "com.amazonaws.s3#GetBucketAccelerateConfigurationOutput" }, "traits": { - "smithy.api#documentation": "This implementation of the GET operation uses the accelerate
subresource to return the Transfer Acceleration \n state of a bucket, which is either Enabled
or Suspended
. Amazon S3 Transfer Acceleration is a bucket-level \n feature that enables you to perform faster data transfers to and from Amazon S3.
To use this operation, you must have permission to perform the\n s3:GetAccelerateConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.
You set the Transfer Acceleration state of an existing bucket to Enabled
or Suspended
by using \n the PutBucketAccelerateConfiguration operation.
A GET accelerate
request does not return a state value for a bucket that has\n no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has\n never been set on the bucket.
For more information about transfer acceleration, see Transfer Acceleration in the\n Amazon Simple Storage Service Developer Guide.
\n\n Related Resources\n
\nThis implementation of the GET operation uses the accelerate
subresource to\n return the Transfer Acceleration state of a bucket, which is either Enabled
or\n Suspended
. Amazon S3 Transfer Acceleration is a bucket-level feature that\n enables you to perform faster data transfers to and from Amazon S3.
To use this operation, you must have permission to perform the\n s3:GetAccelerateConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.
You set the Transfer Acceleration state of an existing bucket to Enabled
or\n Suspended
by using the PutBucketAccelerateConfiguration operation.
A GET accelerate
request does not return a state value for a bucket that\n has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state\n has never been set on the bucket.
For more information about transfer acceleration, see Transfer Acceleration in the\n Amazon Simple Storage Service Developer Guide.
\n\n Related Resources\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
This implementation of the GET
operation uses the acl
subresource to return the access control list (ACL) of a bucket. \n To use GET
to return the ACL of the bucket, you must have READ_ACP
access to the bucket. If READ_ACP
\n permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.
\n Related Resources\n
\n\n ListObjects\n
\nThis implementation of the GET
operation uses the acl
\n subresource to return the access control list (ACL) of a bucket. To use GET
to\n return the ACL of the bucket, you must have READ_ACP
access to the bucket. If\n READ_ACP
permission is granted to the anonymous user, you can return the\n ACL of the bucket without using an authorization header.
\n Related Resources\n
\n\n ListObjects\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
This implementation of the GET operation returns an analytics configuration (identified by\n the analytics configuration ID) from the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration
action. The bucket owner has this\n permission by default. The bucket owner can grant this permission to others. For more\n information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the\n Amazon Simple Storage Service Developer Guide.
\n \n\n Related Resources\n
\nThis implementation of the GET operation returns an analytics configuration (identified\n by the analytics configuration ID) from the bucket.
\nTo use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis in the Amazon Simple Storage Service Developer Guide.
\n \n\n Related Resources\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Returns the cors configuration information set for the bucket.
\n \nTo use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.
\n \nFor more information about cors, see Enabling Cross-Origin\n Resource Sharing.
\n \nThe following operations are related to GetBucketCors
:
\n PutBucketCors\n
\n\n DeleteBucketCors\n
\nReturns the cors configuration information set for the bucket.
\n\nTo use this operation, you must have permission to perform the s3:GetBucketCORS action.\n By default, the bucket owner has this permission and can grant it to others.
\n\nFor more information about cors, see Enabling\n Cross-Origin Resource Sharing.
\n\nThe following operations are related to GetBucketCors
:
\n PutBucketCors\n
\n\n DeleteBucketCors\n
\nA set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.
", + "smithy.api#documentation": "A set of origins and methods (cross-origin access that you want to allow). You can add\n up to 100 rules to the configuration.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "CORSRule" } @@ -3678,7 +3739,7 @@ "target": "com.amazonaws.s3#GetBucketEncryptionOutput" }, "traits": { - "smithy.api#documentation": "Returns the default encryption configuration for an Amazon S3 bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.
\n \n To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
The following operations are related to GetBucketEncryption
:
\n PutBucketEncryption\n
\nReturns the default encryption configuration for an Amazon S3 bucket. For information about\n the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.
\n\n To use this operation, you must have permission to perform the\n s3:GetEncryptionConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
The following operations are related to GetBucketEncryption
:
\n PutBucketEncryption\n
\nThe name of the bucket from which the server-side encryption configuration is\n retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "ExpectedBucketOwner": { "target": "com.amazonaws.s3#AccountId", "traits": { "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Gets the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
\nThe S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
\nIf you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n GetBucketIntelligentTieringConfiguration
include:
Container for S3 Intelligent-Tiering configuration.
", + "smithy.api#httpPayload": {} + } + } + } + }, + "com.amazonaws.s3#GetBucketIntelligentTieringConfigurationRequest": { + "type": "structure", + "members": { "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "The name of the bucket from which the server-side encryption configuration is retrieved.
", + "smithy.api#documentation": "The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "Id": { + "target": "com.amazonaws.s3#IntelligentTieringId", + "traits": { + "smithy.api#documentation": "The ID used to identify the S3 Intelligent-Tiering configuration.
", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } } } }, @@ -3726,7 +3837,7 @@ "target": "com.amazonaws.s3#GetBucketInventoryConfigurationOutput" }, "traits": { - "smithy.api#documentation": "Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
\n \nTo use this operation, you must have permissions to perform the s3:GetInventoryConfiguration
action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
\n \nThe following operations are related to GetBucketInventoryConfiguration
:
Returns an inventory configuration (identified by the inventory configuration ID) from\n the bucket.
\n\nTo use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration
action. The bucket owner has this permission\n by default and can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
\n\nThe following operations are related to\n GetBucketInventoryConfiguration
:
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key\n name prefix, one or more object tags, or a combination of both. Accordingly, this\n section describes the latest API. The response describes the new filter element that you\n can use to specify a filter to select a subset of objects to which the rule applies. If\n you are using a previous version of the lifecycle configuration, it still works. For the\n earlier API description, see GetBucketLifecycle.
\nReturns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, \n see Object Lifecycle Management.
\n \nTo use this operation, you must have permission to perform the s3:GetLifecycleConfiguration
action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
\n GetBucketLifecycleConfiguration
has the following special error:
Error code: NoSuchLifecycleConfiguration
\n
Description: The lifecycle configuration does not exist.
\nHTTP Status Code: 404 Not Found
\nSOAP Fault Code Prefix: Client
\nThe following operations are related to GetBucketLifecycleConfiguration
:
\n GetBucketLifecycle\n
\n\n PutBucketLifecycle\n
\nBucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The response describes the new filter element\n that you can use to specify a filter to select a subset of objects to which the rule\n applies. If you are using a previous version of the lifecycle configuration, it still\n works. For the earlier API description, see GetBucketLifecycle.
\nReturns the lifecycle configuration information set on the bucket. For information about\n lifecycle configuration, see Object\n Lifecycle Management.
\n\nTo use this operation, you must have permission to perform the\n s3:GetLifecycleConfiguration
action. The bucket owner has this permission,\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
\n GetBucketLifecycleConfiguration
has the following special error:
Error code: NoSuchLifecycleConfiguration
\n
Description: The lifecycle configuration does not exist.
\nHTTP Status Code: 404 Not Found
\nSOAP Fault Code Prefix: Client
\nThe following operations are related to\n GetBucketLifecycleConfiguration
:
\n GetBucketLifecycle\n
\n\n PutBucketLifecycle\n
\nReturns the Region the bucket resides in. You set the bucket's Region using the\n LocationConstraint
request parameter in a CreateBucket
\n request. For more information, see CreateBucket.
To use this implementation of the operation, you must be the bucket owner.
\n \nThe following operations are related to GetBucketLocation
:
\n GetObject\n
\n\n CreateBucket\n
\nReturns the Region the bucket resides in. You set the bucket's Region using the\n LocationConstraint
request parameter in a CreateBucket
\n request. For more information, see CreateBucket.
To use this implementation of the operation, you must be the bucket owner.
\n\nThe following operations are related to GetBucketLocation
:
\n GetObject\n
\n\n CreateBucket\n
\nSpecifies the Region where the bucket resides. For a list of all the Amazon S3 supported\n location constraints by Region, see Regions and\n\t\t Endpoints. Buckets in Region us-east-1
have a LocationConstraint of null
.
Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported\n location constraints by Region, see Regions and Endpoints.\n Buckets in Region us-east-1
have a LocationConstraint of\n null
.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.
\n \nThe following operations are related to GetBucketLogging
:
\n CreateBucket\n
\n\n PutBucketLogging\n
\nReturns the logging status of a bucket and the permissions users have to view and modify\n that status. To use GET, you must be the bucket owner.
\n\nThe following operations are related to GetBucketLogging
:
\n CreateBucket\n
\n\n PutBucketLogging\n
\nGets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.
\n \n To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
\n \nThe following operations are related to GetBucketMetricsConfiguration
:
Gets a metrics configuration (specified by the metrics configuration ID) from the\n bucket. Note that this doesn't include the daily storage metrics.
\n\n To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration
action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon\n CloudWatch.
\n\nThe following operations are related to\n GetBucketMetricsConfiguration
:
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Returns the notification configuration of a bucket.
\nIf notifications are not enabled on the bucket, the operation returns an empty NotificationConfiguration
element.
By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification
permission.
For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.
\n \nThe following operation is related to GetBucketNotification
:
Returns the notification configuration of a bucket.
\nIf notifications are not enabled on the bucket, the operation returns an empty\n NotificationConfiguration
element.
By default, you must be the bucket owner to read the notification configuration of a\n bucket. However, the bucket owner can use a bucket policy to grant permission to other\n users to read this configuration with the s3:GetBucketNotification
\n permission.
For more information about setting and reading the notification configuration on a\n bucket, see Setting Up Notification of\n Bucket Events. For more information about bucket policies, see Using Bucket Policies.
\n\nThe following operation is related to GetBucketNotification
:
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Returns the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the GetBucketPolicy
permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.
If you don't have GetBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed
error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and User Policies.
\n \nThe following operation is related to GetBucketPolicy
:
\n GetObject\n
\nReturns the policy of a specified bucket. If you are using an identity other than the\n root user of the AWS account that owns the bucket, the calling identity must have the\n GetBucketPolicy
permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.
If you don't have GetBucketPolicy
permissions, Amazon S3 returns a 403\n Access Denied
error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed
error.
As a security precaution, the root user of the AWS account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and User\n Policies.
\n\nThe following operation is related to GetBucketPolicy
:
\n GetObject\n
\nRetrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.
For more information about when Amazon S3 considers a bucket public, see The Meaning of \"Public\".
\n \nThe following operations are related to GetBucketPolicyStatus
:
\n GetPublicAccessBlock\n
\n\n PutPublicAccessBlock\n
\nRetrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.\n In order to use this operation, you must have the s3:GetBucketPolicyStatus
\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
For more information about when Amazon S3 considers a bucket public, see The Meaning of \"Public\".
\n\nThe following operations are related to GetBucketPolicyStatus
:
\n GetPublicAccessBlock\n
\n\n PutPublicAccessBlock\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Returns the replication configuration of a bucket.
\n\n It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, \n a get request soon after put or delete can return a wrong result.\n
\nFor information about replication configuration, see Replication in the Amazon Simple Storage Service Developer Guide.
\n \nThis operation requires permissions for the s3:GetReplicationConfiguration
action. For more information about permissions, see Using Bucket Policies and User Policies.
If you include the Filter
element in a replication configuration, you must also include the DeleteMarkerReplication
and Priority
elements. The response also returns those elements.
For information about GetBucketReplication
errors, see List of replication-related error codes\n
The following operations are related to GetBucketReplication
:
\n PutBucketReplication\n
\nReturns the replication configuration of a bucket.
\nIt can take a while to propagate the put or delete a replication configuration to\n all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong\n result.
\nFor information about replication configuration, see Replication in the\n Amazon Simple Storage Service Developer Guide.
\n\nThis operation requires permissions for the s3:GetReplicationConfiguration
\n action. For more information about permissions, see Using Bucket Policies and User\n Policies.
If you include the Filter
element in a replication configuration, you must\n also include the DeleteMarkerReplication
and Priority
elements.\n The response also returns those elements.
For information about GetBucketReplication
errors, see List of\n replication-related error codes\n
The following operations are related to GetBucketReplication
:
\n PutBucketReplication\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Returns the request payment configuration of a bucket. \n To use this version of the operation, you must be the bucket owner. For more information, see \n Requester Pays Buckets.
\n \nThe following operations are related to GetBucketRequestPayment
:
\n ListObjects\n
\nReturns the request payment configuration of a bucket. To use this version of the\n operation, you must be the bucket owner. For more information, see Requester Pays Buckets.
\n\nThe following operations are related to GetBucketRequestPayment
:
\n ListObjects\n
\nReturns the tag set associated with the bucket.
\nTo use this operation, you must have permission to perform the s3:GetBucketTagging
action. By default, the bucket owner has this permission and can grant this permission to others.
\n GetBucketTagging
has the following special error:
Error code: NoSuchTagSetError
\n
Description: There is no tag set associated with the bucket.
\nThe following operations are related to GetBucketTagging
:
\n PutBucketTagging\n
\n\n DeleteBucketTagging\n
\nReturns the tag set associated with the bucket.
\nTo use this operation, you must have permission to perform the\n s3:GetBucketTagging
action. By default, the bucket owner has this\n permission and can grant this permission to others.
\n GetBucketTagging
has the following special error:
Error code: NoSuchTagSetError
\n
Description: There is no tag set associated with the bucket.
\nThe following operations are related to GetBucketTagging
:
\n PutBucketTagging\n
\n\n DeleteBucketTagging\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Returns the versioning state of a bucket.
\nTo retrieve the versioning state of a bucket, you must be the bucket owner.
\n \nThis implementation also returns the MFA Delete status of the versioning state. If the\n MFA Delete status is enabled
, the bucket owner must use an authentication\n device to change the versioning state of the bucket.
The following operations are related to GetBucketVersioning
:
\n GetObject\n
\n\n PutObject\n
\n\n DeleteObject\n
\nReturns the versioning state of a bucket.
\nTo retrieve the versioning state of a bucket, you must be the bucket owner.
\n\nThis implementation also returns the MFA Delete status of the versioning state. If the\n MFA Delete status is enabled
, the bucket owner must use an authentication\n device to change the versioning state of the bucket.
The following operations are related to GetBucketVersioning
:
\n GetObject\n
\n\n PutObject\n
\n\n DeleteObject\n
\nSpecifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.
", + "smithy.api#documentation": "Specifies whether MFA delete is enabled in the bucket versioning configuration. This\n element is only returned if the bucket has been configured with MFA delete. If the bucket\n has never been so configured, this element is not returned.
", "smithy.api#xmlName": "MfaDelete" } } @@ -4339,13 +4451,6 @@ "com.amazonaws.s3#GetBucketVersioningRequest": { "type": "structure", "members": { - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.\n
\nThis GET operation requires the S3:GetBucketWebsite
permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite
permission.
The following operations are related to DeleteBucketWebsite
:
\n DeleteBucketWebsite\n
\n\n PutBucketWebsite\n
\nReturns the website configuration for a bucket. To host website on Amazon S3, you can\n configure a bucket as website by adding a website configuration. For more information about\n hosting websites, see Hosting Websites on\n Amazon S3.
\nThis GET operation requires the S3:GetBucketWebsite
permission. By default,\n only the bucket owner can read the bucket website configuration. However, bucket owners can\n allow other users to read the website configuration by writing a bucket policy granting\n them the S3:GetBucketWebsite
permission.
The following operations are related to DeleteBucketWebsite
:
\n DeleteBucketWebsite\n
\n\n PutBucketWebsite\n
\nThe object key name of the website error document to use for 4XX class errors.
" + "smithy.api#documentation": "Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3\n bucket.
" } }, - "RedirectAllRequestsTo": { - "target": "com.amazonaws.s3#RedirectAllRequestsTo", + "IndexDocument": { + "target": "com.amazonaws.s3#IndexDocument", "traits": { - "smithy.api#documentation": "Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
" + "smithy.api#documentation": "The name of the index document for the website (for example\n index.html
).
Rules that define when a redirect is applied and the redirect behavior.
" + "smithy.api#documentation": "The object key name of the website error document to use for 4XX class errors.
" } }, - "IndexDocument": { - "target": "com.amazonaws.s3#IndexDocument", + "RoutingRules": { + "target": "com.amazonaws.s3#RoutingRules", "traits": { - "smithy.api#documentation": "The name of the index document for the website (for example index.html
).
Rules that define when a redirect is applied and the redirect behavior.
" } } } @@ -4405,13 +4517,6 @@ "com.amazonaws.s3#GetBucketWebsiteRequest": { "type": "structure", "members": { - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Retrieves objects from Amazon S3. To use GET
, you must have READ
access to the object. If you grant READ
access to the anonymous user, you can return the object without using an authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg
, you can name it photos/2006/February/sample.jpg
.
To get an object from such a logical hierarchy, specify the full key name for the object\n in the GET
operation. For a virtual hosted-style request example, if you have\n the object photos/2006/February/sample.jpg
, specify the resource as\n /photos/2006/February/sample.jpg
. For a path-style request example, if you\n have the object photos/2006/February/sample.jpg
in the bucket named\n examplebucket
, specify the resource as\n /examplebucket/photos/2006/February/sample.jpg
. For more information about\n request types, see HTTP Host Header Bucket Specification.
To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.
\n \nIf the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectStateError
error. For information about restoring archived objects, see Restoring Archived Objects.
Encryption request headers, like x-amz-server-side-encryption
, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\nFor more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
\n \nAssuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging
action), \n the response also returns the x-amz-tagging-count
header that provides the count of number of tags associated with the object. \n You can use GetObjectTagging to retrieve the tag set associated with an object.
\n Permissions\n
\nYou need the s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket
permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3 will return an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket
permission, Amazon S3 will return an HTTP status code 403 (\"access denied\") error.
\n Versioning\n
\nBy default, the GET operation returns the current version of an object. To return a different version, use the versionId
subresource.
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true
in the response.
For more information about versioning, see PutBucketVersioning.
\n \n\n Overriding Response Header Values\n
\nThere are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.
\n \nYou can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type
, Content-Language
, Expires
, Cache-Control
, Content-Disposition
, and Content-Encoding
. To override these header values in the GET response, you use the following request parameters.
You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.
\n\n response-content-type
\n
\n response-content-language
\n
\n response-expires
\n
\n response-cache-control
\n
\n response-content-disposition
\n
\n response-content-encoding
\n
\n Additional Considerations about Request Headers\n
\n \nIf both of the If-Match
and If-Unmodified-Since
headers are present in the request as follows: If-Match
condition evaluates to true
, and; If-Unmodified-Since
condition evaluates to false
; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match
and If-Modified-Since
headers are present in the request as follows: If-None-Match
condition evaluates to false
, and; If-Modified-Since
condition evaluates to true
; then, S3 returns 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
\n \nThe following operations are related to GetObject
:
\n ListBuckets\n
\n\n GetObjectAcl\n
\nRetrieves objects from Amazon S3. To use GET
, you must have READ
\n access to the object. If you grant READ
access to the anonymous user, you can\n return the object without using an authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer\n file system. You can, however, create a logical hierarchy by using object key names that\n imply a folder structure. For example, instead of naming an object sample.jpg
,\n you can name it photos/2006/February/sample.jpg
.
To get an object from such a logical hierarchy, specify the full key name for the object\n in the GET
operation. For a virtual hosted-style request example, if you have\n the object photos/2006/February/sample.jpg
, specify the resource as\n /photos/2006/February/sample.jpg
. For a path-style request example, if you\n have the object photos/2006/February/sample.jpg
in the bucket named\n examplebucket
, specify the resource as\n /examplebucket/photos/2006/February/sample.jpg
. For more information about\n request types, see HTTP Host Header Bucket Specification.
To distribute large files to many people, you can save bandwidth costs by using\n BitTorrent. For more information, see Amazon S3\n Torrent. For more information about returning the ACL of an object, see GetObjectAcl.
\n\nIf the object you are retrieving is stored in the S3 Glacier, S3 Glacier Deep Archive,\n S3 Intelligent-Tiering Archive, or S3 Intelligent-Tiering Deep Archive storage classes, before you can retrieve\n the object you must first restore a copy using RestoreObject. Otherwise, this\n operation returns an InvalidObjectStateError
error. For information about\n restoring archived objects, see Restoring\n Archived Objects.
Encryption request headers, like x-amz-server-side-encryption
, should not\n be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS\n KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your\n object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object,\n you must use the following headers:
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\nFor more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).
\n\nAssuming you have permission to read object tags (permission for the\n s3:GetObjectVersionTagging
action), the response also returns the\n x-amz-tagging-count
header that provides the count of number of tags\n associated with the object. You can use GetObjectTagging to retrieve\n the tag set associated with an object.
\n Permissions\n
\nYou need the s3:GetObject
permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket
permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3 will\n return an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket
permission, Amazon S3 will return an\n HTTP status code 403 (\"access denied\") error.
\n Versioning\n
\nBy default, the GET operation returns the current version of an object. To return a\n different version, use the versionId
subresource.
If the current version of the object is a delete marker, Amazon S3 behaves as if the\n object was deleted and includes x-amz-delete-marker: true
in the\n response.
For more information about versioning, see PutBucketVersioning.
\n\n\n Overriding Response Header Values\n
\nThere are times when you want to override certain response header values in a GET\n response. For example, you might override the Content-Disposition response header value in\n your GET request.
\n\nYou can override values for a set of response headers using the following query\n parameters. These response header values are sent only on a successful request, that is,\n when status code 200 OK is returned. The set of headers you can override using these\n parameters is a subset of the headers that Amazon S3 accepts when you create an object. The\n response headers that you can override for the GET response are Content-Type
,\n Content-Language
, Expires
, Cache-Control
,\n Content-Disposition
, and Content-Encoding
. To override these\n header values in the GET response, you use the following request parameters.
You must sign the request, either using an Authorization header or a presigned URL,\n when using these parameters. They cannot be used with an unsigned (anonymous)\n request.
\n\n response-content-type
\n
\n response-content-language
\n
\n response-expires
\n
\n response-cache-control
\n
\n response-content-disposition
\n
\n response-content-encoding
\n
\n Additional Considerations about Request Headers\n
\n\nIf both of the If-Match
and If-Unmodified-Since
headers are\n present in the request as follows: If-Match
condition evaluates to\n true
, and; If-Unmodified-Since
condition evaluates to\n false
; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match
and If-Modified-Since
headers are\n present in the request as follows: If-None-Match
condition evaluates to\n false
, and; If-Modified-Since
condition evaluates to\n true
; then, S3 returns 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
\n\nThe following operations are related to GetObject
:
\n ListBuckets\n
\n\n GetObjectAcl\n
\nReturns the access control list (ACL) of an object. To use this operation, you must have\n READ_ACP
access to the object.
This action is not supported by Amazon S3 on Outposts.
\n \n\n Versioning\n
\nBy default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.
\n \nThe following operations are related to GetObjectAcl
:
\n GetObject\n
\n\n DeleteObject\n
\n\n PutObject\n
\nReturns the access control list (ACL) of an object. To use this operation, you must have\n READ_ACP
access to the object.
This action is not supported by Amazon S3 on Outposts.
\n\n Versioning\n
\nBy default, GET returns ACL information about the current version of an object. To\n return ACL information about a different version, use the versionId subresource.
\n\nThe following operations are related to GetObjectAcl
:
\n GetObject\n
\n\n DeleteObject\n
\n\n PutObject\n
\nContainer for the bucket owner's display name and ID.
" + } + }, "Grants": { "target": "com.amazonaws.s3#Grants", "traits": { @@ -4476,12 +4597,6 @@ "smithy.api#xmlName": "AccessControlList" } }, - "Owner": { - "target": "com.amazonaws.s3#Owner", - "traits": { - "smithy.api#documentation": "\t\n Container for the bucket owner's display name and ID.
" - } - }, "RequestCharged": { "target": "com.amazonaws.s3#RequestCharged", "traits": { @@ -4493,27 +4608,27 @@ "com.amazonaws.s3#GetObjectAclRequest": { "type": "structure", "members": { - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "The key of the object for which to get the ACL information.
", + "smithy.api#documentation": "The bucket name that contains the object for which to get the ACL information.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "The bucket name that contains the object for which to get the ACL information.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#documentation": "The key of the object for which to get the ACL information.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
VersionId used to reference a specific version of the object.
", + "smithy.api#httpQuery": "versionId" } }, "RequestPayer": { @@ -4522,11 +4637,11 @@ "smithy.api#httpHeader": "x-amz-request-payer" } }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "VersionId used to reference a specific version of the object.
", - "smithy.api#httpQuery": "versionId" + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Gets an object's current Legal Hold\n status. For more information, see Locking Objects.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "Gets an object's current Legal Hold status. For more information, see Locking Objects.
\nThis action is not supported by Amazon S3 on Outposts.
", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}/{Key+}?legal-hold", @@ -4563,10 +4678,18 @@ "com.amazonaws.s3#GetObjectLegalHoldRequest": { "type": "structure", "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "The bucket name containing the object whose Legal Hold status you want to retrieve.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "Key": { "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "The key name for the object whose Legal Hold\n status you want to retrieve.
", + "smithy.api#documentation": "The key name for the object whose Legal Hold status you want to retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -4578,14 +4701,6 @@ "smithy.api#httpQuery": "versionId" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "The bucket name containing the object whose Legal\n Hold status you want to retrieve.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "RequestPayer": { "target": "com.amazonaws.s3#RequestPayer", "traits": { @@ -4610,7 +4725,7 @@ "target": "com.amazonaws.s3#GetObjectLockConfigurationOutput" }, "traits": { - "smithy.api#documentation": "Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
", + "smithy.api#documentation": "Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock\n configuration will be applied by default to every new object placed in the specified\n bucket. For more information, see Locking\n Objects.
", "smithy.api#http": { "method": "GET", "uri": "/{Bucket}?object-lock", @@ -4653,53 +4768,46 @@ "com.amazonaws.s3#GetObjectOutput": { "type": "structure", "members": { - "ObjectLockMode": { - "target": "com.amazonaws.s3#ObjectLockMode", - "traits": { - "smithy.api#documentation": "The Object Lock mode currently in place for this object.
", - "smithy.api#httpHeader": "x-amz-object-lock-mode" - } - }, - "ContentLanguage": { - "target": "com.amazonaws.s3#ContentLanguage", + "Body": { + "target": "com.amazonaws.s3#StreamingBlob", "traits": { - "smithy.api#documentation": "The language the content is in.
", - "smithy.api#httpHeader": "Content-Language" + "smithy.api#documentation": "Object data.
", + "smithy.api#httpPayload": {} } }, - "ContentDisposition": { - "target": "com.amazonaws.s3#ContentDisposition", + "DeleteMarker": { + "target": "com.amazonaws.s3#DeleteMarker", "traits": { - "smithy.api#documentation": "Specifies presentational information for the object.
", - "smithy.api#httpHeader": "Content-Disposition" + "smithy.api#documentation": "Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If\n false, this response header does not appear in the response.
", + "smithy.api#httpHeader": "x-amz-delete-marker" } }, - "CacheControl": { - "target": "com.amazonaws.s3#CacheControl", + "AcceptRanges": { + "target": "com.amazonaws.s3#AcceptRanges", "traits": { - "smithy.api#documentation": "Specifies caching behavior along the request/reply chain.
", - "smithy.api#httpHeader": "Cache-Control" + "smithy.api#documentation": "Indicates that a range of bytes was specified.
", + "smithy.api#httpHeader": "accept-ranges" } }, - "ContentType": { - "target": "com.amazonaws.s3#ContentType", + "Expiration": { + "target": "com.amazonaws.s3#Expiration", "traits": { - "smithy.api#documentation": "A standard MIME type describing the format of the object data.
", - "smithy.api#httpHeader": "Content-Type" + "smithy.api#documentation": "If the object expiration is configured (see PUT Bucket lifecycle), the response includes\n this header. It includes the expiry-date and rule-id key-value pairs providing object\n expiration information. The value of the rule-id is URL encoded.
", + "smithy.api#httpHeader": "x-amz-expiration" } }, - "ContentRange": { - "target": "com.amazonaws.s3#ContentRange", + "Restore": { + "target": "com.amazonaws.s3#Restore", "traits": { - "smithy.api#documentation": "The portion of the object returned in the response.
", - "smithy.api#httpHeader": "Content-Range" + "smithy.api#documentation": "Provides information about object restoration operation and expiration time of the\n restored object copy.
", + "smithy.api#httpHeader": "x-amz-restore" } }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", + "LastModified": { + "target": "com.amazonaws.s3#LastModified", "traits": { - "smithy.api#documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key\n (CMK) that was used for the object.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + "smithy.api#documentation": "Last modified date of the object
", + "smithy.api#httpHeader": "Last-Modified" } }, "ContentLength": { @@ -4709,59 +4817,80 @@ "smithy.api#httpHeader": "Content-Length" } }, - "ObjectLockRetainUntilDate": { - "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "ETag": { + "target": "com.amazonaws.s3#ETag", "traits": { - "smithy.api#documentation": "The date and time when this object's Object Lock will expire.
", - "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + "smithy.api#documentation": "An ETag is an opaque identifier assigned by a web server to a specific version of a\n resource found at a URL.
", + "smithy.api#httpHeader": "ETag" } }, - "ObjectLockLegalHoldStatus": { - "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "MissingMeta": { + "target": "com.amazonaws.s3#MissingMeta", "traits": { - "smithy.api#documentation": "Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.
", - "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + "smithy.api#documentation": "This is set to the number of metadata entries not returned in x-amz-meta
\n headers. This can happen if you create metadata using an API like SOAP that supports more\n flexible metadata than the REST API. For example, using SOAP, you can create metadata whose\n values are not legal HTTP headers.
Version of the object.
", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", + "traits": { + "smithy.api#documentation": "Specifies caching behavior along the request/reply chain.
", + "smithy.api#httpHeader": "Cache-Control" + } + }, + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", + "traits": { + "smithy.api#documentation": "Specifies presentational information for the object.
", + "smithy.api#httpHeader": "Content-Disposition" + } + }, + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", "traits": { - "smithy.api#documentation": "A map of metadata to store with the object in S3.
", - "smithy.api#httpPrefixHeaders": "x-amz-meta-" + "smithy.api#documentation": "Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.
", + "smithy.api#httpHeader": "Content-Encoding" } }, - "DeleteMarker": { - "target": "com.amazonaws.s3#DeleteMarker", + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", "traits": { - "smithy.api#documentation": "Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
", - "smithy.api#httpHeader": "x-amz-delete-marker" + "smithy.api#documentation": "The language the content is in.
", + "smithy.api#httpHeader": "Content-Language" } }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", + "ContentRange": { + "target": "com.amazonaws.s3#ContentRange", "traits": { - "smithy.api#documentation": "Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
", - "smithy.api#httpHeader": "x-amz-storage-class" + "smithy.api#documentation": "The portion of the object returned in the response.
", + "smithy.api#httpHeader": "Content-Range" } }, - "ContentEncoding": { - "target": "com.amazonaws.s3#ContentEncoding", + "ContentType": { + "target": "com.amazonaws.s3#ContentType", "traits": { - "smithy.api#documentation": "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
", - "smithy.api#httpHeader": "Content-Encoding" + "smithy.api#documentation": "A standard MIME type describing the format of the object data.
", + "smithy.api#httpHeader": "Content-Type" } }, - "Restore": { - "target": "com.amazonaws.s3#Restore", + "Expires": { + "target": "com.amazonaws.s3#Expires", "traits": { - "smithy.api#documentation": "Provides information about object restoration operation and expiration time of the restored object copy.
", - "smithy.api#httpHeader": "x-amz-restore" + "smithy.api#documentation": "The date and time at which the object is no longer cacheable.
", + "smithy.api#httpHeader": "Expires" } }, "WebsiteRedirectLocation": { "target": "com.amazonaws.s3#WebsiteRedirectLocation", "traits": { - "smithy.api#documentation": "If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
", + "smithy.api#documentation": "If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.
", "smithy.api#httpHeader": "x-amz-website-redirect-location" } }, @@ -4772,69 +4901,61 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, - "PartsCount": { - "target": "com.amazonaws.s3#PartsCount", + "Metadata": { + "target": "com.amazonaws.s3#Metadata", "traits": { - "smithy.api#documentation": "The count of parts this object has.
", - "smithy.api#httpHeader": "x-amz-mp-parts-count" + "smithy.api#documentation": "A map of metadata to store with the object in S3.
", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" } }, "SSECustomerAlgorithm": { "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
", + "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "AcceptRanges": { - "target": "com.amazonaws.s3#AcceptRanges", - "traits": { - "smithy.api#documentation": "Indicates that a range of bytes was specified.
", - "smithy.api#httpHeader": "accept-ranges" - } - }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "Version of the object.
", - "smithy.api#httpHeader": "x-amz-version-id" - } - }, - "Body": { - "target": "com.amazonaws.s3#StreamingBlob", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "Object data.
", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, - "Expires": { - "target": "com.amazonaws.s3#Expires", + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "The date and time at which the object is no longer cacheable.
", - "smithy.api#httpHeader": "Expires" + "smithy.api#documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, - "Expiration": { - "target": "com.amazonaws.s3#Expiration", + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "If the object expiration is configured (see PUT Bucket lifecycle), the response includes this\n header. It includes the expiry-date and rule-id key-value pairs providing object expiration\n information. The value of the rule-id is URL encoded.
", - "smithy.api#httpHeader": "x-amz-expiration" + "smithy.api#documentation": "Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.
", + "smithy.api#httpHeader": "x-amz-storage-class" } }, - "MissingMeta": { - "target": "com.amazonaws.s3#MissingMeta", + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", "traits": { - "smithy.api#documentation": "This is set to the number of metadata entries not returned in x-amz-meta
headers.\n This can happen if you create metadata using an API like SOAP that supports more flexible\n metadata than the REST API. For example, using SOAP, you can create metadata whose values\n are not legal HTTP headers.
Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
", + "smithy.api#documentation": "Amazon S3 can return this if your request involves a bucket that is either a source or\n destination in a replication rule.
", "smithy.api#httpHeader": "x-amz-replication-status" } }, + "PartsCount": { + "target": "com.amazonaws.s3#PartsCount", + "traits": { + "smithy.api#documentation": "The count of parts this object has.
", + "smithy.api#httpHeader": "x-amz-mp-parts-count" + } + }, "TagCount": { "target": "com.amazonaws.s3#TagCount", "traits": { @@ -4842,31 +4963,25 @@ "smithy.api#httpHeader": "x-amz-tagging-count" } }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "LastModified": { - "target": "com.amazonaws.s3#LastModified", + "ObjectLockMode": { + "target": "com.amazonaws.s3#ObjectLockMode", "traits": { - "smithy.api#documentation": "Last modified date of the object
", - "smithy.api#httpHeader": "Last-Modified" + "smithy.api#documentation": "The Object Lock mode currently in place for this object.
", + "smithy.api#httpHeader": "x-amz-object-lock-mode" } }, - "ETag": { - "target": "com.amazonaws.s3#ETag", + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", "traits": { - "smithy.api#documentation": "An ETag is an opaque identifier assigned by a web server to a specific version of a resource\n found at a URL.
", - "smithy.api#httpHeader": "ETag" + "smithy.api#documentation": "The date and time when this object's Object Lock will expire.
", + "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" } }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" + "smithy.api#documentation": "Indicates whether this object has an active legal hold. This field is only returned if\n you have permission to view an object's legal hold status.
", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" } } } @@ -4874,20 +4989,6 @@ "com.amazonaws.s3#GetObjectRequest": { "type": "structure", "members": { - "ResponseContentEncoding": { - "target": "com.amazonaws.s3#ResponseContentEncoding", - "traits": { - "smithy.api#documentation": "Sets the Content-Encoding
header of the response.
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm
header.
Specifies the algorithm to use to when encrypting the object (for example, AES256).
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + "smithy.api#documentation": "Return the object only if its entity tag (ETag) is the same as the one specified,\n otherwise return a 412 (precondition failed).
", + "smithy.api#httpHeader": "If-Match" } }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "IfModifiedSince": { + "target": "com.amazonaws.s3#IfModifiedSince", "traits": { - "smithy.api#documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + "smithy.api#documentation": "Return the object only if it has been modified since the specified time, otherwise\n return a 304 (not modified).
", + "smithy.api#httpHeader": "If-Modified-Since" } }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "IfNoneMatch": { + "target": "com.amazonaws.s3#IfNoneMatch", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "smithy.api#documentation": "Return the object only if its entity tag (ETag) is different from the one specified,\n otherwise return a 304 (not modified).
", + "smithy.api#httpHeader": "If-None-Match" + } + }, + "IfUnmodifiedSince": { + "target": "com.amazonaws.s3#IfUnmodifiedSince", + "traits": { + "smithy.api#documentation": "Return the object only if it has not been modified since the specified time, otherwise\n return a 412 (precondition failed).
", + "smithy.api#httpHeader": "If-Unmodified-Since" } }, "Key": { @@ -4924,6 +5033,13 @@ "smithy.api#required": {} } }, + "Range": { + "target": "com.amazonaws.s3#Range", + "traits": { + "smithy.api#documentation": "Downloads the specified range bytes of an object. For more information about the HTTP\n Range header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
\nAmazon S3 doesn't support retrieving multiple ranges of data per GET
\n request.
Sets the Content-Language
header of the response.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
", - "smithy.api#httpHeader": "If-Unmodified-Since" + "smithy.api#documentation": "Sets the Content-Encoding
header of the response.
Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.
", - "smithy.api#httpQuery": "partNumber" + "smithy.api#documentation": "Sets the Content-Language
header of the response.
Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
", - "smithy.api#httpHeader": "If-Modified-Since" + "smithy.api#documentation": "Sets the Content-Type
header of the response.
Sets the Expires
header of the response.
Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
", - "smithy.api#httpHeader": "If-None-Match" + "smithy.api#documentation": "Specifies the algorithm to use to when encrypting the object (for example,\n AES256).
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "IfMatch": { - "target": "com.amazonaws.s3#IfMatch", + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", "traits": { - "smithy.api#documentation": "Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
", - "smithy.api#httpHeader": "If-Match" + "smithy.api#documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm
header.
Sets the Expires
header of the response.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, - "Range": { - "target": "com.amazonaws.s3#Range", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "Downloads the specified range bytes of an object. For more information about the HTTP Range\n header, see https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
\nAmazon S3 doesn't support retrieving multiple ranges of data per GET
request.
Sets the Content-Type
header of the response.
Part number of the object being read. This is a positive integer between 1 and 10,000.\n Effectively performs a 'ranged' GET request for the part specified. Useful for downloading\n just a part of an object.
", + "smithy.api#httpQuery": "partNumber" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The version ID for the object whose retention settings you want to retrieve.
", - "smithy.api#httpQuery": "versionId" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", + "com.amazonaws.s3#GetObjectRetentionRequest": { + "type": "structure", + "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The bucket name containing the object whose retention settings you want to retrieve.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "Key": { @@ -5071,18 +5180,24 @@ "smithy.api#required": {} } }, + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", + "traits": { + "smithy.api#documentation": "The version ID for the object whose retention settings you want to retrieve.
", + "smithy.api#httpQuery": "versionId" + } + }, "RequestPayer": { "target": "com.amazonaws.s3#RequestPayer", "traits": { "smithy.api#httpHeader": "x-amz-request-payer" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "The bucket name containing the object whose retention settings you want to retrieve.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.
\n \nTo use this operation, you must have permission to perform the s3:GetObjectTagging
action. By default, the GET operation returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging
action.
By default, the bucket owner has this permission and can grant this permission to others.
\n \nFor information about the Amazon S3 object tagging feature, see Object Tagging.
\n \nThe following operation is related to GetObjectTagging
:
\n PutObjectTagging\n
\nReturns the tag-set of an object. You send the GET request against the tagging\n subresource associated with the object.
\n\nTo use this operation, you must have permission to perform the\n s3:GetObjectTagging
action. By default, the GET operation returns\n information about current version of an object. For a versioned bucket, you can have\n multiple versions of an object in your bucket. To retrieve tags of any other version, use\n the versionId query parameter. You also need permission for the\n s3:GetObjectVersionTagging
action.
By default, the bucket owner has this permission and can grant this permission to\n others.
\n\nFor information about the Amazon S3 object tagging feature, see Object Tagging.
\n\nThe following operation is related to GetObjectTagging
:
\n PutObjectTagging\n
\nContains the tag set.
", - "smithy.api#required": {} - } - }, "VersionId": { "target": "com.amazonaws.s3#ObjectVersionId", "traits": { "smithy.api#documentation": "The versionId of the object for which you got the tagging information.
", "smithy.api#httpHeader": "x-amz-version-id" } + }, + "TagSet": { + "target": "com.amazonaws.s3#TagSet", + "traits": { + "smithy.api#documentation": "Contains the tag set.
", + "smithy.api#required": {} + } } } }, @@ -5134,6 +5249,14 @@ "smithy.api#required": {} } }, + "Key": { + "target": "com.amazonaws.s3#ObjectKey", + "traits": { + "smithy.api#documentation": "Object key for which to get the tagging information.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "VersionId": { "target": "com.amazonaws.s3#ObjectVersionId", "traits": { @@ -5147,14 +5270,6 @@ "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Object key for which to get the tagging information.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -5167,7 +5282,7 @@ "target": "com.amazonaws.s3#GetObjectTorrentOutput" }, "traits": { - "smithy.api#documentation": "Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're\n distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.
\nYou can get torrent only for objects that are less than 5 GB in size, and that are not\n encrypted using server-side encryption with a customer-provided encryption key.
\nTo use GET, you must have READ access to the object.
\nThis action is not supported by Amazon S3 on Outposts.
\n \nThe following operation is related to GetObjectTorrent
:
\n GetObject\n
\nReturns torrent files from a bucket. BitTorrent can save you bandwidth when you're\n distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.
\nYou can get torrent only for objects that are less than 5 GB in size, and that are\n not encrypted using server-side encryption with a customer-provided encryption\n key.
\nTo use GET, you must have READ access to the object.
\nThis action is not supported by Amazon S3 on Outposts.
\nThe following operation is related to GetObjectTorrent
:
\n GetObject\n
\nRetrieves the PublicAccessBlock
configuration for an Amazon S3 bucket. To\n use this operation, you must have the s3:GetBucketPublicAccessBlock
\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.
When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or an object, it checks the PublicAccessBlock
configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock
settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
\n \nThe following operations are related to GetPublicAccessBlock
:
\n PutPublicAccessBlock\n
\n\n GetPublicAccessBlock\n
\nRetrieves the PublicAccessBlock
configuration for an Amazon S3 bucket. To use\n this operation, you must have the s3:GetBucketPublicAccessBlock
permission.\n For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or\n an object, it checks the PublicAccessBlock
configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock
settings are different between the bucket and the\n account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
\n\nThe following operations are related to GetPublicAccessBlock
:
\n PutPublicAccessBlock\n
\n\n GetPublicAccessBlock\n
\nThe PublicAccessBlock
configuration currently in effect for this Amazon S3\n bucket.
The PublicAccessBlock
configuration currently in effect for this Amazon S3\n bucket.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The name of the Amazon S3 bucket whose PublicAccessBlock
configuration you\n want to retrieve.
The name of the Amazon S3 bucket whose PublicAccessBlock
configuration you want\n to retrieve.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
S3 Glacier retrieval tier at which the restore will be processed.
", + "smithy.api#documentation": "Retrieval tier at which the restore will be processed.
", "smithy.api#required": {} } } @@ -5329,22 +5444,16 @@ "com.amazonaws.s3#Grantee": { "type": "structure", "members": { - "EmailAddress": { - "target": "com.amazonaws.s3#EmailAddress", - "traits": { - "smithy.api#documentation": "Email address of the grantee.
\nUsing email addresses to specify a grantee is only supported in the following AWS Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
\nScreen name of the grantee.
" } }, - "URI": { - "target": "com.amazonaws.s3#URI", + "EmailAddress": { + "target": "com.amazonaws.s3#EmailAddress", "traits": { - "smithy.api#documentation": "URI of the grantee group.
" + "smithy.api#documentation": "Email address of the grantee.
\nUsing email addresses to specify a grantee is only supported in the following AWS Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
\nThe canonical user ID of the grantee.
" } }, + "URI": { + "target": "com.amazonaws.s3#URI", + "traits": { + "smithy.api#documentation": "URI of the grantee group.
" + } + }, "Type": { "target": "com.amazonaws.s3#Type", "traits": { @@ -5391,7 +5506,7 @@ } ], "traits": { - "smithy.api#documentation": "This operation is useful to determine if a bucket exists and you have permission to access it. The operation returns a 200 OK
if the bucket exists and you have permission to access it. Otherwise, the operation might return responses such as 404 Not Found
and 403 Forbidden
.
To use this operation, you must have permissions to perform the s3:ListBucket
action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
This operation is useful to determine if a bucket exists and you have permission to\n access it. The operation returns a 200 OK
if the bucket exists and you have\n permission to access it. Otherwise, the operation might return responses such as 404\n Not Found
and 403 Forbidden
.
To use this operation, you must have permissions to perform the\n s3:ListBucket
action. The bucket owner has this permission by default and\n can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.
\n \nA HEAD
request has the same options as a GET
operation on an object. The response is identical to the GET
response except that there is no response body.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\nFor more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
\nEncryption request headers, like x-amz-server-side-encryption
, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
Request headers are limited to 8 KB in size. For more information, see Common Request Headers.
\nConsider the following when using request headers:
\n Consideration 1 – If both of the If-Match
and If-Unmodified-Since
headers are present in the request as follows:
\n If-Match
condition evaluates to true
, and;
\n If-Unmodified-Since
condition evaluates to false
;
Then Amazon S3 returns 200 OK
and the data requested.
\n Consideration 2 – If both of the If-None-Match
and If-Modified-Since
headers are present in the request as follows:
\n If-None-Match
condition evaluates to false
, and;
\n If-Modified-Since
condition evaluates to true
;
Then Amazon S3 returns the 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
\n \n\n Permissions\n
\nYou need the s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3 returns an HTTP\n status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket
permission, Amazon S3 returns an HTTP status\n code 403 (\"access denied\") error.
The following operation is related to HeadObject
:
\n GetObject\n
\nThe HEAD operation retrieves metadata from an object without returning the object\n itself. This operation is useful if you're only interested in an object's metadata. To use\n HEAD, you must have READ access to the object.
\n\nA HEAD
request has the same options as a GET
operation on an\n object. The response is identical to the GET
response except that there is no\n response body.
If you encrypt an object by using server-side encryption with customer-provided\n encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the\n metadata from the object, you must use the following headers:
\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\nFor more information about SSE-C, see Server-Side Encryption (Using\n Customer-Provided Encryption Keys).
\nEncryption request headers, like x-amz-server-side-encryption
, should\n not be sent for GET requests if your object uses server-side encryption with CMKs stored\n in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys\n (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest\n error.
Request headers are limited to 8 KB in size. For more information, see Common Request\n Headers.
\nConsider the following when using request headers:
\n Consideration 1 – If both of the If-Match
and\n If-Unmodified-Since
headers are present in the request as\n follows:
\n If-Match
condition evaluates to true
, and;
\n If-Unmodified-Since
condition evaluates to\n false
;
Then Amazon S3 returns 200 OK
and the data requested.
Consideration 2 – If both of the If-None-Match
and\n If-Modified-Since
headers are present in the request as\n follows:
\n If-None-Match
condition evaluates to false
,\n and;
\n If-Modified-Since
condition evaluates to\n true
;
Then Amazon S3 returns the 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
\n\n\n Permissions\n
\nYou need the s3:GetObject
permission for this operation. For more\n information, see Specifying Permissions\n in a Policy. If the object you request does not exist, the error Amazon S3 returns\n depends on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3 returns\n an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket
permission, Amazon S3 returns an HTTP\n status code 403 (\"access denied\") error.
The following operation is related to HeadObject
:
\n GetObject\n
\nSpecifies caching behavior along the request/reply chain.
", - "smithy.api#httpHeader": "Cache-Control" + "smithy.api#documentation": "Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If\n false, this response header does not appear in the response.
", + "smithy.api#httpHeader": "x-amz-delete-marker" + } + }, + "AcceptRanges": { + "target": "com.amazonaws.s3#AcceptRanges", + "traits": { + "smithy.api#documentation": "Indicates that a range of bytes was specified.
", + "smithy.api#httpHeader": "accept-ranges" + } + }, + "Expiration": { + "target": "com.amazonaws.s3#Expiration", + "traits": { + "smithy.api#documentation": "If the object expiration is configured (see PUT Bucket lifecycle), the response includes\n this header. It includes the expiry-date and rule-id key-value pairs providing object\n expiration information. The value of the rule-id is URL encoded.
", + "smithy.api#httpHeader": "x-amz-expiration" + } + }, + "Restore": { + "target": "com.amazonaws.s3#Restore", + "traits": { + "smithy.api#documentation": "If the object is an archived object (an object whose storage class is GLACIER), the\n response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.
\n\nIf an archive copy is already restored, the header value indicates when Amazon S3 is\n scheduled to delete the object copy. For example:
\n\n\n x-amz-restore: ongoing-request=\"false\", expiry-date=\"Fri, 23 Dec 2012 00:00:00\n GMT\"
\n
If the object restoration is in progress, the header returns the value\n ongoing-request=\"true\"
.
For more information about archiving objects, see Transitioning Objects: General Considerations.
", + "smithy.api#httpHeader": "x-amz-restore" + } + }, + "ArchiveStatus": { + "target": "com.amazonaws.s3#ArchiveStatus", + "traits": { + "smithy.api#documentation": "The archive state of the head object.
", + "smithy.api#httpHeader": "x-amz-archive-status" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "Last modified date of the object
", + "smithy.api#httpHeader": "Last-Modified" } }, "ContentLength": { @@ -5458,25 +5608,32 @@ "smithy.api#httpHeader": "Content-Length" } }, - "ObjectLockRetainUntilDate": { - "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "ETag": { + "target": "com.amazonaws.s3#ETag", "traits": { - "smithy.api#documentation": "The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention
permission.
An ETag is an opaque identifier assigned by a web server to a specific version of a\n resource found at a URL.
", + "smithy.api#httpHeader": "ETag" } }, - "ContentType": { - "target": "com.amazonaws.s3#ContentType", + "MissingMeta": { + "target": "com.amazonaws.s3#MissingMeta", "traits": { - "smithy.api#documentation": "A standard MIME type describing the format of the object data.
", - "smithy.api#httpHeader": "Content-Type" + "smithy.api#documentation": "This is set to the number of metadata entries not returned in x-amz-meta
\n headers. This can happen if you create metadata using an API like SOAP that supports more\n flexible metadata than the REST API. For example, using SOAP, you can create metadata whose\n values are not legal HTTP headers.
An ETag is an opaque identifier assigned by a web server to a specific version of a resource\n found at a URL.
", - "smithy.api#httpHeader": "ETag" + "smithy.api#documentation": "Version of the object.
", + "smithy.api#httpHeader": "x-amz-version-id" + } + }, + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", + "traits": { + "smithy.api#documentation": "Specifies caching behavior along the request/reply chain.
", + "smithy.api#httpHeader": "Cache-Control" } }, "ContentDisposition": { @@ -5486,6 +5643,13 @@ "smithy.api#httpHeader": "Content-Disposition" } }, + "ContentEncoding": { + "target": "com.amazonaws.s3#ContentEncoding", + "traits": { + "smithy.api#documentation": "Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field.
", + "smithy.api#httpHeader": "Content-Encoding" + } + }, "ContentLanguage": { "target": "com.amazonaws.s3#ContentLanguage", "traits": { @@ -5493,11 +5657,11 @@ "smithy.api#httpHeader": "Content-Language" } }, - "Expiration": { - "target": "com.amazonaws.s3#Expiration", + "ContentType": { + "target": "com.amazonaws.s3#ContentType", "traits": { - "smithy.api#documentation": "If the object expiration is configured (see PUT Bucket lifecycle), the response includes this\n header. It includes the expiry-date and rule-id key-value pairs providing object expiration\n information. The value of the rule-id is URL encoded.
", - "smithy.api#httpHeader": "x-amz-expiration" + "smithy.api#documentation": "A standard MIME type describing the format of the object data.
", + "smithy.api#httpHeader": "Content-Type" } }, "Expires": { @@ -5507,136 +5671,94 @@ "smithy.api#httpHeader": "Expires" } }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, - "ReplicationStatus": { - "target": "com.amazonaws.s3#ReplicationStatus", - "traits": { - "smithy.api#documentation": "Amazon S3 can return this header if your request involves a bucket that is either a source or destination in a replication rule.
\n \nIn replication, you have a source bucket on which you configure replication and\n destination bucket where Amazon S3 stores object replicas. When you request an object\n (GetObject
) or object metadata (HeadObject
) from these\n buckets, Amazon S3 will return the x-amz-replication-status
header in the\n response as follows:
If requesting an object from the source bucket — Amazon S3 will return the\n x-amz-replication-status
header if the object in your request is\n eligible for replication.
For example, suppose that in your replication configuration, you specify\n object prefix TaxDocs
requesting Amazon S3 to replicate objects with key\n prefix TaxDocs
. Any objects you upload with this key name prefix, for\n example TaxDocs/document1.pdf
, are eligible for replication. For any\n object request with this key name prefix, Amazon S3 will return the\n x-amz-replication-status
header with value PENDING, COMPLETED or\n FAILED indicating object replication status.
If requesting an object from the destination bucket — Amazon S3 will return the\n x-amz-replication-status
header with value REPLICA if the object in\n your request is a replica that Amazon S3 created.
For more information, see Replication.
", - "smithy.api#httpHeader": "x-amz-replication-status" - } - }, - "ObjectLockLegalHoldStatus": { - "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", - "traits": { - "smithy.api#documentation": "Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold
permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.
If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
", + "smithy.api#documentation": "If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata.
", "smithy.api#httpHeader": "x-amz-website-redirect-location" } }, "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "If the object is stored using server-side encryption either with an AWS KMS customer master\n key (CMK) or an Amazon S3-managed encryption key, the response includes this header with\n the value of the server-side encryption algorithm used when storing this object in Amazon\n S3 (for example, AES256, aws:kms).
", + "smithy.api#documentation": "If the object is stored using server-side encryption either with an AWS KMS customer\n master key (CMK) or an Amazon S3-managed encryption key, the response includes this header with\n the value of the server-side encryption algorithm used when storing this object in Amazon\n S3 (for example, AES256, aws:kms).
", "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", + "Metadata": { + "target": "com.amazonaws.s3#Metadata", "traits": { - "smithy.api#documentation": "Version of the object.
", - "smithy.api#httpHeader": "x-amz-version-id" + "smithy.api#documentation": "A map of metadata to store with the object in S3.
", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" } }, "SSECustomerAlgorithm": { "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
", + "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "PartsCount": { - "target": "com.amazonaws.s3#PartsCount", - "traits": { - "smithy.api#documentation": "The count of parts this object has.
", - "smithy.api#httpHeader": "x-amz-mp-parts-count" - } - }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - }, - "LastModified": { - "target": "com.amazonaws.s3#LastModified", - "traits": { - "smithy.api#documentation": "Last modified date of the object
", - "smithy.api#httpHeader": "Last-Modified" - } - }, - "MissingMeta": { - "target": "com.amazonaws.s3#MissingMeta", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "This is set to the number of metadata entries not returned in x-amz-meta
headers.\n This can happen if you create metadata using an API like SOAP that supports more flexible\n metadata than the REST API. For example, using SOAP, you can create metadata whose values\n are not legal HTTP headers.
If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, - "Restore": { - "target": "com.amazonaws.s3#Restore", + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "If the object is an archived object (an object whose storage class is GLACIER), \n the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.
\n \nIf an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:
\n \n\n x-amz-restore: ongoing-request=\"false\", expiry-date=\"Fri, 23 Dec 2012 00:00:00 GMT\"
\n
If the object restoration is in progress, the header returns the value ongoing-request=\"true\"
.
For more information about archiving objects, see Transitioning Objects: General Considerations.
", - "smithy.api#httpHeader": "x-amz-restore" + "smithy.api#documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, - "ContentEncoding": { - "target": "com.amazonaws.s3#ContentEncoding", + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
", - "smithy.api#httpHeader": "Content-Encoding" + "smithy.api#documentation": "Provides storage class information of the object. Amazon S3 returns this header for all\n objects except for S3 Standard storage class objects.
\n\nFor more information, see Storage\n Classes.
", + "smithy.api#httpHeader": "x-amz-storage-class" } }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", "traits": { - "smithy.api#documentation": "Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
\n \nFor more information, see Storage Classes.
", - "smithy.api#httpHeader": "x-amz-storage-class" + "smithy.api#httpHeader": "x-amz-request-charged" } }, - "Metadata": { - "target": "com.amazonaws.s3#Metadata", + "ReplicationStatus": { + "target": "com.amazonaws.s3#ReplicationStatus", "traits": { - "smithy.api#documentation": "A map of metadata to store with the object in S3.
", - "smithy.api#httpPrefixHeaders": "x-amz-meta-" + "smithy.api#documentation": "Amazon S3 can return this header if your request involves a bucket that is either a source or\n destination in a replication rule.
\n\nIn replication, you have a source bucket on which you configure replication and\n destination bucket where Amazon S3 stores object replicas. When you request an object\n (GetObject
) or object metadata (HeadObject
) from these\n buckets, Amazon S3 will return the x-amz-replication-status
header in the response\n as follows:
If requesting an object from the source bucket — Amazon S3 will return the\n x-amz-replication-status
header if the object in your request is\n eligible for replication.
For example, suppose that in your replication configuration, you specify object\n prefix TaxDocs
requesting Amazon S3 to replicate objects with key prefix\n TaxDocs
. Any objects you upload with this key name prefix, for\n example TaxDocs/document1.pdf
, are eligible for replication. For any\n object request with this key name prefix, Amazon S3 will return the\n x-amz-replication-status
header with value PENDING, COMPLETED or\n FAILED indicating object replication status.
If requesting an object from the destination bucket — Amazon S3 will return the\n x-amz-replication-status
header with value REPLICA if the object in\n your request is a replica that Amazon S3 created.
For more information, see Replication.
", + "smithy.api#httpHeader": "x-amz-replication-status" } }, - "DeleteMarker": { - "target": "com.amazonaws.s3#DeleteMarker", + "PartsCount": { + "target": "com.amazonaws.s3#PartsCount", "traits": { - "smithy.api#documentation": "Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
", - "smithy.api#httpHeader": "x-amz-delete-marker" + "smithy.api#documentation": "The count of parts this object has.
", + "smithy.api#httpHeader": "x-amz-mp-parts-count" } }, "ObjectLockMode": { "target": "com.amazonaws.s3#ObjectLockMode", "traits": { - "smithy.api#documentation": "The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention
permission. For more information about S3 Object Lock, see Object Lock.
The Object Lock mode, if any, that's in effect for this object. This header is only\n returned if the requester has the s3:GetObjectRetention
permission. For more\n information about S3 Object Lock, see Object\n Lock.
If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key\n (CMK) that was used for the object.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + "smithy.api#documentation": "The date and time when the Object Lock retention period expires. This header is only\n returned if the requester has the s3:GetObjectRetention
permission.
Indicates that a range of bytes was specified.
", - "smithy.api#httpHeader": "accept-ranges" + "smithy.api#documentation": "Specifies whether a legal hold is in effect for this object. This header is only\n returned if the requester has the s3:GetObjectLegalHold
permission. This\n header is not returned if the specified version of this object has never had a legal hold\n applied. For more information about S3 Object Lock, see Object Lock.
Specifies the algorithm to use to when encrypting the object (for example, AES256).
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + "smithy.api#documentation": "The name of the bucket containing the object.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", + "IfMatch": { + "target": "com.amazonaws.s3#IfMatch", "traits": { - "smithy.api#documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm
header.
Return the object only if its entity tag (ETag) is the same as the one specified,\n otherwise return a 412 (precondition failed).
", + "smithy.api#httpHeader": "If-Match" } }, - "Range": { - "target": "com.amazonaws.s3#Range", + "IfModifiedSince": { + "target": "com.amazonaws.s3#IfModifiedSince", "traits": { - "smithy.api#documentation": "Downloads the specified range bytes of an object. For more information about the HTTP Range\n header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
\nAmazon S3 doesn't support retrieving multiple ranges of data per GET
request.
Return the object only if it has been modified since the specified time, otherwise\n return a 304 (not modified).
", + "smithy.api#httpHeader": "If-Modified-Since" } }, "IfNoneMatch": { "target": "com.amazonaws.s3#IfNoneMatch", "traits": { - "smithy.api#documentation": "Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
", + "smithy.api#documentation": "Return the object only if its entity tag (ETag) is different from the one specified,\n otherwise return a 304 (not modified).
", "smithy.api#httpHeader": "If-None-Match" } }, - "PartNumber": { - "target": "com.amazonaws.s3#PartNumber", - "traits": { - "smithy.api#documentation": "Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.
", - "smithy.api#httpQuery": "partNumber" - } - }, "IfUnmodifiedSince": { "target": "com.amazonaws.s3#IfUnmodifiedSince", "traits": { - "smithy.api#documentation": "Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
", + "smithy.api#documentation": "Return the object only if it has not been modified since the specified time, otherwise\n return a 412 (precondition failed).
", "smithy.api#httpHeader": "If-Unmodified-Since" } }, - "IfModifiedSince": { - "target": "com.amazonaws.s3#IfModifiedSince", - "traits": { - "smithy.api#documentation": "Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
", - "smithy.api#httpHeader": "If-Modified-Since" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The object key.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "Range": { + "target": "com.amazonaws.s3#Range", "traits": { - "smithy.api#documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + "smithy.api#documentation": "Downloads the specified range bytes of an object. For more information about the HTTP\n Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
\nAmazon S3 doesn't support retrieving multiple ranges of data per GET
\n request.
The name of the bucket containing the object.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "VersionId used to reference a specific version of the object.
", + "smithy.api#httpQuery": "versionId" } }, - "IfMatch": { - "target": "com.amazonaws.s3#IfMatch", + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
", - "smithy.api#httpHeader": "If-Match" + "smithy.api#documentation": "Specifies the algorithm to use to when encrypting the object (for example,\n AES256).
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", "traits": { - "smithy.api#documentation": "The object key.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm
header.
VersionId used to reference a specific version of the object.
", - "smithy.api#httpQuery": "versionId" + "smithy.api#documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, "RequestPayer": { @@ -5742,6 +5850,20 @@ "traits": { "smithy.api#httpHeader": "x-amz-request-payer" } + }, + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", + "traits": { + "smithy.api#documentation": "Part number of the object being read. This is a positive integer between 1 and 10,000.\n Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about\n the size of the part and the number of parts in this object.
", + "smithy.api#httpQuery": "partNumber" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
A suffix that is appended to a request that is for a directory on the website endpoint (for\n example,if the suffix is index.html and you make a request to samplebucket/images/ the data\n that is returned will be for the object with the key name images/index.html) The suffix\n must not be empty and must not include a slash character.
", + "smithy.api#documentation": "A suffix that is appended to a request that is for a directory on the website endpoint\n (for example,if the suffix is index.html and you make a request to samplebucket/images/ the\n data that is returned will be for the object with the key name images/index.html) The\n suffix must not be empty and must not include a slash character.
", "smithy.api#required": {} } } @@ -5793,7 +5915,7 @@ "ID": { "target": "com.amazonaws.s3#ID", "traits": { - "smithy.api#documentation": "If the principal is an AWS account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.
" + "smithy.api#documentation": "If the principal is an AWS account, it provides the Canonical User ID. If the principal\n is an IAM User, it provides a user ARN value.
" } }, "DisplayName": { @@ -5810,16 +5932,22 @@ "com.amazonaws.s3#InputSerialization": { "type": "structure", "members": { - "JSON": { - "target": "com.amazonaws.s3#JSONInput", + "CSV": { + "target": "com.amazonaws.s3#CSVInput", "traits": { - "smithy.api#documentation": "Specifies JSON as object's input serialization format.
" + "smithy.api#documentation": "Describes the serialization of a CSV-encoded object.
" } }, "CompressionType": { "target": "com.amazonaws.s3#CompressionType", "traits": { - "smithy.api#documentation": "Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.
" + "smithy.api#documentation": "Specifies object's compression format. Valid values: NONE, GZIP, BZIP2. Default Value:\n NONE.
" + } + }, + "JSON": { + "target": "com.amazonaws.s3#JSONInput", + "traits": { + "smithy.api#documentation": "Specifies JSON as object's input serialization format.
" } }, "Parquet": { @@ -5827,46 +5955,182 @@ "traits": { "smithy.api#documentation": "Specifies Parquet as object's input serialization format.
" } + } + }, + "traits": { + "smithy.api#documentation": "Describes the serialization format of the object.
" + } + }, + "com.amazonaws.s3#IntelligentTieringAccessTier": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "ARCHIVE_ACCESS" + }, + { + "value": "DEEP_ARCHIVE_ACCESS" + } + ] + } + }, + "com.amazonaws.s3#IntelligentTieringAndOperator": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "An object key name prefix that identifies the subset of objects to which the\n configuration applies.
" + } }, - "CSV": { - "target": "com.amazonaws.s3#CSVInput", + "Tags": { + "target": "com.amazonaws.s3#TagSet", "traits": { - "smithy.api#documentation": "Describes the serialization of a CSV-encoded object.
" + "smithy.api#documentation": "All of these tags must exist in the object's tag set in order for the configuration to\n apply.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tag" } } }, "traits": { - "smithy.api#documentation": "Describes the serialization format of the object.
" + "smithy.api#documentation": "A container for specifying S3 Intelligent-Tiering filters. The filters determine the\n subset of objects to which the rule applies.
" + } + }, + "com.amazonaws.s3#IntelligentTieringConfiguration": { + "type": "structure", + "members": { + "Id": { + "target": "com.amazonaws.s3#IntelligentTieringId", + "traits": { + "smithy.api#documentation": "The ID used to identify the S3 Intelligent-Tiering configuration.
", + "smithy.api#required": {} + } + }, + "Filter": { + "target": "com.amazonaws.s3#IntelligentTieringFilter", + "traits": { + "smithy.api#documentation": "Specifies a bucket filter. The configuration only includes objects that meet the\n filter's criteria.
" + } + }, + "Status": { + "target": "com.amazonaws.s3#IntelligentTieringStatus", + "traits": { + "smithy.api#documentation": "Specifies the status of the configuration.
", + "smithy.api#required": {} + } + }, + "Tierings": { + "target": "com.amazonaws.s3#TieringList", + "traits": { + "smithy.api#documentation": "Specifies the S3 Intelligent-Tiering storage class tier of the configuration.
", + "smithy.api#required": {}, + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Tiering" + } + } + }, + "traits": { + "smithy.api#documentation": "Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.
\nFor information about the S3 Intelligent-Tiering storage class, see Storage class for\n automatically optimizing frequently and infrequently accessed objects.
" + } + }, + "com.amazonaws.s3#IntelligentTieringConfigurationList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#IntelligentTieringConfiguration" + } + }, + "com.amazonaws.s3#IntelligentTieringDays": { + "type": "integer" + }, + "com.amazonaws.s3#IntelligentTieringFilter": { + "type": "structure", + "members": { + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "An object key name prefix that identifies the subset of objects to which the rule\n applies.
" + } + }, + "Tag": { + "target": "com.amazonaws.s3#Tag" + }, + "And": { + "target": "com.amazonaws.s3#IntelligentTieringAndOperator", + "traits": { + "smithy.api#documentation": "A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates, and an object must match all of the\n predicates in order for the filter to apply.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The Filter
is used to identify objects that the S3 Intelligent-Tiering\n configuration applies to.
Object is archived and inaccessible until restored.
", + "smithy.api#error": "client" } }, "com.amazonaws.s3#InventoryConfiguration": { "type": "structure", "members": { - "IncludedObjectVersions": { - "target": "com.amazonaws.s3#InventoryIncludedObjectVersions", + "Destination": { + "target": "com.amazonaws.s3#InventoryDestination", "traits": { - "smithy.api#documentation": "Object versions to include in the inventory list. If set to All
, the list includes all the object versions, which adds the version-related fields VersionId
, IsLatest
, and DeleteMarker
to the list. If set to Current
, the list does not contain these version-related fields.
Contains information about where to publish the inventory results.
", "smithy.api#required": {} } }, "IsEnabled": { "target": "com.amazonaws.s3#IsEnabled", "traits": { - "smithy.api#documentation": "Specifies whether the inventory is enabled or disabled. If set to True
, an inventory list is generated. If set to False
, no inventory list is generated.
Specifies whether the inventory is enabled or disabled. If set to True
, an\n inventory list is generated. If set to False
, no inventory list is\n generated.
Specifies the schedule for generating inventory results.
", + "smithy.api#documentation": "Specifies an inventory filter. The inventory only includes objects that meet the\n filter's criteria.
" + } + }, + "Id": { + "target": "com.amazonaws.s3#InventoryId", + "traits": { + "smithy.api#documentation": "The ID used to identify the inventory configuration.
", "smithy.api#required": {} } }, - "Filter": { - "target": "com.amazonaws.s3#InventoryFilter", + "IncludedObjectVersions": { + "target": "com.amazonaws.s3#InventoryIncludedObjectVersions", "traits": { - "smithy.api#documentation": "Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.
" + "smithy.api#documentation": "Object versions to include in the inventory list. If set to All
, the list\n includes all the object versions, which adds the version-related fields\n VersionId
, IsLatest
, and DeleteMarker
to the\n list. If set to Current
, the list does not contain these version-related\n fields.
Contains the optional fields that are included in the inventory results.
" } }, - "Destination": { - "target": "com.amazonaws.s3#InventoryDestination", - "traits": { - "smithy.api#documentation": "Contains information about where to publish the inventory results.
", - "smithy.api#required": {} - } - }, - "Id": { - "target": "com.amazonaws.s3#InventoryId", + "Schedule": { + "target": "com.amazonaws.s3#InventorySchedule", "traits": { - "smithy.api#documentation": "The ID used to identify the inventory configuration.
", + "smithy.api#documentation": "Specifies the schedule for generating inventory results.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Specifies the inventory configuration for an Amazon S3 bucket.\n For more information, see GET Bucket inventory in the Amazon Simple Storage Service API Reference.\n
" + "smithy.api#documentation": "Specifies the inventory configuration for an Amazon S3 bucket. For more information, see\n GET Bucket inventory in the Amazon Simple Storage Service API Reference.\n
" } }, "com.amazonaws.s3#InventoryConfigurationList": { @@ -5906,7 +6163,7 @@ "S3BucketDestination": { "target": "com.amazonaws.s3#InventoryS3BucketDestination", "traits": { - "smithy.api#documentation": "Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.
", + "smithy.api#documentation": "Contains the bucket name, file format, bucket owner (optional), and prefix (optional)\n where inventory results are published.
", "smithy.api#required": {} } } @@ -5918,23 +6175,23 @@ "com.amazonaws.s3#InventoryEncryption": { "type": "structure", "members": { - "SSEKMS": { - "target": "com.amazonaws.s3#SSEKMS", - "traits": { - "smithy.api#documentation": "Specifies the use of SSE-KMS to encrypt delivered inventory reports.
", - "smithy.api#xmlName": "SSE-KMS" - } - }, "SSES3": { "target": "com.amazonaws.s3#SSES3", "traits": { "smithy.api#documentation": "Specifies the use of SSE-S3 to encrypt delivered inventory reports.
", "smithy.api#xmlName": "SSE-S3" } + }, + "SSEKMS": { + "target": "com.amazonaws.s3#SSEKMS", + "traits": { + "smithy.api#documentation": "Specifies the use of SSE-KMS to encrypt delivered inventory reports.
", + "smithy.api#xmlName": "SSE-KMS" + } } }, "traits": { - "smithy.api#documentation": "Contains the type of server-side encryption used to encrypt the inventory results.
" + "smithy.api#documentation": "Contains the type of server-side encryption used to encrypt the inventory\n results.
" } }, "com.amazonaws.s3#InventoryFilter": { @@ -5949,7 +6206,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies an inventory filter. The inventory only includes objects that meet the filter's criteria.
" + "smithy.api#documentation": "Specifies an inventory filter. The inventory only includes objects that meet the\n filter's criteria.
" } }, "com.amazonaws.s3#InventoryFormat": { @@ -6049,17 +6306,24 @@ "com.amazonaws.s3#InventoryS3BucketDestination": { "type": "structure", "members": { - "Format": { - "target": "com.amazonaws.s3#InventoryFormat", + "AccountId": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "Specifies the output format of the inventory results.
", + "smithy.api#documentation": "The account ID that owns the destination S3 bucket. If no account ID is provided, the\n owner is not validated before exporting data.
\nAlthough this value is optional, we strongly recommend that you set it to help\n prevent problems if the destination bucket ownership changes.
\nThe Amazon Resource Name (ARN) of the bucket where inventory results will be\n published.
", "smithy.api#required": {} } }, - "Encryption": { - "target": "com.amazonaws.s3#InventoryEncryption", + "Format": { + "target": "com.amazonaws.s3#InventoryFormat", "traits": { - "smithy.api#documentation": "Contains the type of server-side encryption used to encrypt the inventory results.
" + "smithy.api#documentation": "Specifies the output format of the inventory results.
", + "smithy.api#required": {} } }, "Prefix": { @@ -6068,22 +6332,15 @@ "smithy.api#documentation": "The prefix that is prepended to all inventory results.
" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the bucket where inventory results will be published.
", - "smithy.api#required": {} - } - }, - "AccountId": { - "target": "com.amazonaws.s3#AccountId", + "Encryption": { + "target": "com.amazonaws.s3#InventoryEncryption", "traits": { - "smithy.api#documentation": "The account ID that owns the destination S3 bucket. \n If no account ID is provided, the owner is not validated before exporting data.
\n\n Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket \n ownership changes.\n
\nContains the type of server-side encryption used to encrypt the inventory\n results.
" } } }, "traits": { - "smithy.api#documentation": "Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where\n inventory results are published.
" + "smithy.api#documentation": "Contains the bucket name, file format, bucket owner (optional), and prefix (optional)\n where inventory results are published.
" } }, "com.amazonaws.s3#InventorySchedule": { @@ -6133,7 +6390,7 @@ "RecordDelimiter": { "target": "com.amazonaws.s3#RecordDelimiter", "traits": { - "smithy.api#documentation": "The value used to separate individual records in the output. If no value is specified, Amazon S3 \n uses a newline character ('\\n').
" + "smithy.api#documentation": "The value used to separate individual records in the output. If no value is specified,\n Amazon S3 uses a newline character ('\\n').
" } } }, @@ -6174,10 +6431,21 @@ "com.amazonaws.s3#LambdaFunctionConfiguration": { "type": "structure", "members": { + "Id": { + "target": "com.amazonaws.s3#NotificationId" + }, + "LambdaFunctionArn": { + "target": "com.amazonaws.s3#LambdaFunctionArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the\n specified event type occurs.
", + "smithy.api#required": {}, + "smithy.api#xmlName": "CloudFunction" + } + }, "Events": { "target": "com.amazonaws.s3#EventList", "traits": { - "smithy.api#documentation": "The Amazon S3 bucket event for which to invoke the AWS Lambda function.\n For more information, see Supported Event Types in the\n Amazon Simple Storage Service Developer Guide.
", + "smithy.api#documentation": "The Amazon S3 bucket event for which to invoke the AWS Lambda function. For more information,\n see Supported\n Event Types in the Amazon Simple Storage Service Developer Guide.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Event" @@ -6185,17 +6453,6 @@ }, "Filter": { "target": "com.amazonaws.s3#NotificationConfigurationFilter" - }, - "LambdaFunctionArn": { - "target": "com.amazonaws.s3#LambdaFunctionArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Lambda function that Amazon S3 invokes when the specified event type occurs.
", - "smithy.api#required": {}, - "smithy.api#xmlName": "CloudFunction" - } - }, - "Id": { - "target": "com.amazonaws.s3#NotificationId" } }, "traits": { @@ -6214,22 +6471,22 @@ "com.amazonaws.s3#LifecycleExpiration": { "type": "structure", "members": { + "Date": { + "target": "com.amazonaws.s3#Date", + "traits": { + "smithy.api#documentation": "Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601\n Format.
" + } + }, "Days": { "target": "com.amazonaws.s3#Days", "traits": { - "smithy.api#documentation": "Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.
" + "smithy.api#documentation": "Indicates the lifetime, in days, of the objects that are subject to the rule. The value\n must be a non-zero positive integer.
" } }, "ExpiredObjectDeleteMarker": { "target": "com.amazonaws.s3#ExpiredObjectDeleteMarker", "traits": { - "smithy.api#documentation": "Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.
" - } - }, - "Date": { - "target": "com.amazonaws.s3#Date", - "traits": { - "smithy.api#documentation": "Indicates at what date the object is to be moved or deleted. Should be in GMT ISO 8601 Format.
" + "smithy.api#documentation": "Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set\n to true, the delete marker will be expired; if set to false the policy takes no action.\n This cannot be specified with Days or Date in a Lifecycle Expiration Policy.
" } } }, @@ -6240,18 +6497,10 @@ "com.amazonaws.s3#LifecycleRule": { "type": "structure", "members": { - "NoncurrentVersionTransitions": { - "target": "com.amazonaws.s3#NoncurrentVersionTransitionList", - "traits": { - "smithy.api#documentation": "Specifies the transition rule for the lifecycle rule that describes when noncurrent\n objects transition to a specific storage class. If your bucket is versioning-enabled (or\n versioning is suspended), you can set this action to request that Amazon S3 transition\n noncurrent object versions to a specific storage class at a set period in the object's\n lifetime.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "NoncurrentVersionTransition" - } - }, "Expiration": { "target": "com.amazonaws.s3#LifecycleExpiration", "traits": { - "smithy.api#documentation": "Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.
" + "smithy.api#documentation": "Specifies the expiration for the lifecycle of the object in the form of date, days and,\n whether the object has a delete marker.
" } }, "ID": { @@ -6260,6 +6509,23 @@ "smithy.api#documentation": "Unique identifier for the rule. The value cannot be longer than 255 characters.
" } }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "Prefix identifying one or more objects to which the rule applies. This is\n No longer used; use Filter
instead.
If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not\n currently being applied.
", + "smithy.api#required": {} + } + }, "Transitions": { "target": "com.amazonaws.s3#TransitionList", "traits": { @@ -6268,11 +6534,12 @@ "smithy.api#xmlName": "Transition" } }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", + "NoncurrentVersionTransitions": { + "target": "com.amazonaws.s3#NoncurrentVersionTransitionList", "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "Prefix identifying one or more objects to which the rule applies. This is\n No longer used; use Filter
instead.
Specifies the transition rule for the lifecycle rule that describes when noncurrent\n objects transition to a specific storage class. If your bucket is versioning-enabled (or\n versioning is suspended), you can set this action to request that Amazon S3 transition\n noncurrent object versions to a specific storage class at a set period in the object's\n lifetime.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "NoncurrentVersionTransition" } }, "NoncurrentVersionExpiration": { @@ -6280,16 +6547,6 @@ }, "AbortIncompleteMultipartUpload": { "target": "com.amazonaws.s3#AbortIncompleteMultipartUpload" - }, - "Filter": { - "target": "com.amazonaws.s3#LifecycleRuleFilter" - }, - "Status": { - "target": "com.amazonaws.s3#ExpirationStatus", - "traits": { - "smithy.api#documentation": "If 'Enabled', the rule is currently being applied. If 'Disabled', the rule is not currently being applied.
", - "smithy.api#required": {} - } } }, "traits": { @@ -6308,22 +6565,19 @@ "Tags": { "target": "com.amazonaws.s3#TagSet", "traits": { - "smithy.api#documentation": "All of these tags must exist in the object's tag set in order for the rule to apply.
", + "smithy.api#documentation": "All of these tags must exist in the object's tag set in order for the rule to\n apply.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Tag" } } }, "traits": { - "smithy.api#documentation": "This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.
" + "smithy.api#documentation": "This is used in a Lifecycle Rule Filter to apply a logical AND to two or more\n predicates. The Lifecycle Rule will apply to any object matching all of the predicates\n configured inside the And operator.
" } }, "com.amazonaws.s3#LifecycleRuleFilter": { "type": "structure", "members": { - "And": { - "target": "com.amazonaws.s3#LifecycleRuleAndOperator" - }, "Prefix": { "target": "com.amazonaws.s3#Prefix", "traits": { @@ -6335,6 +6589,9 @@ "traits": { "smithy.api#documentation": "This tag must exist in the object's tag set in order for the rule to apply.
" } + }, + "And": { + "target": "com.amazonaws.s3#LifecycleRuleAndOperator" } }, "traits": { @@ -6356,7 +6613,7 @@ "target": "com.amazonaws.s3#ListBucketAnalyticsConfigurationsOutput" }, "traits": { - "smithy.api#documentation": "Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
\n \nThis operation supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated
element in the response. If there are no more configurations to list, IsTruncated
is set to false. If there are more configurations to list, IsTruncated
is set to true, and there will be a value in NextContinuationToken
. You use the NextContinuationToken
value to continue the pagination of the list by passing the value in continuation-token in the request to GET
the next page.
To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
\n \nThe following operations are related to ListBucketAnalyticsConfigurations
:
Lists the analytics configurations for the bucket. You can have up to 1,000 analytics\n configurations per bucket.
\n\nThis operation supports list pagination and does not return more than 100 configurations\n at a time. You should always check the IsTruncated
element in the response. If\n there are no more configurations to list, IsTruncated
is set to false. If\n there are more configurations to list, IsTruncated
is set to true, and there\n will be a value in NextContinuationToken
. You use the\n NextContinuationToken
value to continue the pagination of the list by\n passing the value in continuation-token in the request to GET
the next\n page.
To use this operation, you must have permissions to perform the\n s3:GetAnalyticsConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class\n Analysis.
\n\nThe following operations are related to\n ListBucketAnalyticsConfigurations
:
The list of analytics configurations for a bucket.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "AnalyticsConfiguration" + "smithy.api#documentation": "Indicates whether the returned list of analytics configurations is complete. A value of\n true indicates that the list is not complete and the NextContinuationToken will be provided\n for a subsequent request.
" } }, - "NextContinuationToken": { - "target": "com.amazonaws.s3#NextToken", + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", "traits": { - "smithy.api#documentation": "\n NextContinuationToken
is sent when isTruncated
is true, which\n indicates that there are more analytics configurations to list. The next request must\n include this NextContinuationToken
. The token is obfuscated and is not a\n usable value.
The marker that is used as a starting point for this analytics configuration list\n response. This value is present if it was sent in the request.
" } }, - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", "traits": { - "smithy.api#documentation": "Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.
" + "smithy.api#documentation": "\n NextContinuationToken
is sent when isTruncated
is true, which\n indicates that there are more analytics configurations to list. The next request must\n include this NextContinuationToken
. The token is obfuscated and is not a\n usable value.
The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.
" + "smithy.api#documentation": "The list of analytics configurations for a bucket.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "AnalyticsConfiguration" } } } @@ -6398,27 +6655,95 @@ "com.amazonaws.s3#ListBucketAnalyticsConfigurationsRequest": { "type": "structure", "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "The name of the bucket from which analytics configurations are retrieved.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "The ContinuationToken that represents a placeholder from where this request should\n begin.
", + "smithy.api#httpQuery": "continuation-token" + } + }, "ExpectedBucketOwner": { "target": "com.amazonaws.s3#AccountId", "traits": { "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Lists the S3 Intelligent-Tiering configuration from the specified bucket.
\nThe S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
\nThe S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
\nIf you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n ListBucketIntelligentTieringConfigurations
include:
Indicates whether the returned list of analytics configurations is complete. A value of\n true indicates that the list is not complete and the NextContinuationToken will be provided\n for a subsequent request.
" + } }, "ContinuationToken": { "target": "com.amazonaws.s3#Token", "traits": { - "smithy.api#documentation": "The ContinuationToken that represents a placeholder from where this request should begin.
", - "smithy.api#httpQuery": "continuation-token" + "smithy.api#documentation": "The ContinuationToken that represents a placeholder from where this request should\n begin.
" + } + }, + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", + "traits": { + "smithy.api#documentation": "The marker used to continue this inventory configuration listing. Use the\n NextContinuationToken
from this response to continue the listing in a\n subsequent request. The continuation token is an opaque value that Amazon S3 understands.
The list of S3 Intelligent-Tiering configurations for a bucket.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "IntelligentTieringConfiguration" + } + } + } + }, + "com.amazonaws.s3#ListBucketIntelligentTieringConfigurationsRequest": { + "type": "structure", + "members": { "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "The name of the bucket from which analytics configurations are retrieved.
", + "smithy.api#documentation": "The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } + }, + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", + "traits": { + "smithy.api#documentation": "The ContinuationToken that represents a placeholder from where this request should\n begin.
", + "smithy.api#httpQuery": "continuation-token" + } } } }, @@ -6431,7 +6756,7 @@ "target": "com.amazonaws.s3#ListBucketInventoryConfigurationsOutput" }, "traits": { - "smithy.api#documentation": "Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
\n \nThis operation supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated
element in the response. If there are no more configurations to list, IsTruncated
is set to false. If there are more configurations to list, IsTruncated
is set to true, and there is a value in NextContinuationToken
. You use the NextContinuationToken
value to continue the pagination of the list by passing the value in continuation-token in the request to GET
the next page.
To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory\n
\n \nThe following operations are related to ListBucketInventoryConfigurations
:
Returns a list of inventory configurations for the bucket. You can have up to 1,000\n analytics configurations per bucket.
\n\nThis operation supports list pagination and does not return more than 100 configurations\n at a time. Always check the IsTruncated
element in the response. If there are\n no more configurations to list, IsTruncated
is set to false. If there are more\n configurations to list, IsTruncated
is set to true, and there is a value in\n NextContinuationToken
. You use the NextContinuationToken
value\n to continue the pagination of the list by passing the value in continuation-token in the\n request to GET
the next page.
To use this operation, you must have permissions to perform the\n s3:GetInventoryConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory\n
\n\nThe following operations are related to\n ListBucketInventoryConfigurations
:
If sent in the request, the marker that is used as a starting point for this inventory\n configuration list response.
" + } + }, "InventoryConfigurationList": { "target": "com.amazonaws.s3#InventoryConfigurationList", "traits": { @@ -6450,22 +6781,16 @@ "smithy.api#xmlName": "InventoryConfiguration" } }, - "NextContinuationToken": { - "target": "com.amazonaws.s3#NextToken", - "traits": { - "smithy.api#documentation": "The marker used to continue this inventory configuration listing. Use the\n NextContinuationToken
from this response to continue the listing in a\n subsequent request. The continuation token is an opaque value that Amazon S3\n understands.
Tells whether the returned list of inventory configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken is provided for a subsequent request.
" + "smithy.api#documentation": "Tells whether the returned list of inventory configurations is complete. A value of true\n indicates that the list is not complete and the NextContinuationToken is provided for a\n subsequent request.
" } }, - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", "traits": { - "smithy.api#documentation": "If sent in the request, the marker that is used as a starting point for this inventory configuration list response.
" + "smithy.api#documentation": "The marker used to continue this inventory configuration listing. Use the\n NextContinuationToken
from this response to continue the listing in a\n subsequent request. The continuation token is an opaque value that Amazon S3 understands.
The marker used to continue an inventory configuration listing that has been truncated.\n Use the NextContinuationToken from a previously truncated list response to continue the\n listing. The continuation token is an opaque value that Amazon S3 understands.
", + "smithy.api#httpQuery": "continuation-token" + } + }, "ExpectedBucketOwner": { "target": "com.amazonaws.s3#AccountId", "traits": { "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.
", - "smithy.api#httpQuery": "continuation-token" - } } } }, @@ -6506,7 +6831,7 @@ "target": "com.amazonaws.s3#ListBucketMetricsConfigurationsOutput" }, "traits": { - "smithy.api#documentation": "Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.
\n \nThis operation supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated
element in the response. If there are no more configurations to list, IsTruncated
is set to false. If there are more configurations to list, IsTruncated
is set to true, and there is a value in NextContinuationToken
. You use the NextContinuationToken
value to continue the pagination of the list by passing the value in continuation-token
in the request to GET
the next page.
To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.
\n \nThe following operations are related to ListBucketMetricsConfigurations
:
Lists the metrics configurations for the bucket. The metrics configurations are only for\n the request metrics of the bucket and do not provide information on daily storage metrics.\n You can have up to 1,000 configurations per bucket.
\n\nThis operation supports list pagination and does not return more than 100 configurations\n at a time. Always check the IsTruncated
element in the response. If there are\n no more configurations to list, IsTruncated
is set to false. If there are more\n configurations to list, IsTruncated
is set to true, and there is a value in\n NextContinuationToken
. You use the NextContinuationToken
value\n to continue the pagination of the list by passing the value in\n continuation-token
in the request to GET
the next page.
To use this operation, you must have permissions to perform the\n s3:GetMetricsConfiguration
action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For more information about metrics configurations and CloudWatch request metrics, see\n Monitoring Metrics with Amazon\n CloudWatch.
\n\nThe following operations are related to\n ListBucketMetricsConfigurations
:
The marker used to continue a metrics configuration listing that has been truncated. Use the\n NextContinuationToken
from a previously truncated list response to continue\n the listing. The continuation token is an opaque value that Amazon S3 understands.
Indicates whether the returned list of metrics configurations is complete. A value of\n true indicates that the list is not complete and the NextContinuationToken will be provided\n for a subsequent request.
" } }, - "MetricsConfigurationList": { - "target": "com.amazonaws.s3#MetricsConfigurationList", + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", "traits": { - "smithy.api#documentation": "The list of metrics configurations for a bucket.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "MetricsConfiguration" + "smithy.api#documentation": "The marker that is used as a starting point for this metrics configuration list\n response. This value is present if it was sent in the request.
" } }, - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", "traits": { - "smithy.api#documentation": "The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.
" + "smithy.api#documentation": "The marker used to continue a metrics configuration listing that has been truncated. Use\n the NextContinuationToken
from a previously truncated list response to\n continue the listing. The continuation token is an opaque value that Amazon S3\n understands.
Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.
" + "smithy.api#documentation": "The list of metrics configurations for a bucket.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "MetricsConfiguration" } } } @@ -6548,10 +6873,18 @@ "com.amazonaws.s3#ListBucketMetricsConfigurationsRequest": { "type": "structure", "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "The name of the bucket containing the metrics configurations to retrieve.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "ContinuationToken": { "target": "com.amazonaws.s3#Token", "traits": { - "smithy.api#documentation": "The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.
", + "smithy.api#documentation": "The marker that is used to continue a metrics configuration listing that has been\n truncated. Use the NextContinuationToken from a previously truncated list response to\n continue the listing. The continuation token is an opaque value that Amazon S3\n understands.
", "smithy.api#httpQuery": "continuation-token" } }, @@ -6561,14 +6894,6 @@ "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The name of the bucket containing the metrics configurations to retrieve.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } } } }, @@ -6589,17 +6914,17 @@ "com.amazonaws.s3#ListBucketsOutput": { "type": "structure", "members": { - "Owner": { - "target": "com.amazonaws.s3#Owner", - "traits": { - "smithy.api#documentation": "The owner of the buckets listed.
" - } - }, "Buckets": { "target": "com.amazonaws.s3#Buckets", "traits": { "smithy.api#documentation": "The list of buckets owned by the requestor.
" } + }, + "Owner": { + "target": "com.amazonaws.s3#Owner", + "traits": { + "smithy.api#documentation": "The owner of the buckets listed.
" + } } } }, @@ -6612,7 +6937,7 @@ "target": "com.amazonaws.s3#ListMultipartUploadsOutput" }, "traits": { - "smithy.api#documentation": "This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.
\n \nThis operation returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads
parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an IsTruncated
element with the value true. To list the additional multipart uploads, use the key-marker
and upload-id-marker
request parameters.
In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.
\n \nFor more information on multipart uploads, see Uploading Objects Using Multipart Upload.
\n \nFor information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
\n \nThe following operations are related to ListMultipartUploads
:
\n UploadPart\n
\n\n ListParts\n
\n\n AbortMultipartUpload\n
\nThis operation lists in-progress multipart uploads. An in-progress multipart upload is a\n multipart upload that has been initiated using the Initiate Multipart Upload request, but\n has not yet been completed or aborted.
\n\nThis operation returns at most 1,000 multipart uploads in the response. 1,000 multipart\n uploads is the maximum number of uploads a response can include, which is also the default\n value. You can further limit the number of uploads in a response by specifying the\n max-uploads
parameter in the response. If additional multipart uploads\n satisfy the list criteria, the response will contain an IsTruncated
element\n with the value true. To list the additional multipart uploads, use the\n key-marker
and upload-id-marker
request parameters.
In the response, the uploads are sorted by key. If your application has initiated more\n than one multipart upload using the same object key, then uploads in the response are first\n sorted by key. Additionally, uploads are sorted in ascending order within each key by the\n upload initiation time.
\n\nFor more information on multipart uploads, see Uploading Objects Using Multipart\n Upload.
\n\nFor information on permissions required to use the multipart upload API, see Multipart Upload API and\n Permissions.
\n\nThe following operations are related to ListMultipartUploads
:
\n UploadPart\n
\n\n ListParts\n
\n\n AbortMultipartUpload\n
\nContains the delimiter you specified in the request. If you don't specify a delimiter in your request, this element is absent from the response.
" + "smithy.api#documentation": "The name of the bucket to which the multipart upload was initiated.
" } }, "KeyMarker": { @@ -6635,30 +6960,28 @@ "smithy.api#documentation": "The key at or after which the listing began.
" } }, - "MaxUploads": { - "target": "com.amazonaws.s3#MaxUploads", + "UploadIdMarker": { + "target": "com.amazonaws.s3#UploadIdMarker", "traits": { - "smithy.api#documentation": "Maximum number of multipart uploads that could have been included in the response.
" + "smithy.api#documentation": "Upload ID after which listing began.
" } }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", + "NextKeyMarker": { + "target": "com.amazonaws.s3#NextKeyMarker", "traits": { - "smithy.api#documentation": "Encoding type used by Amazon S3 to encode object keys in the response.
\nIf you specify encoding-type
request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
\n Delimiter
, KeyMarker
, Prefix
, NextKeyMarker
, Key
.
When a list is truncated, this element specifies the value that should be used for the\n key-marker request parameter in a subsequent request.
" } }, - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", + "Prefix": { + "target": "com.amazonaws.s3#Prefix", "traits": { - "smithy.api#documentation": "Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.
" + "smithy.api#documentation": "When a prefix is provided in the request, this field contains the specified prefix. The\n result contains only keys starting with the specified prefix.
" } }, - "Uploads": { - "target": "com.amazonaws.s3#MultipartUploadList", + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "Container for elements related to a particular multipart upload. A response can contain\n zero or more Upload
elements.
Contains the delimiter you specified in the request. If you don't specify a delimiter in\n your request, this element is absent from the response.
" } }, "NextUploadIdMarker": { @@ -6667,35 +6990,37 @@ "smithy.api#documentation": "When a list is truncated, this element specifies the value that should be used for the\n upload-id-marker
request parameter in a subsequent request.
Upload ID after which listing began.
" + "smithy.api#documentation": "Maximum number of multipart uploads that could have been included in the\n response.
" } }, - "CommonPrefixes": { - "target": "com.amazonaws.s3#CommonPrefixList", + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", "traits": { - "smithy.api#documentation": "If you specify a delimiter in the request, then the result returns each distinct key\n prefix containing the delimiter in a CommonPrefixes
element. The distinct key\n prefixes are returned in the Prefix
child element.
Indicates whether the returned list of multipart uploads is truncated. A value of true\n indicates that the list was truncated. The list can be truncated if the number of multipart\n uploads exceeds the limit allowed or specified by max uploads.
" } }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", + "Uploads": { + "target": "com.amazonaws.s3#MultipartUploadList", "traits": { - "smithy.api#documentation": "When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.
" + "smithy.api#documentation": "Container for elements related to a particular multipart upload. A response can contain\n zero or more Upload
elements.
When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.
" + "smithy.api#documentation": "If you specify a delimiter in the request, then the result returns each distinct key\n prefix containing the delimiter in a CommonPrefixes
element. The distinct key\n prefixes are returned in the Prefix
child element.
The name of the bucket to which the multipart upload was initiated.
" + "smithy.api#documentation": "Encoding type used by Amazon S3 to encode object keys in the response.
\nIf you specify encoding-type
request parameter, Amazon S3 includes this element\n in the response, and returns encoded key name values in the following response\n elements:
\n Delimiter
, KeyMarker
, Prefix
,\n NextKeyMarker
, Key
.
Together with key-marker, specifies the multipart upload after which listing should begin. If\n key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any\n multipart uploads for a key equal to the key-marker might be included in the list only if\n they have an upload ID lexicographically greater than the specified\n upload-id-marker
.
Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.)
", - "smithy.api#httpQuery": "prefix" - } - }, "Delimiter": { "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "Character you use to group keys.
\nAll keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes
. If you don't specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes
result element are not returned elsewhere in the response.
Character you use to group keys.
\nAll keys that contain the same string between the prefix, if specified, and the first\n occurrence of the delimiter after the prefix are grouped under a single result element,\n CommonPrefixes
. If you don't specify the prefix parameter, then the\n substring starts at the beginning of the key. The keys that are grouped under\n CommonPrefixes
result element are not returned elsewhere in the\n response.
Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.
", - "smithy.api#httpQuery": "max-uploads" + "smithy.api#httpQuery": "encoding-type" } }, "KeyMarker": { "target": "com.amazonaws.s3#KeyMarker", "traits": { - "smithy.api#documentation": "Together with upload-id-marker, this parameter specifies the multipart upload after which listing should begin.
\nIf upload-id-marker
is not specified, only the keys lexicographically greater than the specified key-marker
will be included in the list.
If upload-id-marker
is specified, any multipart uploads for a key equal to the key-marker
might also be included, provided those multipart uploads have upload IDs lexicographically greater than the specified upload-id-marker
.
Together with upload-id-marker, this parameter specifies the multipart upload after\n which listing should begin.
\nIf upload-id-marker
is not specified, only the keys lexicographically\n greater than the specified key-marker
will be included in the list.
If upload-id-marker
is specified, any multipart uploads for a key equal to\n the key-marker
might also be included, provided those multipart uploads have\n upload IDs lexicographically greater than the specified\n upload-id-marker
.
Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response\n body. 1,000 is the maximum number of uploads that can be returned in a response.
", + "smithy.api#httpQuery": "max-uploads" + } + }, + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#documentation": "Lists in-progress uploads only for those keys that begin with the specified prefix. You\n can use prefixes to separate a bucket into different grouping of keys. (You can think of\n using prefix to make groups in the same way you'd use a folder in a file system.)
", + "smithy.api#httpQuery": "prefix" + } + }, + "UploadIdMarker": { + "target": "com.amazonaws.s3#UploadIdMarker", + "traits": { + "smithy.api#documentation": "Together with key-marker, specifies the multipart upload after which listing should\n begin. If key-marker is not specified, the upload-id-marker parameter is ignored.\n Otherwise, any multipart uploads for a key equal to the key-marker might be included in the\n list only if they have an upload ID lexicographically greater than the specified\n upload-id-marker
.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Returns metadata about all versions of the objects in a bucket. You can also use request\n parameters as selection criteria to return metadata about a subset of all the object\n versions.
\nA 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.
\nTo use this operation, you must have READ access to the bucket.
\nThis action is not supported by Amazon S3 on Outposts.
\nThe following operations are related to ListObjectVersions
:
\n ListObjectsV2\n
\n\n GetObject\n
\n\n PutObject\n
\n\n DeleteObject\n
\nReturns metadata about all versions of the objects in a bucket. You can also use request\n parameters as selection criteria to return metadata about a subset of all the object\n versions.
\nA 200 OK response can contain valid or invalid XML. Make sure to design your\n application to parse the contents of the response and handle it appropriately.
\nTo use this operation, you must have READ access to the bucket.
\nThis action is not supported by Amazon S3 on Outposts.
\nThe following operations are related to\n ListObjectVersions
:
\n ListObjectsV2\n
\n\n GetObject\n
\n\n PutObject\n
\n\n DeleteObject\n
\nThe bucket name.
" - } - }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", "traits": { - "smithy.api#documentation": "The delimiter grouping the included keys. A delimiter is a character that you specify to\n group keys. All keys that contain the same string between the prefix and the first\n occurrence of the delimiter are grouped under a single result element in\n CommonPrefixes
. These groups are counted as one result against the max-keys\n limitation. These keys are not returned elsewhere in the response.
A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n criteria. If your results were truncated, you can make a follow-up paginated request using\n the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in\n another request to return the rest of the results.
" } }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", + "KeyMarker": { + "target": "com.amazonaws.s3#KeyMarker", "traits": { - "smithy.api#documentation": "\t\n Encoding type used by Amazon S3 to encode object key names in the XML response.
\n \nIf you specify encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
\n \n\n KeyMarker, NextKeyMarker, Prefix, Key
, and Delimiter
.
Marks the last key returned in a truncated response.
" } }, - "NextVersionIdMarker": { - "target": "com.amazonaws.s3#NextVersionIdMarker", + "VersionIdMarker": { + "target": "com.amazonaws.s3#VersionIdMarker", "traits": { - "smithy.api#documentation": "When the number of responses exceeds the value of MaxKeys
,\n NextVersionIdMarker
specifies the first object version not returned that\n satisfies the search criteria. Use this value for the version-id-marker request parameter\n in a subsequent request.
Marks the last version of the key returned in a truncated response.
" } }, "NextKeyMarker": { @@ -6811,29 +7130,32 @@ "smithy.api#documentation": "When the number of responses exceeds the value of MaxKeys
,\n NextKeyMarker
specifies the first key not returned that satisfies the\n search criteria. Use this value for the key-marker request parameter in a subsequent\n request.
All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
", - "smithy.api#xmlFlattened": {} + "smithy.api#documentation": "When the number of responses exceeds the value of MaxKeys
,\n NextVersionIdMarker
specifies the first object version not returned that\n satisfies the search criteria. Use this value for the version-id-marker request parameter\n in a subsequent request.
Marks the last version of the key returned in a truncated response.
" + "smithy.api#documentation": "Container for version information.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "Version" } }, - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", + "DeleteMarkers": { + "target": "com.amazonaws.s3#DeleteMarkers", "traits": { - "smithy.api#documentation": "A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n criteria. If your results were truncated, you can make a follow-up paginated request using\n the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in\n another request to return the rest of the results.
" + "smithy.api#documentation": "Container for an object that is a delete marker.
", + "smithy.api#xmlFlattened": {}, + "smithy.api#xmlName": "DeleteMarker" } }, - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", + "Name": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "Specifies the maximum number of objects to return.
" + "smithy.api#documentation": "The bucket name.
" } }, "Prefix": { @@ -6842,26 +7164,29 @@ "smithy.api#documentation": "Selects objects that start with the value supplied by this parameter.
" } }, - "Versions": { - "target": "com.amazonaws.s3#ObjectVersionList", + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "Container for version information.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "Version" + "smithy.api#documentation": "The delimiter grouping the included keys. A delimiter is a character that you specify to\n group keys. All keys that contain the same string between the prefix and the first\n occurrence of the delimiter are grouped under a single result element in\n CommonPrefixes
. These groups are counted as one result against the max-keys\n limitation. These keys are not returned elsewhere in the response.
Container for an object that is a delete marker.
", - "smithy.api#xmlFlattened": {}, - "smithy.api#xmlName": "DeleteMarker" + "smithy.api#documentation": "Specifies the maximum number of objects to return.
" } }, - "KeyMarker": { - "target": "com.amazonaws.s3#KeyMarker", + "CommonPrefixes": { + "target": "com.amazonaws.s3#CommonPrefixList", "traits": { - "smithy.api#documentation": "Marks the last key returned in a truncated response.
" + "smithy.api#documentation": "All of the keys rolled up into a common prefix count as a single return when calculating\n the number of returns.
", + "smithy.api#xmlFlattened": {} + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#documentation": "Encoding type used by Amazon S3 to encode object key names in the XML response.
\n\nIf you specify encoding-type request parameter, Amazon S3 includes this element in the\n response, and returns encoded key name values in the following response elements:
\n\n\n KeyMarker, NextKeyMarker, Prefix, Key
, and Delimiter
.
Specifies the key to start with when listing objects in a bucket.
", - "smithy.api#httpQuery": "key-marker" + "smithy.api#documentation": "The bucket name that contains the objects.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains
A delimiter is a character that you specify to group keys. All keys that contain the\n same string between the prefix
and the first occurrence of the delimiter are\n grouped under a single result element in CommonPrefixes. These groups are counted as one\n result against the max-keys limitation. These keys are not returned elsewhere in the\n response.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix
and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.
Specifies the key to start with when listing objects in a bucket.
", + "smithy.api#httpQuery": "key-marker" } }, - "VersionIdMarker": { - "target": "com.amazonaws.s3#VersionIdMarker", + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", "traits": { - "smithy.api#documentation": "Specifies the object version you want to start listing from.
", - "smithy.api#httpQuery": "version-id-marker" + "smithy.api#documentation": "Sets the maximum number of keys returned in the response. By default the API returns up\n to 1,000 key names. The response might contain fewer keys but will never contain more. If\n additional keys satisfy the search criteria, but were not returned because max-keys was\n exceeded, the response contains
The bucket name that contains the objects.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Use this parameter to select only those keys that begin with the specified prefix. You\n can use prefixes to separate a bucket into different groupings of keys. (You can think of\n using prefix to make groups in the same way you'd use a folder in a file system.) You can\n use prefix with delimiter to roll up numerous objects into a single result under\n CommonPrefixes.
", + "smithy.api#httpQuery": "prefix" } }, - "Prefix": { - "target": "com.amazonaws.s3#Prefix", + "VersionIdMarker": { + "target": "com.amazonaws.s3#VersionIdMarker", "traits": { - "smithy.api#documentation": "Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way you'd use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.
", - "smithy.api#httpQuery": "prefix" + "smithy.api#documentation": "Specifies the object version you want to start listing from.
", + "smithy.api#httpQuery": "version-id-marker" } }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#httpQuery": "encoding-type" + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request\n parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK\n response can contain valid or invalid XML. Be sure to design your application to parse the\n contents of the response and handle it appropriately.
\nThis API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects
.
The following operations are related to ListObjects
:
\n ListObjectsV2\n
\n\n GetObject\n
\n\n PutObject\n
\n\n CreateBucket\n
\n\n ListBuckets\n
\nReturns some or all (up to 1,000) of the objects in a bucket. You can use the request\n parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK\n response can contain valid or invalid XML. Be sure to design your application to parse the\n contents of the response and handle it appropriately.
\nThis API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility,\n Amazon S3 continues to support ListObjects
.
The following operations are related to ListObjects
:
\n ListObjectsV2\n
\n\n GetObject\n
\n\n PutObject\n
\n\n CreateBucket\n
\n\n ListBuckets\n
\nThe maximum number of keys returned in the response body.
" + "smithy.api#documentation": "A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n criteria.
" + } + }, + "Marker": { + "target": "com.amazonaws.s3#Marker", + "traits": { + "smithy.api#documentation": "Indicates where in the bucket listing begins. Marker is included in the response if it\n was sent with the request.
" + } + }, + "NextMarker": { + "target": "com.amazonaws.s3#NextMarker", + "traits": { + "smithy.api#documentation": "When response is truncated (the IsTruncated element value in the response is true), you\n can use the key name in this field as marker in the subsequent request to get next set of\n objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if\n you have delimiter request parameter specified. If response does not include the NextMarker\n and it is truncated, you can use the value of the last Key in the response as the marker in\n the subsequent request to get the next set of object keys.
" } }, "Contents": { @@ -6965,72 +7302,67 @@ "smithy.api#xmlFlattened": {} } }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", - "traits": { - "smithy.api#documentation": "Causes keys that contain the same string between the prefix and the first occurrence of\n the delimiter to be rolled up into a single result element in the\n CommonPrefixes
collection. These rolled-up keys are not returned elsewhere\n in the response. Each rolled-up result counts as only one return against the\n MaxKeys
value.
The bucket name.
" } }, - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", - "traits": { - "smithy.api#documentation": "A flag that indicates whether Amazon S3 returned all of the results that satisfied the search\n criteria.
" - } - }, - "NextMarker": { - "target": "com.amazonaws.s3#NextMarker", - "traits": { - "smithy.api#documentation": "When response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as marker in the subsequent request to get next set of objects. Amazon S3 lists objects in alphabetical order Note: This element is returned only if you have delimiter request parameter specified. If response does not include the NextMarker and it is truncated, you can use the value of the last Key in the response as the marker in the subsequent request to get the next set of object keys.
" - } - }, "Prefix": { "target": "com.amazonaws.s3#Prefix", "traits": { "smithy.api#documentation": "Keys that begin with the indicated prefix.
" } }, - "Marker": { - "target": "com.amazonaws.s3#Marker", + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
" + "smithy.api#documentation": "Causes keys that contain the same string between the prefix and the first occurrence of\n the delimiter to be rolled up into a single result element in the\n CommonPrefixes
collection. These rolled-up keys are not returned elsewhere\n in the response. Each rolled-up result counts as only one return against the\n MaxKeys
value.
Encoding type used by Amazon S3 to encode object keys in the response.
" + "smithy.api#documentation": "The maximum number of keys returned in the response body.
" } }, "CommonPrefixes": { "target": "com.amazonaws.s3#CommonPrefixList", "traits": { - "smithy.api#documentation": "All of the keys rolled up in a common prefix count as a single return when calculating the number of returns.
\n \nA response can contain CommonPrefixes only if you specify a delimiter.
\n \nCommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by the delimiter.
\n \nCommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.
\n \nFor example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
", + "smithy.api#documentation": "All of the keys rolled up in a common prefix count as a single return when calculating\n the number of returns.
\n\nA response can contain CommonPrefixes only if you specify a delimiter.
\n\nCommonPrefixes contains all (if there are any) keys between Prefix and the next\n occurrence of the string specified by the delimiter.
\n\nCommonPrefixes lists keys that act like subdirectories in the directory specified by\n Prefix.
\n\nFor example, if the prefix is notes/ and the delimiter is a slash (/) as in\n notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a\n common prefix count as a single return when calculating the number of returns.
", "smithy.api#xmlFlattened": {} } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#documentation": "Encoding type used by Amazon S3 to encode object keys in the response.
" + } } } }, "com.amazonaws.s3#ListObjectsRequest": { "type": "structure", "members": { - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
", - "smithy.api#httpQuery": "max-keys" + "smithy.api#documentation": "The name of the bucket containing the objects.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
A delimiter is a character you use to group keys.
", + "smithy.api#httpQuery": "delimiter" + } + }, + "EncodingType": { + "target": "com.amazonaws.s3#EncodingType", + "traits": { + "smithy.api#httpQuery": "encoding-type" } }, "Marker": { @@ -7040,6 +7372,13 @@ "smithy.api#httpQuery": "marker" } }, + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", + "traits": { + "smithy.api#documentation": "Sets the maximum number of keys returned in the response. By default the API returns up\n to 1,000 key names. The response might contain fewer keys but will never contain more.\n
", + "smithy.api#httpQuery": "max-keys" + } + }, "Prefix": { "target": "com.amazonaws.s3#Prefix", "traits": { @@ -7047,32 +7386,18 @@ "smithy.api#httpQuery": "prefix" } }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", - "traits": { - "smithy.api#documentation": "A delimiter is a character you use to group keys.
", - "smithy.api#httpQuery": "delimiter" - } - }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "The name of the bucket containing the objects.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "RequestPayer": { "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.
", + "smithy.api#documentation": "Confirms that the requester knows that she or he will be charged for the list objects\n request. Bucket owners need not specify this parameter in their requests.
", "smithy.api#httpHeader": "x-amz-request-payer" } }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#httpQuery": "encoding-type" + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK
response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.
To use this operation, you must have READ access to the bucket.
\n \nTo use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform the s3:ListBucket
action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects.
\nTo get a list of your buckets, see ListBuckets.
\n \nThe following operations are related to ListObjectsV2
:
\n GetObject\n
\n\n PutObject\n
\n\n CreateBucket\n
\nReturns some or all (up to 1,000) of the objects in a bucket. You can use the request\n parameters as selection criteria to return a subset of the objects in a bucket. A 200\n OK
response can contain valid or invalid XML. Make sure to design your\n application to parse the contents of the response and handle it appropriately.
To use this operation, you must have READ access to the bucket.
\n\nTo use this operation in an AWS Identity and Access Management (IAM) policy, you must\n have permissions to perform the s3:ListBucket
action. The bucket owner has\n this permission by default and can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
This section describes the latest revision of the API. We recommend that you use this\n revised API for application development. For backward compatibility, Amazon S3 continues to\n support the prior version of this API, ListObjects.
\nTo get a list of your buckets, see ListBuckets.
\n\nThe following operations are related to ListObjectsV2
:
\n GetObject\n
\n\n PutObject\n
\n\n CreateBucket\n
\nCauses keys that contain the same string between the prefix and the first occurrence of the\n delimiter to be rolled up into a single result element in the CommonPrefixes collection.\n These rolled-up keys are not returned elsewhere in the response. Each rolled-up result\n counts as only one return against the MaxKeys
value.
Set to false if all of the results were returned. Set to true if more keys are available\n to return. If the number of results exceeds that specified by MaxKeys, all of the results\n might not be returned.
" } }, - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", + "Contents": { + "target": "com.amazonaws.s3#ObjectList", "traits": { - "smithy.api#documentation": "Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.
" + "smithy.api#documentation": "Metadata about each object returned.
", + "smithy.api#xmlFlattened": {} } }, "Name": { @@ -7125,60 +7451,59 @@ "smithy.api#documentation": "The bucket name.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
" } }, - "EncodingType": { - "target": "com.amazonaws.s3#EncodingType", + "Prefix": { + "target": "com.amazonaws.s3#Prefix", "traits": { - "smithy.api#documentation": "Encoding type used by Amazon S3 to encode object key names in the XML response.
\n \nIf you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:
\n \n\n Delimiter, Prefix, Key,
and StartAfter
.
Keys that begin with the indicated prefix.
" } }, - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "\t\n If ContinuationToken was sent with the request, it is included in the response.
" + "smithy.api#documentation": "Causes keys that contain the same string between the prefix and the first occurrence of\n the delimiter to be rolled up into a single result element in the CommonPrefixes\n collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up\n result counts as only one return against the MaxKeys
value.
Metadata about each object returned.
", - "smithy.api#xmlFlattened": {} + "smithy.api#documentation": "Sets the maximum number of keys returned in the response. By default the API returns up\n to 1,000 key names. The response might contain fewer keys but will never contain\n more.
" } }, "CommonPrefixes": { "target": "com.amazonaws.s3#CommonPrefixList", "traits": { - "smithy.api#documentation": "All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.
\n \nA response can contain CommonPrefixes
only if you specify a delimiter.
\n CommonPrefixes
contains all (if there are any) keys between Prefix
and the next occurrence of the string specified by a delimiter.
\n CommonPrefixes
lists keys that act like subdirectories in the directory specified by Prefix
.
For example, if the prefix is notes/
and the delimiter is a slash (/
) as in notes/summer/july
, the common prefix is notes/summer/
. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.
All of the keys rolled up into a common prefix count as a single return when calculating\n the number of returns.
\n\nA response can contain CommonPrefixes
only if you specify a\n delimiter.
\n CommonPrefixes
contains all (if there are any) keys between\n Prefix
and the next occurrence of the string specified by a\n delimiter.
\n CommonPrefixes
lists keys that act like subdirectories in the directory\n specified by Prefix
.
For example, if the prefix is notes/
and the delimiter is a slash\n (/
) as in notes/summer/july
, the common prefix is\n notes/summer/
. All of the keys that roll up into a common prefix count as a\n single return when calculating the number of returns.
If StartAfter was sent with the request, it is included in the response.
" + "smithy.api#documentation": "Encoding type used by Amazon S3 to encode object key names in the XML response.
\n\nIf you specify the encoding-type request parameter, Amazon S3 includes this element in the\n response, and returns encoded key name values in the following response elements:
\n\n\n Delimiter, Prefix, Key,
and StartAfter
.
\n NextContinuationToken
is sent when isTruncated
is true, which means\n there are more keys in the bucket that can be listed. The next list requests to Amazon S3\n can be continued with this NextContinuationToken
.\n NextContinuationToken
is obfuscated and is not a real key
KeyCount is the number of keys returned with this request. KeyCount will always be less\n than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than\n equals 50 keys
" } }, - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", "traits": { - "smithy.api#documentation": "Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
" + "smithy.api#documentation": "If ContinuationToken was sent with the request, it is included in the response.
" } }, - "KeyCount": { - "target": "com.amazonaws.s3#KeyCount", + "NextContinuationToken": { + "target": "com.amazonaws.s3#NextToken", "traits": { - "smithy.api#documentation": "KeyCount is the number of keys returned with this request. KeyCount will always be less than equals to MaxKeys field. Say you ask for 50 keys, your result will include less than equals 50 keys
" + "smithy.api#documentation": "\n NextContinuationToken
is sent when isTruncated
is true, which\n means there are more keys in the bucket that can be listed. The next list requests to Amazon S3\n can be continued with this NextContinuationToken
.\n NextContinuationToken
is obfuscated and is not a real key
\t\n Keys that begin with the indicated prefix.
" + "smithy.api#documentation": "If StartAfter was sent with the request, it is included in the response.
" } } } @@ -7186,25 +7511,19 @@ "com.amazonaws.s3#ListObjectsV2Request": { "type": "structure", "members": { - "ContinuationToken": { - "target": "com.amazonaws.s3#Token", - "traits": { - "smithy.api#documentation": "ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key.
", - "smithy.api#httpQuery": "continuation-token" - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Bucket name to list.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "FetchOwner": { - "target": "com.amazonaws.s3#FetchOwner", + "Delimiter": { + "target": "com.amazonaws.s3#Delimiter", "traits": { - "smithy.api#documentation": "The owner field is not present in listV2 by default, if you want to return owner field with\n each key in the result then set the fetch owner field to true.
", - "smithy.api#httpQuery": "fetch-owner" + "smithy.api#documentation": "A delimiter is a character you use to group keys.
", + "smithy.api#httpQuery": "delimiter" } }, "EncodingType": { @@ -7214,11 +7533,11 @@ "smithy.api#httpQuery": "encoding-type" } }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "MaxKeys": { + "target": "com.amazonaws.s3#MaxKeys", "traits": { - "smithy.api#documentation": "Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.
", - "smithy.api#httpHeader": "x-amz-request-payer" + "smithy.api#documentation": "Sets the maximum number of keys returned in the response. By default the API returns up\n to 1,000 key names. The response might contain fewer keys but will never contain\n more.
", + "smithy.api#httpQuery": "max-keys" } }, "Prefix": { @@ -7228,33 +7547,39 @@ "smithy.api#httpQuery": "prefix" } }, - "StartAfter": { - "target": "com.amazonaws.s3#StartAfter", + "ContinuationToken": { + "target": "com.amazonaws.s3#Token", "traits": { - "smithy.api#documentation": "StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.
", - "smithy.api#httpQuery": "start-after" + "smithy.api#documentation": "ContinuationToken indicates Amazon S3 that the list is being continued on this bucket with a\n token. ContinuationToken is obfuscated and is not a real key.
", + "smithy.api#httpQuery": "continuation-token" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "FetchOwner": { + "target": "com.amazonaws.s3#FetchOwner", "traits": { - "smithy.api#documentation": "Bucket name to list.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The owner field is not present in listV2 by default, if you want to return owner field\n with each key in the result then set the fetch owner field to true.
", + "smithy.api#httpQuery": "fetch-owner" } }, - "Delimiter": { - "target": "com.amazonaws.s3#Delimiter", + "StartAfter": { + "target": "com.amazonaws.s3#StartAfter", "traits": { - "smithy.api#documentation": "A delimiter is a character you use to group keys.
", - "smithy.api#httpQuery": "delimiter" + "smithy.api#documentation": "StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this\n specified key. StartAfter can be any key in the bucket.
", + "smithy.api#httpQuery": "start-after" } }, - "MaxKeys": { - "target": "com.amazonaws.s3#MaxKeys", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "Sets the maximum number of keys returned in the response. By default the API returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
", - "smithy.api#httpQuery": "max-keys" + "smithy.api#documentation": "Confirms that the requester knows that she or he will be charged for the list objects\n request in V2 style. Bucket owners need not specify this parameter in their\n requests.
", + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the max-parts
request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated
field with the value of true, and a NextPartNumberMarker
element. In subsequent ListParts
requests you can include the part-number-marker query string parameter and set its value to the NextPartNumberMarker
field value from the previous response.
For more information on multipart uploads, see Uploading Objects Using Multipart Upload.
\n \nFor information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
\n \nThe following operations are related to ListParts
:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListMultipartUploads\n
\nLists the parts that have been uploaded for a specific multipart upload. This operation\n must include the upload ID, which you obtain by sending the initiate multipart upload\n request (see CreateMultipartUpload).\n This request returns a maximum of 1,000 uploaded parts. The default number of parts\n returned is 1,000 parts. You can restrict the number of parts returned by specifying the\n max-parts
request parameter. If your multipart upload consists of more than\n 1,000 parts, the response returns an IsTruncated
field with the value of true,\n and a NextPartNumberMarker
element. In subsequent ListParts
\n requests you can include the part-number-marker query string parameter and set its value to\n the NextPartNumberMarker
field value from the previous response.
For more information on multipart uploads, see Uploading Objects Using Multipart\n Upload.
\n\nFor information on permissions required to use the multipart upload API, see Multipart Upload API and\n Permissions.
\n\nThe following operations are related to ListParts
:
\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListMultipartUploads\n
\nClass of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded object.
" + "smithy.api#documentation": "If the bucket has a lifecycle rule configured with an action to abort incomplete\n multipart uploads and the prefix in the lifecycle rule matches the object name in the\n request, then the response includes this header indicating when the initiated multipart\n upload will become eligible for abort operation. For more information, see Aborting\n Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
\n\nThe response will also include the x-amz-abort-rule-id
header that will\n provide the ID of the lifecycle configuration rule that defines this action.
This header is returned along with the x-amz-abort-date
header. It identifies\n applicable lifecycle configuration rule that defines the action to abort incomplete\n multipart uploads.
This header is returned along with the x-amz-abort-date
header. It\n identifies applicable lifecycle configuration rule that defines the action to abort\n incomplete multipart uploads.
\t\n Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.
" - } - }, - "NextPartNumberMarker": { - "target": "com.amazonaws.s3#NextPartNumberMarker", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.
" + "smithy.api#documentation": "The name of the bucket to which the multipart upload was initiated.
" } }, "Key": { @@ -7310,22 +7636,22 @@ "smithy.api#documentation": "Object key for which the multipart upload was initiated.
" } }, - "PartNumberMarker": { - "target": "com.amazonaws.s3#PartNumberMarker", + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", "traits": { - "smithy.api#documentation": "When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.
" + "smithy.api#documentation": "Upload ID identifying the multipart upload whose parts are being listed.
" } }, - "Initiator": { - "target": "com.amazonaws.s3#Initiator", + "PartNumberMarker": { + "target": "com.amazonaws.s3#PartNumberMarker", "traits": { - "smithy.api#documentation": "Container element that identifies who initiated the multipart upload. If the initiator is an\n AWS account, this element provides the same information as the Owner
element.\n If the initiator is an IAM User, this element provides the user ARN and display\n name.
When a list is truncated, this element specifies the last part in the list, as well as\n the value to use for the part-number-marker request parameter in a subsequent\n request.
" } }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", + "NextPartNumberMarker": { + "target": "com.amazonaws.s3#NextPartNumberMarker", "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" + "smithy.api#documentation": "When a list is truncated, this element specifies the last part in the list, as well as\n the value to use for the part-number-marker request parameter in a subsequent\n request.
" } }, "MaxParts": { @@ -7334,11 +7660,10 @@ "smithy.api#documentation": "Maximum number of parts that were allowed in the response.
" } }, - "AbortDate": { - "target": "com.amazonaws.s3#AbortDate", + "IsTruncated": { + "target": "com.amazonaws.s3#IsTruncated", "traits": { - "smithy.api#documentation": "If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
\n \nThe response will also include the x-amz-abort-rule-id
header that will\n provide the ID of the lifecycle configuration rule that defines this action.
Indicates whether the returned list of parts is truncated. A true value indicates that\n the list was truncated. A list can be truncated if the number of parts exceeds the limit\n returned in the MaxParts element.
" } }, "Parts": { @@ -7349,22 +7674,28 @@ "smithy.api#xmlName": "Part" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "Initiator": { + "target": "com.amazonaws.s3#Initiator", + "traits": { + "smithy.api#documentation": "Container element that identifies who initiated the multipart upload. If the initiator\n is an AWS account, this element provides the same information as the Owner
\n element. If the initiator is an IAM User, this element provides the user ARN and display\n name.
The name of the bucket to which the multipart upload was initiated.
" + "smithy.api#documentation": "Container element that identifies the object owner, after the object is created. If\n multipart upload is initiated by an IAM user, this element provides the parent account ID\n and display name.
" } }, - "IsTruncated": { - "target": "com.amazonaws.s3#IsTruncated", + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "\t\n Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.
" + "smithy.api#documentation": "Class of storage (STANDARD or REDUCED_REDUNDANCY) used to store the uploaded\n object.
" } }, - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", "traits": { - "smithy.api#documentation": "Upload ID identifying the multipart upload whose parts are being listed.
" + "smithy.api#httpHeader": "x-amz-request-charged" } } } @@ -7372,24 +7703,18 @@ "com.amazonaws.s3#ListPartsRequest": { "type": "structure", "members": { - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "Upload ID identifying the multipart upload whose parts are being listed.
", - "smithy.api#httpQuery": "uploadId", + "smithy.api#documentation": "The name of the bucket to which the parts are being uploaded.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "The name of the bucket to which the parts are being uploaded.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#documentation": "Object key for which the multipart upload was initiated.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -7404,18 +7729,24 @@ "PartNumberMarker": { "target": "com.amazonaws.s3#PartNumberMarker", "traits": { - "smithy.api#documentation": "Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.
", + "smithy.api#documentation": "Specifies the part after which listing should begin. Only parts with higher part numbers\n will be listed.
", "smithy.api#httpQuery": "part-number-marker" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", "traits": { - "smithy.api#documentation": "Object key for which the multipart upload was initiated.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "Upload ID identifying the multipart upload whose parts are being listed.
", + "smithy.api#httpQuery": "uploadId", "smithy.api#required": {} } }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, "ExpectedBucketOwner": { "target": "com.amazonaws.s3#AccountId", "traits": { @@ -7434,12 +7765,6 @@ "com.amazonaws.s3#LoggingEnabled": { "type": "structure", "members": { - "TargetGrants": { - "target": "com.amazonaws.s3#TargetGrants", - "traits": { - "smithy.api#documentation": "Container for granting information.
" - } - }, "TargetBucket": { "target": "com.amazonaws.s3#TargetBucket", "traits": { @@ -7447,16 +7772,22 @@ "smithy.api#required": {} } }, + "TargetGrants": { + "target": "com.amazonaws.s3#TargetGrants", + "traits": { + "smithy.api#documentation": "Container for granting information.
" + } + }, "TargetPrefix": { "target": "com.amazonaws.s3#TargetPrefix", "traits": { - "smithy.api#documentation": "A prefix for all log object keys. If you store log files from multiple Amazon S3\n buckets in a single bucket, you can use a prefix to distinguish which log files\n came from which bucket.
", + "smithy.api#documentation": "A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a\n single bucket, you can use a prefix to distinguish which log files came from which\n bucket.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for\n a bucket. For more information, see PUT Bucket logging in the\n Amazon Simple Storage Service API Reference.
" + "smithy.api#documentation": "Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys\n for a bucket. For more information, see PUT Bucket logging in the\n Amazon Simple Storage Service API Reference.
" } }, "com.amazonaws.s3#MFA": { @@ -7531,17 +7862,17 @@ "com.amazonaws.s3#MetadataEntry": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.s3#MetadataValue", - "traits": { - "smithy.api#documentation": "Value of the Object.
" - } - }, "Name": { "target": "com.amazonaws.s3#MetadataKey", "traits": { "smithy.api#documentation": "Name of the Object.
" } + }, + "Value": { + "target": "com.amazonaws.s3#MetadataValue", + "traits": { + "smithy.api#documentation": "Value of the Object.
" + } } }, "traits": { @@ -7560,20 +7891,19 @@ "Status": { "target": "com.amazonaws.s3#MetricsStatus", "traits": { - "smithy.api#documentation": "\n Specifies whether the replication metrics are enabled.\n
", + "smithy.api#documentation": "Specifies whether the replication metrics are enabled.
", "smithy.api#required": {} } }, "EventThreshold": { "target": "com.amazonaws.s3#ReplicationTimeValue", "traits": { - "smithy.api#documentation": "\n A container specifying the time threshold for emitting the s3:Replication:OperationMissedThreshold
event.\n
A container specifying the time threshold for emitting the\n s3:Replication:OperationMissedThreshold
event.
A container specifying replication metrics-related settings enabling metrics and Amazon S3\n events for S3 Replication Time Control (S3 RTC). Must be specified together with a ReplicationTime
\n block.
A container specifying replication metrics-related settings enabling replication\n metrics and events.
" } }, "com.amazonaws.s3#MetricsAndOperator": { @@ -7595,7 +7925,7 @@ } }, "traits": { - "smithy.api#documentation": "A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator\n must have at least two predicates, and an object must match all of the predicates in order for the\n filter to apply.
" + "smithy.api#documentation": "A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates, and an object must match all of the\n predicates in order for the filter to apply.
" } }, "com.amazonaws.s3#MetricsConfiguration": { @@ -7611,12 +7941,12 @@ "Filter": { "target": "com.amazonaws.s3#MetricsFilter", "traits": { - "smithy.api#documentation": "Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction (MetricsAndOperator).
" + "smithy.api#documentation": "Specifies a metrics configuration filter. The metrics configuration will only include\n objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction\n (MetricsAndOperator).
" } } }, "traits": { - "smithy.api#documentation": "Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) \n from an Amazon S3 bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. \n If you don't include the elements you want to keep, they are erased. For more information, see \n PUT Bucket metrics in the Amazon Simple Storage Service API Reference.
" + "smithy.api#documentation": "Specifies a metrics configuration for the CloudWatch request metrics (specified by the\n metrics configuration ID) from an Amazon S3 bucket. If you're updating an existing metrics\n configuration, note that this is a full replacement of the existing metrics configuration.\n If you don't include the elements you want to keep, they are erased. For more information,\n see PUT Bucket\n metrics in the Amazon Simple Storage Service API Reference.
" } }, "com.amazonaws.s3#MetricsConfigurationList": { @@ -7628,12 +7958,6 @@ "com.amazonaws.s3#MetricsFilter": { "type": "structure", "members": { - "And": { - "target": "com.amazonaws.s3#MetricsAndOperator", - "traits": { - "smithy.api#documentation": "A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.
" - } - }, "Prefix": { "target": "com.amazonaws.s3#Prefix", "traits": { @@ -7645,10 +7969,16 @@ "traits": { "smithy.api#documentation": "The tag used when evaluating a metrics filter.
" } + }, + "And": { + "target": "com.amazonaws.s3#MetricsAndOperator", + "traits": { + "smithy.api#documentation": "A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter.\n The operator must have at least two predicates, and an object must match all of the\n predicates in order for the filter to apply.
" + } } }, "traits": { - "smithy.api#documentation": "Specifies a metrics configuration filter. The metrics configuration only\n includes objects that meet the filter's criteria. A filter must be a prefix, a\n tag, or a conjunction (MetricsAndOperator).
" + "smithy.api#documentation": "Specifies a metrics configuration filter. The metrics configuration only includes\n objects that meet the filter's criteria. A filter must be a prefix, a tag, or a conjunction\n (MetricsAndOperator).
" } }, "com.amazonaws.s3#MetricsId": { @@ -7676,12 +8006,6 @@ "com.amazonaws.s3#MultipartUpload": { "type": "structure", "members": { - "Initiator": { - "target": "com.amazonaws.s3#Initiator", - "traits": { - "smithy.api#documentation": "Identifies who initiated the multipart upload.
" - } - }, "UploadId": { "target": "com.amazonaws.s3#MultipartUploadId", "traits": { @@ -7694,10 +8018,10 @@ "smithy.api#documentation": "Key of the object for which the multipart upload was initiated.
" } }, - "Owner": { - "target": "com.amazonaws.s3#Owner", + "Initiated": { + "target": "com.amazonaws.s3#Initiated", "traits": { - "smithy.api#documentation": "Specifies the owner of the object that is part of the multipart upload.
" + "smithy.api#documentation": "Date and time at which the multipart upload was initiated.
" } }, "StorageClass": { @@ -7706,10 +8030,16 @@ "smithy.api#documentation": "The class of storage used to store the object.
" } }, - "Initiated": { - "target": "com.amazonaws.s3#Initiated", + "Owner": { + "target": "com.amazonaws.s3#Owner", "traits": { - "smithy.api#documentation": "Date and time at which the multipart upload was initiated.
" + "smithy.api#documentation": "Specifies the owner of the object that is part of the multipart upload.
" + } + }, + "Initiator": { + "target": "com.amazonaws.s3#Initiator", + "traits": { + "smithy.api#documentation": "Identifies who initiated the multipart upload.
" } } }, @@ -7733,7 +8063,7 @@ "type": "string" }, "com.amazonaws.s3#NextPartNumberMarker": { - "type": "integer" + "type": "string" }, "com.amazonaws.s3#NextToken": { "type": "string" @@ -7774,32 +8104,32 @@ "NoncurrentDays": { "target": "com.amazonaws.s3#Days", "traits": { - "smithy.api#documentation": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. For information about the noncurrent days calculations, see How\n Amazon S3 Calculates When an Object Became Noncurrent in the Amazon\n Simple Storage Service Developer Guide.
" + "smithy.api#documentation": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. For information about the noncurrent days calculations, see How\n Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple\n Storage Service Developer Guide.
" } } }, "traits": { - "smithy.api#documentation": "Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions.\n\nYou set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.
" + "smithy.api#documentation": "Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently\n deletes the noncurrent object versions. You set this lifecycle configuration action on a\n bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent\n object versions at a specific period in the object's lifetime.
" } }, "com.amazonaws.s3#NoncurrentVersionTransition": { "type": "structure", "members": { - "StorageClass": { - "target": "com.amazonaws.s3#TransitionStorageClass", + "NoncurrentDays": { + "target": "com.amazonaws.s3#Days", "traits": { - "smithy.api#documentation": "The class of storage used to store the object.
" + "smithy.api#documentation": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the\n associated action. For information about the noncurrent days calculations, see How\n Amazon S3 Calculates How Long an Object Has Been Noncurrent in the\n Amazon Simple Storage Service Developer Guide.
" } }, - "NoncurrentDays": { - "target": "com.amazonaws.s3#Days", + "StorageClass": { + "target": "com.amazonaws.s3#TransitionStorageClass", "traits": { - "smithy.api#documentation": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon Simple Storage Service Developer Guide.
" + "smithy.api#documentation": "The class of storage used to store the object.
" } } }, "traits": { - "smithy.api#documentation": "Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA
, ONEZONE_IA
, INTELLIGENT_TIERING
, GLACIER
, or DEEP_ARCHIVE
storage class.\n\nIf your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA
, ONEZONE_IA
, INTELLIGENT_TIERING
, GLACIER
, or DEEP_ARCHIVE
storage class at a specific period in the object's lifetime.
Container for the transition rule that describes when noncurrent objects transition to\n the STANDARD_IA
, ONEZONE_IA
, INTELLIGENT_TIERING
,\n GLACIER
, or DEEP_ARCHIVE
storage class. If your bucket is\n versioning-enabled (or versioning is suspended), you can set this action to request that\n Amazon S3 transition noncurrent object versions to the STANDARD_IA
,\n ONEZONE_IA
, INTELLIGENT_TIERING
, GLACIER
, or\n DEEP_ARCHIVE
storage class at a specific period in the object's\n lifetime.
The topic to which notifications are sent and the events for which notifications are generated.
", + "smithy.api#documentation": "The topic to which notifications are sent and the events for which notifications are\n generated.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "TopicConfiguration" } @@ -7822,7 +8152,7 @@ "QueueConfigurations": { "target": "com.amazonaws.s3#QueueConfigurationList", "traits": { - "smithy.api#documentation": "The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.
", + "smithy.api#documentation": "The Amazon Simple Queue Service queues to publish messages to and the events for which\n to publish messages.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "QueueConfiguration" } @@ -7830,14 +8160,14 @@ "LambdaFunctionConfigurations": { "target": "com.amazonaws.s3#LambdaFunctionConfigurationList", "traits": { - "smithy.api#documentation": "Describes the AWS Lambda functions to invoke and the events for which to invoke them.
", + "smithy.api#documentation": "Describes the AWS Lambda functions to invoke and the events for which to invoke\n them.
", "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "CloudFunctionConfiguration" } } }, "traits": { - "smithy.api#documentation": "A container for specifying the notification configuration of the bucket. If this element is\n empty, notifications are turned off for the bucket.
" + "smithy.api#documentation": "A container for specifying the notification configuration of the bucket. If this element\n is empty, notifications are turned off for the bucket.
" } }, "com.amazonaws.s3#NotificationConfigurationFilter": { @@ -7851,34 +8181,40 @@ } }, "traits": { - "smithy.api#documentation": "Specifies object key name filtering rules. For information about key name filtering, see\n Configuring\n Event Notifications in the Amazon Simple Storage Service Developer\n Guide.
" + "smithy.api#documentation": "Specifies object key name filtering rules. For information about key name filtering, see\n Configuring\n Event Notifications in the Amazon Simple Storage Service Developer\n Guide.
" } }, "com.amazonaws.s3#NotificationId": { "type": "string", "traits": { - "smithy.api#documentation": "An optional unique identifier for configurations in a notification configuration. If you don't\n provide one, Amazon S3 will assign an ID.
" + "smithy.api#documentation": "An optional unique identifier for configurations in a notification configuration. If you\n don't provide one, Amazon S3 will assign an ID.
" } }, "com.amazonaws.s3#Object": { "type": "structure", "members": { - "Size": { - "target": "com.amazonaws.s3#Size", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "Size in bytes of the object
" + "smithy.api#documentation": "The name that you assign to an object. You use the object key to retrieve the\n object.
" + } + }, + "LastModified": { + "target": "com.amazonaws.s3#LastModified", + "traits": { + "smithy.api#documentation": "The date the Object was Last Modified
" } }, "ETag": { "target": "com.amazonaws.s3#ETag", "traits": { - "smithy.api#documentation": "The entity tag is a hash of the object. The ETag reflects changes only to the\n contents of an object, not its metadata. The ETag may or may not be an MD5 digest of\n the object data. Whether or not it is depends on how the object was created and how it\n is encrypted as described below:
\nObjects created by the PUT Object, POST Object, or Copy operation, or through\n the AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags\n that are an MD5 digest of their object data.
\nObjects created by the PUT Object, POST Object, or Copy operation, or through\n the AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have\n ETags that are not an MD5 digest of their object data.
\nIf an object is created by either the Multipart Upload or Part Copy operation,\n the ETag is not an MD5 digest, regardless of the method of encryption.
\nThe entity tag is a hash of the object. The ETag reflects changes only to the contents\n of an object, not its metadata. The ETag may or may not be an MD5 digest of the object\n data. Whether or not it is depends on how the object was created and how it is encrypted as\n described below:
\nObjects created by the PUT Object, POST Object, or Copy operation, or through the\n AWS Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are\n an MD5 digest of their object data.
\nObjects created by the PUT Object, POST Object, or Copy operation, or through the\n AWS Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are\n not an MD5 digest of their object data.
\nIf an object is created by either the Multipart Upload or Part Copy operation, the\n ETag is not an MD5 digest, regardless of the method of encryption.
\nThe owner of the object
" + "smithy.api#documentation": "Size in bytes of the object
" } }, "StorageClass": { @@ -7887,16 +8223,10 @@ "smithy.api#documentation": "The class of storage used to store the object.
" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", - "traits": { - "smithy.api#documentation": "The name that you assign to an object. You use the object key to retrieve the object.
" - } - }, - "LastModified": { - "target": "com.amazonaws.s3#LastModified", + "Owner": { + "target": "com.amazonaws.s3#Owner", "traits": { - "smithy.api#documentation": "The date the Object was Last Modified
" + "smithy.api#documentation": "The owner of the object
" } } }, @@ -8099,7 +8429,7 @@ "DefaultRetention": { "target": "com.amazonaws.s3#DefaultRetention", "traits": { - "smithy.api#documentation": "The default retention period that you want to apply to new objects placed in the specified bucket.
" + "smithy.api#documentation": "The default retention period that you want to apply to new objects placed in the\n specified bucket.
" } } }, @@ -8114,7 +8444,7 @@ "type": "structure", "members": {}, "traits": { - "smithy.api#documentation": "The source object of the COPY operation is not in the active tier and is only stored in Amazon\n S3 Glacier.
", + "smithy.api#documentation": "The source object of the COPY operation is not in the active tier and is only stored in\n Amazon S3 Glacier.
", "smithy.api#error": "client" } }, @@ -8166,16 +8496,16 @@ "com.amazonaws.s3#ObjectVersion": { "type": "structure", "members": { - "Size": { - "target": "com.amazonaws.s3#Size", + "ETag": { + "target": "com.amazonaws.s3#ETag", "traits": { - "smithy.api#documentation": "Size in bytes of the object.
" + "smithy.api#documentation": "The entity tag is an MD5 hash of that version of the object.
" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "Size": { + "target": "com.amazonaws.s3#Size", "traits": { - "smithy.api#documentation": "The object key.
" + "smithy.api#documentation": "Size in bytes of the object.
" } }, "StorageClass": { @@ -8184,22 +8514,22 @@ "smithy.api#documentation": "The class of storage used to store the object.
" } }, - "Owner": { - "target": "com.amazonaws.s3#Owner", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "Specifies the owner of the object.
" + "smithy.api#documentation": "The object key.
" } }, - "IsLatest": { - "target": "com.amazonaws.s3#IsLatest", + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", "traits": { - "smithy.api#documentation": "Specifies whether the object is (true) or is not (false) the latest version of an object.
" + "smithy.api#documentation": "Version ID of an object.
" } }, - "ETag": { - "target": "com.amazonaws.s3#ETag", + "IsLatest": { + "target": "com.amazonaws.s3#IsLatest", "traits": { - "smithy.api#documentation": "The entity tag is an MD5 hash of that version of the object.
" + "smithy.api#documentation": "Specifies whether the object is (true) or is not (false) the latest version of an\n object.
" } }, "LastModified": { @@ -8208,10 +8538,10 @@ "smithy.api#documentation": "Date and time the object was last modified.
" } }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", + "Owner": { + "target": "com.amazonaws.s3#Owner", "traits": { - "smithy.api#documentation": "Version ID of an object.
" + "smithy.api#documentation": "Specifies the owner of the object.
" } } }, @@ -8255,17 +8585,17 @@ "com.amazonaws.s3#OutputSerialization": { "type": "structure", "members": { - "JSON": { - "target": "com.amazonaws.s3#JSONOutput", - "traits": { - "smithy.api#documentation": "Specifies JSON as request's output serialization format.
" - } - }, "CSV": { "target": "com.amazonaws.s3#CSVOutput", "traits": { "smithy.api#documentation": "Describes the serialization of CSV-encoded Select results.
" } + }, + "JSON": { + "target": "com.amazonaws.s3#JSONOutput", + "traits": { + "smithy.api#documentation": "Specifies JSON as request's output serialization format.
" + } } }, "traits": { @@ -8349,10 +8679,10 @@ "com.amazonaws.s3#Part": { "type": "structure", "members": { - "Size": { - "target": "com.amazonaws.s3#Size", + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", "traits": { - "smithy.api#documentation": "Size in bytes of the uploaded part data.
" + "smithy.api#documentation": "Part number identifying the part. This is a positive integer between 1 and\n 10,000.
" } }, "LastModified": { @@ -8361,17 +8691,17 @@ "smithy.api#documentation": "Date and time at which the part was uploaded.
" } }, - "PartNumber": { - "target": "com.amazonaws.s3#PartNumber", - "traits": { - "smithy.api#documentation": "Part number identifying the part. This is a positive integer between 1 and 10,000.
" - } - }, "ETag": { "target": "com.amazonaws.s3#ETag", "traits": { "smithy.api#documentation": "Entity tag returned when the part was uploaded.
" } + }, + "Size": { + "target": "com.amazonaws.s3#Size", + "traits": { + "smithy.api#documentation": "Size in bytes of the uploaded part data.
" + } } }, "traits": { @@ -8382,7 +8712,7 @@ "type": "integer" }, "com.amazonaws.s3#PartNumberMarker": { - "type": "integer" + "type": "string" }, "com.amazonaws.s3#Parts": { "type": "list", @@ -8437,7 +8767,7 @@ "IsPublic": { "target": "com.amazonaws.s3#IsPublic", "traits": { - "smithy.api#documentation": "The policy status for this bucket. TRUE
indicates that this bucket is public.\n FALSE
indicates that the bucket is not public.
The policy status for this bucket. TRUE
indicates that this bucket is\n public. FALSE
indicates that the bucket is not public.
Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting\n this element to TRUE
causes Amazon S3 to reject calls to PUT Bucket policy if the\n specified bucket policy allows public access.
Enabling this setting doesn't affect existing bucket policies.
", - "smithy.api#xmlName": "BlockPublicPolicy" + "smithy.api#documentation": "Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket\n and objects in this bucket. Setting this element to TRUE
causes the following\n behavior:
PUT Bucket acl and PUT Object acl calls fail if the specified ACL is\n public.
\nPUT Object calls fail if the request includes a public ACL.
\nPUT Bucket calls fail if the request includes a public ACL.
\nEnabling this setting doesn't affect existing policies or ACLs.
", + "smithy.api#xmlName": "BlockPublicAcls" } }, - "BlockPublicAcls": { + "IgnorePublicAcls": { "target": "com.amazonaws.s3#Setting", "traits": { - "smithy.api#documentation": "Specifies whether Amazon S3 should block public access control lists (ACLs) for this\n bucket and objects in this bucket. Setting this element to TRUE
causes the\n following behavior:
PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
\nPUT Object calls fail if the request includes a public ACL.
\nPUT Bucket calls fail if the request includes a public ACL.
\nEnabling this setting doesn't affect existing policies or ACLs.
", - "smithy.api#xmlName": "BlockPublicAcls" + "smithy.api#documentation": "Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this\n bucket. Setting this element to TRUE
causes Amazon S3 to ignore all public ACLs on\n this bucket and objects in this bucket.
Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't\n prevent new public ACLs from being set.
", + "smithy.api#xmlName": "IgnorePublicAcls" } }, - "RestrictPublicBuckets": { + "BlockPublicPolicy": { "target": "com.amazonaws.s3#Setting", "traits": { - "smithy.api#documentation": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket.\n Setting this element to TRUE
restricts access to this bucket to only AWS services\n and authorized users within this account if the bucket has a public policy.
Enabling this setting doesn't affect previously stored bucket policies, except that public\n and cross-account access within any public bucket policy, including non-public delegation to\n specific accounts, is blocked.
", - "smithy.api#xmlName": "RestrictPublicBuckets" + "smithy.api#documentation": "Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this\n element to TRUE
causes Amazon S3 to reject calls to PUT Bucket policy if the\n specified bucket policy allows public access.
Enabling this setting doesn't affect existing bucket policies.
", + "smithy.api#xmlName": "BlockPublicPolicy" } }, - "IgnorePublicAcls": { + "RestrictPublicBuckets": { "target": "com.amazonaws.s3#Setting", "traits": { - "smithy.api#documentation": "Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this\n bucket. Setting this element to TRUE
causes Amazon S3 to ignore all public ACLs\n on this bucket and objects in this bucket.
Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't\n prevent new public ACLs from being set.
", - "smithy.api#xmlName": "IgnorePublicAcls" + "smithy.api#documentation": "Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting\n this element to TRUE
restricts access to this bucket to only AWS service\n principals and authorized users within this account if the bucket has a public\n policy.
Enabling this setting doesn't affect previously stored bucket policies, except that\n public and cross-account access within any public bucket policy, including non-public\n delegation to specific accounts, is blocked.
", + "smithy.api#xmlName": "RestrictPublicBuckets" } } }, "traits": { - "smithy.api#documentation": "The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You\n can enable the configuration options in any combination. For more information about when\n Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer Guide.
" + "smithy.api#documentation": "The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can\n enable the configuration options in any combination. For more information about when Amazon S3\n considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer Guide.
" } }, "com.amazonaws.s3#PutBucketAccelerateConfiguration": { @@ -8548,7 +8878,7 @@ "target": "com.amazonaws.s3#PutBucketAccelerateConfigurationRequest" }, "traits": { - "smithy.api#documentation": "Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.
\n \nTo use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
\n \nThe Transfer Acceleration state of a bucket can be set to one of the following two values:
\nEnabled – Enables accelerated data transfers to the bucket.
\nSuspended – Disables accelerated data transfers to the bucket.
\nThe GetBucketAccelerateConfiguration operation returns the transfer acceleration state of a bucket.
\n \nAfter setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.
\n \nThe name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (\".\").
\n \nFor more information about transfer acceleration, see Transfer Acceleration.
\n \nThe following operations are related to PutBucketAccelerateConfiguration
:
\n CreateBucket\n
\nSets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a\n bucket-level feature that enables you to perform faster data transfers to Amazon S3.
\n\nTo use this operation, you must have permission to perform the\n s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The\n bucket owner can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
\n\nThe Transfer Acceleration state of a bucket can be set to one of the following two\n values:
\nEnabled – Enables accelerated data transfers to the bucket.
\nSuspended – Disables accelerated data transfers to the bucket.
\nThe GetBucketAccelerateConfiguration operation returns the transfer acceleration\n state of a bucket.
\n\nAfter setting the Transfer Acceleration state of a bucket to Enabled, it might take up\n to thirty minutes before the data transfer rates to the bucket increase.
\n\nThe name of the bucket used for Transfer Acceleration must be DNS-compliant and must\n not contain periods (\".\").
\n\nFor more information about transfer acceleration, see Transfer Acceleration.
\n\nThe following operations are related to\n PutBucketAccelerateConfiguration
:
\n CreateBucket\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Sets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using\n ACLs. To set the ACL of a bucket, you must have WRITE_ACP
\n permission.
You can use one of the following two ways to set a bucket's permissions:
\nSpecify the ACL in the request body
\nSpecify permissions using request headers
\nYou cannot specify access permission using both the body and the request headers.
\nDepending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.
\n \n \n\n Access Permissions\n
\nYou can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl
request header. Amazon S3 supports a set\n of predefined ACLs, known as canned ACLs. Each canned ACL has a\n predefined set of grantees and permissions. Specify the canned ACL name as the value\n of x-amz-acl
. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
,\n x-amz-grant-read-acp
, x-amz-grant-write-acp
, and\n x-amz-grant-full-control
headers. When using these headers, you\n specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups)\n who will receive the permission. If you use these ACL-specific headers, you cannot\n use the x-amz-acl
header to set a canned ACL. These parameters map to\n the set of permissions that Amazon S3 supports in an ACL. For more information, see\n Access Control List (ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
\n\n id
– if the value specified is the canonical user ID of an AWS account
\n uri
– if you are granting permissions to a predefined group
\n emailAddress
– if the value specified is the email address of an AWS\n account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
\nFor example, the following x-amz-grant-write
header grants\n create, overwrite, and delete objects permission to LogDelivery group predefined by\n Amazon S3 and two AWS accounts identified by their email addresses.
\n x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\", id=\"111122223333\", id=\"555566667777\"\n
\n
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
\n\n Grantee Values\n
\nYou can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
\nBy the person's ID:
\n\n
\n
DisplayName is optional and ignored in the request
\nBy URI:
\n\n
\n
By Email address:
\n\n
\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.\n
\nUsing email addresses to specify a grantee is only supported in the following AWS Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
\n\n Related Resources\n
\n\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetObjectAcl\n
\nSets the permissions on an existing bucket using access control lists (ACL). For more\n information, see Using ACLs. To set\n the ACL of a bucket, you must have WRITE_ACP
permission.
You can use one of the following two ways to set a bucket's permissions:
\nSpecify the ACL in the request body
\nSpecify permissions using request headers
\nYou cannot specify access permission using both the body and the request\n headers.
\nDepending on your application needs, you may choose to set the ACL on a bucket using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, then you can continue to use that\n approach.
\n\n\n\n Access Permissions\n
\nYou can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl
request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL\n has a predefined set of grantees and permissions. Specify the canned ACL name as the\n value of x-amz-acl
. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
,\n x-amz-grant-read-acp
, x-amz-grant-write-acp
, and\n x-amz-grant-full-control
headers. When using these headers, you\n specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n the x-amz-acl
header to set a canned ACL. These parameters map to the\n set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL)\n Overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id
– if the value specified is the canonical user ID of an AWS\n account
\n uri
– if you are granting permissions to a predefined\n group
\n emailAddress
– if the value specified is the email address of\n an AWS account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
\nFor example, the following x-amz-grant-write
header grants create,\n overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and\n two AWS accounts identified by their email addresses.
\n x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\",\n id=\"111122223333\", id=\"555566667777\"
\n
You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.
\n\n Grantee Values\n
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
\n
DisplayName is optional and ignored in the request
\nBy URI:
\n\n
\n
By Email address:
\n\n
\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following AWS Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
\n\n Related Resources\n
\n\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetObjectAcl\n
\nAllows grantee the read, write, read ACP, and write ACP permissions on the bucket.
", - "smithy.api#httpHeader": "x-amz-grant-full-control" + "smithy.api#documentation": "The canned ACL to apply to the bucket.
", + "smithy.api#httpHeader": "x-amz-acl" + } + }, + "AccessControlPolicy": { + "target": "com.amazonaws.s3#AccessControlPolicy", + "traits": { + "smithy.api#documentation": "Contains the elements that set the ACL permissions for an object per grantee.
", + "smithy.api#httpPayload": {} } }, "Bucket": { @@ -8617,56 +8954,49 @@ "smithy.api#required": {} } }, - "GrantReadACP": { - "target": "com.amazonaws.s3#GrantReadACP", - "traits": { - "smithy.api#documentation": "Allows grantee to read the bucket ACL.
", - "smithy.api#httpHeader": "x-amz-grant-read-acp" - } - }, - "GrantWrite": { - "target": "com.amazonaws.s3#GrantWrite", - "traits": { - "smithy.api#documentation": "Allows grantee to create, overwrite, and delete any object in the bucket.
", - "smithy.api#httpHeader": "x-amz-grant-write" - } - }, "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { "smithy.api#deprecated": { "message": "Content-MD5 header will now be automatically computed and injected in associated operation's Http request." }, - "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity \n check to verify that the request body was not corrupted in transit. For more information, go to \n RFC 1864.\n
", + "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.\n
", "smithy.api#httpHeader": "Content-MD5" } }, - "ACL": { - "target": "com.amazonaws.s3#BucketCannedACL", + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", "traits": { - "smithy.api#documentation": "The canned ACL to apply to the bucket.
", - "smithy.api#httpHeader": "x-amz-acl" + "smithy.api#documentation": "Allows grantee the read, write, read ACP, and write ACP permissions on the\n bucket.
", + "smithy.api#httpHeader": "x-amz-grant-full-control" } }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", "traits": { - "smithy.api#documentation": "Allows grantee to write the ACL for the applicable bucket.
", - "smithy.api#httpHeader": "x-amz-grant-write-acp" + "smithy.api#documentation": "Allows grantee to list the objects in the bucket.
", + "smithy.api#httpHeader": "x-amz-grant-read" } }, - "AccessControlPolicy": { - "target": "com.amazonaws.s3#AccessControlPolicy", + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", "traits": { - "smithy.api#documentation": "Contains the elements that set the ACL permissions for an object per grantee.
", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "Allows grantee to read the bucket ACL.
", + "smithy.api#httpHeader": "x-amz-grant-read-acp" } }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", + "GrantWrite": { + "target": "com.amazonaws.s3#GrantWrite", "traits": { - "smithy.api#documentation": "Allows grantee to list the objects in the bucket.
", - "smithy.api#httpHeader": "x-amz-grant-read" + "smithy.api#documentation": "Allows grantee to create, overwrite, and delete any object in the bucket.
", + "smithy.api#httpHeader": "x-amz-grant-write" + } + }, + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", + "traits": { + "smithy.api#documentation": "Allows grantee to write the ACL for the applicable bucket.
", + "smithy.api#httpHeader": "x-amz-grant-write-acp" } }, "ExpectedBucketOwner": { @@ -8684,7 +9014,7 @@ "target": "com.amazonaws.s3#PutBucketAnalyticsConfigurationRequest" }, "traits": { - "smithy.api#documentation": "Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.
\n \nYou can choose to have storage class analysis export analysis reports sent to a\n comma-separated values (CSV) flat file. See the DataExport
request element.\n Reports are updated daily and are based on the object filters that you configure. When\n selecting data export, you specify a destination bucket and an optional destination prefix\n where the file is written. You can export the data to a destination bucket in a different\n account. However, the destination bucket must be in the same Region as the bucket that you\n are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis.
You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
\nTo use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
\n Special Errors\n
\n\n HTTP Error: HTTP 400 Bad Request \n
\n\n Code: InvalidArgument \n
\n\n Cause: Invalid argument. \n
\n\n HTTP Error: HTTP 400 Bad Request \n
\n\n Code: TooManyConfigurations \n
\n\n Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. \n
\n\n HTTP Error: HTTP 403 Forbidden \n
\n\n Code: AccessDenied \n
\n\n Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket. \n
\n\n Related Resources\n
\nSets an analytics configuration for the bucket (specified by the analytics configuration\n ID). You can have up to 1,000 analytics configurations per bucket.
\n\nYou can choose to have storage class analysis export analysis reports sent to a\n comma-separated values (CSV) flat file. See the DataExport
request element.\n Reports are updated daily and are based on the object filters that you configure. When\n selecting data export, you specify a destination bucket and an optional destination prefix\n where the file is written. You can export the data to a destination bucket in a different\n account. However, the destination bucket must be in the same Region as the bucket that you\n are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class\n Analysis.
You must create a bucket policy on the destination bucket where the exported file is\n written to grant permissions to Amazon S3 to write objects to the bucket. For an example\n policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
\nTo use this operation, you must have permissions to perform the\n s3:PutAnalyticsConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
\n Special Errors\n
\n\n HTTP Error: HTTP 400 Bad Request\n
\n\n Code: InvalidArgument\n
\n\n Cause: Invalid argument.\n
\n\n HTTP Error: HTTP 400 Bad Request\n
\n\n Code: TooManyConfigurations\n
\n\n Cause: You are attempting to create a new configuration but have\n already reached the 1,000-configuration limit.\n
\n\n HTTP Error: HTTP 403 Forbidden\n
\n\n Code: AccessDenied\n
\n\n Cause: You are not the owner of the specified bucket, or you do\n not have the s3:PutAnalyticsConfiguration bucket permission to set the\n configuration on the bucket.\n
\n\n Related Resources\n
\nThe ID that identifies the analytics configuration.
", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} - } - }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -8711,6 +9033,14 @@ "smithy.api#required": {} } }, + "Id": { + "target": "com.amazonaws.s3#AnalyticsId", + "traits": { + "smithy.api#documentation": "The ID that identifies the analytics configuration.
", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, "AnalyticsConfiguration": { "target": "com.amazonaws.s3#AnalyticsConfiguration", "traits": { @@ -8734,7 +9064,7 @@ "target": "com.amazonaws.s3#PutBucketCorsRequest" }, "traits": { - "smithy.api#documentation": "Sets the cors
configuration for your bucket. If the configuration exists, Amazon S3 replaces it.
To use this operation, you must be allowed to perform the s3:PutBucketCORS
action. \n By default, the bucket owner has this permission and can grant it to others.
You set this configuration on a bucket so that the bucket can service cross-origin requests.\n For example, you might want to enable a request whose origin is http://www.example.com
to access your \n Amazon S3 bucket at my.example.bucket.com
by using the browser's XMLHttpRequest
capability.
To enable cross-origin resource sharing (CORS) on a bucket, you add the cors
subresource to the bucket. \n The cors
subresource is an XML document in which you configure rules that identify origins and the HTTP \n methods that can be executed on your bucket. The document is limited to 64 KB in size.
When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a\n bucket, it evaluates the cors
configuration on the bucket and uses the\n first CORSRule
rule that matches the incoming browser request to enable a\n cross-origin request. For a rule to match, the following conditions must be met:
The request's Origin
header must match AllowedOrigin
\n elements.
The request method (for example, GET, PUT, HEAD, and so on) or the\n Access-Control-Request-Method
header in case of a pre-flight\n OPTIONS
request must be one of the AllowedMethod
\n elements.
Every header specified in the Access-Control-Request-Headers
request header of a\n pre-flight request must match an AllowedHeader
element.
For more information about CORS, go to Enabling\n Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.
\n \n\n Related Resources\n
\n\n GetBucketCors\n
\n\n DeleteBucketCors\n
\n\n RESTOPTIONSobject\n
\nSets the cors
configuration for your bucket. If the configuration exists,\n Amazon S3 replaces it.
To use this operation, you must be allowed to perform the s3:PutBucketCORS
\n action. By default, the bucket owner has this permission and can grant it to others.
You set this configuration on a bucket so that the bucket can service cross-origin\n requests. For example, you might want to enable a request whose origin is\n http://www.example.com
to access your Amazon S3 bucket at\n my.example.bucket.com
by using the browser's XMLHttpRequest
\n capability.
To enable cross-origin resource sharing (CORS) on a bucket, you add the\n cors
subresource to the bucket. The cors
subresource is an XML\n document in which you configure rules that identify origins and the HTTP methods that can\n be executed on your bucket. The document is limited to 64 KB in size.
When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a\n bucket, it evaluates the cors
configuration on the bucket and uses the first\n CORSRule
rule that matches the incoming browser request to enable a\n cross-origin request. For a rule to match, the following conditions must be met:
The request's Origin
header must match AllowedOrigin
\n elements.
The request method (for example, GET, PUT, HEAD, and so on) or the\n Access-Control-Request-Method
header in case of a pre-flight\n OPTIONS
request must be one of the AllowedMethod
\n elements.
Every header specified in the Access-Control-Request-Headers
request\n header of a pre-flight request must match an AllowedHeader
element.\n
For more information about CORS, go to Enabling\n Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.
\n \n\n Related Resources\n
\n\n GetBucketCors\n
\n\n DeleteBucketCors\n
\n\n RESTOPTIONSobject\n
\nDescribes the cross-origin access configuration for objects in an Amazon S3 bucket. For more\n information, see Enabling Cross-Origin Resource\n Sharing in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { "smithy.api#deprecated": { "message": "Content-MD5 header will now be automatically computed and injected in associated operation's Http request." }, - "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity \n check to verify that the request body was not corrupted in transit. For more information, go to \n RFC 1864.\n
", + "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.\n
", "smithy.api#httpHeader": "Content-MD5" } }, - "CORSConfiguration": { - "target": "com.amazonaws.s3#CORSConfiguration", - "traits": { - "smithy.api#documentation": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more\n information, see Enabling Cross-Origin Resource\n Sharing in the Amazon Simple Storage Service Developer Guide.
", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, "ExpectedBucketOwner": { "target": "com.amazonaws.s3#AccountId", "traits": { @@ -8787,7 +9117,7 @@ "target": "com.amazonaws.s3#PutBucketEncryptionRequest" }, "traits": { - "smithy.api#documentation": "This implementation of the PUT
operation uses the encryption
subresource to set the default encryption \n state of an existing bucket.
This implementation of the PUT
operation sets default encryption for a\n bucket using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer\n master keys (CMKs) (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.
This operation requires AWS Signature Version 4. For more information, see \n Authenticating Requests (AWS Signature Version 4).\n
\nTo use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration
action. \n The bucket owner has this permission by default. The bucket owner can grant this permission to others. \n For more information about permissions, see \n Permissions Related to Bucket Subresource Operations \n and Managing Access Permissions to Your Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide. \n
\n Related Resources\n
\n\n GetBucketEncryption\n
\nThis implementation of the PUT
operation uses the encryption
\n subresource to set the default encryption state of an existing bucket.
This implementation of the PUT
operation sets default encryption for a\n bucket using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer\n master keys (CMKs) (SSE-KMS). For information about the Amazon S3 default encryption feature,\n see Amazon S3 Default Bucket\n Encryption.
This operation requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature\n Version 4).
\nTo use this operation, you must have permissions to perform the\n s3:PutEncryptionConfiguration
action. The bucket owner has this permission\n by default. The bucket owner can grant this permission to others. For more information\n about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.
\n Related Resources\n
\n\n GetBucketEncryption\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed\n keys (SSE-S3) or customer master keys stored in AWS KMS (SSE-KMS). For information about\n the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption\n in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "ContentMD5": { @@ -8816,17 +9147,59 @@ "smithy.api#httpHeader": "Content-MD5" } }, + "ServerSideEncryptionConfiguration": { + "target": "com.amazonaws.s3#ServerSideEncryptionConfiguration", + "traits": { + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Puts a S3 Intelligent-Tiering configuration to the specified bucket.
\nThe S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
\nThe S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
\nIf you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
\nOperations related to\n PutBucketIntelligentTieringConfiguration
include:
Specifies default encryption for a bucket using server-side encryption with Amazon S3-managed keys (SSE-S3) or customer master keys stored in AWS KMS (SSE-KMS). For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#documentation": "The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ServerSideEncryptionConfiguration": { - "target": "com.amazonaws.s3#ServerSideEncryptionConfiguration", + "Id": { + "target": "com.amazonaws.s3#IntelligentTieringId", + "traits": { + "smithy.api#documentation": "The ID used to identify the S3 Intelligent-Tiering configuration.
", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, + "IntelligentTieringConfiguration": { + "target": "com.amazonaws.s3#IntelligentTieringConfiguration", "traits": { + "smithy.api#documentation": "Container for S3 Intelligent-Tiering configuration.
", "smithy.api#httpPayload": {}, "smithy.api#required": {} } @@ -8839,7 +9212,7 @@ "target": "com.amazonaws.s3#PutBucketInventoryConfigurationRequest" }, "traits": { - "smithy.api#documentation": "This implementation of the PUT
operation adds an inventory configuration (identified \n by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket. \n
Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published \n to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the \n inventory flat file is stored is called the destination bucket. The destination bucket must be in the same \n AWS Region as the source bucket.
\nWhen you configure an inventory for a source bucket, you specify the destination bucket\n where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object\n metadata to include and whether to inventory all object versions or only current versions. For more information, see \n Amazon S3 Inventory in the Amazon Simple Storage Service Developer Guide.
\nYou must create a bucket policy on the destination bucket to grant\n permissions to Amazon S3 to write objects to the bucket in the defined location. For an\n example policy, see \n Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
\nTo use this operation, you must have permissions to perform the s3:PutInventoryConfiguration
action. The bucket \n owner has this permission by default and can grant this permission to others. For more information about permissions, see \n Permissions Related to \n Bucket Subresource Operations and Managing Access Permissions to Your \n Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.
\n Special Errors\n
\n\n HTTP 400 Bad Request Error\n
\n\n Code: InvalidArgument
\n\n Cause: Invalid Argument
\n\n HTTP 400 Bad Request Error\n
\n\n Code: TooManyConfigurations
\n\n Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration \n limit.
\n\n HTTP 403 Forbidden Error\n
\n\n Code: AccessDenied
\n\n Cause: You are not the owner of the specified bucket,\n or you do not have the s3:PutInventoryConfiguration
bucket\n permission to set the configuration on the bucket.
\n Related Resources\n
\nThis implementation of the PUT
operation adds an inventory configuration\n (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory\n configurations per bucket.
Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly\n basis, and the results are published to a flat file. The bucket that is inventoried is\n called the source bucket, and the bucket where the inventory flat file\n is stored is called the destination bucket. The\n destination bucket must be in the same AWS Region as the\n source bucket.
\nWhen you configure an inventory for a source bucket, you specify\n the destination bucket where you want the inventory to be stored, and\n whether to generate the inventory daily or weekly. You can also configure what object\n metadata to include and whether to inventory all object versions or only current versions.\n For more information, see Amazon S3\n Inventory in the Amazon Simple Storage Service Developer Guide.
\nYou must create a bucket policy on the destination bucket to\n grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an\n example policy, see \n Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
\nTo use this operation, you must have permissions to perform the\n s3:PutInventoryConfiguration
action. The bucket owner has this permission\n by default and can grant this permission to others. For more information about permissions,\n see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.
\n Special Errors\n
\n\n HTTP 400 Bad Request Error\n
\n\n Code: InvalidArgument
\n\n Cause: Invalid Argument
\n\n HTTP 400 Bad Request Error\n
\n\n Code: TooManyConfigurations
\n\n Cause: You are attempting to create a new configuration\n but have already reached the 1,000-configuration limit.
\n\n HTTP 403 Forbidden Error\n
\n\n Code: AccessDenied
\n\n Cause: You are not the owner of the specified bucket,\n or you do not have the s3:PutInventoryConfiguration
bucket\n permission to set the configuration on the bucket.
\n Related Resources\n
\nCreates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3 Resources.
\n \nBucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.
\n\n Rules \n
\nYou specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:
\n \nFilter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.
\nStatus whether the rule is in effect.
\nOne or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.
\nFor more information, see Object Lifecycle Management and Lifecycle Configuration Elements.
\n \n \n\n Permissions \n
\n \n \nBy default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the AWS account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.
\n \nYou can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
\n \ns3:DeleteObject
\ns3:DeleteObjectVersion
\ns3:PutLifecycleConfiguration
\nFor more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.
\n \nThe following are related to PutBucketLifecycleConfiguration
:
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle\n configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3\n Resources.
\n\nBucket lifecycle configuration now supports specifying a lifecycle rule using an\n object key name prefix, one or more object tags, or a combination of both. Accordingly,\n this section describes the latest API. The previous version of the API supported\n filtering based only on an object key name prefix, which is supported for backward\n compatibility. For the related API description, see PutBucketLifecycle.
\n\n Rules\n
\nYou specify the lifecycle configuration in your request body. The lifecycle\n configuration is specified as XML consisting of one or more rules. Each rule consists of\n the following:
\n\nFilter identifying a subset of objects to which the rule applies. The filter can\n be based on a key name prefix, object tags, or a combination of both.
\nStatus whether the rule is in effect.
\nOne or more lifecycle transition and expiration actions that you want Amazon S3 to\n perform on the objects identified by the filter. If the state of your bucket is\n versioning-enabled or versioning-suspended, you can have many versions of the same\n object (one current version and zero or more noncurrent versions). Amazon S3 provides\n predefined actions that you can specify for current and noncurrent object\n versions.
\nFor more information, see Object\n Lifecycle Management and Lifecycle Configuration Elements.
\n\n\n\n Permissions\n
\n\n\nBy default, all Amazon S3 resources are private, including buckets, objects, and related\n subresources (for example, lifecycle configuration and website configuration). Only the\n resource owner (that is, the AWS account that created it) can access the resource. The\n resource owner can optionally grant access permissions to others by writing an access\n policy. For this operation, a user must get the s3:PutLifecycleConfiguration\n permission.
\n\nYou can also explicitly deny permissions. Explicit deny also supersedes any other\n permissions. If you want to block users or accounts from removing or deleting objects from\n your bucket, you must deny them permissions for the following actions:
\n\ns3:DeleteObject
\ns3:DeleteObjectVersion
\ns3:PutLifecycleConfiguration
\nFor more information about permissions, see Managing Access Permissions to Your Amazon S3\n Resources.
\n\nThe following are related to PutBucketLifecycleConfiguration
:
Container for lifecycle rules. You can add as many as 1,000 rules.
", - "smithy.api#httpPayload": {} - } - }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -8916,6 +9282,13 @@ "smithy.api#required": {} } }, + "LifecycleConfiguration": { + "target": "com.amazonaws.s3#BucketLifecycleConfiguration", + "traits": { + "smithy.api#documentation": "Container for lifecycle rules. You can add as many as 1,000 rules.
", + "smithy.api#httpPayload": {} + } + }, "ExpectedBucketOwner": { "target": "com.amazonaws.s3#AccountId", "traits": { @@ -8931,7 +9304,7 @@ "target": "com.amazonaws.s3#PutBucketLoggingRequest" }, "traits": { - "smithy.api#documentation": "Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.
\n \nThe bucket owner is automatically granted FULL_CONTROL to all logs. You use the\n Grantee
request element to grant access to other people. The\n Permissions
request element specifies the kind of access the grantee has to\n the logs.
\n Grantee Values\n
\nYou can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
\n \nBy the person's ID:
\n\n
\n
DisplayName is optional and ignored in the request.
\nBy Email address:
\n\n
\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
\nBy URI:
\n\n
\n
To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:
\n \n\n
\n
For more information about server access logging, see Server Access Logging.
\n \nFor more information about creating a bucket, see CreateBucket. \n For more information about returning the logging status of a bucket, see GetBucketLogging.
\n \nThe following operations are related to PutBucketLogging
:
\n PutObject\n
\n\n DeleteBucket\n
\n\n CreateBucket\n
\n\n GetBucketLogging\n
\nSet the logging parameters for a bucket and to specify permissions for who can view and\n modify the logging parameters. All logs are saved to buckets in the same AWS Region as the\n source bucket. To set the logging status of a bucket, you must be the bucket owner.
\n\nThe bucket owner is automatically granted FULL_CONTROL to all logs. You use the\n Grantee
request element to grant access to other people. The\n Permissions
request element specifies the kind of access the grantee has to\n the logs.
\n Grantee Values\n
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\n\nBy the person's ID:
\n\n
\n
DisplayName is optional and ignored in the request.
\nBy Email address:
\n\n
\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nBy URI:
\n\n
\n
To enable logging, you use LoggingEnabled and its children request elements. To disable\n logging, you use an empty BucketLoggingStatus request element:
\n\n\n
\n
For more information about server access logging, see Server Access Logging.
\n\nFor more information about creating a bucket, see CreateBucket. For more\n information about returning the logging status of a bucket, see GetBucketLogging.
\n\nThe following operations are related to PutBucketLogging
:
\n PutObject\n
\n\n DeleteBucket\n
\n\n CreateBucket\n
\n\n GetBucketLogging\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The MD5 hash of the PutBucketLogging
request body.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.
\n \nTo use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration
action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing\n Access Permissions to Your Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
\n \nThe following operations are related to PutBucketMetricsConfiguration
:
\n GetBucketLifecycle
has the following special error:
Error code: TooManyConfigurations
\n
Description: You are attempting to create a new configuration but have already reached the\n 1,000-configuration limit.
\nHTTP Status Code: HTTP 400 Bad Request
\nSets a metrics configuration (specified by the metrics configuration ID) for the bucket.\n You can have up to 1,000 metrics configurations per bucket. If you're updating an existing\n metrics configuration, note that this is a full replacement of the existing metrics\n configuration. If you don't include the elements you want to keep, they are erased.
\n\nTo use this operation, you must have permissions to perform the\n s3:PutMetricsConfiguration
action. The bucket owner has this permission by\n default. The bucket owner can grant this permission to others. For more information about\n permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon\n CloudWatch.
\n\nThe following operations are related to\n PutBucketMetricsConfiguration
:
\n GetBucketLifecycle
has the following special error:
Error code: TooManyConfigurations
\n
Description: You are attempting to create a new configuration but have\n already reached the 1,000-configuration limit.
\nHTTP Status Code: HTTP 400 Bad Request
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The ID used to identify the metrics configuration.
", + "smithy.api#httpQuery": "id", + "smithy.api#required": {} + } + }, "MetricsConfiguration": { "target": "com.amazonaws.s3#MetricsConfiguration", "traits": { @@ -9018,12 +9392,11 @@ "smithy.api#required": {} } }, - "Id": { - "target": "com.amazonaws.s3#MetricsId", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "The ID used to identify the metrics configuration.
", - "smithy.api#httpQuery": "id", - "smithy.api#required": {} + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.
\n \nUsing this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.
\n \nBy default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration
.
\n
\n
\n \n
This operation replaces the existing notification configuration with the configuration you include in the request body.
\n \nAfter Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.
\n \nYou can disable notifications by adding the empty NotificationConfiguration element.
\n \nBy default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification
permission.
The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add the configuration to your bucket.
\n\n Responses\n
\nIf the configuration in the request body includes only one\n TopicConfiguration
specifying only the\n s3:ReducedRedundancyLostObject
event type, the response will also include\n the x-amz-sns-test-message-id
header containing the message ID of the test\n notification sent to the topic.
The following operation is related to\n PutBucketNotificationConfiguration
:
Enables notifications of specified events for a bucket. For more information about event\n notifications, see Configuring Event\n Notifications.
\n\nUsing this API, you can replace an existing notification configuration. The\n configuration is an XML file that defines the event types that you want Amazon S3 to publish and\n the destination where you want Amazon S3 to publish an event notification when it detects an\n event of the specified type.
\n\nBy default, your bucket has no event notifications configured. That is, the notification\n configuration will be an empty NotificationConfiguration
.
\n
\n
\n \n
This operation replaces the existing notification configuration with the configuration\n you include in the request body.
\n\nAfter Amazon S3 receives this request, it first verifies that any Amazon Simple Notification\n Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and\n that the bucket owner has permission to publish to it by sending a test notification. In\n the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions\n grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information,\n see Configuring Notifications for Amazon S3\n Events.
\n\nYou can disable notifications by adding the empty NotificationConfiguration\n element.
\n\nBy default, only the bucket owner can configure notifications on a bucket. However,\n bucket owners can use a bucket policy to grant permission to other users to set this\n configuration with s3:PutBucketNotification
permission.
The PUT notification is an atomic operation. For example, suppose your notification\n configuration includes SNS topic, SQS queue, and Lambda function configurations. When\n you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS\n topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add\n the configuration to your bucket.
\n\n Responses\n
\nIf the configuration in the request body includes only one\n TopicConfiguration
specifying only the\n s3:ReducedRedundancyLostObject
event type, the response will also include\n the x-amz-sns-test-message-id
header containing the message ID of the test\n notification sent to the topic.
The following operation is related to\n PutBucketNotificationConfiguration
:
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The name of the bucket.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "NotificationConfiguration": { @@ -9059,12 +9433,11 @@ "smithy.api#required": {} } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "The name of the bucket.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Creates or modifies OwnershipControls
for an Amazon S3 bucket. To use this\n operation, you must have the s3:GetBucketOwnershipControls
permission. For\n more information about Amazon S3 permissions, see Specifying Permissions in a Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
\nThe following operations are related to GetBucketOwnershipControls
:
Creates or modifies OwnershipControls
for an Amazon S3 bucket. To use this\n operation, you must have the s3:PutBucketOwnershipControls
permission. For\n more information about Amazon S3 permissions, see Specifying Permissions in a Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
\nThe following operations are related to PutBucketOwnershipControls
:
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy
permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.
If you don't have PutBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed
error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.\n
\nFor more information about bucket policies, see Using Bucket Policies and User Policies.
\n \nThe following operations are related to PutBucketPolicy
:
\n CreateBucket\n
\n\n DeleteBucket\n
\nApplies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than\n the root user of the AWS account that owns the bucket, the calling identity must have the\n PutBucketPolicy
permissions on the specified bucket and belong to the\n bucket owner's account in order to use this operation.
If you don't have PutBucketPolicy
permissions, Amazon S3 returns a 403\n Access Denied
error. If you have the correct permissions, but you're not using an\n identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not\n Allowed
error.
As a security precaution, the root user of the AWS account that owns a bucket can\n always use this operation, even if the policy explicitly denies the root user the\n ability to perform this action.
\nFor more information about bucket policies, see Using Bucket Policies and User\n Policies.
\n\nThe following operations are related to PutBucketPolicy
:
\n CreateBucket\n
\n\n DeleteBucket\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The name of the bucket.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "ContentMD5": { @@ -9152,26 +9527,26 @@ "smithy.api#httpHeader": "Content-MD5" } }, - "Policy": { - "target": "com.amazonaws.s3#Policy", + "ConfirmRemoveSelfBucketAccess": { + "target": "com.amazonaws.s3#ConfirmRemoveSelfBucketAccess", "traits": { - "smithy.api#documentation": "The bucket policy as a JSON document.
", - "smithy.api#required": {} + "smithy.api#documentation": "Set this parameter to true to confirm that you want to remove your permissions to change\n this bucket policy in the future.
", + "smithy.api#httpHeader": "x-amz-confirm-remove-self-bucket-access" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "Policy": { + "target": "com.amazonaws.s3#Policy", "traits": { - "smithy.api#documentation": "The name of the bucket.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The bucket policy as a JSON document.
", + "smithy.api#httpPayload": {}, "smithy.api#required": {} } }, - "ConfirmRemoveSelfBucketAccess": { - "target": "com.amazonaws.s3#ConfirmRemoveSelfBucketAccess", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.
", - "smithy.api#httpHeader": "x-amz-confirm-remove-self-bucket-access" + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Creates a replication configuration or replaces an existing one. For more information,\n see Replication in the Amazon S3 Developer Guide.
\nTo perform this operation, the user or role performing the operation must have the iam:PassRole permission.
\nSpecify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.
\n \n \nA replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. All rules must specify the same destination bucket.
\n \nTo specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element.\n You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, \n you must also add the following elements: DeleteMarkerReplication
, Status
, and Priority
.
The latest version of the replication configuration XML is V2. XML V2 replication configurations are those that contain the Filter
\n element for rules, and rules that specify S3 Replication Time Control (S3 RTC). In XML V2 replication configurations, Amazon S3 doesn't replicate delete markers. Therefore, you must set the \n DeleteMarkerReplication
element to Disabled
. For backward compatibility, Amazon S3 continues to support the XML V1 replication configuration.
For information about enabling versioning on a bucket, see Using Versioning.
\n \nBy default, a resource owner, in this case the AWS account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.
\n \n\n Handling Replication of Encrypted Objects\n
\nBy default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following: SourceSelectionCriteria
, SseKmsEncryptedObjects
, Status
, EncryptionConfiguration
, and ReplicaKmsKeyID
. For information about replication configuration, see Replicating Objects Created with SSE Using CMKs stored in AWS KMS.
For information on PutBucketReplication
errors, see List of replication-related error codes\n
The following operations are related to PutBucketReplication
:
\n GetBucketReplication\n
\nCreates a replication configuration or replaces an existing one. For more information,\n see Replication in the Amazon S3 Developer Guide.
\nTo perform this operation, the user or role performing the operation must have the\n iam:PassRole permission.
\nSpecify the replication configuration in the request body. In the replication\n configuration, you provide the name of the destination bucket where you want Amazon S3 to\n replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf,\n and other relevant information.
\n\n\nA replication configuration must include at least one rule, and can contain a maximum of\n 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in\n the source bucket. To choose additional subsets of objects to replicate, add a rule for\n each subset. All rules must specify the same destination bucket.
\n\nTo specify a subset of the objects in the source bucket to apply a replication rule to,\n add the Filter element as a child of the Rule element. You can filter objects based on an\n object key prefix, one or more object tags, or both. When you add the Filter element in the\n configuration, you must also add the following elements:\n DeleteMarkerReplication
, Status
, and\n Priority
.
The latest version of the replication configuration XML is V2. XML V2 replication\n configurations are those that contain the Filter
element for rules, and\n rules that specify S3 Replication Time Control (S3 RTC). In XML V2 replication configurations, Amazon S3 doesn't\n replicate delete markers. Therefore, you must set the\n DeleteMarkerReplication
element to Disabled
. For backward\n compatibility, Amazon S3 continues to support the XML V1 replication configuration.
For information about enabling versioning on a bucket, see Using Versioning.
\n\nBy default, a resource owner, in this case the AWS account that created the bucket, can\n perform this operation. The resource owner can also grant others permissions to perform the\n operation. For more information about permissions, see Specifying Permissions in a Policy\n and Managing Access Permissions to Your\n Amazon S3 Resources.
\n\n\n Handling Replication of Encrypted Objects\n
\nBy default, Amazon S3 doesn't replicate objects that are stored at rest using server-side\n encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the\n following: SourceSelectionCriteria
, SseKmsEncryptedObjects
,\n Status
, EncryptionConfiguration
, and\n ReplicaKmsKeyID
. For information about replication configuration, see\n Replicating Objects\n Created with SSE Using CMKs stored in AWS KMS.
For information on PutBucketReplication
errors, see List of\n replication-related error codes\n
The following operations are related to PutBucketReplication
:
\n GetBucketReplication\n
\nThe name of the bucket
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.
", + "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.
", "smithy.api#httpHeader": "Content-MD5" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "ReplicationConfiguration": { + "target": "com.amazonaws.s3#ReplicationConfiguration", "traits": { - "smithy.api#documentation": "The name of the bucket
", - "smithy.api#httpLabel": {}, + "smithy.api#httpPayload": {}, "smithy.api#required": {} } + }, + "Token": { + "target": "com.amazonaws.s3#ObjectLockToken", + "traits": { + "smithy.api#documentation": "A token to allow Object Lock to be enabled for an existing bucket.
", + "smithy.api#httpHeader": "x-amz-bucket-object-lock-token" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.
\n \nThe following operations are related to PutBucketRequestPayment
:
\n CreateBucket\n
\nSets the request payment configuration for a bucket. By default, the bucket owner pays\n for downloads from the bucket. This configuration parameter enables the bucket owner (only)\n to specify that the person requesting the download will be charged for the download. For\n more information, see Requester Pays\n Buckets.
\n\nThe following operations are related to PutBucketRequestPayment
:
\n CreateBucket\n
\nContainer for Payer.
", - "smithy.api#httpPayload": {}, - "smithy.api#required": {} - } - }, "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { "smithy.api#deprecated": { "message": "Content-MD5 header will now be automatically computed and injected in associated operation's Http request." }, - "smithy.api#documentation": ">The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.
", + "smithy.api#documentation": ">The base64-encoded 128-bit MD5 digest of the data. You must use this header as a\n message integrity check to verify that the request body was not corrupted in transit. For\n more information, see RFC\n 1864.
", "smithy.api#httpHeader": "Content-MD5" } }, + "RequestPaymentConfiguration": { + "target": "com.amazonaws.s3#RequestPaymentConfiguration", + "traits": { + "smithy.api#documentation": "Container for Payer.
", + "smithy.api#httpPayload": {}, + "smithy.api#required": {} + } + }, "ExpectedBucketOwner": { "target": "com.amazonaws.s3#AccountId", "traits": { @@ -9294,7 +9669,7 @@ "target": "com.amazonaws.s3#PutBucketTaggingRequest" }, "traits": { - "smithy.api#documentation": "Sets the tags for a bucket.
\nUse tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging.
\n \nWithin a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket Tags.
\nTo use this operation, you must have permissions to perform the s3:PutBucketTagging
action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
\n PutBucketTagging
has the following special errors:
Error code: InvalidTagError
\n
Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions and AWS-Generated Cost Allocation Tag Restrictions.
\nError code: MalformedXMLError
\n
Description: The XML provided does not match the schema.
\nError code: OperationAbortedError
\n
Description: A conflicting conditional operation is currently in progress against this resource. Please try again.
\nError code: InternalError
\n
Description: The service was unable to apply the provided tag to the bucket.
\nThe following operations are related to PutBucketTagging
:
\n GetBucketTagging\n
\n\n DeleteBucketTagging\n
\nSets the tags for a bucket.
\nUse tags to organize your AWS bill to reflect your own cost structure. To do this, sign\n up to get your AWS account bill with tag key values included. Then, to see the cost of\n combined resources, organize your billing information according to resources with the same\n tag key values. For example, you can tag several resources with a specific application\n name, and then organize your billing information to see the total cost of that application\n across several services. For more information, see Cost Allocation\n and Tagging.
\n\nWithin a bucket, if you add a tag that has the same key as an existing tag, the new\n value overwrites the old value. For more information, see Using Cost Allocation in Amazon S3 Bucket\n Tags.
\nTo use this operation, you must have permissions to perform the\n s3:PutBucketTagging
action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources.
\n PutBucketTagging
has the following special errors:
Error code: InvalidTagError
\n
Description: The tag provided was not a valid tag. This error can occur if\n the tag did not pass input validation. For information about tag restrictions,\n see User-Defined Tag Restrictions and AWS-Generated Cost Allocation Tag Restrictions.
\nError code: MalformedXMLError
\n
Description: The XML provided does not match the schema.
\nError code: OperationAbortedError
\n
Description: A conflicting conditional operation is currently in progress\n against this resource. Please try again.
\nError code: InternalError
\n
Description: The service was unable to apply the provided tag to the\n bucket.
\nThe following operations are related to PutBucketTagging
:
\n GetBucketTagging\n
\n\n DeleteBucketTagging\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.
", + "smithy.api#httpHeader": "Content-MD5" + } + }, "Tagging": { "target": "com.amazonaws.s3#Tagging", "traits": { @@ -9329,14 +9707,11 @@ "smithy.api#required": {} } }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#deprecated": { - "message": "Content-MD5 header will now be automatically computed and injected in associated operation's Http request." - }, - "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.
", - "smithy.api#httpHeader": "Content-MD5" + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.
\nYou can set the versioning state with one of the following values:
\n \n\n Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.
\n \n\n Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.
\n \nIf the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.
\n \nIf the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket\n owner must include the x-amz-mfa request
header and the Status
\n and the MfaDelete
request elements in a request to set the versioning state of\n the bucket.
If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.
\n\n Related Resources\n
\n\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetBucketVersioning\n
\nSets the versioning state of an existing bucket. To set the versioning state, you must\n be the bucket owner.
\nYou can set the versioning state with one of the following values:
\n\n\n Enabled—Enables versioning for the objects in the\n bucket. All objects added to the bucket receive a unique version ID.
\n\n\n Suspended—Disables versioning for the objects in the\n bucket. All objects added to the bucket receive the version ID null.
\n\nIf the versioning state has never been set on a bucket, it has no versioning state; a\n GetBucketVersioning request does not return a versioning state value.
\n\nIf the bucket owner enables MFA Delete in the bucket versioning configuration, the\n bucket owner must include the x-amz-mfa request
header and the\n Status
and the MfaDelete
request elements in a request to set\n the versioning state of the bucket.
If you have an object expiration lifecycle policy in your non-versioned bucket and\n you want to maintain the same permanent delete behavior when you enable versioning, you\n must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will\n manage the deletes of the noncurrent object versions in the version-enabled bucket. (A\n version-enabled bucket maintains one current and zero or more noncurrent object\n versions.) For more information, see Lifecycle and Versioning.
\n\n Related Resources\n
\n\n CreateBucket\n
\n\n DeleteBucket\n
\n\n GetBucketVersioning\n
\nThe bucket name.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "ContentMD5": { "target": "com.amazonaws.s3#ContentMD5", "traits": { "smithy.api#deprecated": { "message": "Content-MD5 header will now be automatically computed and injected in associated operation's Http request." }, - "smithy.api#documentation": ">The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.
", + "smithy.api#documentation": ">The base64-encoded 128-bit MD5 digest of the data. You must use this header as a\n message integrity check to verify that the request body was not corrupted in transit. For\n more information, see RFC\n 1864.
", "smithy.api#httpHeader": "Content-MD5" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", - "traits": { - "smithy.api#documentation": "The bucket name.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} - } - }, "MFA": { "target": "com.amazonaws.s3#MFA", "traits": { - "smithy.api#documentation": "The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
", + "smithy.api#documentation": "The concatenation of the authentication device's serial number, a space, and the value\n that is displayed on your authentication device.
", "smithy.api#httpHeader": "x-amz-mfa" } }, @@ -9407,7 +9782,7 @@ "target": "com.amazonaws.s3#PutBucketWebsiteRequest" }, "traits": { - "smithy.api#documentation": "Sets the configuration of the website that is specified in the website
subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see Hosting Websites on Amazon S3.
This PUT operation requires the S3:PutBucketWebsite
permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the S3:PutBucketWebsite
permission.
To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket.
\n\n WebsiteConfiguration
\n
\n RedirectAllRequestsTo
\n
\n HostName
\n
\n Protocol
\n
If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected.
\n\n WebsiteConfiguration
\n
\n IndexDocument
\n
\n Suffix
\n
\n ErrorDocument
\n
\n Key
\n
\n RoutingRules
\n
\n RoutingRule
\n
\n Condition
\n
\n HttpErrorCodeReturnedEquals
\n
\n KeyPrefixEquals
\n
\n Redirect
\n
\n Protocol
\n
\n HostName
\n
\n ReplaceKeyPrefixWith
\n
\n ReplaceKeyWith
\n
\n HttpRedirectCode
\n
Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more\n than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect in the\n Amazon Simple Storage Service Developer Guide.
", + "smithy.api#documentation": "Sets the configuration of the website that is specified in the website
\n subresource. To configure a bucket as a website, you can add this subresource on the bucket\n with website configuration information such as the file name of the index document and any\n redirect rules. For more information, see Hosting Websites on Amazon S3.
This PUT operation requires the S3:PutBucketWebsite
permission. By default,\n only the bucket owner can configure the website attached to a bucket; however, bucket\n owners can allow other users to set the website configuration by writing a bucket policy\n that grants them the S3:PutBucketWebsite
permission.
To redirect all website requests sent to the bucket's website endpoint, you add a\n website configuration with the following elements. Because all requests are sent to another\n website, you don't need to provide index document name for the bucket.
\n\n WebsiteConfiguration
\n
\n RedirectAllRequestsTo
\n
\n HostName
\n
\n Protocol
\n
If you want granular control over redirects, you can use the following elements to add\n routing rules that describe conditions for redirecting requests and information about the\n redirect destination. In this case, the website configuration must provide an index\n document for the bucket, because some requests might not be redirected.
\n\n WebsiteConfiguration
\n
\n IndexDocument
\n
\n Suffix
\n
\n ErrorDocument
\n
\n Key
\n
\n RoutingRules
\n
\n RoutingRule
\n
\n Condition
\n
\n HttpErrorCodeReturnedEquals
\n
\n KeyPrefixEquals
\n
\n Redirect
\n
\n Protocol
\n
\n HostName
\n
\n ReplaceKeyPrefixWith
\n
\n ReplaceKeyWith
\n
\n HttpRedirectCode
\n
Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more\n than 50 routing rules, you can use object redirect. For more information, see Configuring an\n Object Redirect in the Amazon Simple Storage Service Developer Guide.
", "smithy.api#http": { "method": "PUT", "uri": "/{Bucket}?website", @@ -9419,38 +9794,38 @@ "com.amazonaws.s3#PutBucketWebsiteRequest": { "type": "structure", "members": { - "WebsiteConfiguration": { - "target": "com.amazonaws.s3#WebsiteConfiguration", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#documentation": "Container for the request.
", - "smithy.api#httpPayload": {}, + "smithy.api#documentation": "The bucket name.
", + "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.
", + "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, see RFC 1864.
", "smithy.api#httpHeader": "Content-MD5" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "WebsiteConfiguration": { + "target": "com.amazonaws.s3#WebsiteConfiguration", "traits": { - "smithy.api#documentation": "The bucket name.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "Container for the request.
", + "smithy.api#httpPayload": {}, "smithy.api#required": {} } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.
\n \n\nAmazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.
\n \nAmazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.
\n \nTo ensure that data is not corrupted traversing the network, use the Content-MD5
header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.
\n The Content-MD5
header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview in the Amazon Simple Storage Service Developer Guide.\n
\n Server-side Encryption\n
\nYou can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data\n when you access it. You have the option to provide your own encryption key or use AWS\n managed encryption keys. For more information, see Using Server-Side\n Encryption.
\n\n Access Control List (ACL)-Specific Request Headers\n
\nYou can use headers to grant ACL- based permissions. By default, all objects are\n private. Only the owner has full access control. When adding a new object, you can grant\n permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These\n permissions are then added to the ACL on the object. For more information, see Access Control List\n (ACL) Overview and Managing ACLs Using the REST\n API.
\n \n\n Storage Class Options\n
\nBy default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.\n The STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only \n uses the OUTPOSTS Storage Class. For more information, see\n Storage Classes in the\n Amazon S3 Service Developer Guide.
\n \n \n\n Versioning\n
\nIf you enable versioning for a bucket, Amazon S3 automatically generates a unique\n version ID for the object being stored. Amazon S3 returns this ID in the response. When you\n enable versioning for a bucket, if Amazon S3 receives multiple write requests for the\n same object simultaneously, it stores all of the objects.
\nFor more information about versioning, see Adding Objects to\n Versioning Enabled Buckets. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.
\n\n \n\n Related Resources\n
\n\n CopyObject\n
\n\n DeleteObject\n
\nAdds an object to a bucket. You must have WRITE permissions on a bucket to add an object\n to it.
\n\n\nAmazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the\n entire object to the bucket.
\n\nAmazon S3 is a distributed system. If it receives multiple write requests for the same object\n simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object\n locking; if you need this, make sure to build it into your application layer or use\n versioning instead.
\n\nTo ensure that data is not corrupted traversing the network, use the\n Content-MD5
header. When you use this header, Amazon S3 checks the object\n against the provided MD5 value and, if they do not match, returns an error. Additionally,\n you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to\n the calculated MD5 value.
The Content-MD5
header is required for any request to upload an object\n with a retention period configured using Amazon S3 Object Lock. For more information about\n Amazon S3 Object Lock, see Amazon S3 Object Lock Overview\n in the Amazon Simple Storage Service Developer Guide.
\n Server-side Encryption\n
\nYou can optionally request server-side encryption. With server-side encryption, Amazon S3\n encrypts your data as it writes it to disks in its data centers and decrypts the data when\n you access it. You have the option to provide your own encryption key or use AWS managed\n encryption keys. For more information, see Using Server-Side\n Encryption.
\n\n Access Control List (ACL)-Specific Request\n Headers\n
\nYou can use headers to grant ACL- based permissions. By default, all objects are\n private. Only the owner has full access control. When adding a new object, you can grant\n permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These\n permissions are then added to the ACL on the object. For more information, see Access Control List\n (ACL) Overview and Managing ACLs Using the REST\n API.
\n\n\n Storage Class Options\n
\nBy default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3\n Service Developer Guide.
\n\n\n\n Versioning\n
\nIf you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID\n for the object being stored. Amazon S3 returns this ID in the response. When you enable\n versioning for a bucket, if Amazon S3 receives multiple write requests for the same object\n simultaneously, it stores all of the objects.
\nFor more information about versioning, see Adding Objects to\n Versioning Enabled Buckets. For information about returning the versioning state\n of a bucket, see GetBucketVersioning.
\n\n\n\n Related Resources\n
\n\n CopyObject\n
\n\n DeleteObject\n
\nUses the acl
subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket. You must have WRITE_ACP
permission to\n set the ACL of an object. For more information, see What permissions can I grant? in the Amazon Simple Storage Service Developer Guide.
This action is not supported by Amazon S3 on Outposts.
\nDepending on your application needs, you can choose to set the ACL on an object using\n either the request body or the headers. For example, if you have an existing application\n that updates a bucket ACL using the request body, you can continue to use that\n approach. For more information, see\n Access Control List (ACL) Overview in the Amazon S3 Developer Guide.
\n \n \n \n\n Access Permissions\n
\nYou can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl
request header. Amazon S3 supports a set\n of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of\n grantees and permissions. Specify the canned ACL name as the value of\n x-amz-ac
l. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
,\n x-amz-grant-read-acp
, x-amz-grant-write-acp
, and\n x-amz-grant-full-control
headers. When using these headers, you\n specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups)\n who will receive the permission. If you use these ACL-specific headers, you cannot\n use x-amz-acl
header to set a canned ACL. These parameters map to the\n\n set of permissions that Amazon S3 supports in an ACL. For more information, see\n Access Control List (ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
\n\n id
– if the value specified is the canonical user ID of an AWS account
\n uri
– if you are granting permissions to a predefined group
\n emailAddress
– if the value specified is the email address of an AWS\n account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
\nFor example, the following x-amz-grant-read
header grants list\n objects permission to the two AWS accounts identified by their email\n addresses.
\n x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"\n
\n
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
\n\n Grantee Values\n
\nYou can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
\nBy the person's ID:
\n\n
\n
DisplayName is optional and ignored in the request.
\nBy URI:
\n\n
\n
By Email address:
\n\n
\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following AWS Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
\n\n Versioning\n
\nThe ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the versionId
subresource.
\n Related Resources\n
\n\n CopyObject\n
\n\n GetObject\n
\nUses the acl
subresource to set the access control list (ACL) permissions\n for a new or existing object in an S3 bucket. You must have WRITE_ACP
\n permission to set the ACL of an object. For more information, see What\n permissions can I grant? in the Amazon Simple Storage Service Developer Guide.
This action is not supported by Amazon S3 on Outposts.
\nDepending on your application needs, you can choose to set\n the ACL on an object using either the request body or the headers. For example, if you have\n an existing application that updates a bucket ACL using the request body, you can continue\n to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 Developer\n Guide.
\n\n\n\n\n Access Permissions\n
\nYou can set access permissions using one of the following methods:
\nSpecify a canned ACL with the x-amz-acl
request header. Amazon S3 supports\n a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set\n of grantees and permissions. Specify the canned ACL name as the value of\n x-amz-ac
l. If you use this header, you cannot use other access\n control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
,\n x-amz-grant-read-acp
, x-amz-grant-write-acp
, and\n x-amz-grant-full-control
headers. When using these headers, you\n specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who\n will receive the permission. If you use these ACL-specific headers, you cannot use\n x-amz-acl
header to set a canned ACL. These parameters map to the set\n of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL)\n Overview.
You specify each grantee as a type=value pair, where the type is one of the\n following:
\n\n id
– if the value specified is the canonical user ID of an AWS\n account
\n uri
– if you are granting permissions to a predefined\n group
\n emailAddress
– if the value specified is the email address of\n an AWS account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
\nFor example, the following x-amz-grant-read
header grants list\n objects permission to the two AWS accounts identified by their email\n addresses.
\n x-amz-grant-read: emailAddress=\"xyz@amazon.com\",\n emailAddress=\"abc@amazon.com\"
\n
You can use either a canned ACL or specify access permissions explicitly. You cannot do\n both.
\n\n Grantee Values\n
\nYou can specify the person (grantee) to whom you're assigning access rights (using\n request elements) in the following ways:
\nBy the person's ID:
\n\n
\n
DisplayName is optional and ignored in the request.
\nBy URI:
\n\n
\n
By Email address:
\n\n
\n
The grantee is resolved to the CanonicalUser and, in a response to a GET Object\n acl request, appears as the CanonicalUser.
\nUsing email addresses to specify a grantee is only supported in the following AWS Regions:
\nUS East (N. Virginia)
\nUS West (N. California)
\nUS West (Oregon)
\nAsia Pacific (Singapore)
\nAsia Pacific (Sydney)
\nAsia Pacific (Tokyo)
\nEurope (Ireland)
\nSouth America (São Paulo)
\nFor a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
\n\n Versioning\n
\nThe ACL of an object is set at the object version level. By default, PUT sets the ACL of\n the current version of an object. To set the ACL of a different version, use the\n versionId
subresource.
\n Related Resources\n
\n\n CopyObject\n
\n\n GetObject\n
\nThe canned ACL to apply to the object. For more information, see Canned\n ACL.
", + "smithy.api#documentation": "The canned ACL to apply to the object. For more information, see Canned ACL.
", "smithy.api#httpHeader": "x-amz-acl" } }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", + "AccessControlPolicy": { + "target": "com.amazonaws.s3#AccessControlPolicy", "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Contains the elements that set the ACL permissions for an object per grantee.
", + "smithy.api#httpPayload": {} + } + }, + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "The bucket name that contains the object to which you want to attach the ACL.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "ContentMD5": { @@ -9534,24 +9911,24 @@ "smithy.api#deprecated": { "message": "Content-MD5 header will now be automatically computed and injected in associated operation's Http request." }, - "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity \n check to verify that the request body was not corrupted in transit. For more information, go to \n RFC 1864.>\n
", + "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message\n integrity check to verify that the request body was not corrupted in transit. For more\n information, go to RFC\n 1864.>\n
", "smithy.api#httpHeader": "Content-MD5" } }, - "AccessControlPolicy": { - "target": "com.amazonaws.s3#AccessControlPolicy", - "traits": { - "smithy.api#documentation": "Contains the elements that set the ACL permissions for an object per grantee.
", - "smithy.api#httpPayload": {} - } - }, "GrantFullControl": { "target": "com.amazonaws.s3#GrantFullControl", "traits": { - "smithy.api#documentation": "Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#documentation": "Allows grantee the read, write, read ACP, and write ACP permissions on the\n bucket.
\nThis action is not supported by Amazon S3 on Outposts.
", "smithy.api#httpHeader": "x-amz-grant-full-control" } }, + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", + "traits": { + "smithy.api#documentation": "Allows grantee to list the objects in the\n bucket.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#httpHeader": "x-amz-grant-read" + } + }, "GrantReadACP": { "target": "com.amazonaws.s3#GrantReadACP", "traits": { @@ -9559,13 +9936,6 @@ "smithy.api#httpHeader": "x-amz-grant-read-acp" } }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", - "traits": { - "smithy.api#documentation": "Allows grantee to list the objects in the bucket.
\nThis action is not supported by Amazon S3 on Outposts.
", - "smithy.api#httpHeader": "x-amz-grant-read" - } - }, "GrantWrite": { "target": "com.amazonaws.s3#GrantWrite", "traits": { @@ -9573,6 +9943,13 @@ "smithy.api#httpHeader": "x-amz-grant-write" } }, + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", + "traits": { + "smithy.api#documentation": "Allows grantee to write the ACL for the applicable\n bucket.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#httpHeader": "x-amz-grant-write-acp" + } + }, "Key": { "target": "com.amazonaws.s3#ObjectKey", "traits": { @@ -9581,11 +9958,10 @@ "smithy.api#required": {} } }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "Allows grantee to write the ACL for the applicable bucket.
\nThis action is not supported by Amazon S3 on Outposts.
", - "smithy.api#httpHeader": "x-amz-grant-write-acp" + "smithy.api#httpHeader": "x-amz-request-payer" } }, "VersionId": { @@ -9595,12 +9971,11 @@ "smithy.api#httpQuery": "versionId" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "The bucket name that contains the object to which you want to attach the ACL.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Applies a Legal Hold configuration to the specified object.
\nThis action is not supported by Amazon S3 on Outposts.
\n\n Related Resources\n
\n\n Locking Objects\n
\nApplies a Legal Hold configuration to the specified object.
\nThis action is not supported by Amazon S3 on Outposts.
\n\n Related Resources\n
\n\n Locking Objects\n
\nThe MD5 hash for the request body.
", - "smithy.api#httpHeader": "Content-MD5" + "smithy.api#documentation": "The key name for the object that you want to place a Legal Hold on.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "LegalHold": { "target": "com.amazonaws.s3#ObjectLockLegalHold", "traits": { - "smithy.api#documentation": "Container element for the Legal Hold configuration you want to apply to the specified object.
", + "smithy.api#documentation": "Container element for the Legal Hold configuration you want to apply to the specified\n object.
", "smithy.api#httpPayload": {} } }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The key name for the object that you want to place a Legal Hold on.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#deprecated": { + "message": "Content-MD5 header will now be automatically computed and injected in associated operation's Http request." + }, + "smithy.api#documentation": "The MD5 hash for the request body.
", + "smithy.api#httpHeader": "Content-MD5" } }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.
\n\n DefaultRetention
requires either Days or Years. You can't specify both at the same time.
\n Related Resources\n
\n\n Locking Objects\n
\nPlaces an Object Lock configuration on the specified bucket. The rule specified in the\n Object Lock configuration will be applied by default to every new object placed in the\n specified bucket.
\n\n DefaultRetention
requires either Days or Years. You can't specify both\n at the same time.
\n Related Resources\n
\n\n Locking\n Objects\n
\nA token to allow Object Lock to be enabled for an existing bucket.
", - "smithy.api#httpHeader": "x-amz-bucket-object-lock-token" - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "smithy.api#documentation": "The bucket whose Object Lock configuration you want to create or replace.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "ObjectLockConfiguration": { @@ -9744,12 +10114,17 @@ "smithy.api#httpPayload": {} } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "The bucket whose Object Lock configuration you want to create or replace.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "Token": { + "target": "com.amazonaws.s3#ObjectLockToken", + "traits": { + "smithy.api#documentation": "A token to allow Object Lock to be enabled for an existing bucket.
", + "smithy.api#httpHeader": "x-amz-bucket-object-lock-token" } }, "ContentMD5": { @@ -9774,27 +10149,13 @@ "com.amazonaws.s3#PutObjectOutput": { "type": "structure", "members": { - "SSEKMSEncryptionContext": { - "target": "com.amazonaws.s3#SSEKMSEncryptionContext", - "traits": { - "smithy.api#documentation": "If present, specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-context" - } - }, "Expiration": { "target": "com.amazonaws.s3#Expiration", "traits": { - "smithy.api#documentation": "\t\n If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL encoded.
", + "smithy.api#documentation": "If the expiration is configured for the object (see PutBucketLifecycleConfiguration), the response includes this header. It\n includes the expiry-date and rule-id key-value pairs that provide information about object\n expiration. The value of the rule-id is URL encoded.
", "smithy.api#httpHeader": "x-amz-expiration" } }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, "ETag": { "target": "com.amazonaws.s3#ETag", "traits": { @@ -9802,11 +10163,11 @@ "smithy.api#httpHeader": "ETag" } }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + "smithy.api#documentation": "If you specified server-side encryption either with an AWS KMS customer master key (CMK)\n or Amazon S3-managed encryption key in your PUT request, the response includes this header. It\n confirms the encryption algorithm that Amazon S3 used to encrypt the object.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, "VersionId": { @@ -9816,24 +10177,38 @@ "smithy.api#httpHeader": "x-amz-version-id" } }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" + "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "traits": { + "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, "SSEKMSKeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "If x-amz-server-side-encryption
is present and has the value of\n aws:kms
, this header specifies the ID of the AWS Key Management Service\n (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.
If x-amz-server-side-encryption
is present and has the value of\n aws:kms
, this header specifies the ID of the AWS Key Management Service\n (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the\n object.
If you specified server-side encryption either with an AWS KMS customer master key (CMK) or Amazon S3-managed encryption key in your PUT request, the response includes this header. It confirms the encryption algorithm that Amazon S3 used to encrypt the object.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption" + "smithy.api#documentation": "If present, specifies the AWS KMS Encryption Context to use for object encryption. The\n value of this header is a base64-encoded UTF-8 string holding JSON with the encryption\n context key-value pairs.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" } } } @@ -9841,6 +10216,20 @@ "com.amazonaws.s3#PutObjectRequest": { "type": "structure", "members": { + "ACL": { + "target": "com.amazonaws.s3#ObjectCannedACL", + "traits": { + "smithy.api#documentation": "The canned ACL to apply to the object. For more information, see Canned\n ACL.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#httpHeader": "x-amz-acl" + } + }, + "Body": { + "target": "com.amazonaws.s3#StreamingBlob", + "traits": { + "smithy.api#documentation": "Object data.
", + "smithy.api#httpPayload": {} + } + }, "Bucket": { "target": "com.amazonaws.s3#BucketName", "traits": { @@ -9849,172 +10238,172 @@ "smithy.api#required": {} } }, - "GrantFullControl": { - "target": "com.amazonaws.s3#GrantFullControl", + "CacheControl": { + "target": "com.amazonaws.s3#CacheControl", "traits": { - "smithy.api#documentation": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
\nThis action is not supported by Amazon S3 on Outposts.
", - "smithy.api#httpHeader": "x-amz-grant-full-control" + "smithy.api#documentation": "Can be used to specify caching behavior along the request/reply chain. For more\n information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
", + "smithy.api#httpHeader": "Cache-Control" } }, - "Metadata": { - "target": "com.amazonaws.s3#Metadata", + "ContentDisposition": { + "target": "com.amazonaws.s3#ContentDisposition", "traits": { - "smithy.api#documentation": "A map of metadata to store with the object in S3.
", - "smithy.api#httpPrefixHeaders": "x-amz-meta-" + "smithy.api#documentation": "Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.
", + "smithy.api#httpHeader": "Content-Disposition" } }, "ContentEncoding": { "target": "com.amazonaws.s3#ContentEncoding", "traits": { - "smithy.api#documentation": "Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.
", + "smithy.api#documentation": "Specifies what content encodings have been applied to the object and thus what decoding\n mechanisms must be applied to obtain the media-type referenced by the Content-Type header\n field. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.11.
", "smithy.api#httpHeader": "Content-Encoding" } }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "ContentLanguage": { + "target": "com.amazonaws.s3#ContentLanguage", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "smithy.api#documentation": "The language the content is in.
", + "smithy.api#httpHeader": "Content-Language" } }, - "GrantReadACP": { - "target": "com.amazonaws.s3#GrantReadACP", + "ContentLength": { + "target": "com.amazonaws.s3#ContentLength", "traits": { - "smithy.api#documentation": "Allows grantee to read the object ACL.
\nThis action is not supported by Amazon S3 on Outposts.
", - "smithy.api#httpHeader": "x-amz-grant-read-acp" + "smithy.api#documentation": "Size of the body in bytes. This parameter is useful when the size of the body cannot be\n determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.
", + "smithy.api#httpHeader": "Content-Length" } }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", + "ContentMD5": { + "target": "com.amazonaws.s3#ContentMD5", "traits": { - "smithy.api#documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" + "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the message (without the headers) according to\n RFC 1864. This header can be used as a message integrity check to verify that the data is\n the same data that was originally sent. Although it is optional, we recommend using the\n Content-MD5 mechanism as an end-to-end integrity check. For more information about REST\n request authentication, see REST\n Authentication.
", + "smithy.api#httpHeader": "Content-MD5" } }, - "CacheControl": { - "target": "com.amazonaws.s3#CacheControl", + "ContentType": { + "target": "com.amazonaws.s3#ContentType", "traits": { - "smithy.api#documentation": "\t\n Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
", - "smithy.api#httpHeader": "Cache-Control" + "smithy.api#documentation": "A standard MIME type describing the format of the contents. For more information, see\n http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.
", + "smithy.api#httpHeader": "Content-Type" } }, - "WebsiteRedirectLocation": { - "target": "com.amazonaws.s3#WebsiteRedirectLocation", + "Expires": { + "target": "com.amazonaws.s3#Expires", "traits": { - "smithy.api#documentation": "If the bucket is configured as a website, redirects requests for this object to another object\n in the same bucket or to an external URL. Amazon S3 stores the value of this header in the\n object metadata. For information about object metadata, see Object Key and Metadata.
\n \nIn the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:
\n \n\n x-amz-website-redirect-location: /anotherPage.html
\n
In the following example, the request header sets the object redirect to another website:
\n \n\n x-amz-website-redirect-location: http://www.example.com/
\n
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.
", - "smithy.api#httpHeader": "x-amz-website-redirect-location" + "smithy.api#documentation": "The date and time at which the object is no longer cacheable. For more information, see\n http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.
", + "smithy.api#httpHeader": "Expires" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "GrantFullControl": { + "target": "com.amazonaws.s3#GrantFullControl", "traits": { - "smithy.api#documentation": "Object key for which the PUT operation was initiated.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the\n object.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#httpHeader": "x-amz-grant-full-control" } }, - "ObjectLockLegalHoldStatus": { - "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", + "GrantRead": { + "target": "com.amazonaws.s3#GrantRead", "traits": { - "smithy.api#documentation": "Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock.
", - "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" + "smithy.api#documentation": "Allows grantee to read the object data and its\n metadata.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#httpHeader": "x-amz-grant-read" } }, - "GrantWriteACP": { - "target": "com.amazonaws.s3#GrantWriteACP", + "GrantReadACP": { + "target": "com.amazonaws.s3#GrantReadACP", "traits": { - "smithy.api#documentation": "Allows grantee to write the ACL for the applicable object.
\nThis action is not supported by Amazon S3 on Outposts.
", - "smithy.api#httpHeader": "x-amz-grant-write-acp" + "smithy.api#documentation": "Allows grantee to read the object ACL.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#httpHeader": "x-amz-grant-read-acp" } }, - "ContentLength": { - "target": "com.amazonaws.s3#ContentLength", + "GrantWriteACP": { + "target": "com.amazonaws.s3#GrantWriteACP", "traits": { - "smithy.api#documentation": "Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.13.
", - "smithy.api#httpHeader": "Content-Length" + "smithy.api#documentation": "Allows grantee to write the ACL for the applicable\n object.
\nThis action is not supported by Amazon S3 on Outposts.
", + "smithy.api#httpHeader": "x-amz-grant-write-acp" } }, - "ObjectLockRetainUntilDate": { - "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "The date and time when you want this object's Object Lock to expire.
", - "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" + "smithy.api#documentation": "Object key for which the PUT operation was initiated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "Metadata": { + "target": "com.amazonaws.s3#Metadata", "traits": { - "smithy.api#documentation": "Specifies the algorithm to use to when encrypting the object (for example, AES256).
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + "smithy.api#documentation": "A map of metadata to store with the object in S3.
", + "smithy.api#httpPrefixHeaders": "x-amz-meta-" } }, - "ContentDisposition": { - "target": "com.amazonaws.s3#ContentDisposition", + "ServerSideEncryption": { + "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { - "smithy.api#documentation": "Specifies presentational information for the object. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html#sec19.5.1.
", - "smithy.api#httpHeader": "Content-Disposition" + "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", + "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm
header.
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The\n STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses\n the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3\n Service Developer Guide.
", + "smithy.api#httpHeader": "x-amz-storage-class" } }, - "SSEKMSEncryptionContext": { - "target": "com.amazonaws.s3#SSEKMSEncryptionContext", + "WebsiteRedirectLocation": { + "target": "com.amazonaws.s3#WebsiteRedirectLocation", "traits": { - "smithy.api#documentation": "Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-context" + "smithy.api#documentation": "If the bucket is configured as a website, redirects requests for this object to another\n object in the same bucket or to an external URL. Amazon S3 stores the value of this header in\n the object metadata. For information about object metadata, see Object Key and Metadata.
\n\nIn the following example, the request header sets the redirect to an object\n (anotherPage.html) in the same bucket:
\n\n\n x-amz-website-redirect-location: /anotherPage.html
\n
In the following example, the request header sets the object redirect to another\n website:
\n\n\n x-amz-website-redirect-location: http://www.example.com/
\n
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page\n Redirects.
", + "smithy.api#httpHeader": "x-amz-website-redirect-location" } }, - "Tagging": { - "target": "com.amazonaws.s3#TaggingHeader", + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, \"Key1=Value1\")
", - "smithy.api#httpHeader": "x-amz-tagging" + "smithy.api#documentation": "Specifies the algorithm to use to when encrypting the object (for example,\n AES256).
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "Expires": { - "target": "com.amazonaws.s3#Expires", + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", "traits": { - "smithy.api#documentation": "The date and time at which the object is no longer cacheable. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.21.
", - "smithy.api#httpHeader": "Expires" + "smithy.api#documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm
header.
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.\n The STANDARD storage class provides high durability and high availability. Depending on\n performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only \n uses the OUTPOSTS Storage Class. For more information, see\n Storage Classes in the\n Amazon S3 Service Developer Guide.
", - "smithy.api#httpHeader": "x-amz-storage-class" + "smithy.api#documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
If x-amz-server-side-encryption
is present and has the value of\n aws:kms
, this header specifies the ID of the AWS Key Management Service\n (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the\n object.
If the value of x-amz-server-side-encryption
is aws:kms
, this\n header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for\n the object. If you specify x-amz-server-side-encryption:aws:kms
, but do not\n provide x-amz-server-side-encryption-aws-kms-key-id
, Amazon S3 uses the AWS\n managed CMK in AWS to protect the data.
Object data.
", - "smithy.api#httpPayload": {} + "smithy.api#documentation": "Specifies the AWS KMS Encryption Context to use for object encryption. The value of this\n header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value\n pairs.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-context" } }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.
", - "smithy.api#httpHeader": "Content-MD5" + "smithy.api#httpHeader": "x-amz-request-payer" } }, - "ServerSideEncryption": { - "target": "com.amazonaws.s3#ServerSideEncryption", + "Tagging": { + "target": "com.amazonaws.s3#TaggingHeader", "traits": { - "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", - "smithy.api#httpHeader": "x-amz-server-side-encryption" + "smithy.api#documentation": "The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For\n example, \"Key1=Value1\")
", + "smithy.api#httpHeader": "x-amz-tagging" } }, "ObjectLockMode": { @@ -10024,39 +10413,25 @@ "smithy.api#httpHeader": "x-amz-object-lock-mode" } }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "If x-amz-server-side-encryption
is present and has the value of\n aws:kms
, this header specifies the ID of the AWS Key Management Service\n (AWS KMS) symmetrical customer managed customer master key (CMK) that was used for the object.
If the value of x-amz-server-side-encryption
is aws:kms
, this\n header specifies the ID of the symmetric customer managed AWS KMS CMK that will be used for the object. If you specify\n x-amz-server-side-encryption:aws:kms
, but do not provide\n x-amz-server-side-encryption-aws-kms-key-id
, Amazon S3 uses the AWS managed CMK\n in AWS to protect the data.
The language the content is in.
", - "smithy.api#httpHeader": "Content-Language" - } - }, - "GrantRead": { - "target": "com.amazonaws.s3#GrantRead", + "ObjectLockRetainUntilDate": { + "target": "com.amazonaws.s3#ObjectLockRetainUntilDate", "traits": { - "smithy.api#documentation": "Allows grantee to read the object data and its metadata.
\nThis action is not supported by Amazon S3 on Outposts.
", - "smithy.api#httpHeader": "x-amz-grant-read" + "smithy.api#documentation": "The date and time when you want this object's Object Lock to expire.
", + "smithy.api#httpHeader": "x-amz-object-lock-retain-until-date" } }, - "ACL": { - "target": "com.amazonaws.s3#ObjectCannedACL", + "ObjectLockLegalHoldStatus": { + "target": "com.amazonaws.s3#ObjectLockLegalHoldStatus", "traits": { - "smithy.api#documentation": "The canned ACL to apply to the object. For more information, see Canned ACL.
\nThis action is not supported by Amazon S3 on Outposts.
", - "smithy.api#httpHeader": "x-amz-acl" + "smithy.api#documentation": "Specifies whether a legal hold will be applied to this object. For more information\n about S3 Object Lock, see Object\n Lock.
", + "smithy.api#httpHeader": "x-amz-object-lock-legal-hold" } }, - "ContentType": { - "target": "com.amazonaws.s3#ContentType", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#documentation": "A standard MIME type describing the format of the contents. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17.
", - "smithy.api#httpHeader": "Content-Type" + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Places an Object Retention configuration on an object.
\nThis action is not supported by Amazon S3 on Outposts.
\n\n Related Resources\n
\n\n Locking Objects\n
\nPlaces an Object Retention configuration on an object.
\nThis action is not supported by Amazon S3 on Outposts.
\n\n Related Resources\n
\n\n Locking Objects\n
\nThe key name for the object that you want to apply this Object Retention configuration to.
", + "smithy.api#documentation": "The bucket name that contains the object you want to apply this Object Retention\n configuration to.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "The bucket name that contains the object you want to apply this Object Retention configuration to.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#documentation": "The key name for the object that you want to apply this Object Retention configuration\n to.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -10116,24 +10491,17 @@ "smithy.api#httpPayload": {} } }, - "VersionId": { - "target": "com.amazonaws.s3#ObjectVersionId", - "traits": { - "smithy.api#documentation": "The version ID for the object that you want to apply this Object Retention configuration to.
", - "smithy.api#httpQuery": "versionId" - } - }, "RequestPayer": { "target": "com.amazonaws.s3#RequestPayer", "traits": { "smithy.api#httpHeader": "x-amz-request-payer" } }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", + "VersionId": { + "target": "com.amazonaws.s3#ObjectVersionId", "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The version ID for the object that you want to apply this Object Retention configuration\n to.
", + "smithy.api#httpQuery": "versionId" } }, "BypassGovernanceRetention": { @@ -10152,6 +10520,13 @@ "smithy.api#documentation": "The MD5 hash for the request body.
", "smithy.api#httpHeader": "Content-MD5" } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Sets the supplied tag-set to an object that already exists in a bucket.
\nA tag is a key-value pair. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging.
\n \nFor tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.
\n \nTo use this operation, you must have permission to perform the s3:PutObjectTagging
action. By default, the bucket owner has this permission and can grant this permission to others.
To put tags of any other version, use the versionId
query parameter. You also need permission for the s3:PutObjectVersionTagging
action.
For information about the Amazon S3 object tagging feature, see Object Tagging.
\n \n \n\n Special Errors\n
\n\n Code: InvalidTagError \n
\n\n Cause: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For more information, see Object Tagging. \n
\n\n Code: MalformedXMLError \n
\n\n Cause: The XML provided does not match the schema. \n
\n\n Code: OperationAbortedError \n
\n\n Cause: A conflicting conditional operation is currently in progress against this resource. Please try again. \n
\n\n Code: InternalError \n
\n\n Cause: The service was unable to apply the provided tag to the object. \n
\n\n Related Resources\n
\n\n GetObjectTagging\n
\nSets the supplied tag-set to an object that already exists in a bucket.
\nA tag is a key-value pair. You can associate tags with an object by sending a PUT\n request against the tagging subresource that is associated with the object. You can\n retrieve tags by sending a GET request. For more information, see GetObjectTagging.
\n\nFor tagging-related restrictions related to characters and encodings, see Tag\n Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per\n object.
\n\nTo use this operation, you must have permission to perform the\n s3:PutObjectTagging
action. By default, the bucket owner has this\n permission and can grant this permission to others.
To put tags of any other version, use the versionId
query parameter. You\n also need permission for the s3:PutObjectVersionTagging
action.
For information about the Amazon S3 object tagging feature, see Object Tagging.
\n\n\n\n Special Errors\n
\n\n Code: InvalidTagError \n
\n\n Cause: The tag provided was not a valid tag. This error can occur\n if the tag did not pass input validation. For more information, see Object Tagging.\n
\n\n Code: MalformedXMLError \n
\n\n Cause: The XML provided does not match the schema.\n
\n\n Code: OperationAbortedError \n
\n\n Cause: A conflicting conditional operation is currently in\n progress against this resource. Please try again.\n
\n\n Code: InternalError\n
\n\n Cause: The service was unable to apply the provided tag to the\n object.\n
\n\n Related Resources\n
\n\n GetObjectTagging\n
\nThe account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The MD5 hash for the request body.
", + "smithy.api#httpHeader": "Content-MD5" } }, "Tagging": { @@ -10226,14 +10604,11 @@ "smithy.api#required": {} } }, - "ContentMD5": { - "target": "com.amazonaws.s3#ContentMD5", + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", "traits": { - "smithy.api#deprecated": { - "message": "Content-MD5 header will now be automatically computed and injected in associated operation's Http request." - }, - "smithy.api#documentation": "The MD5 hash for the request body.
", - "smithy.api#httpHeader": "Content-MD5" + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Creates or modifies the PublicAccessBlock
configuration for an Amazon S3\n bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock
\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.
When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or an\n object, it checks the PublicAccessBlock
configuration for both the bucket\n (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock
configurations are different between the bucket and\n the account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
\n \n \n \n\n Related Resources\n
\n\n GetPublicAccessBlock\n
\nCreates or modifies the PublicAccessBlock
configuration for an Amazon S3 bucket.\n To use this operation, you must have the s3:PutBucketPublicAccessBlock
\n permission. For more information about Amazon S3 permissions, see Specifying Permissions in a\n Policy.
When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or\n an object, it checks the PublicAccessBlock
configuration for both the\n bucket (or the bucket that contains the object) and the bucket owner's account. If the\n PublicAccessBlock
configurations are different between the bucket and\n the account, Amazon S3 uses the most restrictive combination of the bucket-level and\n account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
\n\n\n\n\n Related Resources\n
\n\n GetPublicAccessBlock\n
\nThe PublicAccessBlock
configuration that you want to apply to this Amazon S3\n bucket. You can enable the configuration options in any combination. For more information\n about when Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer\n Guide.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The name of the Amazon S3 bucket whose PublicAccessBlock
configuration you\n want to set.
The name of the Amazon S3 bucket whose PublicAccessBlock
configuration you want\n to set.
The MD5 hash of the PutPublicAccessBlock
request body.
The PublicAccessBlock
configuration that you want to apply to this Amazon S3\n bucket. You can enable the configuration options in any combination. For more information\n about when Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer\n Guide.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message\n when it detects events of the specified type.
", + "smithy.api#required": {}, + "smithy.api#xmlName": "Queue" + } + }, "Events": { "target": "com.amazonaws.s3#EventList", "traits": { @@ -10306,23 +10692,12 @@ "smithy.api#xmlName": "Event" } }, - "Id": { - "target": "com.amazonaws.s3#NotificationId" - }, "Filter": { "target": "com.amazonaws.s3#NotificationConfigurationFilter" - }, - "QueueArn": { - "target": "com.amazonaws.s3#QueueArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a\n message when it detects events of the specified type.
", - "smithy.api#required": {}, - "smithy.api#xmlName": "Queue" - } } }, "traits": { - "smithy.api#documentation": "Specifies the configuration for publishing messages to an Amazon Simple\n Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.
" + "smithy.api#documentation": "Specifies the configuration for publishing messages to an Amazon Simple Queue Service\n (Amazon SQS) queue when Amazon S3 detects specified events.
" } }, "com.amazonaws.s3#QueueConfigurationList": { @@ -10379,60 +10754,60 @@ "com.amazonaws.s3#Redirect": { "type": "structure", "members": { - "HttpRedirectCode": { - "target": "com.amazonaws.s3#HttpRedirectCode", + "HostName": { + "target": "com.amazonaws.s3#HostName", "traits": { - "smithy.api#documentation": "The HTTP redirect code to use on the response. Not required if one of the siblings is present.
" + "smithy.api#documentation": "The host name to use in the redirect request.
" } }, - "ReplaceKeyPrefixWith": { - "target": "com.amazonaws.s3#ReplaceKeyPrefixWith", + "HttpRedirectCode": { + "target": "com.amazonaws.s3#HttpRedirectCode", "traits": { - "smithy.api#documentation": "The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/
(objects in the docs/
folder) to documents/
, you can set a condition block with KeyPrefixEquals
set to docs/
and in the Redirect set ReplaceKeyPrefixWith
to /documents
. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith
is not provided.
The HTTP redirect code to use on the response. Not required if one of the siblings is\n present.
" } }, "Protocol": { "target": "com.amazonaws.s3#Protocol", "traits": { - "smithy.api#documentation": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
" + "smithy.api#documentation": "Protocol to use when redirecting requests. The default is the protocol that is used in\n the original request.
" } }, - "HostName": { - "target": "com.amazonaws.s3#HostName", + "ReplaceKeyPrefixWith": { + "target": "com.amazonaws.s3#ReplaceKeyPrefixWith", "traits": { - "smithy.api#documentation": "The host name to use in the redirect request.
" + "smithy.api#documentation": "The object key prefix to use in the redirect request. For example, to redirect requests\n for all pages with prefix docs/
(objects in the docs/
folder) to\n documents/
, you can set a condition block with KeyPrefixEquals
\n set to docs/
and in the Redirect set ReplaceKeyPrefixWith
to\n /documents
. Not required if one of the siblings is present. Can be present\n only if ReplaceKeyWith
is not provided.
The specific object key to use in the redirect request. For example, redirect request to error.html
. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith
is not provided.
The specific object key to use in the redirect request. For example, redirect request to\n error.html
. Not required if one of the siblings is present. Can be present\n only if ReplaceKeyPrefixWith
is not provided.
Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.
" + "smithy.api#documentation": "Specifies how requests are redirected. In the event of an error, you can specify a\n different error code to return.
" } }, "com.amazonaws.s3#RedirectAllRequestsTo": { "type": "structure", "members": { - "Protocol": { - "target": "com.amazonaws.s3#Protocol", - "traits": { - "smithy.api#documentation": "Protocol to use when redirecting requests. The default is the protocol that is used in the original request.
" - } - }, "HostName": { "target": "com.amazonaws.s3#HostName", "traits": { "smithy.api#documentation": "Name of the host where requests are redirected.
", "smithy.api#required": {} } + }, + "Protocol": { + "target": "com.amazonaws.s3#Protocol", + "traits": { + "smithy.api#documentation": "Protocol to use when redirecting requests. The default is the protocol that is used in\n the original request.
" + } } }, "traits": { - "smithy.api#documentation": "Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.
" + "smithy.api#documentation": "Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3\n bucket.
" } }, "com.amazonaws.s3#ReplaceKeyPrefixWith": { @@ -10450,14 +10825,14 @@ "Role": { "target": "com.amazonaws.s3#Role", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that Amazon S3 assumes\n when replicating objects. For more information, see How to Set Up Replication in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that\n Amazon S3 assumes when replicating objects. For more information, see How to Set Up\n Replication in the Amazon Simple Storage Service Developer Guide.
", "smithy.api#required": {} } }, "Rules": { "target": "com.amazonaws.s3#ReplicationRules", "traits": { - "smithy.api#documentation": "A container for one or more replication rules. A replication configuration must have at\n least one rule and can contain a maximum of 1,000 rules.
", + "smithy.api#documentation": "A container for one or more replication rules. A replication configuration must have at\n least one rule and can contain a maximum of 1,000 rules.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Rule" @@ -10465,43 +10840,34 @@ } }, "traits": { - "smithy.api#documentation": "A container for replication rules. You can add up to 1,000 rules. The maximum size of a\n replication configuration is 2 MB.
" + "smithy.api#documentation": "A container for replication rules. You can add up to 1,000 rules. The maximum size of a\n replication configuration is 2 MB.
" } }, "com.amazonaws.s3#ReplicationRule": { "type": "structure", "members": { - "Prefix": { - "target": "com.amazonaws.s3#Prefix", - "traits": { - "smithy.api#deprecated": {}, - "smithy.api#documentation": "An object key name prefix that identifies the object or objects to which the rule applies.\n The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify\n an empty string.
" - } - }, "ID": { "target": "com.amazonaws.s3#ID", "traits": { "smithy.api#documentation": "A unique identifier for the rule. The maximum value is 255 characters.
" } }, - "SourceSelectionCriteria": { - "target": "com.amazonaws.s3#SourceSelectionCriteria", + "Priority": { + "target": "com.amazonaws.s3#Priority", "traits": { - "smithy.api#documentation": "A container that describes additional filters for identifying the source objects that you\n want to replicate. You can choose to enable or disable the replication of these objects.\n Currently, Amazon S3 supports only the filter that you can specify for objects created with\n server-side encryption using a customer master key (CMK) stored in AWS Key Management Service (SSE-KMS).
" + "smithy.api#documentation": "The priority associated with the rule. If you specify multiple rules in a replication\n configuration, Amazon S3 prioritizes the rules to prevent conflicts when filtering. If two or\n more rules identify the same object based on a specified filter, the rule with higher\n priority takes precedence. For example:
\nSame object quality prefix-based filter criteria if prefixes you specified in\n multiple rules overlap
\nSame object qualify tag-based filter criteria specified in multiple rules
\nFor more information, see Replication in the\n Amazon Simple Storage Service Developer Guide.
" } }, - "DeleteMarkerReplication": { - "target": "com.amazonaws.s3#DeleteMarkerReplication" + "Prefix": { + "target": "com.amazonaws.s3#Prefix", + "traits": { + "smithy.api#deprecated": {}, + "smithy.api#documentation": "An object key name prefix that identifies the object or objects to which the rule\n applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket,\n specify an empty string.
" + } }, "Filter": { "target": "com.amazonaws.s3#ReplicationRuleFilter" }, - "Priority": { - "target": "com.amazonaws.s3#Priority", - "traits": { - "smithy.api#documentation": "The priority associated with the rule. If you specify multiple rules in a replication\n configuration, Amazon S3 prioritizes the rules to prevent conflicts when filtering. If two or\n more rules identify the same object based on a specified filter, the rule with higher priority\n takes precedence. For example:
\nSame object quality prefix-based filter criteria if prefixes you specified in multiple rules\n overlap
\nSame object qualify tag-based filter criteria specified in multiple rules
\nFor more information, see Replication in the Amazon Simple Storage Service Developer\n Guide.
" - } - }, "Status": { "target": "com.amazonaws.s3#ReplicationRuleStatus", "traits": { @@ -10509,6 +10875,12 @@ "smithy.api#required": {} } }, + "SourceSelectionCriteria": { + "target": "com.amazonaws.s3#SourceSelectionCriteria", + "traits": { + "smithy.api#documentation": "A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer master key (CMK) stored in AWS Key Management\n Service (SSE-KMS).
" + } + }, "ExistingObjectReplication": { "target": "com.amazonaws.s3#ExistingObjectReplication", "traits": { @@ -10518,9 +10890,12 @@ "Destination": { "target": "com.amazonaws.s3#Destination", "traits": { - "smithy.api#documentation": "A container for information about the replication destination\n and its configurations including enabling the S3 Replication Time Control (S3 RTC).
", + "smithy.api#documentation": "A container for information about the replication destination and its configurations\n including enabling the S3 Replication Time Control (S3 RTC).
", "smithy.api#required": {} } + }, + "DeleteMarkerReplication": { + "target": "com.amazonaws.s3#DeleteMarkerReplication" } }, "traits": { @@ -10546,33 +10921,33 @@ } }, "traits": { - "smithy.api#documentation": "A container for specifying rule filters. The filters determine the subset of objects to which the rule\n applies. This element is required only if you specify more than one filter.
\nFor example:
\nIf you specify both a Prefix
and a Tag
filter, wrap these filters in\n an And
tag.
If you specify a filter based on multiple tags, wrap the Tag
\n elements in an And
tag
A container for specifying rule filters. The filters determine the subset of objects to\n which the rule applies. This element is required only if you specify more than one filter.
\nFor example:
\nIf you specify both a Prefix
and a Tag
filter, wrap\n these filters in an And
tag.
If you specify a filter based on multiple tags, wrap the Tag
elements\n in an And
tag
A container for specifying a tag key and value.
\nThe rule applies only to objects that have the tag in their tag set.
" - } - }, "Prefix": { "target": "com.amazonaws.s3#Prefix", "traits": { "smithy.api#documentation": "An object key name prefix that identifies the subset of objects to which the rule\n applies.
" } }, + "Tag": { + "target": "com.amazonaws.s3#Tag", + "traits": { + "smithy.api#documentation": "A container for specifying a tag key and value.
\nThe rule applies only to objects that have the tag in their tag set.
" + } + }, "And": { "target": "com.amazonaws.s3#ReplicationRuleAndOperator", "traits": { - "smithy.api#documentation": "A container for specifying rule filters. The filters determine the subset of objects to\n which the rule applies. This element is required only if you specify more than one filter. For\n example:
\nIf you specify both a Prefix
and a Tag
filter, wrap these filters\n in an And
tag.
If you specify a filter based on multiple tags, wrap the Tag
elements in an\n And
tag.
A container for specifying rule filters. The filters determine the subset of objects to\n which the rule applies. This element is required only if you specify more than one filter.\n For example:
\nIf you specify both a Prefix
and a Tag
filter, wrap\n these filters in an And
tag.
If you specify a filter based on multiple tags, wrap the Tag
elements\n in an And
tag.
A filter that identifies the subset of objects to which the replication rule applies. A\n Filter
must specify exactly one Prefix
, Tag
, or an\n And
child element.
A filter that identifies the subset of objects to which the replication rule applies. A\n Filter
must specify exactly one Prefix
, Tag
, or\n an And
child element.
A container specifying the time by which replication should be complete for all objects and\n operations on objects.
", + "smithy.api#documentation": "Specifies whether the replication time is enabled.
", "smithy.api#required": {} } }, - "Status": { - "target": "com.amazonaws.s3#ReplicationTimeStatus", + "Time": { + "target": "com.amazonaws.s3#ReplicationTimeValue", "traits": { - "smithy.api#documentation": "\n Specifies whether the replication time is enabled.\n
", + "smithy.api#documentation": "A container specifying the time by which replication should be complete for all objects\n and operations on objects.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "\n A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on \n objects must be replicated. Must be specified together with a Metrics
block.\n
A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is\n enabled and the time when all objects and operations on objects must be replicated. Must be\n specified together with a Metrics
block.
\n Contains an integer specifying time in minutes.\n
\nValid values: 15 minutes.
" + "smithy.api#documentation": "Contains an integer specifying time in minutes.
\nValid values: 15 minutes.
" } } }, "traits": { - "smithy.api#documentation": "\n A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics EventThreshold
. \n
A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics\n EventThreshold
.
If present, indicates that the requester was successfully charged for the request.
", + "smithy.api#documentation": "If present, indicates that the requester was successfully charged for the\n request.
", "smithy.api#enum": [ { "value": "requester" @@ -10676,7 +11051,7 @@ "com.amazonaws.s3#RequestPayer": { "type": "string", "traits": { - "smithy.api#documentation": "Confirms that the requester knows that they will be charged for the request. Bucket\n owners need not specify this parameter in their requests. For information about downloading\n objects from requester pays buckets, see Downloading Objects in Requestor Pays Buckets in the\n Amazon S3 Developer Guide.
", + "smithy.api#documentation": "Confirms that the requester knows that they will be charged for the request. Bucket\n owners need not specify this parameter in their requests. For information about downloading\n objects from requester pays buckets, see Downloading Objects in\n Requestor Pays Buckets in the Amazon S3 Developer Guide.
", "smithy.api#enum": [ { "value": "requester" @@ -10705,7 +11080,7 @@ "Enabled": { "target": "com.amazonaws.s3#EnableRequestProgress", "traits": { - "smithy.api#documentation": "Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default value: FALSE.
" + "smithy.api#documentation": "Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE,\n FALSE. Default value: FALSE.
" } } }, @@ -10748,7 +11123,7 @@ } ], "traits": { - "smithy.api#documentation": "Restores an archived copy of an object back into Amazon S3
\nThis action is not supported by Amazon S3 on Outposts.
\nThis action performs the following types of requests:
\n\n select
- Perform a select query on an archived object
\n restore an archive
- Restore an archived object
To use this operation, you must have permissions to perform the\n s3:RestoreObject
action. The bucket owner\n has this permission by default and can grant this permission to others. For more\n information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.
\n Querying Archives with Select Requests\n
\nYou use a select type of request to perform SQL queries on archived objects. The\n archived objects that are being queried by the select request must be formatted as\n uncompressed comma-separated values (CSV) files. You can run queries and custom analytics\n on your archived data without having to restore your data to a hotter Amazon S3 tier. For an\n overview about select requests, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide.
\nWhen making a select request, do the following:
\nDefine an output location for the select query's output. This must be an Amazon S3\n bucket in the same AWS Region as the bucket that contains the archive object that is\n being queried. The AWS account that initiates the job must have permissions to write\n to the S3 bucket. You can specify the storage class and encryption for the output\n objects stored in the bucket. For more information about output, see Querying Archived Objects\n in the Amazon Simple Storage Service Developer Guide.
\nFor more information about the S3
structure in the request body, see\n the following:
\n PutObject\n
\n\n Managing Access with\n ACLs in the Amazon Simple Storage Service Developer Guide\n
\n\n Protecting Data Using\n Server-Side Encryption in the\n Amazon Simple Storage Service Developer Guide\n
\nDefine the SQL expression for the SELECT
type of restoration for your\n query in the request body's SelectParameters
structure. You can use\n expressions like the following examples.
The following expression returns all records from the specified\n object.
\n\n SELECT * FROM Object
\n
Assuming that you are not using any headers for data stored in the object,\n you can specify columns with positional headers.
\n\n SELECT s._1, s._2 FROM Object s WHERE s._3 > 100
\n
If you have headers and you set the fileHeaderInfo
in the\n CSV
structure in the request body to USE
, you can\n specify headers in the query. (If you set the fileHeaderInfo
field\n to IGNORE
, the first row is skipped for the query.) You cannot mix\n ordinal positions with header column names.
\n SELECT s.Id, s.FirstName, s.SSN FROM S3Object s
\n
For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and\n S3 Glacier Select in the Amazon Simple Storage Service Developer Guide.
\nWhen making a select request, you can also do the following:
\nTo expedite your queries, specify the Expedited
tier. For more\n information about tiers, see \"Restoring Archives,\" later in this topic.
Specify details about the data serialization format of both the input object that\n is being queried and the serialization of the CSV-encoded query results.
\nThe following are additional important facts about the select feature:
\nThe output results are new Amazon S3 objects. Unlike archive retrievals, they are\n stored until explicitly deleted-manually or through a lifecycle policy.
\nYou can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't\n deduplicate requests, so avoid issuing duplicate requests.
\n Amazon S3 accepts a select request even if the object has already been restored. A\n select request doesn’t return error response 409
.
\n Restoring Archives\n
\nObjects in the GLACIER and DEEP_ARCHIVE storage classes are archived. To access an\n archived object, you must first initiate a restore request. This restores a temporary copy\n of the archived object. In a restore request, you specify the number of days that you want\n the restored copy to exist. After the specified period, Amazon S3 deletes the temporary copy but\n the object remains archived in the GLACIER or DEEP_ARCHIVE storage class that object was\n restored from.
\nTo restore a specific object version, you can provide a version ID. If you don't provide\n a version ID, Amazon S3 restores the current version.
\nThe time it takes restore jobs to finish depends on which storage class the object is\n being restored from and which data access tier you specify.
\nWhen restoring an archived object (or using a select request), you can specify one of\n the following data access tier options in the Tier
element of the request\n body:
\n \n Expedited
\n - Expedited retrievals\n allow you to quickly access your data stored in the GLACIER storage class when\n occasional urgent requests for a subset of archives are required. For all but the\n largest archived objects (250 MB+), data accessed using Expedited retrievals are\n typically made available within 1–5 minutes. Provisioned capacity ensures that\n retrieval capacity for Expedited retrievals is available when you need it. Expedited\n retrievals and provisioned capacity are not available for the DEEP_ARCHIVE storage\n class.
\n \n Standard
\n - S3 Standard retrievals allow\n you to access any of your archived objects within several hours. This is the default\n option for the GLACIER and DEEP_ARCHIVE retrieval requests that do not specify the\n retrieval option. S3 Standard retrievals typically complete within 3-5 hours from the\n GLACIER storage class and typically complete within 12 hours from the DEEP_ARCHIVE\n storage class.
\n \n Bulk
\n - Bulk retrievals are Amazon S3\n Glacier’s lowest-cost retrieval option, enabling you to retrieve large amounts, even\n petabytes, of data inexpensively in a day. Bulk retrievals typically complete within\n 5-12 hours from the GLACIER storage class and typically complete within 48 hours from\n the DEEP_ARCHIVE storage class.
For more information about archive retrieval options and provisioned capacity for\n Expedited
data access, see Restoring Archived Objects in the Amazon Simple Storage Service Developer Guide.
You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed\n while it is in progress. You upgrade the speed of an in-progress restoration by issuing\n another restore request to the same object, setting a new Tier
request\n element. When issuing a request to upgrade the restore tier, you must choose a tier that is\n faster than the tier that the in-progress restore is using. You must not change any other\n parameters, such as the Days
request element. For more information, see \n Upgrading the Speed of an In-Progress Restore in the\n Amazon Simple Storage Service Developer Guide.
To get the status of object restoration, you can send a HEAD
request.\n Operations return the x-amz-restore
header, which provides information about\n the restoration status, in the response. You can use Amazon S3 event notifications to notify you\n when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in\n the Amazon Simple Storage Service Developer Guide.
After restoring an archived object, you can update the restoration period by reissuing\n the request with a new period. Amazon S3 updates the restoration period relative to the current\n time and charges only for the request-there are no data transfer charges. You cannot\n update the restoration period when Amazon S3 is actively processing your current restore request\n for the object.
\nIf your bucket has a lifecycle configuration with a rule that includes an expiration\n action, the object expiration overrides the life span that you specify in a restore\n request. For example, if you restore an object copy for 10 days, but the object is\n scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information\n about lifecycle configuration, see PutBucketLifecycleConfiguration and\n Object Lifecycle Management\n in Amazon Simple Storage Service Developer Guide.
\n\n Responses\n
\nA successful operation returns either the 200 OK
or 202\n Accepted
status code.
If the object copy is not previously restored, then Amazon S3 returns 202\n Accepted
in the response.
If the object copy is previously restored, Amazon S3 returns 200 OK
in the\n response.
\n Special Errors\n
\n\n Code: RestoreAlreadyInProgress\n
\n\n Cause: Object restore is already in progress. (This error does not\n apply to SELECT type requests.)\n
\n\n HTTP Status Code: 409 Conflict\n
\n\n SOAP Fault Code Prefix: Client\n
\n\n Code: GlacierExpeditedRetrievalNotAvailable\n
\n\n Cause: S3 Glacier expedited retrievals are currently not available.\n Try again later. (Returned if there is insufficient capacity to process the\n Expedited request. This error applies only to Expedited retrievals and not\n to S3 Standard or Bulk retrievals.)\n
\n\n HTTP Status Code: 503\n
\n\n SOAP Fault Code Prefix: N/A\n
\n\n Related Resources\n
\n\n SQL Reference for\n Amazon S3 Select and S3 Glacier Select in the Amazon Simple Storage Service Developer Guide\n
\nRestores an archived copy of an object back into Amazon S3
\nThis action is not supported by Amazon S3 on Outposts.
\nThis action performs the following types of requests:
\n\n select
- Perform a select query on an archived object
\n restore an archive
- Restore an archived object
To use this operation, you must have permissions to perform the\n s3:RestoreObject
action. The bucket owner has this permission by default\n and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3\n Resources in the Amazon Simple Storage Service Developer Guide.
\n Querying Archives with Select Requests\n
\nYou use a select type of request to perform SQL queries on archived objects. The\n archived objects that are being queried by the select request must be formatted as\n uncompressed comma-separated values (CSV) files. You can run queries and custom analytics\n on your archived data without having to restore your data to a hotter Amazon S3 tier. For an\n overview about select requests, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide.
\nWhen making a select request, do the following:
\nDefine an output location for the select query's output. This must be an Amazon S3\n bucket in the same AWS Region as the bucket that contains the archive object that is\n being queried. The AWS account that initiates the job must have permissions to write\n to the S3 bucket. You can specify the storage class and encryption for the output\n objects stored in the bucket. For more information about output, see Querying Archived Objects\n in the Amazon Simple Storage Service Developer Guide.
\nFor more information about the S3
structure in the request body, see\n the following:
\n PutObject\n
\n\n Managing Access with\n ACLs in the Amazon Simple Storage Service Developer Guide\n
\n\n Protecting Data Using\n Server-Side Encryption in the\n Amazon Simple Storage Service Developer Guide\n
\nDefine the SQL expression for the SELECT
type of restoration for your\n query in the request body's SelectParameters
structure. You can use\n expressions like the following examples.
The following expression returns all records from the specified\n object.
\n\n SELECT * FROM Object
\n
Assuming that you are not using any headers for data stored in the object,\n you can specify columns with positional headers.
\n\n SELECT s._1, s._2 FROM Object s WHERE s._3 > 100
\n
If you have headers and you set the fileHeaderInfo
in the\n CSV
structure in the request body to USE
, you can\n specify headers in the query. (If you set the fileHeaderInfo
field\n to IGNORE
, the first row is skipped for the query.) You cannot mix\n ordinal positions with header column names.
\n SELECT s.Id, s.FirstName, s.SSN FROM S3Object s
\n
For more information about using SQL with S3 Glacier Select restore, see SQL Reference for Amazon S3 Select and\n S3 Glacier Select in the Amazon Simple Storage Service Developer Guide.
\nWhen making a select request, you can also do the following:
\nTo expedite your queries, specify the Expedited
tier. For more\n information about tiers, see \"Restoring Archives,\" later in this topic.
Specify details about the data serialization format of both the input object that\n is being queried and the serialization of the CSV-encoded query results.
\nThe following are additional important facts about the select feature:
\nThe output results are new Amazon S3 objects. Unlike archive retrievals, they are\n stored until explicitly deleted-manually or through a lifecycle policy.
\nYou can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't\n deduplicate requests, so avoid issuing duplicate requests.
\n Amazon S3 accepts a select request even if the object has already been restored. A\n select request doesn’t return error response 409
.
\n Restoring Archives\n
\nObjects that you archive to the S3 Glacier,\n S3 Glacier Deep Archive, S3 Intelligent-Tiering Archive, or S3 Intelligent-Tiering Deep Archive storage\n classes are not accessible in real time. For objects in Archive Access tier or\n Deep Archive Access tier you must first initiate a restore request, and then wait until the object\n is moved into the Frequent Access tier. For objects in S3 Glacier or\n S3 Glacier Deep Archive you must first initiate a restore request, and then wait\n until a temporary copy of the object is available. To access an archived object, you must\n restore the object for the duration (number of days) that you specify.
\nTo restore a specific object version, you can provide a version ID. If you don't provide\n a version ID, Amazon S3 restores the current version.
\nWhen restoring an archived object (or using a select request), you can specify one of\n the following data access tier options in the Tier
element of the request\n body:
\n \n Expedited
\n - Expedited retrievals\n allow you to quickly access your data stored in the S3 Glacier or\n S3 Intelligent-Tiering Archive storage class when occasional urgent requests for a subset of\n archives are required. For all but the largest archived objects (250 MB+), data\n accessed using Expedited retrievals is typically made available within 1–5 minutes.\n Provisioned capacity ensures that retrieval capacity for Expedited retrievals is\n available when you need it. Expedited retrievals and provisioned capacity are not\n available for objects stored in the S3 Glacier Deep Archive or\n S3 Intelligent-Tiering Deep Archive storage class.
\n \n Standard
\n - Standard retrievals allow\n you to access any of your archived objects within several hours. This is the default\n option for retrieval requests that do not specify the retrieval option. Standard\n retrievals typically finish within 3–5 hours for objects stored in the\n S3 Glacier or S3 Intelligent-Tiering Archive storage class. They typically\n finish within 12 hours for objects stored in the S3 Glacier Deep Archive or\n S3 Intelligent-Tiering Deep Archive storage class. Standard retrievals are free for objects stored\n in S3 Intelligent-Tiering.
\n \n Bulk
\n - Bulk retrievals are the\n lowest-cost retrieval option in S3 Glacier, enabling you to retrieve large amounts,\n even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12\n hours for objects stored in the S3 Glacier or S3 Intelligent-Tiering Archive\n storage class. They typically finish within 48 hours for objects stored in the\n S3 Glacier Deep Archive or S3 Intelligent-Tiering Deep Archive storage class. Bulk\n retrievals are free for objects stored in S3 Intelligent-Tiering.
For more information about archive retrieval options and provisioned capacity for\n Expedited
data access, see Restoring Archived Objects in the Amazon Simple Storage Service Developer Guide.
You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed\n while it is in progress. For more information, see \n Upgrading the speed of an in-progress restore in the\n Amazon Simple Storage Service Developer Guide.
\nTo get the status of object restoration, you can send a HEAD
request.\n Operations return the x-amz-restore
header, which provides information about\n the restoration status, in the response. You can use Amazon S3 event notifications to notify you\n when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in\n the Amazon Simple Storage Service Developer Guide.
After restoring an archived object, you can update the restoration period by reissuing\n the request with a new period. Amazon S3 updates the restoration period relative to the current\n time and charges only for the request-there are no data transfer charges. You cannot\n update the restoration period when Amazon S3 is actively processing your current restore request\n for the object.
\nIf your bucket has a lifecycle configuration with a rule that includes an expiration\n action, the object expiration overrides the life span that you specify in a restore\n request. For example, if you restore an object copy for 10 days, but the object is\n scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information\n about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in\n Amazon Simple Storage Service Developer Guide.
\n\n Responses\n
\nA successful operation returns either the 200 OK
or 202\n Accepted
status code.
If the object is not previously restored, then Amazon S3 returns 202\n Accepted
in the response.
If the object is previously restored, Amazon S3 returns 200 OK
in the\n response.
\n Special Errors\n
\n\n Code: RestoreAlreadyInProgress\n
\n\n Cause: Object restore is already in progress. (This error does not\n apply to SELECT type requests.)\n
\n\n HTTP Status Code: 409 Conflict\n
\n\n SOAP Fault Code Prefix: Client\n
\n\n Code: GlacierExpeditedRetrievalNotAvailable\n
\n\n Cause: expedited retrievals are currently not available. Try again\n later. (Returned if there is insufficient capacity to process the Expedited\n request. This error applies only to Expedited retrievals and not to\n S3 Standard or Bulk retrievals.)\n
\n\n HTTP Status Code: 503\n
\n\n SOAP Fault Code Prefix: N/A\n
\n\n Related Resources\n
\n\n SQL Reference for\n Amazon S3 Select and S3 Glacier Select in the\n Amazon Simple Storage Service Developer Guide\n
\nIndicates the path in the provided S3 output location where Select results will be restored to.
", + "smithy.api#documentation": "Indicates the path in the provided S3 output location where Select results will be\n restored to.
", "smithy.api#httpHeader": "x-amz-restore-output-path" } } @@ -10777,16 +11152,20 @@ "com.amazonaws.s3#RestoreObjectRequest": { "type": "structure", "members": { - "RestoreRequest": { - "target": "com.amazonaws.s3#RestoreRequest", + "Bucket": { + "target": "com.amazonaws.s3#BucketName", "traits": { - "smithy.api#httpPayload": {} + "smithy.api#documentation": "The bucket name containing the object to restore.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" + "smithy.api#documentation": "Object key for which the operation was initiated.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "VersionId": { @@ -10796,20 +11175,16 @@ "smithy.api#httpQuery": "versionId" } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "RestoreRequest": { + "target": "com.amazonaws.s3#RestoreRequest", "traits": { - "smithy.api#documentation": "Object key for which the operation was initiated.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#httpPayload": {} } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", "traits": { - "smithy.api#documentation": "The bucket name or containing the object to restore.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#httpHeader": "x-amz-request-payer" } }, "ExpectedBucketOwner": { @@ -10827,34 +11202,28 @@ "com.amazonaws.s3#RestoreRequest": { "type": "structure", "members": { - "GlacierJobParameters": { - "target": "com.amazonaws.s3#GlacierJobParameters", - "traits": { - "smithy.api#documentation": "S3 Glacier related parameters pertaining to this job. Do not use with restores that specify\n OutputLocation
.
Lifetime of the active copy in days. Do not use with restores that specify\n OutputLocation
.
Lifetime of the active copy in days. Do not use with restores that specify\n OutputLocation
.
The Days element is required for regular restores, and must not be provided for select\n requests.
" } }, - "OutputLocation": { - "target": "com.amazonaws.s3#OutputLocation", + "GlacierJobParameters": { + "target": "com.amazonaws.s3#GlacierJobParameters", "traits": { - "smithy.api#documentation": "Describes the location where the restore job's output is stored.
" + "smithy.api#documentation": "S3 Glacier related parameters pertaining to this job. Do not use with restores that\n specify OutputLocation
.
Describes the parameters for Select job types.
" + "smithy.api#documentation": "Type of restore request.
" } }, "Tier": { "target": "com.amazonaws.s3#Tier", "traits": { - "smithy.api#documentation": "S3 Glacier retrieval tier at which the restore will be processed.
" + "smithy.api#documentation": "Retrieval tier at which the restore will be processed.
" } }, "Description": { @@ -10863,10 +11232,16 @@ "smithy.api#documentation": "The optional description for the job.
" } }, - "Type": { - "target": "com.amazonaws.s3#RestoreRequestType", + "SelectParameters": { + "target": "com.amazonaws.s3#SelectParameters", "traits": { - "smithy.api#documentation": "Type of restore request.
" + "smithy.api#documentation": "Describes the parameters for Select job types.
" + } + }, + "OutputLocation": { + "target": "com.amazonaws.s3#OutputLocation", + "traits": { + "smithy.api#documentation": "Describes the location where the restore job's output is stored.
" } } }, @@ -10891,17 +11266,17 @@ "com.amazonaws.s3#RoutingRule": { "type": "structure", "members": { - "Redirect": { - "target": "com.amazonaws.s3#Redirect", + "Condition": { + "target": "com.amazonaws.s3#Condition", "traits": { - "smithy.api#documentation": "Container for redirect information. You can redirect requests to another host, to another\n page, or with another protocol. In the event of an error, you can specify a different error\n code to return.
", - "smithy.api#required": {} + "smithy.api#documentation": "A container for describing a condition that must be met for the specified redirect to\n apply. For example, 1. If request is for pages in the /docs
folder, redirect\n to the /documents
folder. 2. If request results in HTTP error 4xx, redirect\n request to another host where you might process the error.
A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs
folder, redirect to the /documents
folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.
Container for redirect information. You can redirect requests to another host, to\n another page, or with another protocol. In the event of an error, you can specify a\n different error code to return.
", + "smithy.api#required": {} } } }, @@ -10943,29 +11318,26 @@ "smithy.api#required": {} } }, - "StorageClass": { - "target": "com.amazonaws.s3#StorageClass", + "Prefix": { + "target": "com.amazonaws.s3#LocationPrefix", "traits": { - "smithy.api#documentation": "The class of storage used to store the restore results.
" + "smithy.api#documentation": "The prefix that is prepended to the restore results for this request.
", + "smithy.api#required": {} } }, + "Encryption": { + "target": "com.amazonaws.s3#Encryption" + }, "CannedACL": { "target": "com.amazonaws.s3#ObjectCannedACL", "traits": { "smithy.api#documentation": "The canned ACL to apply to the restore results.
" } }, - "UserMetadata": { - "target": "com.amazonaws.s3#UserMetadata", - "traits": { - "smithy.api#documentation": "A list of metadata to store with the restore results in S3.
" - } - }, - "Prefix": { - "target": "com.amazonaws.s3#LocationPrefix", + "AccessControlList": { + "target": "com.amazonaws.s3#Grants", "traits": { - "smithy.api#documentation": "The prefix that is prepended to the restore results for this request.
", - "smithy.api#required": {} + "smithy.api#documentation": "A list of grants that control access to the staged results.
" } }, "Tagging": { @@ -10974,13 +11346,16 @@ "smithy.api#documentation": "The tag-set that is applied to the restore results.
" } }, - "Encryption": { - "target": "com.amazonaws.s3#Encryption" + "UserMetadata": { + "target": "com.amazonaws.s3#UserMetadata", + "traits": { + "smithy.api#documentation": "A list of metadata to store with the restore results in S3.
" + } }, - "AccessControlList": { - "target": "com.amazonaws.s3#Grants", + "StorageClass": { + "target": "com.amazonaws.s3#StorageClass", "traits": { - "smithy.api#documentation": "A list of grants that control access to the staged results.
" + "smithy.api#documentation": "The class of storage used to store the restore results.
" } } }, @@ -11006,7 +11381,7 @@ "KeyId": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "Specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) to use\n for encrypting inventory reports.
", + "smithy.api#documentation": "Specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed\n customer master key (CMK) to use for encrypting inventory reports.
", "smithy.api#required": {} } } @@ -11039,21 +11414,21 @@ "com.amazonaws.s3#ScanRange": { "type": "structure", "members": { - "End": { - "target": "com.amazonaws.s3#End", + "Start": { + "target": "com.amazonaws.s3#Start", "traits": { - "smithy.api#documentation": "Specifies the end of the byte range. This parameter is optional. Valid values: non-negative\n integers. The default value is one less than the size of the object being queried. If only\n the End parameter is supplied, it is interpreted to mean scan the last N bytes of the file.\n For example,
\n means scan the last 50 bytes.
Specifies the start of the byte range. This parameter is optional. Valid values:\n non-negative integers. The default value is 0. If only start is supplied, it means scan\n from that point to the end of the file.For example;\n
means scan\n from byte 50 until the end of the file.
Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. \n If only start is supplied, it means scan from that point to the end of the file.For example;
means scan from byte 50 until the end of the file.
Specifies the end of the byte range. This parameter is optional. Valid values:\n non-negative integers. The default value is one less than the size of the object being\n queried. If only the End parameter is supplied, it is interpreted to mean scan the last N\n bytes of the file. For example,\n
means scan the\n last 50 bytes.
Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional,\n but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.
" + "smithy.api#documentation": "Specifies the byte range of the object to get the records from. A record is processed\n when its first byte is contained by the range. This parameter is optional, but when\n specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the\n start and end of the range.
" } }, "com.amazonaws.s3#SelectObjectContent": { @@ -11065,7 +11440,7 @@ "target": "com.amazonaws.s3#SelectObjectContentOutput" }, "traits": { - "smithy.api#documentation": "This operation filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3\n uses this format to parse object data into records, and returns only records that match\n the specified SQL expression. You must also specify the data serialization format for\n the response.
\nThis action is not supported by Amazon S3 on Outposts.
\nFor more information about Amazon S3 Select, see \n Selecting Content from Objects\n in the Amazon Simple Storage Service Developer Guide.
\nFor more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3\n Select and S3 Glacier Select in the Amazon Simple Storage Service Developer Guide.
\n \n\n Permissions\n
\nYou must have s3:GetObject
permission for this operation. Amazon S3 Select\n does not support anonymous access. For more information about permissions, see\n Specifying Permissions in a\n Policy in the Amazon Simple Storage Service Developer Guide.
\n Object Data Formats\n
\nYou can use Amazon S3 Select to query objects that have the following format\n properties:
\n\n CSV, JSON, and Parquet - Objects must be in CSV,\n JSON, or Parquet format.
\n\n UTF-8 - UTF-8 is the only encoding\n type Amazon S3 Select supports.
\n\n GZIP or BZIP2 - CSV and JSON files can be compressed\n using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that\n Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar\n compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support\n whole-object compression for Parquet objects.
\n\n Server-side encryption - Amazon S3 Select\n supports querying objects that are protected with server-side\n encryption.
\nFor objects that are encrypted with customer-provided encryption keys\n (SSE-C), you must use HTTPS, and you must use the headers that are\n documented in the GetObject. For more information\n about SSE-C, see Server-Side\n Encryption (Using Customer-Provided Encryption Keys) in the\n Amazon Simple Storage Service Developer Guide.
\nFor objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3)\n and customer master keys (CMKs) stored in AWS Key Management Service (SSE-KMS), server-side encryption is\n handled transparently, so you don't need to specify anything. For more\n information about server-side encryption, including SSE-S3 and SSE-KMS, see\n Protecting Data Using\n Server-Side Encryption in the\n Amazon Simple Storage Service Developer Guide.
\n\n Working with the Response Body\n
\nGiven the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a Transfer-Encoding
header with chunked
\n as its value in the response. For more information, see Appendix: SelectObjectContent Response\n .
\n GetObject Support\n
\nThe SelectObjectContent
operation does not support the following GetObject
functionality. For more information, see GetObject.
\n Range
: Although you can specify a scan range for an Amazon S3 Select request\n (see SelectObjectContentRequest - ScanRange in the request\n parameters), you cannot specify the range of bytes of an object to return.
GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You\n cannot specify the GLACIER, DEEP_ARCHIVE, or \n REDUCED_REDUNDANCY
storage classes. For more information, about\n storage classes see Storage\n Classes in the Amazon Simple Storage Service Developer Guide.
\n Special Errors\n
\n\nFor a list of special errors for this operation, see \n List of SELECT Object Content Error Codes\n
\n\n Related Resources\n
\n\n GetObject\n
\nThis operation filters the contents of an Amazon S3 object based on a simple structured query\n language (SQL) statement. In the request, along with the SQL expression, you must also\n specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses\n this format to parse object data into records, and returns only records that match the\n specified SQL expression. You must also specify the data serialization format for the\n response.
\nThis action is not supported by Amazon S3 on Outposts.
\nFor more information about Amazon S3 Select,\n see Selecting Content from\n Objects in the Amazon Simple Storage Service Developer Guide.
\nFor more information about using SQL with Amazon S3 Select, see SQL Reference for Amazon S3 Select\n and S3 Glacier Select in the Amazon Simple Storage Service Developer Guide.
\n \n\n Permissions\n
\nYou must have s3:GetObject
permission for this operation. Amazon S3 Select does\n not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy\n in the Amazon Simple Storage Service Developer Guide.
\n Object Data Formats\n
\nYou can use Amazon S3 Select to query objects that have the following format\n properties:
\n\n CSV, JSON, and Parquet - Objects must be in CSV, JSON, or\n Parquet format.
\n\n UTF-8 - UTF-8 is the only encoding type Amazon S3 Select\n supports.
\n\n GZIP or BZIP2 - CSV and JSON files can be compressed using\n GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select\n supports for CSV and JSON files. Amazon S3 Select supports columnar compression for\n Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression\n for Parquet objects.
\n\n Server-side encryption - Amazon S3 Select supports querying\n objects that are protected with server-side encryption.
\nFor objects that are encrypted with customer-provided encryption keys (SSE-C), you\n must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption\n (Using Customer-Provided Encryption Keys) in the\n Amazon Simple Storage Service Developer Guide.
\nFor objects that are encrypted with Amazon S3 managed encryption keys (SSE-S3) and\n customer master keys (CMKs) stored in AWS Key Management Service (SSE-KMS),\n server-side encryption is handled transparently, so you don't need to specify\n anything. For more information about server-side encryption, including SSE-S3 and\n SSE-KMS, see Protecting Data Using\n Server-Side Encryption in the Amazon Simple Storage Service Developer Guide.
\n\n Working with the Response Body\n
\nGiven the response size is unknown, Amazon S3 Select streams the response as a series of\n messages and includes a Transfer-Encoding
header with chunked
as\n its value in the response. For more information, see Appendix: SelectObjectContent\n Response\n .
\n GetObject Support\n
\nThe SelectObjectContent
operation does not support the following\n GetObject
functionality. For more information, see GetObject.
\n Range
: Although you can specify a scan range for an Amazon S3 Select request\n (see SelectObjectContentRequest - ScanRange in the request parameters),\n you cannot specify the range of bytes of an object to return.
GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot specify\n the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY
storage classes. For\n more information, about storage classes see Storage Classes\n in the Amazon Simple Storage Service Developer Guide.
\n Special Errors\n
\n\nFor a list of special errors for this operation, see List of\n SELECT Object Content Error Codes\n
\n\n Related Resources\n
\n\n GetObject\n
\nThe Continuation Event.
" + "smithy.api#documentation": "The Records Event.
" + } + }, + "Stats": { + "target": "com.amazonaws.s3#StatsEvent", + "traits": { + "smithy.api#documentation": "The Stats Event.
" } }, "Progress": { @@ -11088,10 +11469,10 @@ "smithy.api#documentation": "The Progress Event.
" } }, - "Stats": { - "target": "com.amazonaws.s3#StatsEvent", + "Cont": { + "target": "com.amazonaws.s3#ContinuationEvent", "traits": { - "smithy.api#documentation": "The Stats Event.
" + "smithy.api#documentation": "The Continuation Event.
" } }, "End": { @@ -11099,12 +11480,6 @@ "traits": { "smithy.api#documentation": "The End Event.
" } - }, - "Records": { - "target": "com.amazonaws.s3#RecordsEvent", - "traits": { - "smithy.api#documentation": "The Records Event.
" - } } }, "traits": { @@ -11127,6 +11502,14 @@ "com.amazonaws.s3#SelectObjectContentRequest": { "type": "structure", "members": { + "Bucket": { + "target": "com.amazonaws.s3#BucketName", + "traits": { + "smithy.api#documentation": "The S3 bucket.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, "Key": { "target": "com.amazonaws.s3#ObjectKey", "traits": { @@ -11142,13 +11525,6 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "OutputSerialization": { - "target": "com.amazonaws.s3#OutputSerialization", - "traits": { - "smithy.api#documentation": "Describes the format of the data that you want Amazon S3 to return in response.
", - "smithy.api#required": {} - } - }, "SSECustomerKey": { "target": "com.amazonaws.s3#SSECustomerKey", "traits": { @@ -11156,27 +11532,6 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key" } }, - "ExpressionType": { - "target": "com.amazonaws.s3#ExpressionType", - "traits": { - "smithy.api#documentation": "The type of the provided expression (for example, SQL).
", - "smithy.api#required": {} - } - }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Describes the format of the data in the object that is being queried.
", - "smithy.api#required": {} - } - }, "SSECustomerKeyMD5": { "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { @@ -11191,11 +11546,10 @@ "smithy.api#required": {} } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "ExpressionType": { + "target": "com.amazonaws.s3#ExpressionType", "traits": { - "smithy.api#documentation": "The S3 bucket.
", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "The type of the provided expression (for example, SQL).
", "smithy.api#required": {} } }, @@ -11205,31 +11559,52 @@ "smithy.api#documentation": "Specifies if periodic request progress information should be enabled.
" } }, + "InputSerialization": { + "target": "com.amazonaws.s3#InputSerialization", + "traits": { + "smithy.api#documentation": "Describes the format of the data in the object that is being queried.
", + "smithy.api#required": {} + } + }, + "OutputSerialization": { + "target": "com.amazonaws.s3#OutputSerialization", + "traits": { + "smithy.api#documentation": "Describes the format of the data that you want Amazon S3 to return in response.
", + "smithy.api#required": {} + } + }, "ScanRange": { "target": "com.amazonaws.s3#ScanRange", "traits": { - "smithy.api#documentation": "Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional,\n but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.
\n\n ScanRange
may be used in the following ways:
\n
- process only the records starting between the bytes 50 and 100 (inclusive, counting from zero)
\n
- process only the records starting after the byte 50
\n
- process only the records within the last 50 bytes of the file.
Specifies the byte range of the object to get the records from. A record is processed\n when its first byte is contained by the range. This parameter is optional, but when\n specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the\n start and end of the range.
\n\n ScanRange
may be used in the following ways:
\n
\n - process only the records starting between the bytes 50 and 100 (inclusive, counting\n from zero)
\n
-\n process only the records starting after the byte 50
\n
-\n process only the records within the last 50 bytes of the file.
The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Request to filter the contents of an Amazon S3 object based on a simple Structured Query\n Language (SQL) statement. In the request, along with the SQL expression, you must specify a\n data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object\n data into records. It returns only records that match the specified SQL expression. You must\n also specify the data serialization format for the response. For more information, see S3Select API\n Documentation.
" + "smithy.api#documentation": "Request to filter the contents of an Amazon S3 object based on a simple Structured Query\n Language (SQL) statement. In the request, along with the SQL expression, you must specify a\n data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data\n into records. It returns only records that match the specified SQL expression. You must\n also specify the data serialization format for the response. For more information, see\n S3Select API Documentation.
" } }, "com.amazonaws.s3#SelectParameters": { "type": "structure", "members": { - "ExpressionType": { - "target": "com.amazonaws.s3#ExpressionType", + "InputSerialization": { + "target": "com.amazonaws.s3#InputSerialization", "traits": { - "smithy.api#documentation": "The type of the provided expression (for example, SQL).
", + "smithy.api#documentation": "Describes the serialization format of the object.
", "smithy.api#required": {} } }, - "OutputSerialization": { - "target": "com.amazonaws.s3#OutputSerialization", + "ExpressionType": { + "target": "com.amazonaws.s3#ExpressionType", "traits": { - "smithy.api#documentation": "Describes how the results of the Select job are serialized.
", + "smithy.api#documentation": "The type of the provided expression (for example, SQL).
", "smithy.api#required": {} } }, @@ -11240,10 +11615,10 @@ "smithy.api#required": {} } }, - "InputSerialization": { - "target": "com.amazonaws.s3#InputSerialization", + "OutputSerialization": { + "target": "com.amazonaws.s3#OutputSerialization", "traits": { - "smithy.api#documentation": "Describes the serialization format of the object.
", + "smithy.api#documentation": "Describes how the results of the Select job are serialized.
", "smithy.api#required": {} } } @@ -11278,12 +11653,12 @@ "KMSMasterKeyID": { "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "AWS Key Management Service (KMS) customer master key ID to use for the default encryption. This parameter is allowed if and only if SSEAlgorithm
is set to aws:kms
.
You can specify the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you are using encryption with cross-account operations, you must use a fully qualified CMK ARN. For more information, see Using encryption for cross-account operations.
\n\n For example:\n
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see Using Symmetric and Asymmetric Keys in the AWS Key Management Service Developer Guide.
\nAWS Key Management Service (KMS) customer master key ID to use for the default\n encryption. This parameter is allowed if and only if SSEAlgorithm
is set to\n aws:kms
.
You can specify the key ID or the Amazon Resource Name (ARN) of the CMK. However, if you\n are using encryption with cross-account operations, you must use a fully qualified CMK ARN.\n For more information, see Using encryption for cross-account operations.
\n\n For example:\n
\nKey ID: 1234abcd-12ab-34cd-56ef-1234567890ab
\n
Key ARN:\n arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
\n
Amazon S3 only supports symmetric CMKs and not asymmetric CMKs. For more information, see\n Using Symmetric and\n Asymmetric Keys in the AWS Key Management Service Developer\n Guide.
\nDescribes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied. For more information, see PUT Bucket encryption in the Amazon Simple Storage Service API Reference.
" + "smithy.api#documentation": "Describes the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied. For more information, see PUT Bucket encryption in\n the Amazon Simple Storage Service API Reference.
" } }, "com.amazonaws.s3#ServerSideEncryptionConfiguration": { @@ -11292,7 +11667,7 @@ "Rules": { "target": "com.amazonaws.s3#ServerSideEncryptionRules", "traits": { - "smithy.api#documentation": "Container for information about a particular server-side encryption configuration rule.
", + "smithy.api#documentation": "Container for information about a particular server-side encryption configuration\n rule.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Rule" @@ -11309,7 +11684,7 @@ "ApplyServerSideEncryptionByDefault": { "target": "com.amazonaws.s3#ServerSideEncryptionByDefault", "traits": { - "smithy.api#documentation": "Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn't specify any server-side encryption, this default encryption will be applied.
" + "smithy.api#documentation": "Specifies the default server-side encryption to apply to new objects in the bucket. If a\n PUT Object request doesn't specify any server-side encryption, this default encryption will\n be applied.
" } } }, @@ -11335,12 +11710,12 @@ "SseKmsEncryptedObjects": { "target": "com.amazonaws.s3#SseKmsEncryptedObjects", "traits": { - "smithy.api#documentation": " A container for filter information for the selection of Amazon S3 objects encrypted with AWS\n KMS. If you include SourceSelectionCriteria
in the replication configuration,\n this element is required.
A container for filter information for the selection of Amazon S3 objects encrypted with AWS\n KMS. If you include SourceSelectionCriteria
in the replication configuration,\n this element is required.
A container that describes additional filters for identifying the source objects that you\n want to replicate. You can choose to enable or disable the replication of these objects.\n Currently, Amazon S3 supports only the filter that you can specify for objects created with\n server-side encryption using a customer master key (CMK) stored in AWS Key Management Service (SSE-KMS).
" + "smithy.api#documentation": "A container that describes additional filters for identifying the source objects that\n you want to replicate. You can choose to enable or disable the replication of these\n objects. Currently, Amazon S3 supports only the filter that you can specify for objects created\n with server-side encryption using a customer master key (CMK) stored in AWS Key Management\n Service (SSE-KMS).
" } }, "com.amazonaws.s3#SseKmsEncryptedObjects": { @@ -11349,13 +11724,13 @@ "Status": { "target": "com.amazonaws.s3#SseKmsEncryptedObjectsStatus", "traits": { - "smithy.api#documentation": "Specifies whether Amazon S3 replicates objects created with server-side encryption using a customer master key (CMK) stored in AWS Key Management Service.
", + "smithy.api#documentation": "Specifies whether Amazon S3 replicates objects created with server-side encryption using a\n customer master key (CMK) stored in AWS Key Management Service.
", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "A container for filter information for the selection of S3 objects encrypted with AWS\n KMS.
" + "smithy.api#documentation": "A container for filter information for the selection of S3 objects encrypted with AWS\n KMS.
" } }, "com.amazonaws.s3#SseKmsEncryptedObjectsStatus": { @@ -11380,12 +11755,6 @@ "com.amazonaws.s3#Stats": { "type": "structure", "members": { - "BytesReturned": { - "target": "com.amazonaws.s3#BytesReturned", - "traits": { - "smithy.api#documentation": "The total number of bytes of records payload data returned.
" - } - }, "BytesScanned": { "target": "com.amazonaws.s3#BytesScanned", "traits": { @@ -11397,6 +11766,12 @@ "traits": { "smithy.api#documentation": "The total number of uncompressed object bytes processed.
" } + }, + "BytesReturned": { + "target": "com.amazonaws.s3#BytesReturned", + "traits": { + "smithy.api#documentation": "The total number of bytes of records payload data returned.
" + } } }, "traits": { @@ -11455,12 +11830,12 @@ "DataExport": { "target": "com.amazonaws.s3#StorageClassAnalysisDataExport", "traits": { - "smithy.api#documentation": "Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.
" + "smithy.api#documentation": "Specifies how data related to the storage class analysis for an Amazon S3 bucket should be\n exported.
" } } }, "traits": { - "smithy.api#documentation": "Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.
" + "smithy.api#documentation": "Specifies data related to access patterns to be collected and made available to analyze\n the tradeoffs between different storage classes for an Amazon S3 bucket.
" } }, "com.amazonaws.s3#StorageClassAnalysisDataExport": { @@ -11469,7 +11844,7 @@ "OutputSchemaVersion": { "target": "com.amazonaws.s3#StorageClassAnalysisSchemaVersion", "traits": { - "smithy.api#documentation": "The version of the output schema to use when exporting data. Must be V_1
.
The version of the output schema to use when exporting data. Must be\n V_1
.
Container for data related to the storage class analysis for an Amazon S3 bucket for export.
" + "smithy.api#documentation": "Container for data related to the storage class analysis for an Amazon S3 bucket for\n export.
" } }, "com.amazonaws.s3#StorageClassAnalysisSchemaVersion": { @@ -11507,17 +11882,17 @@ "com.amazonaws.s3#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.s3#Value", + "Key": { + "target": "com.amazonaws.s3#ObjectKey", "traits": { - "smithy.api#documentation": "Value of the tag.
", + "smithy.api#documentation": "Name of the object key.
", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.s3#ObjectKey", + "Value": { + "target": "com.amazonaws.s3#Value", "traits": { - "smithy.api#documentation": "Name of the object key.
", + "smithy.api#documentation": "Value of the tag.
", "smithy.api#required": {} } } @@ -11620,6 +11995,34 @@ ] } }, + "com.amazonaws.s3#Tiering": { + "type": "structure", + "members": { + "Days": { + "target": "com.amazonaws.s3#IntelligentTieringDays", + "traits": { + "smithy.api#documentation": "The number of days that you want your archived data to be accessible. The minimum number\n of days specified in the restore request must be at least 90 days. If a smaller value is\n specifed it will be ignored.
", + "smithy.api#required": {} + } + }, + "AccessTier": { + "target": "com.amazonaws.s3#IntelligentTieringAccessTier", + "traits": { + "smithy.api#documentation": "S3 Intelligent-Tiering access tier. See Storage class for\n automatically optimizing frequently and infrequently accessed objects for a list\n of access tiers in the S3 Intelligent-Tiering storage class.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The S3 Intelligent-Tiering storage class is designed to optimize storage costs by\n automatically moving data to the most cost-effective storage access tier, without\n additional operational overhead.
" + } + }, + "com.amazonaws.s3#TieringList": { + "type": "list", + "member": { + "target": "com.amazonaws.s3#Tiering" + } + }, "com.amazonaws.s3#Token": { "type": "string" }, @@ -11629,10 +12032,21 @@ "com.amazonaws.s3#TopicConfiguration": { "type": "structure", "members": { + "Id": { + "target": "com.amazonaws.s3#NotificationId" + }, + "TopicArn": { + "target": "com.amazonaws.s3#TopicArn", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message\n when it detects events of the specified type.
", + "smithy.api#required": {}, + "smithy.api#xmlName": "Topic" + } + }, "Events": { "target": "com.amazonaws.s3#EventList", "traits": { - "smithy.api#documentation": "The Amazon S3 bucket event about which to send notifications. For more\n information, see Supported Event\n Types in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#documentation": "The Amazon S3 bucket event about which to send notifications. For more information, see\n Supported\n Event Types in the Amazon Simple Storage Service Developer Guide.
", "smithy.api#required": {}, "smithy.api#xmlFlattened": {}, "smithy.api#xmlName": "Event" @@ -11640,21 +12054,10 @@ }, "Filter": { "target": "com.amazonaws.s3#NotificationConfigurationFilter" - }, - "TopicArn": { - "target": "com.amazonaws.s3#TopicArn", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a\n message when it detects events of the specified type.
", - "smithy.api#required": {}, - "smithy.api#xmlName": "Topic" - } - }, - "Id": { - "target": "com.amazonaws.s3#NotificationId" } }, "traits": { - "smithy.api#documentation": "A container for specifying the configuration for publication of messages to an Amazon Simple\n Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.
" + "smithy.api#documentation": "A container for specifying the configuration for publication of messages to an Amazon\n Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.
" } }, "com.amazonaws.s3#TopicConfigurationList": { @@ -11666,16 +12069,16 @@ "com.amazonaws.s3#Transition": { "type": "structure", "members": { - "Days": { - "target": "com.amazonaws.s3#Days", + "Date": { + "target": "com.amazonaws.s3#Date", "traits": { - "smithy.api#documentation": "Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.
" + "smithy.api#documentation": "Indicates when objects are transitioned to the specified storage class. The date value\n must be in ISO 8601 format. The time is always midnight UTC.
" } }, - "Date": { - "target": "com.amazonaws.s3#Date", + "Days": { + "target": "com.amazonaws.s3#Days", "traits": { - "smithy.api#documentation": "Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.
" + "smithy.api#documentation": "Indicates the number of days after creation when objects are transitioned to the\n specified storage class. The value must be a positive integer.
" } }, "StorageClass": { @@ -11686,7 +12089,7 @@ } }, "traits": { - "smithy.api#documentation": "Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon Simple Storage Service Developer Guide.
" + "smithy.api#documentation": "Specifies when an object transitions to a specified storage class. For more information\n about Amazon S3 lifecycle configuration rules, see Transitioning\n Objects Using Amazon S3 Lifecycle in the Amazon Simple Storage Service Developer Guide.
" } }, "com.amazonaws.s3#TransitionList": { @@ -11748,7 +12151,7 @@ "target": "com.amazonaws.s3#UploadPartOutput" }, "traits": { - "smithy.api#documentation": "Uploads a part in a multipart upload.
\nIn this operation, you provide part data in your request. However, you have an\n option to specify your existing Amazon S3 object as a data source for the part you are\n uploading. To upload a part from an existing object, you use the UploadPartCopy\n operation.
\nYou must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to\n your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must\n include in your upload part request.
\nPart numbers can be any number from 1 to 10,000, inclusive. A part number uniquely\n identifies a part and also defines its position within the object being created. If you\n upload a new part using the same part number that was used with a previous part, the\n previously uploaded part is overwritten. Each part must be at least 5 MB in size, except\n the last part. There is no size limit on the last part of your multipart upload.
\nTo ensure that data is not corrupted when traversing the network, specify the\n Content-MD5
header in the upload part request. Amazon S3 checks the part\n data against the provided MD5 value. If they do not match, Amazon S3 returns an error.
If the upload request is signed with Signature Version 4, then AWS S3 uses the x-amz-content-sha256
header as a checksum instead of Content-MD5
. For more information see Authenticating Requests: Using the Authorization Header (AWS Signature Version 4).
\n Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
\n \nFor more information on multipart uploads, go to Multipart Upload Overview in the\n Amazon Simple Storage Service Developer Guide .
\nFor information on the permissions required to use the multipart upload API, go to\n Multipart Upload API and\n Permissions in the Amazon Simple Storage Service Developer Guide.
\n \nYou can optionally request server-side encryption where Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it for you when you access it. You have\n the option of providing your own encryption key, or you can use the AWS managed encryption\n keys. If you choose to provide your own encryption key, the request headers you provide in\n the request must match the headers you used in the request to initiate the upload by using\n CreateMultipartUpload. For more information, go to Using Server-Side Encryption in\n the Amazon Simple Storage Service Developer Guide.
\n \nServer-side encryption is supported by the S3 Multipart Upload actions. Unless you are\n using a customer-provided encryption key, you don't need to specify the encryption\n parameters in each UploadPart request. Instead, you only need to specify the server-side\n encryption parameters in the initial Initiate Multipart request. For more information, see\n CreateMultipartUpload.
\n \nIf you requested server-side encryption using a customer-provided encryption\n key in your initiate multipart upload request, you must provide identical\n encryption information in each part upload using the following headers.
\n \n \nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\n\n Special Errors\n
\n\n Code: NoSuchUpload \n
\n\n Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. \n
\n\n \tHTTP Status Code: 404 Not Found\t \n
\n\n SOAP Fault Code Prefix: Client \n
\n\n Related Resources\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nUploads a part in a multipart upload.
\nIn this operation, you provide part data in your request. However, you have an option\n to specify your existing Amazon S3 object as a data source for the part you are uploading. To\n upload a part from an existing object, you use the UploadPartCopy operation.\n
\nYou must initiate a multipart upload (see CreateMultipartUpload)\n before you can upload any part. In response to your initiate request, Amazon S3 returns an\n upload ID, a unique identifier, that you must include in your upload part request.
\nPart numbers can be any number from 1 to 10,000, inclusive. A part number uniquely\n identifies a part and also defines its position within the object being created. If you\n upload a new part using the same part number that was used with a previous part, the\n previously uploaded part is overwritten. Each part must be at least 5 MB in size, except\n the last part. There is no size limit on the last part of your multipart upload.
\nTo ensure that data is not corrupted when traversing the network, specify the\n Content-MD5
header in the upload part request. Amazon S3 checks the part data\n against the provided MD5 value. If they do not match, Amazon S3 returns an error.
If the upload request is signed with Signature Version 4, then AWS S3 uses the\n x-amz-content-sha256
header as a checksum instead of\n Content-MD5
. For more information see Authenticating Requests: Using the Authorization Header (AWS Signature Version\n 4).
\n Note: After you initiate multipart upload and upload\n one or more parts, you must either complete or abort multipart upload in order to stop\n getting charged for storage of the uploaded parts. Only after you either complete or abort\n multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts\n storage.
\n\nFor more information on multipart uploads, go to Multipart Upload Overview in the\n Amazon Simple Storage Service Developer Guide .
\nFor information on the permissions required to use the multipart upload API, go to\n Multipart Upload API and\n Permissions in the Amazon Simple Storage Service Developer Guide.
\n\nYou can optionally request server-side encryption where Amazon S3 encrypts your data as it\n writes it to disks in its data centers and decrypts it for you when you access it. You have\n the option of providing your own encryption key, or you can use the AWS managed encryption\n keys. If you choose to provide your own encryption key, the request headers you provide in\n the request must match the headers you used in the request to initiate the upload by using\n CreateMultipartUpload. For more information, go to Using Server-Side Encryption in\n the Amazon Simple Storage Service Developer Guide.
\n\nServer-side encryption is supported by the S3 Multipart Upload actions. Unless you are\n using a customer-provided encryption key, you don't need to specify the encryption\n parameters in each UploadPart request. Instead, you only need to specify the server-side\n encryption parameters in the initial Initiate Multipart request. For more information, see\n CreateMultipartUpload.
\n\nIf you requested server-side encryption using a customer-provided encryption key in your\n initiate multipart upload request, you must provide identical encryption information in\n each part upload using the following headers.
\n\n\nx-amz-server-side-encryption-customer-algorithm
\nx-amz-server-side-encryption-customer-key
\nx-amz-server-side-encryption-customer-key-MD5
\n\n Special Errors\n
\n\n Code: NoSuchUpload\n
\n\n Cause: The specified multipart upload does not exist. The upload\n ID might be invalid, or the multipart upload might have been aborted or\n completed.\n
\n\n HTTP Status Code: 404 Not Found \n
\n\n SOAP Fault Code Prefix: Client\n
\n\n Related Resources\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nUploads a part by copying data from an existing object as data source. You specify the\n data source by adding the request header x-amz-copy-source
in your request and a\n byte range by adding the request header x-amz-copy-source-range
in your request.
The minimum allowable part size for a multipart upload is 5 MB. For more information about\n multipart upload limits, go to Quick Facts in the\n Amazon Simple Storage Service Developer Guide.
\nInstead of using an existing object as part data, you might use the UploadPart operation and provide data in your request.
\nYou must initiate a multipart upload before you can upload any part. In response to your\n initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in\n your upload part request.
\nFor more information about using the UploadPartCopy
operation, see the\n following:
For conceptual information about multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon Simple Storage Service Developer Guide.
\nFor information about permissions required to use the multipart upload API, see\n Multipart Upload API and\n Permissions in the Amazon Simple Storage Service Developer Guide.
\nFor information about copying objects using a single atomic operation vs. the\n multipart upload, see Operations on\n Objects in the Amazon Simple Storage Service Developer Guide.
\nFor information about using server-side encryption with customer-provided\n encryption keys with the UploadPartCopy operation, see CopyObject\n and UploadPart.
\nNote the following additional considerations about the request headers\n x-amz-copy-source-if-match
, x-amz-copy-source-if-none-match
,\n x-amz-copy-source-if-unmodified-since
, and\n x-amz-copy-source-if-modified-since
:
\n
\n\n Consideration 1 - If both of the\n x-amz-copy-source-if-match
and\n x-amz-copy-source-if-unmodified-since
headers are present in the\n request as follows:
\n x-amz-copy-source-if-match
condition evaluates to true
,\n and;
\n x-amz-copy-source-if-unmodified-since
condition evaluates to\n false
;
Amazon S3 returns 200 OK
and copies the data.\n
\n Consideration 2 - If both of the\n x-amz-copy-source-if-none-match
and\n x-amz-copy-source-if-modified-since
headers are present in the request\n as follows:
\n x-amz-copy-source-if-none-match
condition evaluates to\n false
, and;
\n x-amz-copy-source-if-modified-since
condition evaluates to\n true
;
Amazon S3 returns 412 Precondition Failed
response code.\n
\n Versioning\n
\nIf your bucket has versioning enabled, you could have multiple versions of the same\n object. By default, x-amz-copy-source
identifies the current version of\n the object to copy. If the current version is a delete marker and you don't specify a\n versionId in the x-amz-copy-source
, Amazon S3 returns a 404 error, because\n the object does not exist. If you specify versionId in the\n x-amz-copy-source
and the versionId is a delete marker, Amazon S3 returns\n an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the\n x-amz-copy-source
.
You can optionally specify a specific version of the source object to copy by adding the\n versionId
subresource as shown in the following example:
\n x-amz-copy-source: /bucket/object?versionId=version id
\n
\n Special Errors\n
\n\n Code: NoSuchUpload \n
\n\n Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. \n
\n\n HTTP Status Code: 404 Not Found \n
\n\n Code: InvalidRequest \n
\n\n Cause: The specified copy source is not supported as a byte-range copy source. \n
\n\n HTTP Status Code: 400 Bad Request \n
\n\n Related Resources\n
\n\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nUploads a part by copying data from an existing object as data source. You specify the\n data source by adding the request header x-amz-copy-source
in your request and\n a byte range by adding the request header x-amz-copy-source-range
in your\n request.
The minimum allowable part size for a multipart upload is 5 MB. For more information\n about multipart upload limits, go to Quick\n Facts in the Amazon Simple Storage Service Developer Guide.
\nInstead of using an existing object as part data, you might use the UploadPart\n operation and provide data in your request.
\nYou must initiate a multipart upload before you can upload any part. In response to your\n initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in\n your upload part request.
\nFor more information about using the UploadPartCopy
operation, see the\n following:
For conceptual information about multipart uploads, see Uploading Objects Using Multipart\n Upload in the Amazon Simple Storage Service Developer Guide.
\nFor information about permissions required to use the multipart upload API, see\n Multipart Upload API and\n Permissions in the Amazon Simple Storage Service Developer Guide.
\nFor information about copying objects using a single atomic operation vs. the\n multipart upload, see Operations on\n Objects in the Amazon Simple Storage Service Developer Guide.
\nFor information about using server-side encryption with customer-provided\n encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.
\nNote the following additional considerations about the request headers\n x-amz-copy-source-if-match
, x-amz-copy-source-if-none-match
,\n x-amz-copy-source-if-unmodified-since
, and\n x-amz-copy-source-if-modified-since
:
\n
\n Consideration 1 - If both of the\n x-amz-copy-source-if-match
and\n x-amz-copy-source-if-unmodified-since
headers are present in the\n request as follows:
\n x-amz-copy-source-if-match
condition evaluates to true
,\n and;
\n x-amz-copy-source-if-unmodified-since
condition evaluates to\n false
;
Amazon S3 returns 200 OK
and copies the data.\n
\n Consideration 2 - If both of the\n x-amz-copy-source-if-none-match
and\n x-amz-copy-source-if-modified-since
headers are present in the\n request as follows:
\n x-amz-copy-source-if-none-match
condition evaluates to\n false
, and;
\n x-amz-copy-source-if-modified-since
condition evaluates to\n true
;
Amazon S3 returns 412 Precondition Failed
response code.\n
\n Versioning\n
\nIf your bucket has versioning enabled, you could have multiple versions of the same\n object. By default, x-amz-copy-source
identifies the current version of the\n object to copy. If the current version is a delete marker and you don't specify a versionId\n in the x-amz-copy-source
, Amazon S3 returns a 404 error, because the object does\n not exist. If you specify versionId in the x-amz-copy-source
and the versionId\n is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify\n a delete marker as a version for the x-amz-copy-source
.
You can optionally specify a specific version of the source object to copy by adding the\n versionId
subresource as shown in the following example:
\n x-amz-copy-source: /bucket/object?versionId=version id
\n
\n Special Errors\n
\n\n Code: NoSuchUpload\n
\n\n Cause: The specified multipart upload does not exist. The upload\n ID might be invalid, or the multipart upload might have been aborted or\n completed.\n
\n\n HTTP Status Code: 404 Not Found\n
\n\n Code: InvalidRequest\n
\n\n Cause: The specified copy source is not supported as a byte-range\n copy source.\n
\n\n HTTP Status Code: 400 Bad Request\n
\n\n Related Resources\n
\n\n UploadPart\n
\n\n AbortMultipartUpload\n
\n\n ListParts\n
\n\n ListMultipartUploads\n
\nThe version of the source object that was copied, if you have enabled versioning on the source bucket.
", + "smithy.api#documentation": "The version of the source object that was copied, if you have enabled versioning on the\n source bucket.
", "smithy.api#httpHeader": "x-amz-copy-source-version-id" } }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", - "traits": { - "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" - } - }, - "SSECustomerKeyMD5": { - "target": "com.amazonaws.s3#SSECustomerKeyMD5", - "traits": { - "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, "CopyPartResult": { "target": "com.amazonaws.s3#CopyPartResult", "traits": { @@ -11804,109 +12193,66 @@ "smithy.api#httpPayload": {} } }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", - "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" - } - }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", - "traits": { - "smithy.api#documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key\n (CMK) that was used for the object.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" - } - }, "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { "smithy.api#documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example,\n AES256, aws:kms).
", - "smithy.api#httpHeader": "x-amz-server-side-encryption" - } - } - } - }, - "com.amazonaws.s3#UploadPartCopyRequest": { - "type": "structure", - "members": { - "UploadId": { - "target": "com.amazonaws.s3#MultipartUploadId", - "traits": { - "smithy.api#documentation": "Upload ID identifying the multipart upload whose part is being copied.
", - "smithy.api#httpQuery": "uploadId", - "smithy.api#required": {} - } - }, - "RequestPayer": { - "target": "com.amazonaws.s3#RequestPayer", - "traits": { - "smithy.api#httpHeader": "x-amz-request-payer" - } - }, - "CopySourceRange": { - "target": "com.amazonaws.s3#CopySourceRange", - "traits": { - "smithy.api#documentation": "The range of bytes to copy from the source object. The range value must use the form\n bytes=first-last, where the first and last are the zero-based byte offsets to copy. For\n example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You\n can copy a range only if the source object is greater than 5 MB.
", - "smithy.api#httpHeader": "x-amz-copy-source-range" - } - }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", - "traits": { - "smithy.api#documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm
header. This must be the\n same encryption key specified in the initiate multipart upload request.
Specifies the algorithm to use to when encrypting the object (for example, AES256).
", + "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "CopySourceIfMatch": { - "target": "com.amazonaws.s3#CopySourceIfMatch", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { - "smithy.api#documentation": "Copies the object if its entity tag (ETag) matches the specified tag.
", - "smithy.api#httpHeader": "x-amz-copy-source-if-match" + "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, - "Bucket": { - "target": "com.amazonaws.s3#BucketName", + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "The bucket name.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) that was used for the object.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" } }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", "traits": { - "smithy.api#documentation": "The account id of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.
", - "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key" + "smithy.api#documentation": "The bucket name.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "CopySource": { "target": "com.amazonaws.s3#CopySource", "traits": { - "smithy.api#documentation": "Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want \n to access the source object through an access point:
\nFor objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). \n For example, to copy the object reports/january.pdf
from the bucket awsexamplebucket
, use awsexamplebucket/reports/january.pdf
. The value must be URL encoded.
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:
. For example, to copy the object reports/january.pdf
through access point my-access-point
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.
Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.
\nAlternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:
. For example, to copy the object reports/january.pdf
through outpost my-outpost
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL encoded.
To copy a specific version of an object, append ?versionId=
\n to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.
Specifies the source object for the copy operation. You specify the value in one of two\n formats, depending on whether you want to access the source object through an access\n point:
\nFor objects not accessed through an access point, specify the name of the source\n bucket and key of the source object, separated by a slash (/). For example, to copy\n the object reports/january.pdf
from the bucket\n awsexamplebucket
, use\n awsexamplebucket/reports/january.pdf
. The value must be URL\n encoded.
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:
. For example, to copy the object reports/january.pdf
through access point my-access-point
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.
Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same AWS Region.
\nAlternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:
. For example, to copy the object reports/january.pdf
through outpost my-outpost
owned by account 123456789012
in Region us-west-2
, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL encoded.
To copy a specific version of an object, append ?versionId=
\n to the value (for example,\n awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893
).\n If you don't specify a version ID, Amazon S3 copies the latest version of the source\n object.
Part number of part being copied. This is a positive integer between 1 and 10,000.
", - "smithy.api#httpQuery": "partNumber", - "smithy.api#required": {} + "smithy.api#documentation": "Copies the object if its entity tag (ETag) matches the specified tag.
", + "smithy.api#httpHeader": "x-amz-copy-source-if-match" } }, "CopySourceIfModifiedSince": { @@ -11916,11 +12262,25 @@ "smithy.api#httpHeader": "x-amz-copy-source-if-modified-since" } }, - "CopySourceSSECustomerAlgorithm": { - "target": "com.amazonaws.s3#CopySourceSSECustomerAlgorithm", + "CopySourceIfNoneMatch": { + "target": "com.amazonaws.s3#CopySourceIfNoneMatch", "traits": { - "smithy.api#documentation": "Specifies the algorithm to use when decrypting the source object (for example, AES256).
", - "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-algorithm" + "smithy.api#documentation": "Copies the object if its entity tag (ETag) is different than the specified ETag.
", + "smithy.api#httpHeader": "x-amz-copy-source-if-none-match" + } + }, + "CopySourceIfUnmodifiedSince": { + "target": "com.amazonaws.s3#CopySourceIfUnmodifiedSince", + "traits": { + "smithy.api#documentation": "Copies the object if it hasn't been modified since the specified time.
", + "smithy.api#httpHeader": "x-amz-copy-source-if-unmodified-since" + } + }, + "CopySourceRange": { + "target": "com.amazonaws.s3#CopySourceRange", + "traits": { + "smithy.api#documentation": "The range of bytes to copy from the source object. The range value must use the form\n bytes=first-last, where the first and last are the zero-based byte offsets to copy. For\n example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You\n can copy a range only if the source object is greater than 5 MB.
", + "smithy.api#httpHeader": "x-amz-copy-source-range" } }, "Key": { @@ -11931,18 +12291,34 @@ "smithy.api#required": {} } }, - "CopySourceIfUnmodifiedSince": { - "target": "com.amazonaws.s3#CopySourceIfUnmodifiedSince", + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", "traits": { - "smithy.api#documentation": "Copies the object if it hasn't been modified since the specified time.
", - "smithy.api#httpHeader": "x-amz-copy-source-if-unmodified-since" + "smithy.api#documentation": "Part number of part being copied. This is a positive integer between 1 and\n 10,000.
", + "smithy.api#httpQuery": "partNumber", + "smithy.api#required": {} } }, - "ExpectedSourceBucketOwner": { - "target": "com.amazonaws.s3#AccountId", + "UploadId": { + "target": "com.amazonaws.s3#MultipartUploadId", "traits": { - "smithy.api#documentation": "The account id of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
Upload ID identifying the multipart upload whose part is being copied.
", + "smithy.api#httpQuery": "uploadId", + "smithy.api#required": {} + } + }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "Specifies the algorithm to use to when encrypting the object (for example,\n AES256).
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm
header. This must be the\n same encryption key specified in the initiate multipart upload request.
Copies the object if its entity tag (ETag) is different than the specified ETag.
", - "smithy.api#httpHeader": "x-amz-copy-source-if-none-match" + "smithy.api#documentation": "Specifies the algorithm to use when decrypting the source object (for example,\n AES256).
", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-algorithm" + } + }, + "CopySourceSSECustomerKey": { + "target": "com.amazonaws.s3#CopySourceSSECustomerKey", + "traits": { + "smithy.api#documentation": "Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source\n object. The encryption key provided in this header must be one that was used when the\n source object was created.
", + "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key" } }, "CopySourceSSECustomerKeyMD5": { @@ -11965,19 +12348,32 @@ "smithy.api#documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses\n this header for a message integrity check to ensure that the encryption key was transmitted\n without error.
", "smithy.api#httpHeader": "x-amz-copy-source-server-side-encryption-customer-key-MD5" } + }, + "RequestPayer": { + "target": "com.amazonaws.s3#RequestPayer", + "traits": { + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "The account id of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The account id of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
If server-side encryption with a customer-provided encryption key was requested, the response\n will include this header to provide round-trip message integrity verification of the\n customer-provided encryption key.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" - } - }, "ServerSideEncryption": { "target": "com.amazonaws.s3#ServerSideEncryption", "traits": { @@ -11985,31 +12381,38 @@ "smithy.api#httpHeader": "x-amz-server-side-encryption" } }, - "SSEKMSKeyId": { - "target": "com.amazonaws.s3#SSEKMSKeyId", + "ETag": { + "target": "com.amazonaws.s3#ETag", "traits": { - "smithy.api#documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key\n (CMK) was used for the object.
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + "smithy.api#documentation": "Entity tag for the uploaded object.
", + "smithy.api#httpHeader": "ETag" } }, "SSECustomerAlgorithm": { "target": "com.amazonaws.s3#SSECustomerAlgorithm", "traits": { - "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
", + "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header confirming the encryption algorithm used.
", "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" } }, - "RequestCharged": { - "target": "com.amazonaws.s3#RequestCharged", + "SSECustomerKeyMD5": { + "target": "com.amazonaws.s3#SSECustomerKeyMD5", "traits": { - "smithy.api#httpHeader": "x-amz-request-charged" + "smithy.api#documentation": "If server-side encryption with a customer-provided encryption key was requested, the\n response will include this header to provide round-trip message integrity verification of\n the customer-provided encryption key.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-key-MD5" } }, - "ETag": { - "target": "com.amazonaws.s3#ETag", + "SSEKMSKeyId": { + "target": "com.amazonaws.s3#SSEKMSKeyId", "traits": { - "smithy.api#documentation": "Entity tag for the uploaded object.
", - "smithy.api#httpHeader": "ETag" + "smithy.api#documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric\n customer managed customer master key (CMK) was used for the object.
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-aws-kms-key-id" + } + }, + "RequestCharged": { + "target": "com.amazonaws.s3#RequestCharged", + "traits": { + "smithy.api#httpHeader": "x-amz-request-charged" } } } @@ -12017,14 +12420,6 @@ "com.amazonaws.s3#UploadPartRequest": { "type": "structure", "members": { - "PartNumber": { - "target": "com.amazonaws.s3#PartNumber", - "traits": { - "smithy.api#documentation": "Part number of part being uploaded. This is a positive integer between 1 and 10,000.
", - "smithy.api#httpQuery": "partNumber", - "smithy.api#required": {} - } - }, "Body": { "target": "com.amazonaws.s3#StreamingBlob", "traits": { @@ -12032,39 +12427,26 @@ "smithy.api#httpPayload": {} } }, - "ExpectedBucketOwner": { - "target": "com.amazonaws.s3#AccountId", - "traits": { - "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The name of the bucket to which the multipart upload was initiated.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} } }, "ContentLength": { "target": "com.amazonaws.s3#ContentLength", "traits": { - "smithy.api#documentation": "Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
", + "smithy.api#documentation": "Size of the body in bytes. This parameter is useful when the size of the body cannot be\n determined automatically.
", "smithy.api#httpHeader": "Content-Length" } }, - "SSECustomerKey": { - "target": "com.amazonaws.s3#SSECustomerKey", - "traits": { - "smithy.api#documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header
. This must be the\n same encryption key specified in the initiate multipart upload request.
The name of the bucket to which the multipart upload was initiated.
\nWhen using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
\nWhen using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
", - "smithy.api#httpLabel": {}, - "smithy.api#required": {} + "smithy.api#documentation": "The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated\n when using the command from the CLI. This parameter is required if object lock parameters\n are specified.
", + "smithy.api#httpHeader": "Content-MD5" } }, "Key": { @@ -12075,11 +12457,12 @@ "smithy.api#required": {} } }, - "SSECustomerAlgorithm": { - "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "PartNumber": { + "target": "com.amazonaws.s3#PartNumber", "traits": { - "smithy.api#documentation": "Specifies the algorithm to use to when encrypting the object (for example, AES256).
", - "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + "smithy.api#documentation": "Part number of part being uploaded. This is a positive integer between 1 and\n 10,000.
", + "smithy.api#httpQuery": "partNumber", + "smithy.api#required": {} } }, "UploadId": { @@ -12090,6 +12473,20 @@ "smithy.api#required": {} } }, + "SSECustomerAlgorithm": { + "target": "com.amazonaws.s3#SSECustomerAlgorithm", + "traits": { + "smithy.api#documentation": "Specifies the algorithm to use to when encrypting the object (for example,\n AES256).
", + "smithy.api#httpHeader": "x-amz-server-side-encryption-customer-algorithm" + } + }, + "SSECustomerKey": { + "target": "com.amazonaws.s3#SSECustomerKey", + "traits": { + "smithy.api#documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This\n value is used to store the object and then it is discarded; Amazon S3 does not store the\n encryption key. The key must be appropriate for use with the algorithm specified in the\n x-amz-server-side-encryption-customer-algorithm header
. This must be the\n same encryption key specified in the initiate multipart upload request.
The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when\n using the command from the CLI. This parameter is required if object lock parameters are\n specified.
", - "smithy.api#httpHeader": "Content-MD5" + "smithy.api#httpHeader": "x-amz-request-payer" + } + }, + "ExpectedBucketOwner": { + "target": "com.amazonaws.s3#AccountId", + "traits": { + "smithy.api#documentation": "The account id of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied)
error.
The versioning state of the bucket.
" - } - }, "MFADelete": { "target": "com.amazonaws.s3#MFADelete", "traits": { - "smithy.api#documentation": "Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is only returned if the bucket has been configured with MFA delete. If the bucket has never been so configured, this element is not returned.
", + "smithy.api#documentation": "Specifies whether MFA delete is enabled in the bucket versioning configuration. This\n element is only returned if the bucket has been configured with MFA delete. If the bucket\n has never been so configured, this element is not returned.
", "smithy.api#xmlName": "MfaDelete" } + }, + "Status": { + "target": "com.amazonaws.s3#BucketVersioningStatus", + "traits": { + "smithy.api#documentation": "The versioning state of the bucket.
" + } } }, "traits": { - "smithy.api#documentation": "Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning in the\n Amazon Simple Storage Service API Reference.
" + "smithy.api#documentation": "Describes the versioning state of an Amazon S3 bucket. For more information, see PUT\n Bucket versioning in the Amazon Simple Storage Service API Reference.
" } }, "com.amazonaws.s3#WebsiteConfiguration": { @@ -12151,18 +12554,18 @@ "smithy.api#documentation": "The name of the error document for the website.
" } }, - "RedirectAllRequestsTo": { - "target": "com.amazonaws.s3#RedirectAllRequestsTo", - "traits": { - "smithy.api#documentation": "The redirect behavior for every request to this bucket's website endpoint.
\nIf you specify this property, you can't specify any other property.
\nThe name of the index document for the website.
" } }, + "RedirectAllRequestsTo": { + "target": "com.amazonaws.s3#RedirectAllRequestsTo", + "traits": { + "smithy.api#documentation": "The redirect behavior for every request to this bucket's website endpoint.
\nIf you specify this property, you can't specify any other property.
\nThe language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The type of shared portfolios to accept. The default is to accept imported portfolios.
\n\n AWS_ORGANIZATIONS
- Accept portfolios shared by the management account of your\n organization.
\n IMPORTED
- Accept imported portfolios.
\n AWS_SERVICECATALOG
- Not supported. (Throws ResourceNotFoundException.)
For example, aws servicecatalog accept-portfolio-share --portfolio-id \"port-2qwzkwxt3y5fk\" --portfolio-share-type AWS_ORGANIZATIONS
\n
The portfolio identifier.
", "smithy.api#required": {} } + }, + "PortfolioShareType": { + "target": "com.amazonaws.servicecatalog#PortfolioShareType", + "traits": { + "smithy.api#documentation": "The type of shared portfolios to accept. The default is to accept imported portfolios.
\n\n AWS_ORGANIZATIONS
- Accept portfolios shared by the management account of your\n organization.
\n IMPORTED
- Accept imported portfolios.
\n AWS_SERVICECATALOG
- Not supported. (Throws ResourceNotFoundException.)
For example, aws servicecatalog accept-portfolio-share --portfolio-id \"port-2qwzkwxt3y5fk\" --portfolio-share-type AWS_ORGANIZATIONS
\n
The user to which the access level applies. The only supported value is Self
.
The access level.
\n\n Account
- Filter results based on the account.
\n Role
- Filter results based on the federated role of the specified user.
\n User
- Filter results based on the specified user.
The user to which the access level applies. The only supported value is Self
.
The resource identifier. Either a portfolio-id or a product-id.
", + "smithy.api#documentation": "The name of the budget you want to associate.
", "smithy.api#required": {} } }, - "BudgetName": { - "target": "com.amazonaws.servicecatalog#BudgetName", + "ResourceId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The name of the budget you want to associate.
", + "smithy.api#documentation": "The resource identifier. Either a portfolio-id or a product-id.
", "smithy.api#required": {} } } @@ -533,11 +533,10 @@ "com.amazonaws.servicecatalog#AssociatePrincipalWithPortfolioInput": { "type": "structure", "members": { - "PrincipalType": { - "target": "com.amazonaws.servicecatalog#PrincipalType", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "The principal type. The supported value is IAM
.
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The ARN of the principal (IAM user, role, or group).
", "smithy.api#required": {} } + }, + "PrincipalType": { + "target": "com.amazonaws.servicecatalog#PrincipalType", + "traits": { + "smithy.api#documentation": "The principal type. The supported value is IAM
.
The self-service action identifier. For example, act-fs7abcd89wxyz
.
The product identifier. For example, prod-abcdzk7xy33qa
.
The product identifier. For example, prod-abcdzk7xy33qa
.
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne
.
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The self-service action identifier. For example, act-fs7abcd89wxyz
.
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne
.
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The TagOption identifier.
", + "smithy.api#documentation": "The resource identifier.
", "smithy.api#required": {} } }, - "ResourceId": { - "target": "com.amazonaws.servicecatalog#ResourceId", + "TagOptionId": { + "target": "com.amazonaws.servicecatalog#TagOptionId", "traits": { - "smithy.api#documentation": "The resource identifier.
", + "smithy.api#documentation": "The TagOption identifier.
", "smithy.api#required": {} } } @@ -807,18 +807,18 @@ "com.amazonaws.servicecatalog#BatchDisassociateServiceActionFromProvisioningArtifactInput": { "type": "structure", "members": { - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
One or more associations, each consisting of the Action ID, the Product ID, and the Provisioning Artifact ID.
", "smithy.api#required": {} } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The owner of the constraint.
" - } - }, "ConstraintId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -943,6 +937,12 @@ "smithy.api#documentation": "The description of the constraint.
" } }, + "Owner": { + "target": "com.amazonaws.servicecatalog#AccountId", + "traits": { + "smithy.api#documentation": "The owner of the constraint.
" + } + }, "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -978,17 +978,17 @@ "com.amazonaws.servicecatalog#ConstraintSummary": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.servicecatalog#ConstraintDescription", - "traits": { - "smithy.api#documentation": "The description of the constraint.
" - } - }, "Type": { "target": "com.amazonaws.servicecatalog#ConstraintType", "traits": { "smithy.api#documentation": "The type of constraint.
\n\n LAUNCH
\n
\n NOTIFICATION
\n
STACKSET
\n\n TEMPLATE
\n
The description of the constraint.
" + } } }, "traits": { @@ -1044,11 +1044,16 @@ "com.amazonaws.servicecatalog#CopyProductInput": { "type": "structure", "members": { - "IdempotencyToken": { - "target": "com.amazonaws.servicecatalog#IdempotencyToken", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.
", - "smithy.api#idempotencyToken": {}, + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The Amazon Resource Name (ARN) of the source product.
", "smithy.api#required": {} } }, @@ -1058,34 +1063,29 @@ "smithy.api#documentation": "The identifier of the target product. By default, a new product is created.
" } }, - "CopyOptions": { - "target": "com.amazonaws.servicecatalog#CopyOptions", - "traits": { - "smithy.api#documentation": "The copy options. If the value is CopyTags
, the tags from the source\n product are copied to the target product.
A name for the target product. The default is the name of the source product.
" } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The identifiers of the provisioning artifacts (also known as versions) of the product to copy. \n By default, all provisioning artifacts are copied.
" } }, - "SourceProductArn": { - "target": "com.amazonaws.servicecatalog#ProductArn", + "CopyOptions": { + "target": "com.amazonaws.servicecatalog#CopyOptions", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the source product.
", + "smithy.api#documentation": "The copy options. If the value is CopyTags
, the tags from the source\n product are copied to the target product.
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.
", + "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } @@ -1156,13 +1156,6 @@ "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The product identifier.
", - "smithy.api#required": {} - } - }, "PortfolioId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -1170,17 +1163,17 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.servicecatalog#ConstraintDescription", + "ProductId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The description of the constraint.
" + "smithy.api#documentation": "The product identifier.
", + "smithy.api#required": {} } }, - "IdempotencyToken": { - "target": "com.amazonaws.servicecatalog#IdempotencyToken", + "Parameters": { + "target": "com.amazonaws.servicecatalog#ConstraintParameters", "traits": { - "smithy.api#documentation": "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.
", - "smithy.api#idempotencyToken": {}, + "smithy.api#documentation": "The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:
\nYou are required to specify either the RoleArn
or the LocalRoleName
but can't use both.
Specify the RoleArn
property as follows:
\n {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}
\n
Specify the LocalRoleName
property as follows:
\n {\"LocalRoleName\": \"SCBasicLaunchRole\"}
\n
If you specify the LocalRoleName
property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be \n account-agnostic so the administrator can create fewer resources per shared account.
The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.
\nYou cannot have both a LAUNCH
and a STACKSET
constraint.
You also cannot have more than one LAUNCH
constraint on a product and portfolio.
Specify the NotificationArns
property as follows:
\n {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}
\n
Specify the TagUpdatesOnProvisionedProduct
property as follows:
\n {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}
\n
The TagUpdatesOnProvisionedProduct
property accepts a string value of ALLOWED
or NOT_ALLOWED
.
Specify the Parameters
property as follows:
\n {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}
\n
You cannot have both a LAUNCH
and a STACKSET
constraint.
You also cannot have more than one STACKSET
constraint on a product and portfolio.
Products with a STACKSET
constraint will launch an AWS CloudFormation stack set.
Specify the Rules
property. For more information, see\n Template Constraint Rules.
The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:
\nYou are required to specify either the RoleArn
or the LocalRoleName
but can't use both.
Specify the RoleArn
property as follows:
\n {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}
\n
Specify the LocalRoleName
property as follows:
\n {\"LocalRoleName\": \"SCBasicLaunchRole\"}
\n
If you specify the LocalRoleName
property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be \n account-agnostic so the administrator can create fewer resources per shared account.
The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.
\nYou cannot have both a LAUNCH
and a STACKSET
constraint.
You also cannot have more than one LAUNCH
constraint on a product and portfolio.
Specify the NotificationArns
property as follows:
\n {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}
\n
Specify the TagUpdatesOnProvisionedProduct
property as follows:
\n {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}
\n
The TagUpdatesOnProvisionedProduct
property accepts a string value of ALLOWED
or NOT_ALLOWED
.
Specify the Parameters
property as follows:
\n {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}
\n
You cannot have both a LAUNCH
and a STACKSET
constraint.
You also cannot have more than one STACKSET
constraint on a product and portfolio.
Products with a STACKSET
constraint will launch an AWS CloudFormation stack set.
Specify the Rules
property. For more information, see\n Template Constraint Rules.
The description of the constraint.
" + } + }, + "IdempotencyToken": { + "target": "com.amazonaws.servicecatalog#IdempotencyToken", + "traits": { + "smithy.api#documentation": "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.
", + "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } @@ -1203,12 +1203,6 @@ "com.amazonaws.servicecatalog#CreateConstraintOutput": { "type": "structure", "members": { - "Status": { - "target": "com.amazonaws.servicecatalog#Status", - "traits": { - "smithy.api#documentation": "The status of the current request.
" - } - }, "ConstraintDetail": { "target": "com.amazonaws.servicecatalog#ConstraintDetail", "traits": { @@ -1220,6 +1214,12 @@ "traits": { "smithy.api#documentation": "The constraint parameters.
" } + }, + "Status": { + "target": "com.amazonaws.servicecatalog#Status", + "traits": { + "smithy.api#documentation": "The status of the current request.
" + } } } }, @@ -1249,18 +1249,19 @@ "com.amazonaws.servicecatalog#CreatePortfolioInput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.servicecatalog#AddTags", - "traits": { - "smithy.api#documentation": "One or more tags.
" - } - }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The name to use for display purposes.
", + "smithy.api#required": {} + } + }, "Description": { "target": "com.amazonaws.servicecatalog#PortfolioDescription", "traits": { @@ -1274,11 +1275,10 @@ "smithy.api#required": {} } }, - "DisplayName": { - "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", + "Tags": { + "target": "com.amazonaws.servicecatalog#AddTags", "traits": { - "smithy.api#documentation": "The name to use for display purposes.
", - "smithy.api#required": {} + "smithy.api#documentation": "One or more tags.
" } }, "IdempotencyToken": { @@ -1340,18 +1340,6 @@ "com.amazonaws.servicecatalog#CreatePortfolioShareInput": { "type": "structure", "members": { - "OrganizationNode": { - "target": "com.amazonaws.servicecatalog#OrganizationNode", - "traits": { - "smithy.api#documentation": "The organization node to whom you are going to share. If OrganizationNode
\n is passed in, PortfolioShare
will be created for the node an\n ListOrganizationPortfolioAccessd its children (when applies), and a\n PortfolioShareToken
will be returned in the output in order for the\n administrator to monitor the status of the PortfolioShare
creation\n process.
The AWS account ID. For example, 123456789012
.
The portfolio identifier.
", "smithy.api#required": {} } + }, + "AccountId": { + "target": "com.amazonaws.servicecatalog#AccountId", + "traits": { + "smithy.api#documentation": "The AWS account ID. For example, 123456789012
.
The organization node to whom you are going to share. If OrganizationNode
\n is passed in, PortfolioShare
will be created for the node an\n ListOrganizationPortfolioAccessd its children (when applies), and a\n PortfolioShareToken
will be returned in the output in order for the\n administrator to monitor the status of the PortfolioShare
creation\n process.
The support information about the product.
" + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The type of product.
", + "smithy.api#documentation": "The name of the product.
", "smithy.api#required": {} } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "Owner": { + "target": "com.amazonaws.servicecatalog#ProductViewOwner", "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The owner of the product.
", + "smithy.api#required": {} } }, - "SupportUrl": { - "target": "com.amazonaws.servicecatalog#SupportUrl", + "Description": { + "target": "com.amazonaws.servicecatalog#ProductViewShortDescription", "traits": { - "smithy.api#documentation": "The contact URL for product support.
" + "smithy.api#documentation": "The description of the product.
" } }, "Distributor": { @@ -1435,10 +1436,10 @@ "smithy.api#documentation": "The distributor of the product.
" } }, - "Description": { - "target": "com.amazonaws.servicecatalog#ProductViewShortDescription", + "SupportDescription": { + "target": "com.amazonaws.servicecatalog#SupportDescription", "traits": { - "smithy.api#documentation": "The description of the product.
" + "smithy.api#documentation": "The support information about the product.
" } }, "SupportEmail": { @@ -1447,17 +1448,16 @@ "smithy.api#documentation": "The contact email for product support.
" } }, - "Name": { - "target": "com.amazonaws.servicecatalog#ProductViewName", + "SupportUrl": { + "target": "com.amazonaws.servicecatalog#SupportUrl", "traits": { - "smithy.api#documentation": "The name of the product.
", - "smithy.api#required": {} + "smithy.api#documentation": "The contact URL for product support.
" } }, - "ProvisioningArtifactParameters": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactProperties", + "ProductType": { + "target": "com.amazonaws.servicecatalog#ProductType", "traits": { - "smithy.api#documentation": "The configuration of the provisioning artifact.
", + "smithy.api#documentation": "The type of product.
", "smithy.api#required": {} } }, @@ -1467,18 +1467,18 @@ "smithy.api#documentation": "One or more tags.
" } }, - "IdempotencyToken": { - "target": "com.amazonaws.servicecatalog#IdempotencyToken", + "ProvisioningArtifactParameters": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactProperties", "traits": { - "smithy.api#documentation": "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.
", - "smithy.api#idempotencyToken": {}, + "smithy.api#documentation": "The configuration of the provisioning artifact.
", "smithy.api#required": {} } }, - "Owner": { - "target": "com.amazonaws.servicecatalog#ProductViewOwner", + "IdempotencyToken": { + "target": "com.amazonaws.servicecatalog#IdempotencyToken", "traits": { - "smithy.api#documentation": "The owner of the product.
", + "smithy.api#documentation": "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.
", + "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } @@ -1533,23 +1533,16 @@ "com.amazonaws.servicecatalog#CreateProvisionedProductPlanInput": { "type": "structure", "members": { - "ProvisioningArtifactId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "The identifier of the provisioning artifact.
", - "smithy.api#required": {} - } - }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The product identifier.
", + "smithy.api#documentation": "The name of the plan.
", "smithy.api#required": {} } }, @@ -1566,16 +1559,16 @@ "smithy.api#documentation": "Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related\n events.
" } }, - "ProvisioningParameters": { - "target": "com.amazonaws.servicecatalog#UpdateProvisioningParameters", + "PathId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "Parameters specified by the administrator that are required for provisioning the\n product.
" + "smithy.api#documentation": "The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths.
" } }, - "PlanName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanName", + "ProductId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The name of the plan.
", + "smithy.api#documentation": "The product identifier.
", "smithy.api#required": {} } }, @@ -1586,10 +1579,17 @@ "smithy.api#required": {} } }, - "PathId": { + "ProvisioningArtifactId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths.
" + "smithy.api#documentation": "The identifier of the provisioning artifact.
", + "smithy.api#required": {} + } + }, + "ProvisioningParameters": { + "target": "com.amazonaws.servicecatalog#UpdateProvisioningParameters", + "traits": { + "smithy.api#documentation": "Parameters specified by the administrator that are required for provisioning the\n product.
" } }, "IdempotencyToken": { @@ -1611,12 +1611,24 @@ "com.amazonaws.servicecatalog#CreateProvisionedProductPlanOutput": { "type": "structure", "members": { + "PlanName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanName", + "traits": { + "smithy.api#documentation": "The name of the plan.
" + } + }, "PlanId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { "smithy.api#documentation": "The plan identifier.
" } }, + "ProvisionProductId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "The product identifier.
" + } + }, "ProvisionedProductName": { "target": "com.amazonaws.servicecatalog#ProvisionedProductName", "traits": { @@ -1628,18 +1640,6 @@ "traits": { "smithy.api#documentation": "The identifier of the provisioning artifact.
" } - }, - "PlanName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanName", - "traits": { - "smithy.api#documentation": "The name of the plan.
" - } - }, - "ProvisionProductId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "The product identifier.
" - } } } }, @@ -1669,11 +1669,16 @@ "com.amazonaws.servicecatalog#CreateProvisioningArtifactInput": { "type": "structure", "members": { - "IdempotencyToken": { - "target": "com.amazonaws.servicecatalog#IdempotencyToken", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.
", - "smithy.api#idempotencyToken": {}, + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The product identifier.
", "smithy.api#required": {} } }, @@ -1684,28 +1689,23 @@ "smithy.api#required": {} } }, - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", + "IdempotencyToken": { + "target": "com.amazonaws.servicecatalog#IdempotencyToken", "traits": { - "smithy.api#documentation": "The product identifier.
", + "smithy.api#documentation": "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.
", + "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The status of the current request.
" + "smithy.api#documentation": "Information about the provisioning artifact.
" } }, "Info": { @@ -1714,10 +1714,10 @@ "smithy.api#documentation": "The URL of the CloudFormation template in Amazon S3, in JSON format.
" } }, - "ProvisioningArtifactDetail": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDetail", + "Status": { + "target": "com.amazonaws.servicecatalog#Status", "traits": { - "smithy.api#documentation": "Information about the provisioning artifact.
" + "smithy.api#documentation": "The status of the current request.
" } } } @@ -1745,24 +1745,17 @@ "com.amazonaws.servicecatalog#CreateServiceActionInput": { "type": "structure", "members": { - "IdempotencyToken": { - "target": "com.amazonaws.servicecatalog#IdempotencyToken", + "Name": { + "target": "com.amazonaws.servicecatalog#ServiceActionName", "traits": { - "smithy.api#documentation": "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.
", - "smithy.api#idempotencyToken": {}, + "smithy.api#documentation": "The self-service action name.
", "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.servicecatalog#ServiceActionDescription", - "traits": { - "smithy.api#documentation": "The self-service action description.
" - } - }, - "Name": { - "target": "com.amazonaws.servicecatalog#ServiceActionName", + "DefinitionType": { + "target": "com.amazonaws.servicecatalog#ServiceActionDefinitionType", "traits": { - "smithy.api#documentation": "The self-service action name.
", + "smithy.api#documentation": "The service action definition type. For example, SSM_AUTOMATION
.
The self-service action description.
" + } + }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The service action definition type. For example, SSM_AUTOMATION
.
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.
", + "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } @@ -1825,17 +1825,17 @@ "com.amazonaws.servicecatalog#CreateTagOptionInput": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.servicecatalog#TagOptionValue", + "Key": { + "target": "com.amazonaws.servicecatalog#TagOptionKey", "traits": { - "smithy.api#documentation": "The TagOption value.
", + "smithy.api#documentation": "The TagOption key.
", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.servicecatalog#TagOptionKey", + "Value": { + "target": "com.amazonaws.servicecatalog#TagOptionValue", "traits": { - "smithy.api#documentation": "The TagOption key.
", + "smithy.api#documentation": "The TagOption value.
", "smithy.api#required": {} } } @@ -1884,18 +1884,18 @@ "com.amazonaws.servicecatalog#DeleteConstraintInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The identifier of the constraint.
", "smithy.api#required": {} } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The portfolio identifier.
", "smithy.api#required": {} } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The organization node to whom you are going to stop sharing.
" - } - }, - "AccountId": { - "target": "com.amazonaws.servicecatalog#AccountId", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "The AWS account ID.
" + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The AWS account ID.
" + } + }, + "OrganizationNode": { + "target": "com.amazonaws.servicecatalog#OrganizationNode", + "traits": { + "smithy.api#documentation": "The organization node to whom you are going to stop sharing.
" } } } @@ -2047,18 +2047,18 @@ "com.amazonaws.servicecatalog#DeleteProductInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The product identifier.
", "smithy.api#required": {} } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The self-service action identifier. For example, act-fs7abcd89wxyz
.
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The identifier of the constraint.
", "smithy.api#required": {} } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
Information about the constraint.
" + } + }, "ConstraintParameters": { "target": "com.amazonaws.servicecatalog#ConstraintParameters", "traits": { @@ -2297,12 +2303,6 @@ "traits": { "smithy.api#documentation": "The status of the current request.
" } - }, - "ConstraintDetail": { - "target": "com.amazonaws.servicecatalog#ConstraintDetail", - "traits": { - "smithy.api#documentation": "Information about the constraint.
" - } } } }, @@ -2350,17 +2350,17 @@ "smithy.api#documentation": "The status of the copy product operation.
" } }, - "StatusDetail": { - "target": "com.amazonaws.servicecatalog#StatusDetail", - "traits": { - "smithy.api#documentation": "The status message.
" - } - }, "TargetProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { "smithy.api#documentation": "The identifier of the copied product.
" } + }, + "StatusDetail": { + "target": "com.amazonaws.servicecatalog#StatusDetail", + "traits": { + "smithy.api#documentation": "The status message.
" + } } } }, @@ -2466,10 +2466,10 @@ "com.amazonaws.servicecatalog#DescribePortfolioShareStatusOutput": { "type": "structure", "members": { - "ShareDetails": { - "target": "com.amazonaws.servicecatalog#ShareDetails", + "PortfolioShareToken": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "Information about the portfolio share operation.
" + "smithy.api#documentation": "The token for the portfolio share operation. For example, share-6v24abcdefghi
.
Organization node identifier. It can be either account id, organizational unit id or organization id.
" } }, - "PortfolioShareToken": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "The token for the portfolio share operation. For example, share-6v24abcdefghi
.
Status of the portfolio share operation.
" } + }, + "ShareDetails": { + "target": "com.amazonaws.servicecatalog#ShareDetails", + "traits": { + "smithy.api#documentation": "Information about the portfolio share operation.
" + } } } }, @@ -2541,10 +2541,10 @@ "com.amazonaws.servicecatalog#DescribeProductAsAdminInput": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.servicecatalog#ProductViewName", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "The product name.
" + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The product identifier.
" } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "Name": { + "target": "com.amazonaws.servicecatalog#ProductViewName", "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The product name.
" } } } @@ -2564,6 +2564,18 @@ "com.amazonaws.servicecatalog#DescribeProductAsAdminOutput": { "type": "structure", "members": { + "ProductViewDetail": { + "target": "com.amazonaws.servicecatalog#ProductViewDetail", + "traits": { + "smithy.api#documentation": "Information about the product view.
" + } + }, + "ProvisioningArtifactSummaries": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactSummaries", + "traits": { + "smithy.api#documentation": "Information about the provisioning artifacts (also known as versions) for the specified product.
" + } + }, "Tags": { "target": "com.amazonaws.servicecatalog#Tags", "traits": { @@ -2581,24 +2593,18 @@ "traits": { "smithy.api#documentation": "Information about the associated budgets.
" } - }, - "ProvisioningArtifactSummaries": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactSummaries", - "traits": { - "smithy.api#documentation": "Information about the provisioning artifacts (also known as versions) for the specified product.
" - } - }, - "ProductViewDetail": { - "target": "com.amazonaws.servicecatalog#ProductViewDetail", - "traits": { - "smithy.api#documentation": "Information about the product view.
" - } } } }, "com.amazonaws.servicecatalog#DescribeProductInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The product name.
" } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
Information about the associated launch paths.
" - } - }, "ProductViewSummary": { "target": "com.amazonaws.servicecatalog#ProductViewSummary", "traits": { @@ -2645,6 +2639,12 @@ "traits": { "smithy.api#documentation": "Information about the associated budgets.
" } + }, + "LaunchPaths": { + "target": "com.amazonaws.servicecatalog#LaunchPaths", + "traits": { + "smithy.api#documentation": "Information about the associated launch paths.
" + } } } }, @@ -2689,17 +2689,17 @@ "com.amazonaws.servicecatalog#DescribeProductViewOutput": { "type": "structure", "members": { - "ProvisioningArtifacts": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifacts", - "traits": { - "smithy.api#documentation": "Information about the provisioning artifacts for the product.
" - } - }, "ProductViewSummary": { "target": "com.amazonaws.servicecatalog#ProductViewSummary", "traits": { "smithy.api#documentation": "Summary information about the product.
" } + }, + "ProvisioningArtifacts": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifacts", + "traits": { + "smithy.api#documentation": "Information about the provisioning artifacts for the product.
" + } } } }, @@ -2789,16 +2789,10 @@ "com.amazonaws.servicecatalog#DescribeProvisionedProductPlanInput": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", - "traits": { - "smithy.api#documentation": "The maximum number of items to return with this call.
" - } - }, - "PageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The maximum number of items to return with this call.
" + } + }, + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } } } @@ -2862,6 +2862,18 @@ "com.amazonaws.servicecatalog#DescribeProvisioningArtifactInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The identifier of the provisioning artifact.
" + } + }, "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -2874,28 +2886,16 @@ "smithy.api#documentation": "The provisioning artifact name.
" } }, - "Verbose": { - "target": "com.amazonaws.servicecatalog#Verbose", - "traits": { - "smithy.api#documentation": "Indicates whether a verbose level of detail is enabled.
" - } - }, "ProductName": { "target": "com.amazonaws.servicecatalog#ProductViewName", "traits": { "smithy.api#documentation": "The product name.
" } }, - "ProvisioningArtifactId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "The identifier of the provisioning artifact.
" - } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "Verbose": { + "target": "com.amazonaws.servicecatalog#Verbose", "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
Indicates whether a verbose level of detail is enabled.
" } } } @@ -2909,17 +2909,17 @@ "smithy.api#documentation": "Information about the provisioning artifact.
" } }, - "Status": { - "target": "com.amazonaws.servicecatalog#Status", - "traits": { - "smithy.api#documentation": "The status of the current request.
" - } - }, "Info": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { "smithy.api#documentation": "The URL of the CloudFormation template in Amazon S3.
" } + }, + "Status": { + "target": "com.amazonaws.servicecatalog#Status", + "traits": { + "smithy.api#documentation": "The status of the current request.
" + } } } }, @@ -2946,16 +2946,16 @@ "com.amazonaws.servicecatalog#DescribeProvisioningParametersInput": { "type": "structure", "members": { - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "The product identifier. You must provide the product name or ID, but not both.
" + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The name of the provisioning artifact. You must provide the name or ID, but not both.
" + "smithy.api#documentation": "The product identifier. You must provide the product name or ID, but not both.
" } }, "ProductName": { @@ -2964,28 +2964,28 @@ "smithy.api#documentation": "The name of the product. You must provide the name or ID, but not both.
" } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "ProvisioningArtifactId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The identifier of the provisioning artifact. You must provide the name or ID, but not both.
" } }, - "PathName": { - "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", + "ProvisioningArtifactName": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", "traits": { - "smithy.api#documentation": "The name of the path. You must provide the name or ID, but not both.
" + "smithy.api#documentation": "The name of the provisioning artifact. You must provide the name or ID, but not both.
" } }, - "ProvisioningArtifactId": { + "PathId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The identifier of the provisioning artifact. You must provide the name or ID, but not both.
" + "smithy.api#documentation": "The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.
" } }, - "PathId": { - "target": "com.amazonaws.servicecatalog#Id", + "PathName": { + "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", "traits": { - "smithy.api#documentation": "The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.
" + "smithy.api#documentation": "The name of the path. You must provide the name or ID, but not both.
" } } } @@ -2993,12 +2993,6 @@ "com.amazonaws.servicecatalog#DescribeProvisioningParametersOutput": { "type": "structure", "members": { - "ProvisioningArtifactPreferences": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactPreferences", - "traits": { - "smithy.api#documentation": "An object that contains information about preferences, such as regions and accounts, for the provisioning artifact.
" - } - }, "ProvisioningArtifactParameters": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactParameters", "traits": { @@ -3023,6 +3017,12 @@ "smithy.api#documentation": "Information about the TagOptions associated with the resource.
" } }, + "ProvisioningArtifactPreferences": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactPreferences", + "traits": { + "smithy.api#documentation": "An object that contains information about preferences, such as regions and accounts, for the provisioning artifact.
" + } + }, "ProvisioningArtifactOutputs": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactOutputs", "traits": { @@ -3051,10 +3051,10 @@ "com.amazonaws.servicecatalog#DescribeRecordInput": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "The maximum number of items to return with this call.
" + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The page token for the next set of results. To retrieve the first set of results, use null.
" } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The maximum number of items to return with this call.
" } } } @@ -3081,12 +3081,6 @@ "com.amazonaws.servicecatalog#DescribeRecordOutput": { "type": "structure", "members": { - "NextPageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", - "traits": { - "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" - } - }, "RecordDetail": { "target": "com.amazonaws.servicecatalog#RecordDetail", "traits": { @@ -3098,6 +3092,12 @@ "traits": { "smithy.api#documentation": "Information about the product created as the result of a request. For example, the output for \n a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.
" } + }, + "NextPageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" + } } } }, @@ -3148,18 +3148,18 @@ "smithy.api#required": {} } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The self-service action identifier.
", "smithy.api#required": {} } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The self-service action identifier.
", "smithy.api#required": {} } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The portfolio identifier.
", + "smithy.api#documentation": "The product identifier.
", "smithy.api#required": {} } }, - "ProductId": { + "PortfolioId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The product identifier.
", + "smithy.api#documentation": "The portfolio identifier.
", "smithy.api#required": {} } } @@ -3445,23 +3445,17 @@ "com.amazonaws.servicecatalog#DisassociateServiceActionFromProvisioningArtifactInput": { "type": "structure", "members": { - "ProvisioningArtifactId": { + "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne
.
The product identifier. For example, prod-abcdzk7xy33qa
.
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The product identifier. For example, prod-abcdzk7xy33qa
.
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne
.
The self-service action identifier. For example, act-fs7abcd89wxyz
.
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The TagOption identifier.
", - "smithy.api#httpQuery": "tagOptionId", - "smithy.api#required": {} - } - }, "ResourceId": { "target": "com.amazonaws.servicecatalog#ResourceId", "traits": { @@ -3516,6 +3508,14 @@ "smithy.api#httpQuery": "resourceId", "smithy.api#required": {} } + }, + "TagOptionId": { + "target": "com.amazonaws.servicecatalog#TagOptionId", + "traits": { + "smithy.api#documentation": "The TagOption identifier.
", + "smithy.api#httpQuery": "tagOptionId", + "smithy.api#required": {} + } } } }, @@ -3631,18 +3631,18 @@ "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.
", - "smithy.api#idempotencyToken": {}, + "smithy.api#documentation": "The plan identifier.
", "smithy.api#required": {} } }, - "PlanId": { - "target": "com.amazonaws.servicecatalog#Id", + "IdempotencyToken": { + "target": "com.amazonaws.servicecatalog#IdempotencyToken", "traits": { - "smithy.api#documentation": "The plan identifier.
", + "smithy.api#documentation": "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.
", + "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } @@ -3685,12 +3685,6 @@ "com.amazonaws.servicecatalog#ExecuteProvisionedProductServiceActionInput": { "type": "structure", "members": { - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as TARGET
, the provided value will \n override the default value generated by AWS Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for \n any special parameters such as TARGET
.
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
A map of all self-service action parameters and their values. If a provided parameter is of a special type, such as TARGET
, the provided value will \n override the default value generated by AWS Service Catalog. If the parameters field is not provided, no additional parameters are passed and default values will be used for \n any special parameters such as TARGET
.
The execution parameter type.
" - } - }, "Name": { "target": "com.amazonaws.servicecatalog#ExecutionParameterKey", "traits": { "smithy.api#documentation": "The name of the execution parameter.
" } }, + "Type": { + "target": "com.amazonaws.servicecatalog#ExecutionParameterType", + "traits": { + "smithy.api#documentation": "The execution parameter type.
" + } + }, "DefaultValues": { "target": "com.amazonaws.servicecatalog#ExecutionParameterValueList", "traits": { @@ -3821,16 +3821,10 @@ "com.amazonaws.servicecatalog#FailedServiceActionAssociation": { "type": "structure", "members": { - "ErrorCode": { - "target": "com.amazonaws.servicecatalog#ServiceActionAssociationErrorCode", - "traits": { - "smithy.api#documentation": "The error code. Valid values are listed below.
" - } - }, - "ErrorMessage": { - "target": "com.amazonaws.servicecatalog#ServiceActionAssociationErrorMessage", + "ServiceActionId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "A text description of the error.
" + "smithy.api#documentation": "The self-service action identifier. For example, act-fs7abcd89wxyz
.
The product identifier. For example, prod-abcdzk7xy33qa
.
The self-service action identifier. For example, act-fs7abcd89wxyz
.
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne
.
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne
.
The error code. Valid values are listed below.
" + } + }, + "ErrorMessage": { + "target": "com.amazonaws.servicecatalog#ServiceActionAssociationErrorMessage", + "traits": { + "smithy.api#documentation": "A text description of the error.
" } } }, @@ -3931,10 +3931,10 @@ "com.amazonaws.servicecatalog#GetProvisionedProductOutputsInput": { "type": "structure", "members": { - "ProvisionedProductName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductName", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "The name of the provisioned product that you want the outputs from.
" + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The identifier of the provisioned product that you want the outputs from.
" } }, + "ProvisionedProductName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductName", + "traits": { + "smithy.api#documentation": "The name of the provisioned product that you want the outputs from.
" + } + }, "OutputKeys": { "target": "com.amazonaws.servicecatalog#OutputKeys", "traits": { @@ -3960,29 +3966,23 @@ "traits": { "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" - } - }, "Outputs": { "target": "com.amazonaws.servicecatalog#RecordOutputs", "traits": { "smithy.api#documentation": "Information about the product created as the result of a request. For example, the output for a CloudFormation-backed product that creates an S3 bucket would include the S3 bucket URL.\n
" } + }, + "NextPageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" + } } } }, @@ -4048,17 +4048,17 @@ "com.amazonaws.servicecatalog#LaunchPath": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.servicecatalog#PortfolioName", - "traits": { - "smithy.api#documentation": "The name of the launch path.
" - } - }, "Id": { "target": "com.amazonaws.servicecatalog#Id", "traits": { "smithy.api#documentation": "The identifier of the launch path.
" } + }, + "Name": { + "target": "com.amazonaws.servicecatalog#PortfolioName", + "traits": { + "smithy.api#documentation": "The name of the launch path.
" + } } }, "traits": { @@ -4080,12 +4080,6 @@ "smithy.api#documentation": "The identifier of the product path.
" } }, - "Name": { - "target": "com.amazonaws.servicecatalog#PortfolioName", - "traits": { - "smithy.api#documentation": "The name of the portfolio to which the user was assigned.
" - } - }, "ConstraintSummaries": { "target": "com.amazonaws.servicecatalog#ConstraintSummaries", "traits": { @@ -4097,6 +4091,12 @@ "traits": { "smithy.api#documentation": "The tags associated with this product path.
" } + }, + "Name": { + "target": "com.amazonaws.servicecatalog#PortfolioName", + "traits": { + "smithy.api#documentation": "The name of the portfolio to which the user was assigned.
" + } } }, "traits": { @@ -4149,12 +4149,6 @@ "com.amazonaws.servicecatalog#ListAcceptedPortfolioSharesInput": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", - "traits": { - "smithy.api#documentation": "The maximum number of items to return with this call.
" - } - }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { @@ -4167,6 +4161,12 @@ "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } }, + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", + "traits": { + "smithy.api#documentation": "The maximum number of items to return with this call.
" + } + }, "PortfolioShareType": { "target": "com.amazonaws.servicecatalog#PortfolioShareType", "traits": { @@ -4178,17 +4178,17 @@ "com.amazonaws.servicecatalog#ListAcceptedPortfolioSharesOutput": { "type": "structure", "members": { - "NextPageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", - "traits": { - "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" - } - }, "PortfolioDetails": { "target": "com.amazonaws.servicecatalog#PortfolioDetails", "traits": { "smithy.api#documentation": "Information about the portfolios.
" } + }, + "NextPageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" + } } } }, @@ -4220,6 +4220,12 @@ "com.amazonaws.servicecatalog#ListBudgetsForResourceInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The page token for the next set of results. To retrieve the first set of results, use null.
" } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" - } - }, "Budgets": { "target": "com.amazonaws.servicecatalog#Budgets", "traits": { "smithy.api#documentation": "Information about the associated budgets.
" } + }, + "NextPageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" + } } } }, @@ -4292,6 +4292,12 @@ "com.amazonaws.servicecatalog#ListConstraintsForPortfolioInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The page token for the next set of results. To retrieve the first set of results, use null.
" - } - }, "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { "smithy.api#documentation": "The product identifier.
" } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The maximum number of items to return with this call.
" } + }, + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" + } } } }, @@ -4370,6 +4370,12 @@ "com.amazonaws.servicecatalog#ListLaunchPathsInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The maximum number of items to return with this call.
" } }, "PageToken": { @@ -4388,12 +4394,6 @@ "traits": { "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } - }, - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", - "traits": { - "smithy.api#documentation": "The maximum number of items to return with this call.
" - } } } }, @@ -4451,12 +4451,6 @@ "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The page token for the next set of results. To retrieve the first set of results, use null.
" - } - }, "PortfolioId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -4471,6 +4465,12 @@ "smithy.api#required": {} } }, + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" + } + }, "PageSize": { "target": "com.amazonaws.servicecatalog#PageSize", "traits": { @@ -4482,17 +4482,17 @@ "com.amazonaws.servicecatalog#ListOrganizationPortfolioAccessOutput": { "type": "structure", "members": { - "NextPageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", - "traits": { - "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" - } - }, "OrganizationNodes": { "target": "com.amazonaws.servicecatalog#OrganizationNodes", "traits": { "smithy.api#documentation": "Displays information about the organization nodes.
" } + }, + "NextPageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" + } } } }, @@ -4524,6 +4524,19 @@ "com.amazonaws.servicecatalog#ListPortfolioAccessInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The portfolio identifier.
", + "smithy.api#required": {} + } + }, "OrganizationParentId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -4536,24 +4549,11 @@ "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The maximum number of items to return with this call.
" } - }, - "PortfolioId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "The portfolio identifier.
", - "smithy.api#required": {} - } } } }, @@ -4624,12 +4624,6 @@ "com.amazonaws.servicecatalog#ListPortfoliosForProductInput": { "type": "structure", "members": { - "PageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", - "traits": { - "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" - } - }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { @@ -4643,6 +4637,12 @@ "smithy.api#required": {} } }, + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" + } + }, "PageSize": { "target": "com.amazonaws.servicecatalog#PageSize", "traits": { @@ -4671,6 +4671,12 @@ "com.amazonaws.servicecatalog#ListPortfoliosInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The maximum number of items to return with this call.
" } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The maximum number of items to return with this call.
" + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The maximum number of items to return with this call.
" } }, "PageToken": { @@ -4766,17 +4766,17 @@ "com.amazonaws.servicecatalog#ListPrincipalsForPortfolioOutput": { "type": "structure", "members": { - "NextPageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", - "traits": { - "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" - } - }, "Principals": { "target": "com.amazonaws.servicecatalog#Principals", "traits": { "smithy.api#documentation": "The IAM principals (users or roles) associated with the portfolio.
" } + }, + "NextPageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" + } } } }, @@ -4803,22 +4803,22 @@ "com.amazonaws.servicecatalog#ListProvisionedProductPlansInput": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "The maximum number of items to return with this call.
" + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The access level to use to obtain results. The default is User
.
The product identifier.
" } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The maximum number of items to return with this call.
" } }, "PageToken": { @@ -4827,10 +4827,10 @@ "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } }, - "ProvisionProductId": { - "target": "com.amazonaws.servicecatalog#Id", + "AccessLevelFilter": { + "target": "com.amazonaws.servicecatalog#AccessLevelFilter", "traits": { - "smithy.api#documentation": "The product identifier.
" + "smithy.api#documentation": "The access level to use to obtain results. The default is User
.
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" - } - }, "ProvisionedProductPlans": { "target": "com.amazonaws.servicecatalog#ProvisionedProductPlans", "traits": { "smithy.api#documentation": "Information about the plans.
" } + }, + "NextPageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" + } } } }, @@ -4900,18 +4900,6 @@ "com.amazonaws.servicecatalog#ListProvisioningArtifactsForServiceActionInput": { "type": "structure", "members": { - "PageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", - "traits": { - "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" - } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The maximum number of items to return with this call.
" } + }, + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" + } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" - } - }, "ProvisioningArtifactDetails": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDetails", "traits": { "smithy.api#documentation": "Information about the provisioning artifacts.
" } + }, + "NextPageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" + } } } }, @@ -5005,6 +5005,12 @@ "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The access level to use to obtain results. The default is User
.
The maximum number of items to return with this call.
" } }, - "AccessLevelFilter": { - "target": "com.amazonaws.servicecatalog#AccessLevelFilter", - "traits": { - "smithy.api#documentation": "The access level to use to obtain results. The default is User
.
The filter value.
" - } - }, "Key": { "target": "com.amazonaws.servicecatalog#SearchFilterKey", "traits": { "smithy.api#documentation": "The filter key.
\n\n product
- Filter results based on the specified product identifier.
\n provisionedproduct
- Filter results based on the provisioned product identifier.
The filter value.
" + } } }, "traits": { @@ -5107,13 +5107,6 @@ "smithy.api#required": {} } }, - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", - "traits": { - "smithy.api#documentation": "The maximum number of items to return with this call.
", - "smithy.api#httpQuery": "pageSize" - } - }, "ResourceType": { "target": "com.amazonaws.servicecatalog#ResourceType", "traits": { @@ -5121,6 +5114,13 @@ "smithy.api#httpQuery": "resourceType" } }, + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", + "traits": { + "smithy.api#documentation": "The maximum number of items to return with this call.
", + "smithy.api#httpQuery": "pageSize" + } + }, "PageToken": { "target": "com.amazonaws.servicecatalog#PageToken", "traits": { @@ -5133,17 +5133,17 @@ "com.amazonaws.servicecatalog#ListResourcesForTagOptionOutput": { "type": "structure", "members": { - "PageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", - "traits": { - "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" - } - }, "ResourceDetails": { "target": "com.amazonaws.servicecatalog#ResourceDetails", "traits": { "smithy.api#documentation": "Information about the resources.
" } + }, + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" + } } } }, @@ -5197,12 +5197,6 @@ "com.amazonaws.servicecatalog#ListServiceActionsForProvisioningArtifactInput": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", - "traits": { - "smithy.api#documentation": "The maximum number of items to return with this call.
" - } - }, "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -5210,12 +5204,6 @@ "smithy.api#required": {} } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The maximum number of items to return with this call.
" + } + }, "PageToken": { "target": "com.amazonaws.servicecatalog#PageToken", "traits": { "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The page token for the next set of results. To retrieve the first set of results, use null.
" - } - }, "PageSize": { "target": "com.amazonaws.servicecatalog#PageSize", "traits": { "smithy.api#documentation": "The maximum number of items to return with this call.
" } + }, + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" + } } } }, "com.amazonaws.servicecatalog#ListServiceActionsOutput": { "type": "structure", "members": { - "NextPageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", - "traits": { - "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" - } - }, "ServiceActionSummaries": { "target": "com.amazonaws.servicecatalog#ServiceActionSummaries", "traits": { "smithy.api#documentation": "An object containing information about the service actions associated with the provisioning artifact.
" } + }, + "NextPageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" + } } } }, @@ -5311,10 +5311,10 @@ "com.amazonaws.servicecatalog#ListStackInstancesForProvisionedProductInput": { "type": "structure", "members": { - "PageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The maximum number of items to return with this call.
" + "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The maximum number of items to return with this call.
" } } } @@ -5341,17 +5341,17 @@ "com.amazonaws.servicecatalog#ListStackInstancesForProvisionedProductOutput": { "type": "structure", "members": { - "NextPageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", - "traits": { - "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" - } - }, "StackInstances": { "target": "com.amazonaws.servicecatalog#StackInstances", "traits": { "smithy.api#documentation": "List of stack instances.
" } + }, + "NextPageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token to use to retrieve the next set of results. If there are no additional results, this value is null.
" + } } } }, @@ -5389,17 +5389,17 @@ "smithy.api#documentation": "The TagOption key.
" } }, - "Active": { - "target": "com.amazonaws.servicecatalog#TagOptionActive", - "traits": { - "smithy.api#documentation": "The active state.
" - } - }, "Value": { "target": "com.amazonaws.servicecatalog#TagOptionValue", "traits": { "smithy.api#documentation": "The TagOption value.
" } + }, + "Active": { + "target": "com.amazonaws.servicecatalog#TagOptionActive", + "traits": { + "smithy.api#documentation": "The active state.
" + } } }, "traits": { @@ -5409,10 +5409,10 @@ "com.amazonaws.servicecatalog#ListTagOptionsInput": { "type": "structure", "members": { - "PageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", + "Filters": { + "target": "com.amazonaws.servicecatalog#ListTagOptionsFilters", "traits": { - "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" + "smithy.api#documentation": "The search filters. If no search filters are specified, the output includes all TagOptions.
" } }, "PageSize": { @@ -5421,10 +5421,10 @@ "smithy.api#documentation": "The maximum number of items to return with this call.
" } }, - "Filters": { - "target": "com.amazonaws.servicecatalog#ListTagOptionsFilters", + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", "traits": { - "smithy.api#documentation": "The search filters. If no search filters are specified, the output includes all TagOptions.
" + "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" } } } @@ -5498,17 +5498,17 @@ "com.amazonaws.servicecatalog#OrganizationNode": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.servicecatalog#OrganizationNodeValue", - "traits": { - "smithy.api#documentation": "The identifier of the organization node.
" - } - }, "Type": { "target": "com.amazonaws.servicecatalog#OrganizationNodeType", "traits": { "smithy.api#documentation": "The organization node type.
" } + }, + "Value": { + "target": "com.amazonaws.servicecatalog#OrganizationNodeValue", + "traits": { + "smithy.api#documentation": "The identifier of the organization node.
" + } } }, "traits": { @@ -5663,12 +5663,6 @@ "com.amazonaws.servicecatalog#PortfolioDetail": { "type": "structure", "members": { - "DisplayName": { - "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", - "traits": { - "smithy.api#documentation": "The name to use for display purposes.
" - } - }, "Id": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -5681,10 +5675,10 @@ "smithy.api#documentation": "The ARN assigned to the portfolio.
" } }, - "ProviderName": { - "target": "com.amazonaws.servicecatalog#ProviderName", + "DisplayName": { + "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", "traits": { - "smithy.api#documentation": "The name of the portfolio provider.
" + "smithy.api#documentation": "The name to use for display purposes.
" } }, "Description": { @@ -5698,6 +5692,12 @@ "traits": { "smithy.api#documentation": "The UTC time stamp of the creation time.
" } + }, + "ProviderName": { + "target": "com.amazonaws.servicecatalog#ProviderName", + "traits": { + "smithy.api#documentation": "The name of the portfolio provider.
" + } } }, "traits": { @@ -5744,17 +5744,17 @@ "com.amazonaws.servicecatalog#Principal": { "type": "structure", "members": { - "PrincipalType": { - "target": "com.amazonaws.servicecatalog#PrincipalType", - "traits": { - "smithy.api#documentation": "The principal type. The supported value is IAM
.
The ARN of the principal (IAM user, role, or group).
" } + }, + "PrincipalType": { + "target": "com.amazonaws.servicecatalog#PrincipalType", + "traits": { + "smithy.api#documentation": "The principal type. The supported value is IAM
.
The ARN of the product.
" + "smithy.api#documentation": "Summary information about the product view.
" } }, "Status": { @@ -5880,16 +5880,16 @@ "smithy.api#documentation": "The status of the product.
\n\n AVAILABLE
- The product is ready for use.
\n CREATING
- Product creation has started; the product is not ready for use.
\n FAILED
- An action failed.
The UTC time stamp of the creation time.
" + "smithy.api#documentation": "The ARN of the product.
" } }, - "ProductViewSummary": { - "target": "com.amazonaws.servicecatalog#ProductViewSummary", + "CreatedTime": { + "target": "com.amazonaws.servicecatalog#CreatedTime", "traits": { - "smithy.api#documentation": "Summary information about the product view.
" + "smithy.api#documentation": "The UTC time stamp of the creation time.
" } } }, @@ -6002,28 +6002,16 @@ "com.amazonaws.servicecatalog#ProductViewSummary": { "type": "structure", "members": { - "Distributor": { - "target": "com.amazonaws.servicecatalog#ProductViewDistributor", - "traits": { - "smithy.api#documentation": "The distributor of the product. Contact the product administrator for the\n significance of this value.
" - } - }, - "SupportEmail": { - "target": "com.amazonaws.servicecatalog#SupportEmail", - "traits": { - "smithy.api#documentation": "The email contact information to obtain support for this Product.
" - } - }, - "Type": { - "target": "com.amazonaws.servicecatalog#ProductType", + "Id": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The product type. Contact the product administrator for the significance of this\n value. If this value is MARKETPLACE
, the product was created by AWS\n Marketplace.
The product view identifier.
" } }, - "SupportUrl": { - "target": "com.amazonaws.servicecatalog#SupportUrl", + "ProductId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The URL information to obtain support for this Product.
" + "smithy.api#documentation": "The product identifier.
" } }, "Name": { @@ -6032,16 +6020,28 @@ "smithy.api#documentation": "The name of the product.
" } }, + "Owner": { + "target": "com.amazonaws.servicecatalog#ProductViewOwner", + "traits": { + "smithy.api#documentation": "The owner of the product. Contact the product administrator for the significance of\n this value.
" + } + }, "ShortDescription": { "target": "com.amazonaws.servicecatalog#ProductViewShortDescription", "traits": { "smithy.api#documentation": "Short description of the product.
" } }, - "SupportDescription": { - "target": "com.amazonaws.servicecatalog#SupportDescription", + "Type": { + "target": "com.amazonaws.servicecatalog#ProductType", "traits": { - "smithy.api#documentation": "The description of the support for this Product.
" + "smithy.api#documentation": "The product type. Contact the product administrator for the significance of this\n value. If this value is MARKETPLACE
, the product was created by AWS\n Marketplace.
The distributor of the product. Contact the product administrator for the\n significance of this value.
" } }, "HasDefaultPath": { @@ -6050,22 +6050,22 @@ "smithy.api#documentation": "Indicates whether the product has a default path.\n If the product does not have a default path, call ListLaunchPaths \n to disambiguate between paths. Otherwise, ListLaunchPaths is not \n required, and the output of ProductViewSummary can be used directly with \n DescribeProvisioningParameters.
" } }, - "Id": { - "target": "com.amazonaws.servicecatalog#Id", + "SupportEmail": { + "target": "com.amazonaws.servicecatalog#SupportEmail", "traits": { - "smithy.api#documentation": "The product view identifier.
" + "smithy.api#documentation": "The email contact information to obtain support for this Product.
" } }, - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", + "SupportDescription": { + "target": "com.amazonaws.servicecatalog#SupportDescription", "traits": { - "smithy.api#documentation": "The product identifier.
" + "smithy.api#documentation": "The description of the support for this Product.
" } }, - "Owner": { - "target": "com.amazonaws.servicecatalog#ProductViewOwner", + "SupportUrl": { + "target": "com.amazonaws.servicecatalog#SupportUrl", "traits": { - "smithy.api#documentation": "The owner of the product. Contact the product administrator for the significance of\n this value.
" + "smithy.api#documentation": "The URL information to obtain support for this Product.
" } } }, @@ -6099,7 +6099,7 @@ "type": "string", "traits": { "smithy.api#length": { - "min": 1, + "min": 0, "max": 1024 } } @@ -6139,34 +6139,53 @@ "com.amazonaws.servicecatalog#ProvisionProductInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The product identifier. You must provide the name or ID, but not both.
" } }, + "ProductName": { + "target": "com.amazonaws.servicecatalog#ProductViewName", + "traits": { + "smithy.api#documentation": "The name of the product. You must provide the name or ID, but not both.
" + } + }, + "ProvisioningArtifactId": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "The identifier of the provisioning artifact. You must provide the name or ID, but not both.
" + } + }, "ProvisioningArtifactName": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", "traits": { "smithy.api#documentation": "The name of the provisioning artifact. You must provide the name or ID, but not both.
" } }, - "PathName": { - "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", + "PathId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The name of the path. You must provide the name or ID, but not both.
" + "smithy.api#documentation": "The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.
" } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PathName": { + "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The name of the path. You must provide the name or ID, but not both.
" } }, - "ProvisioningPreferences": { - "target": "com.amazonaws.servicecatalog#ProvisioningPreferences", + "ProvisionedProductName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductName", "traits": { - "smithy.api#documentation": "An object that contains information about the provisioning preferences for a stack set.
" + "smithy.api#documentation": "A user-friendly name for the provisioned product. This value must be\n unique for the AWS account and cannot be updated after the product is provisioned.
", + "smithy.api#required": {} } }, "ProvisioningParameters": { @@ -6175,29 +6194,22 @@ "smithy.api#documentation": "Parameters specified by the administrator that are required for provisioning the\n product.
" } }, - "Tags": { - "target": "com.amazonaws.servicecatalog#Tags", - "traits": { - "smithy.api#documentation": "One or more tags.
" - } - }, - "ProvisioningArtifactId": { - "target": "com.amazonaws.servicecatalog#Id", + "ProvisioningPreferences": { + "target": "com.amazonaws.servicecatalog#ProvisioningPreferences", "traits": { - "smithy.api#documentation": "The identifier of the provisioning artifact. You must provide the name or ID, but not both.
" + "smithy.api#documentation": "An object that contains information about the provisioning preferences for a stack set.
" } }, - "ProvisionedProductName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductName", + "Tags": { + "target": "com.amazonaws.servicecatalog#Tags", "traits": { - "smithy.api#documentation": "A user-friendly name for the provisioned product. This value must be\n unique for the AWS account and cannot be updated after the product is provisioned.
", - "smithy.api#required": {} + "smithy.api#documentation": "One or more tags.
" } }, - "ProductName": { - "target": "com.amazonaws.servicecatalog#ProductViewName", + "NotificationArns": { + "target": "com.amazonaws.servicecatalog#NotificationArns", "traits": { - "smithy.api#documentation": "The name of the product. You must provide the name or ID, but not both.
" + "smithy.api#documentation": "Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related\n events.
" } }, "ProvisionToken": { @@ -6207,18 +6219,6 @@ "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } - }, - "NotificationArns": { - "target": "com.amazonaws.servicecatalog#NotificationArns", - "traits": { - "smithy.api#documentation": "Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related\n events.
" - } - }, - "PathId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths. You must provide the name or ID, but not both.
" - } } } }, @@ -6236,34 +6236,46 @@ "com.amazonaws.servicecatalog#ProvisionedProductAttribute": { "type": "structure", "members": { - "ProvisioningArtifactName": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", + "Name": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductNameOrArn", "traits": { - "smithy.api#documentation": "The name of the provisioning artifact.
" + "smithy.api#documentation": "The user-friendly name of the provisioned product.
" } }, - "ProductId": { + "Arn": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductNameOrArn", + "traits": { + "smithy.api#documentation": "The ARN of the provisioned product.
" + } + }, + "Type": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductType", + "traits": { + "smithy.api#documentation": "The type of provisioned product. The supported values are CFN_STACK
and CFN_STACKSET
.
The product identifier.
" + "smithy.api#documentation": "The identifier of the provisioned product.
" } }, - "PhysicalId": { - "target": "com.amazonaws.servicecatalog#PhysicalId", + "Status": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductStatus", "traits": { - "smithy.api#documentation": "The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.
" + "smithy.api#documentation": "The current status of the provisioned product.
\n\n AVAILABLE
- Stable state, ready to perform any operation. The most\n recent operation succeeded and completed.
\n UNDER_CHANGE
- Transitive state. Operations performed might not have valid results.\n Wait for an AVAILABLE
status before performing operations.
\n TAINTED
- Stable state, ready to perform any operation. The stack has\n completed the requested operation but is not exactly what was requested. For example, a\n request to update to a new version failed and the stack rolled back to the current version.
\n ERROR
- An unexpected error occurred. The provisioned product exists but the stack is not running. \n For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
\n PLAN_IN_PROGRESS
- Transitive state. The plan operations were performed to provision a new product,\n but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE
status before performing operations.
The ARN of the IAM user in the session. This ARN might contain a session ID.
" + "smithy.api#documentation": "The current status message of the provisioned product.
" } }, - "Type": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductType", + "CreatedTime": { + "target": "com.amazonaws.servicecatalog#CreatedTime", "traits": { - "smithy.api#documentation": "The type of provisioned product. The supported values are CFN_STACK
and CFN_STACKSET
.
The UTC time stamp of the creation time.
" } }, "IdempotencyToken": { @@ -6272,58 +6284,58 @@ "smithy.api#documentation": "A unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.
" } }, - "Tags": { - "target": "com.amazonaws.servicecatalog#Tags", + "LastRecordId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "One or more tags.
" + "smithy.api#documentation": "The record identifier of the last request performed on this provisioned product.
" } }, - "LastRecordId": { + "LastProvisioningRecordId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The record identifier of the last request performed on this provisioned product.
" + "smithy.api#documentation": "The record identifier of the last request performed on this provisioned product of the following types:
\n\n ProvisionedProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nThe identifier of the provisioning artifact.
" + "smithy.api#documentation": "The record identifier of the last successful request performed on this provisioned product of the following types:
\n\n ProvisionedProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nThe ARN of the provisioned product.
" + "smithy.api#documentation": "One or more tags.
" } }, - "ProductName": { - "target": "com.amazonaws.servicecatalog#ProductViewName", + "PhysicalId": { + "target": "com.amazonaws.servicecatalog#PhysicalId", "traits": { - "smithy.api#documentation": "The name of the product.
" + "smithy.api#documentation": "The assigned identifier for the resource, such as an EC2 instance ID or an S3 bucket name.
" } }, - "LastSuccessfulProvisioningRecordId": { + "ProductId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The record identifier of the last successful request performed on this provisioned product of the following types:
\n\n ProvisionedProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nThe product identifier.
" } }, - "Id": { - "target": "com.amazonaws.servicecatalog#Id", + "ProductName": { + "target": "com.amazonaws.servicecatalog#ProductViewName", "traits": { - "smithy.api#documentation": "The identifier of the provisioned product.
" + "smithy.api#documentation": "The name of the product.
" } }, - "CreatedTime": { - "target": "com.amazonaws.servicecatalog#CreatedTime", + "ProvisioningArtifactId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The UTC time stamp of the creation time.
" + "smithy.api#documentation": "The identifier of the provisioning artifact.
" } }, - "Status": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductStatus", + "ProvisioningArtifactName": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", "traits": { - "smithy.api#documentation": "The current status of the provisioned product.
\n\n AVAILABLE
- Stable state, ready to perform any operation. The most\n recent operation succeeded and completed.
\n UNDER_CHANGE
- Transitive state. Operations performed might not have valid results.\n Wait for an AVAILABLE
status before performing operations.
\n TAINTED
- Stable state, ready to perform any operation. The stack has\n completed the requested operation but is not exactly what was requested. For example, a\n request to update to a new version failed and the stack rolled back to the current version.
\n ERROR
- An unexpected error occurred. The provisioned product exists but the stack is not running. \n For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
\n PLAN_IN_PROGRESS
- Transitive state. The plan operations were performed to provision a new product,\n but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE
status before performing operations.
The name of the provisioning artifact.
" } }, "UserArn": { @@ -6332,22 +6344,10 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the IAM user.
" } }, - "Name": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductNameOrArn", - "traits": { - "smithy.api#documentation": "The user-friendly name of the provisioned product.
" - } - }, - "LastProvisioningRecordId": { - "target": "com.amazonaws.servicecatalog#Id", - "traits": { - "smithy.api#documentation": "The record identifier of the last request performed on this provisioned product of the following types:
\n\n ProvisionedProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nThe current status message of the provisioned product.
" + "smithy.api#documentation": "The ARN of the IAM user in the session. This ARN might contain a session ID.
" } } }, @@ -6364,10 +6364,10 @@ "com.amazonaws.servicecatalog#ProvisionedProductDetail": { "type": "structure", "members": { - "CreatedTime": { - "target": "com.amazonaws.servicecatalog#CreatedTime", + "Name": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductNameOrArn", "traits": { - "smithy.api#documentation": "The UTC time stamp of the creation time.
" + "smithy.api#documentation": "The user-friendly name of the provisioned product.
" } }, "Arn": { @@ -6376,22 +6376,22 @@ "smithy.api#documentation": "The ARN of the provisioned product.
" } }, - "Id": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductId", + "Type": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductType", "traits": { - "smithy.api#documentation": "The identifier of the provisioned product.
" + "smithy.api#documentation": "The type of provisioned product. The supported values are CFN_STACK
and CFN_STACKSET
.
The record identifier of the last request performed on this provisioned product.
" + "smithy.api#documentation": "The identifier of the provisioned product.
" } }, - "Name": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductNameOrArn", + "Status": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductStatus", "traits": { - "smithy.api#documentation": "The user-friendly name of the provisioned product.
" + "smithy.api#documentation": "The current status of the provisioned product.
\n\n AVAILABLE
- Stable state, ready to perform any operation. The most\n recent operation succeeded and completed.
\n UNDER_CHANGE
- Transitive state. Operations performed might not have valid results.\n Wait for an AVAILABLE
status before performing operations.
\n TAINTED
- Stable state, ready to perform any operation. The stack has\n completed the requested operation but is not exactly what was requested. For example, a\n request to update to a new version failed and the stack rolled back to the current version.
\n ERROR
- An unexpected error occurred. The provisioned product exists but the stack is not running. \n For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
\n PLAN_IN_PROGRESS
- Transitive state. The plan operations were performed to provision a new product,\n but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE
status before performing operations.
The current status message of the provisioned product.
" } }, - "LastSuccessfulProvisioningRecordId": { - "target": "com.amazonaws.servicecatalog#Id", + "CreatedTime": { + "target": "com.amazonaws.servicecatalog#CreatedTime", "traits": { - "smithy.api#documentation": "The record identifier of the last successful request performed on this provisioned product of the following types:
\n\n ProvisionedProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nThe UTC time stamp of the creation time.
" } }, - "LastProvisioningRecordId": { - "target": "com.amazonaws.servicecatalog#Id", + "IdempotencyToken": { + "target": "com.amazonaws.servicecatalog#IdempotencyToken", "traits": { - "smithy.api#documentation": "The record identifier of the last request performed on this provisioned product of the following types:
\n\n ProvisionedProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nA unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.
" } }, - "Type": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductType", + "LastRecordId": { + "target": "com.amazonaws.servicecatalog#LastRequestId", "traits": { - "smithy.api#documentation": "The type of provisioned product. The supported values are CFN_STACK
and CFN_STACKSET
.
The record identifier of the last request performed on this provisioned product.
" } }, - "LaunchRoleArn": { - "target": "com.amazonaws.servicecatalog#RoleArn", + "LastProvisioningRecordId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The ARN of the launch role associated with the provisioned product.
" + "smithy.api#documentation": "The record identifier of the last request performed on this provisioned product of the following types:
\n\n ProvisionedProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nA unique identifier that you provide to ensure idempotency. If multiple requests differ only by the idempotency token,\n the same response is returned for each repeated request.
" + "smithy.api#documentation": "The record identifier of the last successful request performed on this provisioned product of the following types:
\n\n ProvisionedProduct\n
\n\n UpdateProvisionedProduct\n
\n\n ExecuteProvisionedProductPlan\n
\n\n TerminateProvisionedProduct\n
\nThe identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne
.
The product identifier. For example, prod-abcdzk7xy33qa
.
The product identifier. For example, prod-abcdzk7xy33qa
.
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne
.
The current status of the provisioned product.
\n\n AVAILABLE
- Stable state, ready to perform any operation. The most\n recent operation succeeded and completed.
\n UNDER_CHANGE
- Transitive state. Operations performed might not have valid results.\n Wait for an AVAILABLE
status before performing operations.
\n TAINTED
- Stable state, ready to perform any operation. The stack has\n completed the requested operation but is not exactly what was requested. For example, a\n request to update to a new version failed and the stack rolled back to the current version.
\n ERROR
- An unexpected error occurred. The provisioned product exists but the stack is not running. \n For example, CloudFormation received a parameter value that was not valid and could not launch the stack.
\n PLAN_IN_PROGRESS
- Transitive state. The plan operations were performed to provision a new product,\n but resources have not yet been created. After reviewing the list of resources to be created, execute the plan. Wait for an AVAILABLE
status before performing operations.
The ARN of the launch role associated with the provisioned product.
" } } }, @@ -6494,46 +6494,46 @@ "com.amazonaws.servicecatalog#ProvisionedProductPlanDetails": { "type": "structure", "members": { - "NotificationArns": { - "target": "com.amazonaws.servicecatalog#NotificationArns", + "CreatedTime": { + "target": "com.amazonaws.servicecatalog#CreatedTime", "traits": { - "smithy.api#documentation": "Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related\n events.
" + "smithy.api#documentation": "The UTC time stamp of the creation time.
" } }, - "ProvisioningArtifactId": { + "PathId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The identifier of the provisioning artifact.
" + "smithy.api#documentation": "The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths.
" } }, - "StatusMessage": { - "target": "com.amazonaws.servicecatalog#StatusMessage", + "ProductId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The status message.
" + "smithy.api#documentation": "The product identifier.
" } }, - "Tags": { - "target": "com.amazonaws.servicecatalog#Tags", + "PlanName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanName", "traits": { - "smithy.api#documentation": "One or more tags.
" + "smithy.api#documentation": "The name of the plan.
" } }, - "ProvisionProductId": { + "PlanId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The product identifier.
" + "smithy.api#documentation": "The plan identifier.
" } }, - "ProvisioningParameters": { - "target": "com.amazonaws.servicecatalog#UpdateProvisioningParameters", + "ProvisionProductId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "Parameters specified by the administrator that are required for provisioning the\n product.
" + "smithy.api#documentation": "The product identifier.
" } }, - "UpdatedTime": { - "target": "com.amazonaws.servicecatalog#UpdatedTime", + "ProvisionProductName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductName", "traits": { - "smithy.api#documentation": "The time when the plan was last updated.
" + "smithy.api#documentation": "The user-friendly name of the provisioned product.
" } }, "PlanType": { @@ -6542,10 +6542,10 @@ "smithy.api#documentation": "The plan type.
" } }, - "ProvisionProductName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductName", + "ProvisioningArtifactId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The user-friendly name of the provisioned product.
" + "smithy.api#documentation": "The identifier of the provisioning artifact.
" } }, "Status": { @@ -6554,34 +6554,34 @@ "smithy.api#documentation": "The status.
" } }, - "PathId": { - "target": "com.amazonaws.servicecatalog#Id", + "UpdatedTime": { + "target": "com.amazonaws.servicecatalog#UpdatedTime", "traits": { - "smithy.api#documentation": "The path identifier of the product. This value is optional if the product \n has a default path, and required if the product has more than one path.\n To list the paths for a product, use ListLaunchPaths.
" + "smithy.api#documentation": "The time when the plan was last updated.
" } }, - "PlanId": { - "target": "com.amazonaws.servicecatalog#Id", + "NotificationArns": { + "target": "com.amazonaws.servicecatalog#NotificationArns", "traits": { - "smithy.api#documentation": "The plan identifier.
" + "smithy.api#documentation": "Passed to CloudFormation. The SNS topic ARNs to which to publish stack-related\n events.
" } }, - "CreatedTime": { - "target": "com.amazonaws.servicecatalog#CreatedTime", + "ProvisioningParameters": { + "target": "com.amazonaws.servicecatalog#UpdateProvisioningParameters", "traits": { - "smithy.api#documentation": "The UTC time stamp of the creation time.
" + "smithy.api#documentation": "Parameters specified by the administrator that are required for provisioning the\n product.
" } }, - "PlanName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanName", + "Tags": { + "target": "com.amazonaws.servicecatalog#Tags", "traits": { - "smithy.api#documentation": "The name of the plan.
" + "smithy.api#documentation": "One or more tags.
" } }, - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", + "StatusMessage": { + "target": "com.amazonaws.servicecatalog#StatusMessage", "traits": { - "smithy.api#documentation": "The product identifier.
" + "smithy.api#documentation": "The status message.
" } } }, @@ -6626,22 +6626,28 @@ "com.amazonaws.servicecatalog#ProvisionedProductPlanSummary": { "type": "structure", "members": { + "PlanName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanName", + "traits": { + "smithy.api#documentation": "The name of the plan.
" + } + }, "PlanId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { "smithy.api#documentation": "The plan identifier.
" } }, - "ProvisionProductName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductName", + "ProvisionProductId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The user-friendly name of the provisioned product.
" + "smithy.api#documentation": "The product identifier.
" } }, - "ProvisioningArtifactId": { - "target": "com.amazonaws.servicecatalog#Id", + "ProvisionProductName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductName", "traits": { - "smithy.api#documentation": "The identifier of the provisioning artifact.
" + "smithy.api#documentation": "The user-friendly name of the provisioned product.
" } }, "PlanType": { @@ -6650,16 +6656,10 @@ "smithy.api#documentation": "The plan type.
" } }, - "ProvisionProductId": { + "ProvisioningArtifactId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The product identifier.
" - } - }, - "PlanName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductPlanName", - "traits": { - "smithy.api#documentation": "The name of the plan.
" + "smithy.api#documentation": "The identifier of the provisioning artifact.
" } } }, @@ -6755,22 +6755,22 @@ "com.amazonaws.servicecatalog#ProvisioningArtifact": { "type": "structure", "members": { - "Name": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", + "Id": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The name of the provisioning artifact.
" + "smithy.api#documentation": "The identifier of the provisioning artifact.
" } }, - "Guidance": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactGuidance", + "Name": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", "traits": { - "smithy.api#documentation": "Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
" + "smithy.api#documentation": "The name of the provisioning artifact.
" } }, - "Id": { - "target": "com.amazonaws.servicecatalog#Id", + "Description": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDescription", "traits": { - "smithy.api#documentation": "The identifier of the provisioning artifact.
" + "smithy.api#documentation": "The description of the provisioning artifact.
" } }, "CreatedTime": { @@ -6779,10 +6779,10 @@ "smithy.api#documentation": "The UTC time stamp of the creation time.
" } }, - "Description": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactDescription", + "Guidance": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactGuidance", "traits": { - "smithy.api#documentation": "The description of the provisioning artifact.
" + "smithy.api#documentation": "Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
" } } }, @@ -6811,22 +6811,10 @@ "com.amazonaws.servicecatalog#ProvisioningArtifactDetail": { "type": "structure", "members": { - "Active": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactActive", - "traits": { - "smithy.api#documentation": "Indicates whether the product version is active.
" - } - }, - "Type": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactType", - "traits": { - "smithy.api#documentation": "The type of provisioning artifact.
\n\n CLOUD_FORMATION_TEMPLATE
- AWS CloudFormation template
\n MARKETPLACE_AMI
- AWS Marketplace AMI
\n MARKETPLACE_CAR
- AWS Marketplace Clusters and AWS Resources
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
" + "smithy.api#documentation": "The identifier of the provisioning artifact.
" } }, "Name": { @@ -6841,10 +6829,10 @@ "smithy.api#documentation": "The description of the provisioning artifact.
" } }, - "Id": { - "target": "com.amazonaws.servicecatalog#Id", + "Type": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactType", "traits": { - "smithy.api#documentation": "The identifier of the provisioning artifact.
" + "smithy.api#documentation": "The type of provisioning artifact.
\n\n CLOUD_FORMATION_TEMPLATE
- AWS CloudFormation template
\n MARKETPLACE_AMI
- AWS Marketplace AMI
\n MARKETPLACE_CAR
- AWS Marketplace Clusters and AWS Resources
The UTC time stamp of the creation time.
" } + }, + "Active": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactActive", + "traits": { + "smithy.api#documentation": "Indicates whether the product version is active.
" + } + }, + "Guidance": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactGuidance", + "traits": { + "smithy.api#documentation": "Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
" + } } }, "traits": { @@ -6912,17 +6912,17 @@ "com.amazonaws.servicecatalog#ProvisioningArtifactOutput": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.servicecatalog#OutputDescription", - "traits": { - "smithy.api#documentation": "Description of the provisioning artifact output key.
" - } - }, "Key": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactOutputKey", "traits": { "smithy.api#documentation": "The provisioning artifact output key.
" } + }, + "Description": { + "target": "com.amazonaws.servicecatalog#OutputDescription", + "traits": { + "smithy.api#documentation": "Description of the provisioning artifact output key.
" + } } }, "traits": { @@ -6954,28 +6954,16 @@ "com.amazonaws.servicecatalog#ProvisioningArtifactParameter": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.servicecatalog#Description", - "traits": { - "smithy.api#documentation": "The description of the parameter.
" - } - }, - "DefaultValue": { - "target": "com.amazonaws.servicecatalog#DefaultValue", - "traits": { - "smithy.api#documentation": "The default value.
" - } - }, "ParameterKey": { "target": "com.amazonaws.servicecatalog#ParameterKey", "traits": { "smithy.api#documentation": "The parameter key.
" } }, - "ParameterConstraints": { - "target": "com.amazonaws.servicecatalog#ParameterConstraints", + "DefaultValue": { + "target": "com.amazonaws.servicecatalog#DefaultValue", "traits": { - "smithy.api#documentation": "Constraints that the administrator has put on a parameter.
" + "smithy.api#documentation": "The default value.
" } }, "ParameterType": { @@ -6989,6 +6977,18 @@ "traits": { "smithy.api#documentation": "If this value is true, the value for this parameter is obfuscated from view when the\n parameter is retrieved. This parameter is used to hide sensitive information.
" } + }, + "Description": { + "target": "com.amazonaws.servicecatalog#Description", + "traits": { + "smithy.api#documentation": "The description of the parameter.
" + } + }, + "ParameterConstraints": { + "target": "com.amazonaws.servicecatalog#ParameterConstraints", + "traits": { + "smithy.api#documentation": "Constraints that the administrator has put on a parameter.
" + } } }, "traits": { @@ -7036,12 +7036,6 @@ "smithy.api#documentation": "The description of the provisioning artifact, including how it differs from the previous provisioning artifact.
" } }, - "DisableTemplateValidation": { - "target": "com.amazonaws.servicecatalog#DisableTemplateValidation", - "traits": { - "smithy.api#documentation": "If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.
" - } - }, "Info": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { @@ -7054,6 +7048,12 @@ "traits": { "smithy.api#documentation": "The type of provisioning artifact.
\n\n CLOUD_FORMATION_TEMPLATE
- AWS CloudFormation template
\n MARKETPLACE_AMI
- AWS Marketplace AMI
\n MARKETPLACE_CAR
- AWS Marketplace Clusters and AWS Resources
If set to true, AWS Service Catalog stops validating the specified provisioning artifact even if it is invalid.
" + } } }, "traits": { @@ -7083,6 +7083,12 @@ "com.amazonaws.servicecatalog#ProvisioningArtifactSummary": { "type": "structure", "members": { + "Id": { + "target": "com.amazonaws.servicecatalog#Id", + "traits": { + "smithy.api#documentation": "The identifier of the provisioning artifact.
" + } + }, "Name": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", "traits": { @@ -7095,22 +7101,16 @@ "smithy.api#documentation": "The description of the provisioning artifact.
" } }, - "ProvisioningArtifactMetadata": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", - "traits": { - "smithy.api#documentation": "The metadata for the provisioning artifact. This is used with AWS Marketplace products.
" - } - }, "CreatedTime": { "target": "com.amazonaws.servicecatalog#ProvisioningArtifactCreatedTime", "traits": { "smithy.api#documentation": "The UTC time stamp of the creation time.
" } }, - "Id": { - "target": "com.amazonaws.servicecatalog#Id", + "ProvisioningArtifactMetadata": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactInfo", "traits": { - "smithy.api#documentation": "The identifier of the provisioning artifact.
" + "smithy.api#documentation": "The metadata for the provisioning artifact. This is used with AWS Marketplace products.
" } } }, @@ -7198,10 +7198,10 @@ "com.amazonaws.servicecatalog#ProvisioningPreferences": { "type": "structure", "members": { - "StackSetFailureTolerancePercentage": { - "target": "com.amazonaws.servicecatalog#StackSetFailureTolerancePercentage", + "StackSetAccounts": { + "target": "com.amazonaws.servicecatalog#StackSetAccounts", "traits": { - "smithy.api#documentation": "The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.
\nWhen calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.
\nApplicable only to a CFN_STACKSET
provisioned product type.
Conditional: You must specify either StackSetFailureToleranceCount
or StackSetFailureTolerancePercentage
, but not both.
One or more AWS accounts that will have access to the provisioned product.
\nApplicable only to a CFN_STACKSET
provisioned product type.
The AWS accounts specified should be within the list of accounts in the STACKSET
constraint. To get the list of accounts in the STACKSET
constraint, use the DescribeProvisioningParameters
operation.
If no values are specified, the default value is all accounts from the STACKSET
constraint.
One or more AWS Regions where the provisioned product will be available.
\nApplicable only to a CFN_STACKSET
provisioned product type.
The specified regions should be within the list of regions from the STACKSET
constraint. To get the list of regions in the STACKSET
constraint, use the DescribeProvisioningParameters
operation.
If no values are specified, the default value is all regions from the STACKSET
constraint.
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount
. StackSetMaxConcurrentCount
is at most one more than the StackSetFailureToleranceCount
.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
\nApplicable only to a CFN_STACKSET
provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount
or StackSetMaxConcurrentPercentage
, but not both.
The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.
\nApplicable only to a CFN_STACKSET
provisioned product type.
Conditional: You must specify either StackSetFailureToleranceCount
or StackSetFailureTolerancePercentage
, but not both.
The default value is 0
if no value is specified.
The maximum percentage of accounts in which to perform this operation at one time.
\nWhen calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1
instead.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
\nApplicable only to a CFN_STACKSET
provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount
or StackSetMaxConcurrentPercentage
, but not both.
The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.
\nWhen calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.
\nApplicable only to a CFN_STACKSET
provisioned product type.
Conditional: You must specify either StackSetFailureToleranceCount
or StackSetFailureTolerancePercentage
, but not both.
One or more AWS accounts that will have access to the provisioned product.
\nApplicable only to a CFN_STACKSET
provisioned product type.
The AWS accounts specified should be within the list of accounts in the STACKSET
constraint. To get the list of accounts in the STACKSET
constraint, use the DescribeProvisioningParameters
operation.
If no values are specified, the default value is all accounts from the STACKSET
constraint.
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount
. StackSetMaxConcurrentCount
is at most one more than the StackSetFailureToleranceCount
.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
\nApplicable only to a CFN_STACKSET
provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount
or StackSetMaxConcurrentPercentage
, but not both.
The number of accounts, per region, for which this operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.
\nApplicable only to a CFN_STACKSET
provisioned product type.
Conditional: You must specify either StackSetFailureToleranceCount
or StackSetFailureTolerancePercentage
, but not both.
The default value is 0
if no value is specified.
The maximum percentage of accounts in which to perform this operation at one time.
\nWhen calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1
instead.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
\nApplicable only to a CFN_STACKSET
provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount
or StackSetMaxConcurrentPercentage
, but not both.
The type of provisioned product. The supported values are CFN_STACK
and CFN_STACKSET
.
The identifier of the record.
" } }, - "Status": { - "target": "com.amazonaws.servicecatalog#RecordStatus", + "ProvisionedProductName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductName", "traits": { - "smithy.api#documentation": "The status of the provisioned product.
\n\n CREATED
- The request was created but the operation has not started.
\n IN_PROGRESS
- The requested operation is in progress.
\n IN_PROGRESS_IN_ERROR
- The provisioned product is under change but the\n requested operation failed and some remediation is occurring. For example, a rollback.
\n SUCCEEDED
- The requested operation has successfully completed.
\n FAILED
- The requested operation has unsuccessfully completed.\n Investigate using the error messages returned.
The user-friendly name of the provisioned product.
" } }, - "PathId": { - "target": "com.amazonaws.servicecatalog#Id", + "Status": { + "target": "com.amazonaws.servicecatalog#RecordStatus", "traits": { - "smithy.api#documentation": "The path identifier.
" + "smithy.api#documentation": "The status of the provisioned product.
\n\n CREATED
- The request was created but the operation has not started.
\n IN_PROGRESS
- The requested operation is in progress.
\n IN_PROGRESS_IN_ERROR
- The provisioned product is under change but the\n requested operation failed and some remediation is occurring. For example, a rollback.
\n SUCCEEDED
- The requested operation has successfully completed.
\n FAILED
- The requested operation has unsuccessfully completed.\n Investigate using the error messages returned.
The UTC time stamp of the creation time.
" } }, - "RecordType": { - "target": "com.amazonaws.servicecatalog#RecordType", + "UpdatedTime": { + "target": "com.amazonaws.servicecatalog#UpdatedTime", "traits": { - "smithy.api#documentation": "The record type.
\n\n PROVISION_PRODUCT
\n
\n UPDATE_PROVISIONED_PRODUCT
\n
\n TERMINATE_PROVISIONED_PRODUCT
\n
The time when the record was last updated.
" } }, - "ProvisionedProductName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductName", + "ProvisionedProductType": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductType", "traits": { - "smithy.api#documentation": "The user-friendly name of the provisioned product.
" + "smithy.api#documentation": "The type of provisioned product. The supported values are CFN_STACK
and CFN_STACKSET
.
The record type.
\n\n PROVISION_PRODUCT
\n
\n UPDATE_PROVISIONED_PRODUCT
\n
\n TERMINATE_PROVISIONED_PRODUCT
\n
The product identifier.
" } }, - "RecordTags": { - "target": "com.amazonaws.servicecatalog#RecordTags", - "traits": { - "smithy.api#documentation": "One or more tags.
" - } - }, - "LaunchRoleArn": { - "target": "com.amazonaws.servicecatalog#RoleArn", - "traits": { - "smithy.api#documentation": "The ARN of the launch role associated with the provisioned product.
" - } - }, "ProvisioningArtifactId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { "smithy.api#documentation": "The identifier of the provisioning artifact.
" } }, - "UpdatedTime": { - "target": "com.amazonaws.servicecatalog#UpdatedTime", - "traits": { - "smithy.api#documentation": "The time when the record was last updated.
" - } - }, - "RecordId": { + "PathId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The identifier of the record.
" + "smithy.api#documentation": "The path identifier.
" } }, "RecordErrors": { @@ -7325,6 +7313,18 @@ "traits": { "smithy.api#documentation": "The errors that occurred.
" } + }, + "RecordTags": { + "target": "com.amazonaws.servicecatalog#RecordTags", + "traits": { + "smithy.api#documentation": "One or more tags.
" + } + }, + "LaunchRoleArn": { + "target": "com.amazonaws.servicecatalog#RoleArn", + "traits": { + "smithy.api#documentation": "The ARN of the launch role associated with the provisioned product.
" + } } }, "traits": { @@ -7340,17 +7340,17 @@ "com.amazonaws.servicecatalog#RecordError": { "type": "structure", "members": { - "Description": { - "target": "com.amazonaws.servicecatalog#ErrorDescription", - "traits": { - "smithy.api#documentation": "The description of the error.
" - } - }, "Code": { "target": "com.amazonaws.servicecatalog#ErrorCode", "traits": { "smithy.api#documentation": "The numeric value of the error.
" } + }, + "Description": { + "target": "com.amazonaws.servicecatalog#ErrorDescription", + "traits": { + "smithy.api#documentation": "The description of the error.
" + } } }, "traits": { @@ -7500,6 +7500,12 @@ "com.amazonaws.servicecatalog#RejectPortfolioShareInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The type of shared portfolios to reject. The default is to reject imported portfolios.
\n\n AWS_ORGANIZATIONS
- Reject portfolios shared by the management account of your\n organization.
\n IMPORTED
- Reject imported portfolios.
\n AWS_SERVICECATALOG
- Not supported. (Throws ResourceNotFoundException.)
For example, aws servicecatalog reject-portfolio-share --portfolio-id \"port-2qwzkwxt3y5fk\" --portfolio-share-type AWS_ORGANIZATIONS
\n
The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The type of resource.
" - } - }, "Action": { "target": "com.amazonaws.servicecatalog#ChangeAction", "traits": { "smithy.api#documentation": "The change action.
" } }, - "Replacement": { - "target": "com.amazonaws.servicecatalog#Replacement", + "LogicalResourceId": { + "target": "com.amazonaws.servicecatalog#LogicalResourceId", "traits": { - "smithy.api#documentation": "If the change type is Modify
, indicates whether the existing resource\n is deleted and replaced with a new one.
The ID of the resource, as defined in the CloudFormation template.
" } }, "PhysicalResourceId": { @@ -7630,16 +7624,16 @@ "smithy.api#documentation": "The ID of the resource, if it was already created.
" } }, - "LogicalResourceId": { - "target": "com.amazonaws.servicecatalog#LogicalResourceId", + "ResourceType": { + "target": "com.amazonaws.servicecatalog#PlanResourceType", "traits": { - "smithy.api#documentation": "The ID of the resource, as defined in the CloudFormation template.
" + "smithy.api#documentation": "The type of resource.
" } }, - "Details": { - "target": "com.amazonaws.servicecatalog#ResourceChangeDetails", + "Replacement": { + "target": "com.amazonaws.servicecatalog#Replacement", "traits": { - "smithy.api#documentation": "Information about the resource changes.
" + "smithy.api#documentation": "If the change type is Modify
, indicates whether the existing resource\n is deleted and replaced with a new one.
The change scope.
" } + }, + "Details": { + "target": "com.amazonaws.servicecatalog#ResourceChangeDetails", + "traits": { + "smithy.api#documentation": "Information about the resource changes.
" + } } }, "traits": { @@ -7656,10 +7656,10 @@ "com.amazonaws.servicecatalog#ResourceChangeDetail": { "type": "structure", "members": { - "CausingEntity": { - "target": "com.amazonaws.servicecatalog#CausingEntity", + "Target": { + "target": "com.amazonaws.servicecatalog#ResourceTargetDefinition", "traits": { - "smithy.api#documentation": "The ID of the entity that caused the change.
" + "smithy.api#documentation": "Information about the resource attribute to be modified.
" } }, "Evaluation": { @@ -7668,10 +7668,10 @@ "smithy.api#documentation": "For static evaluations, the value of the resource attribute will change and the new value is known.\n For dynamic evaluations, the value might change, and any new value will be determined when the plan is updated.
" } }, - "Target": { - "target": "com.amazonaws.servicecatalog#ResourceTargetDefinition", + "CausingEntity": { + "target": "com.amazonaws.servicecatalog#CausingEntity", "traits": { - "smithy.api#documentation": "Information about the resource attribute to be modified.
" + "smithy.api#documentation": "The ID of the entity that caused the change.
" } } }, @@ -7700,16 +7700,10 @@ "smithy.api#documentation": "The identifier of the resource.
" } }, - "Description": { - "target": "com.amazonaws.servicecatalog#ResourceDetailDescription", - "traits": { - "smithy.api#documentation": "The description of the resource.
" - } - }, - "CreatedTime": { - "target": "com.amazonaws.servicecatalog#ResourceDetailCreatedTime", + "ARN": { + "target": "com.amazonaws.servicecatalog#ResourceDetailARN", "traits": { - "smithy.api#documentation": "The creation time of the resource.
" + "smithy.api#documentation": "The ARN of the resource.
" } }, "Name": { @@ -7718,10 +7712,16 @@ "smithy.api#documentation": "The name of the resource.
" } }, - "ARN": { - "target": "com.amazonaws.servicecatalog#ResourceDetailARN", + "Description": { + "target": "com.amazonaws.servicecatalog#ResourceDetailDescription", "traits": { - "smithy.api#documentation": "The ARN of the resource.
" + "smithy.api#documentation": "The description of the resource.
" + } + }, + "CreatedTime": { + "target": "com.amazonaws.servicecatalog#ResourceDetailCreatedTime", + "traits": { + "smithy.api#documentation": "The creation time of the resource.
" } } }, @@ -7836,10 +7836,10 @@ "com.amazonaws.servicecatalog#ScanProvisionedProductsInput": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "The maximum number of items to return with this call.
" + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The access level to use to obtain results. The default is User
.
The page token for the next set of results. To retrieve the first set of results, use null.
" + "smithy.api#documentation": "The maximum number of items to return with this call.
" } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The page token for the next set of results. To retrieve the first set of results, use null.
" } } } @@ -7941,52 +7941,52 @@ "com.amazonaws.servicecatalog#SearchProductsAsAdminInput": { "type": "structure", "members": { - "Filters": { - "target": "com.amazonaws.servicecatalog#ProductViewFilters", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "The search filters. If no search filters are specified, the output includes all products \n to which the administrator has access.
" + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
Access level of the source of the product.
" + "smithy.api#documentation": "The portfolio identifier.
" } }, - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", + "Filters": { + "target": "com.amazonaws.servicecatalog#ProductViewFilters", "traits": { - "smithy.api#documentation": "The maximum number of items to return with this call.
" + "smithy.api#documentation": "The search filters. If no search filters are specified, the output includes all products \n to which the administrator has access.
" } }, - "PageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", + "SortBy": { + "target": "com.amazonaws.servicecatalog#ProductViewSortBy", "traits": { - "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" + "smithy.api#documentation": "The sort field. If no value is specified, the results are not sorted.
" } }, - "PortfolioId": { - "target": "com.amazonaws.servicecatalog#Id", + "SortOrder": { + "target": "com.amazonaws.servicecatalog#SortOrder", "traits": { - "smithy.api#documentation": "The portfolio identifier.
" + "smithy.api#documentation": "The sort order. If no value is specified, the results are not sorted.
" } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The page token for the next set of results. To retrieve the first set of results, use null.
" } }, - "SortOrder": { - "target": "com.amazonaws.servicecatalog#SortOrder", + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", "traits": { - "smithy.api#documentation": "The sort order. If no value is specified, the results are not sorted.
" + "smithy.api#documentation": "The maximum number of items to return with this call.
" } }, - "SortBy": { - "target": "com.amazonaws.servicecatalog#ProductViewSortBy", + "ProductSource": { + "target": "com.amazonaws.servicecatalog#ProductSource", "traits": { - "smithy.api#documentation": "The sort field. If no value is specified, the results are not sorted.
" + "smithy.api#documentation": "Access level of the source of the product.
" } } } @@ -8011,22 +8011,10 @@ "com.amazonaws.servicecatalog#SearchProductsInput": { "type": "structure", "members": { - "PageSize": { - "target": "com.amazonaws.servicecatalog#PageSize", - "traits": { - "smithy.api#documentation": "The maximum number of items to return with this call.
" - } - }, - "PageToken": { - "target": "com.amazonaws.servicecatalog#PageToken", - "traits": { - "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" - } - }, - "SortBy": { - "target": "com.amazonaws.servicecatalog#ProductViewSortBy", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "The sort field. If no value is specified, the results are not sorted.
" + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The search filters. If no search filters are specified, the output includes\n all products to which the caller has access.
" } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "PageSize": { + "target": "com.amazonaws.servicecatalog#PageSize", + "traits": { + "smithy.api#documentation": "The maximum number of items to return with this call.
" + } + }, + "SortBy": { + "target": "com.amazonaws.servicecatalog#ProductViewSortBy", "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The sort field. If no value is specified, the results are not sorted.
" } }, "SortOrder": { @@ -8046,6 +8040,12 @@ "traits": { "smithy.api#documentation": "The sort order. If no value is specified, the results are not sorted.
" } + }, + "PageToken": { + "target": "com.amazonaws.servicecatalog#PageToken", + "traits": { + "smithy.api#documentation": "The page token for the next set of results. To retrieve the first set of results, use null.
" + } } } }, @@ -8097,28 +8097,34 @@ "com.amazonaws.servicecatalog#SearchProvisionedProductsInput": { "type": "structure", "members": { - "SortOrder": { - "target": "com.amazonaws.servicecatalog#SortOrder", - "traits": { - "smithy.api#documentation": "The sort order. If no value is specified, the results are not sorted.
" - } - }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The access level to use to obtain results. The default is User
.
The search filters.
\nWhen the key is SearchQuery
, the searchable fields are arn
, \n createdTime
, id
, lastRecordId
,\n idempotencyToken
, name
, physicalId
, productId
, \n provisioningArtifact
, type
, status
,\n tags
, userArn
, userArnSession
, lastProvisioningRecordId
, lastSuccessfulProvisioningRecordId
, \n productName
, and provisioningArtifactName
.
Example: \"SearchQuery\":[\"status:AVAILABLE\"]
\n
The sort field. If no value is specified, the results are not sorted. The valid values are arn
, id
, name
, \n and lastRecordId
.
The page token for the next set of results. To retrieve the first set of results, use null.
" + "smithy.api#documentation": "The sort order. If no value is specified, the results are not sorted.
" } }, "PageSize": { @@ -8127,16 +8133,10 @@ "smithy.api#documentation": "The maximum number of items to return with this call.
" } }, - "Filters": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductFilters", - "traits": { - "smithy.api#documentation": "The search filters.
\nWhen the key is SearchQuery
, the searchable fields are arn
, \n createdTime
, id
, lastRecordId
,\n idempotencyToken
, name
, physicalId
, productId
, \n provisioningArtifact
, type
, status
,\n tags
, userArn
, userArnSession
, lastProvisioningRecordId
, lastSuccessfulProvisioningRecordId
, \n productName
, and provisioningArtifactName
.
Example: \"SearchQuery\":[\"status:AVAILABLE\"]
\n
The access level to use to obtain results. The default is User
.
The page token for the next set of results. To retrieve the first set of results, use null.
" } } } @@ -8176,24 +8176,24 @@ "com.amazonaws.servicecatalog#ServiceActionAssociation": { "type": "structure", "members": { - "ProvisioningArtifactId": { + "ServiceActionId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne
.
The self-service action identifier. For example, act-fs7abcd89wxyz
.
The self-service action identifier. For example, act-fs7abcd89wxyz
.
The product identifier. For example, prod-abcdzk7xy33qa
.
The product identifier. For example, prod-abcdzk7xy33qa
.
The identifier of the provisioning artifact. For example, pa-4abcdjnxjj6ne
.
The self-service action description.
" + "smithy.api#documentation": "The self-service action identifier.
" } }, "Name": { @@ -8368,16 +8368,16 @@ "smithy.api#documentation": "The self-service action name.
" } }, - "DefinitionType": { - "target": "com.amazonaws.servicecatalog#ServiceActionDefinitionType", + "Description": { + "target": "com.amazonaws.servicecatalog#ServiceActionDescription", "traits": { - "smithy.api#documentation": "The self-service action definition type. For example, SSM_AUTOMATION
.
The self-service action description.
" } }, - "Id": { - "target": "com.amazonaws.servicecatalog#Id", + "DefinitionType": { + "target": "com.amazonaws.servicecatalog#ServiceActionDefinitionType", "traits": { - "smithy.api#documentation": "The self-service action identifier.
" + "smithy.api#documentation": "The self-service action definition type. For example, SSM_AUTOMATION
.
List of errors.
" - } - }, "SuccessfulShares": { "target": "com.amazonaws.servicecatalog#SuccessfulShares", "traits": { "smithy.api#documentation": "List of accounts for whom the operation succeeded.
" } + }, + "ShareErrors": { + "target": "com.amazonaws.servicecatalog#ShareErrors", + "traits": { + "smithy.api#documentation": "List of errors.
" + } } }, "traits": { @@ -8408,10 +8408,10 @@ "com.amazonaws.servicecatalog#ShareError": { "type": "structure", "members": { - "Error": { - "target": "com.amazonaws.servicecatalog#Error", + "Accounts": { + "target": "com.amazonaws.servicecatalog#Namespaces", "traits": { - "smithy.api#documentation": "Error type that happened when processing the operation.
" + "smithy.api#documentation": "List of accounts impacted by the error.
" } }, "Message": { @@ -8420,10 +8420,10 @@ "smithy.api#documentation": "Information about the error.
" } }, - "Accounts": { - "target": "com.amazonaws.servicecatalog#Namespaces", + "Error": { + "target": "com.amazonaws.servicecatalog#Error", "traits": { - "smithy.api#documentation": "List of accounts impacted by the error.
" + "smithy.api#documentation": "Error type that happened when processing the operation.
" } } }, @@ -8506,17 +8506,17 @@ "smithy.api#documentation": "The name of the AWS account that the stack instance is associated with.
" } }, - "StackInstanceStatus": { - "target": "com.amazonaws.servicecatalog#StackInstanceStatus", - "traits": { - "smithy.api#documentation": "The status of the stack instance, in terms of its synchronization with its associated stack set.
\n\n INOPERABLE
: A DeleteStackInstances
operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet
operations. You might need to perform a DeleteStackInstances
operation, with RetainStacks
set to true, to delete the stack instance, and then delete the stack manually.
\n OUTDATED
: The stack isn't currently up to date with the stack set because either \n the associated stack failed during a CreateStackSet
or UpdateStackSet
operation, \n or the stack was part of a CreateStackSet
or UpdateStackSet
operation that failed or was stopped before the stack was created or updated.
\n CURRENT
: The stack is currently up to date with the stack set.
The name of the AWS region that the stack instance is associated with.
" } + }, + "StackInstanceStatus": { + "target": "com.amazonaws.servicecatalog#StackInstanceStatus", + "traits": { + "smithy.api#documentation": "The status of the stack instance, in terms of its synchronization with its associated stack set.
\n\n INOPERABLE
: A DeleteStackInstances
operation has failed and left the stack in an unstable state. Stacks in this state are excluded from further UpdateStackSet
operations. You might need to perform a DeleteStackInstances
operation, with RetainStacks
set to true, to delete the stack instance, and then delete the stack manually.
\n OUTDATED
: The stack isn't currently up to date with the stack set because either \n the associated stack failed during a CreateStackSet
or UpdateStackSet
operation, \n or the stack was part of a CreateStackSet
or UpdateStackSet
operation that failed or was stopped before the stack was created or updated.
\n CURRENT
: The stack is currently up to date with the stack set.
The value for this key.
", + "smithy.api#documentation": "The tag key.
", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.servicecatalog#TagKey", + "Value": { + "target": "com.amazonaws.servicecatalog#TagValue", "traits": { - "smithy.api#documentation": "The tag key.
", + "smithy.api#documentation": "The value for this key.
", "smithy.api#required": {} } } @@ -8722,12 +8722,6 @@ "com.amazonaws.servicecatalog#TagOptionDetail": { "type": "structure", "members": { - "Id": { - "target": "com.amazonaws.servicecatalog#TagOptionId", - "traits": { - "smithy.api#documentation": "The TagOption identifier.
" - } - }, "Key": { "target": "com.amazonaws.servicecatalog#TagOptionKey", "traits": { @@ -8745,6 +8739,12 @@ "traits": { "smithy.api#documentation": "The TagOption active state.
" } + }, + "Id": { + "target": "com.amazonaws.servicecatalog#TagOptionId", + "traits": { + "smithy.api#documentation": "The TagOption identifier.
" + } } }, "traits": { @@ -8797,17 +8797,17 @@ "com.amazonaws.servicecatalog#TagOptionSummary": { "type": "structure", "members": { - "Values": { - "target": "com.amazonaws.servicecatalog#TagOptionValues", - "traits": { - "smithy.api#documentation": "The TagOption value.
" - } - }, "Key": { "target": "com.amazonaws.servicecatalog#TagOptionKey", "traits": { "smithy.api#documentation": "The TagOption key.
" } + }, + "Values": { + "target": "com.amazonaws.servicecatalog#TagOptionValues", + "traits": { + "smithy.api#documentation": "The TagOption value.
" + } } }, "traits": { @@ -8872,16 +8872,10 @@ "com.amazonaws.servicecatalog#TerminateProvisionedProductInput": { "type": "structure", "members": { - "IgnoreErrors": { - "target": "com.amazonaws.servicecatalog#IgnoreErrors", - "traits": { - "smithy.api#documentation": "If set to true, AWS Service Catalog stops managing the specified provisioned product even\n if it cannot delete the underlying resources.
" - } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "ProvisionedProductName": { + "target": "com.amazonaws.servicecatalog#ProvisionedProductNameOrArn", "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The name of the provisioned product. You cannot specify both\n ProvisionedProductName
and ProvisionedProductId
.
The name of the provisioned product. You cannot specify both\n ProvisionedProductName
and ProvisionedProductId
.
If set to true, AWS Service Catalog stops managing the specified provisioned product even\n if it cannot delete the underlying resources.
" + } + }, + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:
\nYou are required to specify either the RoleArn
or the LocalRoleName
but can't use both.
Specify the RoleArn
property as follows:
\n {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}
\n
Specify the LocalRoleName
property as follows:
\n {\"LocalRoleName\": \"SCBasicLaunchRole\"}
\n
If you specify the LocalRoleName
property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be \n account-agnostic so the administrator can create fewer resources per shared account.
The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.
\nYou cannot have both a LAUNCH
and a STACKSET
constraint.
You also cannot have more than one LAUNCH
constraint on a product and portfolio.
Specify the NotificationArns
property as follows:
\n {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}
\n
Specify the TagUpdatesOnProvisionedProduct
property as follows:
\n {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}
\n
The TagUpdatesOnProvisionedProduct
property accepts a string value of ALLOWED
or NOT_ALLOWED
.
Specify the Parameters
property as follows:
\n {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}
\n
You cannot have both a LAUNCH
and a STACKSET
constraint.
You also cannot have more than one STACKSET
constraint on a product and portfolio.
Products with a STACKSET
constraint will launch an AWS CloudFormation stack set.
Specify the Rules
property. For more information, see\n Template Constraint Rules.
The updated description of the constraint.
" } + }, + "Parameters": { + "target": "com.amazonaws.servicecatalog#ConstraintParameters", + "traits": { + "smithy.api#documentation": "The constraint parameters, in JSON format. The syntax depends on the constraint type as follows:
\nYou are required to specify either the RoleArn
or the LocalRoleName
but can't use both.
Specify the RoleArn
property as follows:
\n {\"RoleArn\" : \"arn:aws:iam::123456789012:role/LaunchRole\"}
\n
Specify the LocalRoleName
property as follows:
\n {\"LocalRoleName\": \"SCBasicLaunchRole\"}
\n
If you specify the LocalRoleName
property, when an account uses the launch constraint, the IAM role with that name in the account will be used. This allows launch-role constraints to be \n account-agnostic so the administrator can create fewer resources per shared account.
The given role name must exist in the account used to create the launch constraint and the account of the user who launches a product with this launch constraint.
\nYou cannot have both a LAUNCH
and a STACKSET
constraint.
You also cannot have more than one LAUNCH
constraint on a product and portfolio.
Specify the NotificationArns
property as follows:
\n {\"NotificationArns\" : [\"arn:aws:sns:us-east-1:123456789012:Topic\"]}
\n
Specify the TagUpdatesOnProvisionedProduct
property as follows:
\n {\"Version\":\"2.0\",\"Properties\":{\"TagUpdateOnProvisionedProduct\":\"String\"}}
\n
The TagUpdatesOnProvisionedProduct
property accepts a string value of ALLOWED
or NOT_ALLOWED
.
Specify the Parameters
property as follows:
\n {\"Version\": \"String\", \"Properties\": {\"AccountList\": [ \"String\" ], \"RegionList\": [ \"String\" ], \"AdminRole\": \"String\", \"ExecutionRole\": \"String\"}}
\n
You cannot have both a LAUNCH
and a STACKSET
constraint.
You also cannot have more than one STACKSET
constraint on a product and portfolio.
Products with a STACKSET
constraint will launch an AWS CloudFormation stack set.
Specify the Rules
property. For more information, see\n Template Constraint Rules.
Information about the constraint.
" } }, - "Status": { - "target": "com.amazonaws.servicecatalog#Status", - "traits": { - "smithy.api#documentation": "The status of the current request.
" - } - }, "ConstraintParameters": { "target": "com.amazonaws.servicecatalog#ConstraintParameters", "traits": { "smithy.api#documentation": "The constraint parameters.
" } + }, + "Status": { + "target": "com.amazonaws.servicecatalog#Status", + "traits": { + "smithy.api#documentation": "The status of the current request.
" + } } } }, @@ -9022,24 +9022,12 @@ "com.amazonaws.servicecatalog#UpdatePortfolioInput": { "type": "structure", "members": { - "DisplayName": { - "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", - "traits": { - "smithy.api#documentation": "The name to use for display purposes.
" - } - }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The tags to add.
" - } - }, "Id": { "target": "com.amazonaws.servicecatalog#Id", "traits": { @@ -9047,10 +9035,16 @@ "smithy.api#required": {} } }, - "RemoveTags": { - "target": "com.amazonaws.servicecatalog#TagKeys", + "DisplayName": { + "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", "traits": { - "smithy.api#documentation": "The tags to remove.
" + "smithy.api#documentation": "The name to use for display purposes.
" + } + }, + "Description": { + "target": "com.amazonaws.servicecatalog#PortfolioDescription", + "traits": { + "smithy.api#documentation": "The updated description of the portfolio.
" } }, "ProviderName": { @@ -9059,10 +9053,16 @@ "smithy.api#documentation": "The updated name of the portfolio provider.
" } }, - "Description": { - "target": "com.amazonaws.servicecatalog#PortfolioDescription", + "AddTags": { + "target": "com.amazonaws.servicecatalog#AddTags", "traits": { - "smithy.api#documentation": "The updated description of the portfolio.
" + "smithy.api#documentation": "The tags to add.
" + } + }, + "RemoveTags": { + "target": "com.amazonaws.servicecatalog#TagKeys", + "traits": { + "smithy.api#documentation": "The tags to remove.
" } } } @@ -9070,17 +9070,17 @@ "com.amazonaws.servicecatalog#UpdatePortfolioOutput": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.servicecatalog#Tags", - "traits": { - "smithy.api#documentation": "Information about the tags associated with the portfolio.
" - } - }, "PortfolioDetail": { "target": "com.amazonaws.servicecatalog#PortfolioDetail", "traits": { "smithy.api#documentation": "Information about the portfolio.
" } + }, + "Tags": { + "target": "com.amazonaws.servicecatalog#Tags", + "traits": { + "smithy.api#documentation": "Information about the tags associated with the portfolio.
" + } } } }, @@ -9110,16 +9110,10 @@ "com.amazonaws.servicecatalog#UpdateProductInput": { "type": "structure", "members": { - "RemoveTags": { - "target": "com.amazonaws.servicecatalog#TagKeys", - "traits": { - "smithy.api#documentation": "The tags to remove from the product.
" - } - }, - "SupportEmail": { - "target": "com.amazonaws.servicecatalog#SupportEmail", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "The updated support email for the product.
" + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The updated product name.
" + } + }, + "Owner": { "target": "com.amazonaws.servicecatalog#ProductViewOwner", "traits": { - "smithy.api#documentation": "The updated distributor of the product.
" + "smithy.api#documentation": "The updated owner of the product.
" } }, "Description": { @@ -9141,28 +9141,22 @@ "smithy.api#documentation": "The updated description of the product.
" } }, - "SupportDescription": { - "target": "com.amazonaws.servicecatalog#SupportDescription", - "traits": { - "smithy.api#documentation": "The updated support description for the product.
" - } - }, - "AddTags": { - "target": "com.amazonaws.servicecatalog#AddTags", + "Distributor": { + "target": "com.amazonaws.servicecatalog#ProductViewOwner", "traits": { - "smithy.api#documentation": "The tags to add to the product.
" + "smithy.api#documentation": "The updated distributor of the product.
" } }, - "Name": { - "target": "com.amazonaws.servicecatalog#ProductViewName", + "SupportDescription": { + "target": "com.amazonaws.servicecatalog#SupportDescription", "traits": { - "smithy.api#documentation": "The updated product name.
" + "smithy.api#documentation": "The updated support description for the product.
" } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "SupportEmail": { + "target": "com.amazonaws.servicecatalog#SupportEmail", "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The updated support email for the product.
" } }, "SupportUrl": { @@ -9171,10 +9165,16 @@ "smithy.api#documentation": "The updated support URL for the product.
" } }, - "Owner": { - "target": "com.amazonaws.servicecatalog#ProductViewOwner", + "AddTags": { + "target": "com.amazonaws.servicecatalog#AddTags", "traits": { - "smithy.api#documentation": "The updated owner of the product.
" + "smithy.api#documentation": "The tags to add to the product.
" + } + }, + "RemoveTags": { + "target": "com.amazonaws.servicecatalog#TagKeys", + "traits": { + "smithy.api#documentation": "The tags to remove from the product.
" } } } @@ -9219,28 +9219,28 @@ "com.amazonaws.servicecatalog#UpdateProvisionedProductInput": { "type": "structure", "members": { - "PathName": { - "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", - "traits": { - "smithy.api#documentation": "The name of the path. You must provide the name or ID, but not both.
" - } - }, "AcceptLanguage": { "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The name of the provisioned product. You cannot specify both\n ProvisionedProductName
and ProvisionedProductId
.
The identifier of the provisioned product. You must provide the name or ID, but not both.
" } }, - "ProvisionedProductName": { - "target": "com.amazonaws.servicecatalog#ProvisionedProductNameOrArn", + "ProductId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The name of the provisioned product. You cannot specify both\n ProvisionedProductName
and ProvisionedProductId
.
The identifier of the product. You must provide the name or ID, but not both.
" } }, "ProductName": { @@ -9249,40 +9249,46 @@ "smithy.api#documentation": "The name of the product. You must provide the name or ID, but not both.
" } }, - "ProvisioningParameters": { - "target": "com.amazonaws.servicecatalog#UpdateProvisioningParameters", + "ProvisioningArtifactId": { + "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The new parameters.
" + "smithy.api#documentation": "The identifier of the provisioning artifact.
" } }, - "ProvisioningArtifactId": { + "ProvisioningArtifactName": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", + "traits": { + "smithy.api#documentation": "The name of the provisioning artifact. You must provide the name or ID, but not both.
" + } + }, + "PathId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The identifier of the provisioning artifact.
" + "smithy.api#documentation": "The path identifier. This value is optional if the product \n has a default path, and required if the product has more than one path. You must provide the name or ID, but not both.
" } }, - "Tags": { - "target": "com.amazonaws.servicecatalog#Tags", + "PathName": { + "target": "com.amazonaws.servicecatalog#PortfolioDisplayName", "traits": { - "smithy.api#documentation": "One or more tags. Requires the product to have RESOURCE_UPDATE
constraint with TagUpdatesOnProvisionedProduct
set to ALLOWED
to allow tag updates.
The name of the path. You must provide the name or ID, but not both.
" } }, - "ProvisioningPreferences": { - "target": "com.amazonaws.servicecatalog#UpdateProvisioningPreferences", + "ProvisioningParameters": { + "target": "com.amazonaws.servicecatalog#UpdateProvisioningParameters", "traits": { - "smithy.api#documentation": "An object that contains information about the provisioning preferences for a stack set.
" + "smithy.api#documentation": "The new parameters.
" } }, - "ProvisioningArtifactName": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", + "ProvisioningPreferences": { + "target": "com.amazonaws.servicecatalog#UpdateProvisioningPreferences", "traits": { - "smithy.api#documentation": "The name of the provisioning artifact. You must provide the name or ID, but not both.
" + "smithy.api#documentation": "An object that contains information about the provisioning preferences for a stack set.
" } }, - "PathId": { - "target": "com.amazonaws.servicecatalog#Id", + "Tags": { + "target": "com.amazonaws.servicecatalog#Tags", "traits": { - "smithy.api#documentation": "The path identifier. This value is optional if the product \n has a default path, and required if the product has more than one path. You must provide the name or ID, but not both.
" + "smithy.api#documentation": "One or more tags. Requires the product to have RESOURCE_UPDATE
constraint with TagUpdatesOnProvisionedProduct
set to ALLOWED
to allow tag updates.
The identifier of the product. You must provide the name or ID, but not both.
" - } } } }, @@ -9338,6 +9338,12 @@ "com.amazonaws.servicecatalog#UpdateProvisionedProductPropertiesInput": { "type": "structure", "members": { + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "traits": { + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
A map that contains the provisioned product properties to be updated.
\nThe LAUNCH_ROLE
key accepts user ARNs and role ARNs. This key allows an\n administrator to call UpdateProvisionedProductProperties
to update the launch\n role that is associated with a provisioned product. This role is used when an end-user\n calls a provisioning operation such as UpdateProvisionedProduct
,\n TerminateProvisionedProduct
, or\n ExecuteProvisionedProductServiceAction
. Only an ARN role or\n null
is valid. A user ARN is invalid. For example, if an admin user passes\n null
as the value for the key LAUNCH_ROLE
, the admin removes\n the launch role that is associated with the provisioned product. As a result, the end user\n operations use the credentials of the end user.
The OWNER
key accepts user ARNs and role ARNs. The owner is the user\n that has permission to see, update, terminate, and execute service actions in the\n provisioned product.
The administrator can change the owner of a provisioned product to another IAM user within the same account. Both end user owners and \n administrators can see ownership history of the provisioned product using the ListRecordHistory
API. The new owner can \n describe all past records for the provisioned product using the DescribeRecord
API. The previous owner can no longer use DescribeRecord
, \n but can still see the product's history from when he was an owner using ListRecordHistory
.
If a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or \n Service Catalog console such as update, terminate, and execute service actions. \n If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through \n API or the Service Catalog console on that provisioned product.
", + "smithy.api#documentation": "A map that contains the provisioned product properties to be updated.
\nThe LAUNCH_ROLE
key accepts role ARNs. This key allows an\n administrator to call UpdateProvisionedProductProperties
to update the launch\n role that is associated with a provisioned product. This role is used when an end user\n calls a provisioning operation such as UpdateProvisionedProduct
,\n TerminateProvisionedProduct
, or\n ExecuteProvisionedProductServiceAction
. Only a role ARN or an empty string \"\"
is valid.\n A user ARN is invalid. if an admin user passes an empty string \"\"
as the value for the key LAUNCH_ROLE
,\n the admin removes the launch role that is associated with the provisioned product. As a result, the end user\n operations use the credentials of the end user.
The OWNER
key accepts user ARNs and role ARNs. The owner is the user\n that has permission to see, update, terminate, and execute service actions in the\n provisioned product.
The administrator can change the owner of a provisioned product to another IAM user within the same account. Both end user owners and \n administrators can see ownership history of the provisioned product using the ListRecordHistory
API. The new owner can \n describe all past records for the provisioned product using the DescribeRecord
API. The previous owner can no longer use DescribeRecord
, \n but can still see the product's history from when he was an owner using ListRecordHistory
.
If a provisioned product ownership is assigned to an end user, they can see and perform any action through the API or \n Service Catalog console such as update, terminate, and execute service actions. \n If an end user provisions a product and the owner is updated to someone else, they will no longer be able to see or perform any actions through \n API or the Service Catalog console on that provisioned product.
", "smithy.api#required": {} } }, @@ -9359,22 +9365,16 @@ "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } - }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", - "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The status of the request.
" + "smithy.api#documentation": "The provisioned product identifier.
" } }, "ProvisionedProductProperties": { @@ -9383,16 +9383,16 @@ "smithy.api#documentation": "A map that contains the properties updated.
" } }, - "ProvisionedProductId": { + "RecordId": { "target": "com.amazonaws.servicecatalog#Id", "traits": { - "smithy.api#documentation": "The provisioned product identifier.
" + "smithy.api#documentation": "The identifier of the record.
" } }, - "RecordId": { - "target": "com.amazonaws.servicecatalog#Id", + "Status": { + "target": "com.amazonaws.servicecatalog#RecordStatus", "traits": { - "smithy.api#documentation": "The identifier of the record.
" + "smithy.api#documentation": "The status of the request.
" } } } @@ -9420,22 +9420,17 @@ "com.amazonaws.servicecatalog#UpdateProvisioningArtifactInput": { "type": "structure", "members": { - "Active": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactActive", - "traits": { - "smithy.api#documentation": "Indicates whether the product version is active.
\nInactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.
" - } - }, - "Name": { - "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", + "AcceptLanguage": { + "target": "com.amazonaws.servicecatalog#AcceptLanguage", "traits": { - "smithy.api#documentation": "The updated name of the provisioning artifact.
" + "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
\nThe DEFAULT
value indicates that the product version is active.
The administrator can set the guidance to DEPRECATED
to inform\n users that the product version is deprecated. Users are able to make updates to a provisioned product \n of a deprecated version but cannot launch new provisioned products using a deprecated version.
The product identifier.
", + "smithy.api#required": {} } }, "ProvisioningArtifactId": { @@ -9445,11 +9440,10 @@ "smithy.api#required": {} } }, - "ProductId": { - "target": "com.amazonaws.servicecatalog#Id", + "Name": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactName", "traits": { - "smithy.api#documentation": "The product identifier.
", - "smithy.api#required": {} + "smithy.api#documentation": "The updated name of the provisioning artifact.
" } }, "Description": { @@ -9458,10 +9452,16 @@ "smithy.api#documentation": "The updated description of the provisioning artifact.
" } }, - "AcceptLanguage": { - "target": "com.amazonaws.servicecatalog#AcceptLanguage", + "Active": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactActive", "traits": { - "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
Indicates whether the product version is active.
\nInactive provisioning artifacts are invisible to end users. End users cannot launch or update a provisioned product from an inactive provisioning artifact.
" + } + }, + "Guidance": { + "target": "com.amazonaws.servicecatalog#ProvisioningArtifactGuidance", + "traits": { + "smithy.api#documentation": "Information set by the administrator to provide guidance to end users about which provisioning artifacts to use.
\nThe DEFAULT
value indicates that the product version is active.
The administrator can set the guidance to DEPRECATED
to inform\n users that the product version is deprecated. Users are able to make updates to a provisioned product \n of a deprecated version but cannot launch new provisioned products using a deprecated version.
The parameter key.
" + } + }, "Value": { "target": "com.amazonaws.servicecatalog#ParameterValue", "traits": { @@ -9503,12 +9509,6 @@ "traits": { "smithy.api#documentation": "If set to true, Value
is ignored and the previous parameter value is kept.
The parameter key.
" - } } }, "traits": { @@ -9524,6 +9524,18 @@ "com.amazonaws.servicecatalog#UpdateProvisioningPreferences": { "type": "structure", "members": { + "StackSetAccounts": { + "target": "com.amazonaws.servicecatalog#StackSetAccounts", + "traits": { + "smithy.api#documentation": "One or more AWS accounts that will have access to the provisioned product.
\nApplicable only to a CFN_STACKSET
provisioned product type.
The AWS accounts specified should be within the list of accounts in the STACKSET
constraint. To get the list of accounts in the STACKSET
constraint, use the DescribeProvisioningParameters
operation.
If no values are specified, the default value is all accounts from the STACKSET
constraint.
One or more AWS Regions where the provisioned product will be available.
\nApplicable only to a CFN_STACKSET
provisioned product type.
The specified regions should be within the list of regions from the STACKSET
constraint. To get the list of regions in the STACKSET
constraint, use the DescribeProvisioningParameters
operation.
If no values are specified, the default value is all regions from the STACKSET
constraint.
The percentage of accounts, per region, for which this stack operation can fail before AWS Service Catalog stops the operation in that region. If the operation is stopped in a region, AWS Service Catalog doesn't attempt the operation in any subsequent regions.
\nWhen calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number.
\nApplicable only to a CFN_STACKSET
provisioned product type.
Conditional: You must specify either StackSetFailureToleranceCount
or StackSetFailureTolerancePercentage
, but not both.
The maximum percentage of accounts in which to perform this operation at one time.
\nWhen calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1
instead.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
\nApplicable only to a CFN_STACKSET
provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount
or StackSetMaxConcurrentPercentage
, but not both.
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount
. StackSetMaxConcurrentCount
is at most one more than the StackSetFailureToleranceCount
.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
\nApplicable only to a CFN_STACKSET
provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount
or StackSetMaxConcurrentPercentage
, but not both.
One or more AWS accounts that will have access to the provisioned product.
\nApplicable only to a CFN_STACKSET
provisioned product type.
The AWS accounts specified should be within the list of accounts in the STACKSET
constraint. To get the list of accounts in the STACKSET
constraint, use the DescribeProvisioningParameters
operation.
If no values are specified, the default value is all accounts from the STACKSET
constraint.
The maximum percentage of accounts in which to perform this operation at one time.
\nWhen calculating the number of accounts based on the specified percentage, AWS Service Catalog rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, AWS Service Catalog sets the number as 1
instead.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
\nApplicable only to a CFN_STACKSET
provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount
or StackSetMaxConcurrentPercentage
, but not both.
Determines what action AWS Service Catalog performs to a stack set or a stack instance represented by the provisioned product. The default value is UPDATE
if nothing is specified.
Applicable only to a CFN_STACKSET
provisioned product type.
Creates a new stack instance in the stack set represented by the provisioned product. In this case, only new stack instances are created based on accounts and regions; if new ProductId or ProvisioningArtifactID are passed, they will be ignored.
\nUpdates the stack set represented by the provisioned product and also its stack instances.
\nDeletes a stack instance in the stack set represented by the provisioned product.
\nOne or more AWS Regions where the provisioned product will be available.
\nApplicable only to a CFN_STACKSET
provisioned product type.
The specified regions should be within the list of regions from the STACKSET
constraint. To get the list of regions in the STACKSET
constraint, use the DescribeProvisioningParameters
operation.
If no values are specified, the default value is all regions from the STACKSET
constraint.
The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of StackSetFailureToleranceCount
. StackSetMaxConcurrentCount
is at most one more than the StackSetFailureToleranceCount
.
Note that this setting lets you specify the maximum for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling.
\nApplicable only to a CFN_STACKSET
provisioned product type.
Conditional: You must specify either StackSetMaxConcurrentCount
or StackSetMaxConcurrentPercentage
, but not both.
A map that defines the self-service action.
" + "smithy.api#documentation": "The self-service action identifier.
", + "smithy.api#required": {} } }, "Name": { @@ -9606,6 +9607,12 @@ "smithy.api#documentation": "The self-service action name.
" } }, + "Definition": { + "target": "com.amazonaws.servicecatalog#ServiceActionDefinitionMap", + "traits": { + "smithy.api#documentation": "A map that defines the self-service action.
" + } + }, "Description": { "target": "com.amazonaws.servicecatalog#ServiceActionDescription", "traits": { @@ -9617,13 +9624,6 @@ "traits": { "smithy.api#documentation": "The language code.
\n\n en
- English (default)
\n jp
- Japanese
\n zh
- Chinese
The self-service action identifier.
", - "smithy.api#required": {} - } } } }, @@ -9667,12 +9667,6 @@ "com.amazonaws.servicecatalog#UpdateTagOptionInput": { "type": "structure", "members": { - "Active": { - "target": "com.amazonaws.servicecatalog#TagOptionActive", - "traits": { - "smithy.api#documentation": "The updated active state.
" - } - }, "Id": { "target": "com.amazonaws.servicecatalog#TagOptionId", "traits": { @@ -9685,6 +9679,12 @@ "traits": { "smithy.api#documentation": "The updated value.
" } + }, + "Active": { + "target": "com.amazonaws.servicecatalog#TagOptionActive", + "traits": { + "smithy.api#documentation": "The updated active state.
" + } } } }, diff --git a/codegen/sdk-codegen/aws-models/ssm.2014-11-06.json b/codegen/sdk-codegen/aws-models/ssm.2014-11-06.json index 840aa6e9d45b..99ee950357f2 100644 --- a/codegen/sdk-codegen/aws-models/ssm.2014-11-06.json +++ b/codegen/sdk-codegen/aws-models/ssm.2014-11-06.json @@ -2089,6 +2089,10 @@ { "value": "TagKey", "name": "TAG_KEY" + }, + { + "value": "TargetResourceGroup", + "name": "TARGET_RESOURCE_GROUP" } ] } @@ -19962,7 +19966,7 @@ "value": { "target": "com.amazonaws.ssm#SessionFilterValue", "traits": { - "smithy.api#documentation": "The filter value. Valid values for each filter key are as follows:
\nInvokedAfter: Specify a timestamp to limit your results. For example, specify\n 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.
\nInvokedBefore: Specify a timestamp to limit your results. For example, specify\n 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.
\nTarget: Specify an instance to which session connections have been made.
\nOwner: Specify an AWS user account to see a list of sessions started by that user.
\nStatus: Specify a valid session status to see a list of all sessions with that status.\n Status values you can specify include:
\nConnected
\nConnecting
\nDisconnected
\nTerminated
\nTerminating
\nFailed
\nThe filter value. Valid values for each filter key are as follows:
\nInvokedAfter: Specify a timestamp to limit your results. For example, specify\n 2018-08-29T00:00:00Z to see sessions that started August 29, 2018, and later.
\nInvokedBefore: Specify a timestamp to limit your results. For example, specify\n 2018-08-29T00:00:00Z to see sessions that started before August 29, 2018.
\nTarget: Specify an instance to which session connections have been made.
\nOwner: Specify an AWS user account to see a list of sessions started by that user.
\nStatus: Specify a valid session status to see a list of all sessions with that status.\n Status values you can specify include:
\nConnected
\nConnecting
\nDisconnected
\nTerminated
\nTerminating
\nFailed
\nSessionId: Specify a session ID to return details about the session.
\nA value that indicates the AWS Region where you want to store your data. The gateway AWS\n Region specified must be the same AWS Region as the AWS Region in your Host
\n header in the request. For more information about available AWS Regions and endpoints for\n AWS Storage Gateway, see AWS\n Storage Gateway endpoints and quotas in the AWS General\n Reference.
Valid Values: See AWS\n Storage Gateway endpoints and quotas in the AWS General\n Reference.\n \n
", + "smithy.api#documentation": "Your gateway activation key. You can obtain the activation key by sending an HTTP GET\n request with redirects enabled to the gateway IP address (port 80). The redirect URL\n returned in the response provides you the activation key for your gateway in the query\n string parameter activationKey
. It may also include other activation-related\n parameters, however, these are merely defaults -- the arguments you pass to the\n ActivateGateway
API call determine the actual configuration of your\n gateway.
For more information, see Getting activation\n key in the AWS Storage Gateway User Guide.
", "smithy.api#required": {} } }, - "GatewayType": { - "target": "com.amazonaws.storagegateway#GatewayType", + "GatewayName": { + "target": "com.amazonaws.storagegateway#GatewayName", "traits": { - "smithy.api#documentation": "A value that defines the type of gateway to activate. The type specified is critical to\n all later functions of the gateway and cannot be changed after activation. The default\n value is CACHED
.
Valid Values: STORED
| CACHED
| VTL
|\n FILE_S3
\n
The name you configured for your gateway.
", + "smithy.api#required": {} } }, - "MediumChangerType": { - "target": "com.amazonaws.storagegateway#MediumChangerType", + "GatewayTimezone": { + "target": "com.amazonaws.storagegateway#GatewayTimezone", "traits": { - "smithy.api#documentation": "The value that indicates the type of medium changer to use for tape gateway. This field\n is optional.
\n\nValid Values: STK-L700
| AWS-Gateway-VTL
|\n IBM-03584L32-0402
\n
A value that indicates the time zone you want to set for the gateway. The time zone is\n of the format \"GMT-hr:mm\" or \"GMT+hr:mm\". For example, GMT-4:00 indicates the time is 4\n hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is\n used, for example, for scheduling snapshots and your gateway's maintenance\n schedule.
", + "smithy.api#required": {} } }, - "ActivationKey": { - "target": "com.amazonaws.storagegateway#ActivationKey", + "GatewayRegion": { + "target": "com.amazonaws.storagegateway#RegionId", "traits": { - "smithy.api#documentation": "Your gateway activation key. You can obtain the activation key by sending an HTTP GET\n request with redirects enabled to the gateway IP address (port 80). The redirect URL\n returned in the response provides you the activation key for your gateway in the query\n string parameter activationKey
. It may also include other activation-related\n parameters, however, these are merely defaults -- the arguments you pass to the\n ActivateGateway
API call determine the actual configuration of your\n gateway.
For more information, see Getting activation\n key in the AWS Storage Gateway User Guide.
", + "smithy.api#documentation": "A value that indicates the AWS Region where you want to store your data. The gateway AWS\n Region specified must be the same AWS Region as the AWS Region in your Host
\n header in the request. For more information about available AWS Regions and endpoints for\n AWS Storage Gateway, see AWS\n Storage Gateway endpoints and quotas in the AWS General\n Reference.
Valid Values: See AWS\n Storage Gateway endpoints and quotas in the AWS General\n Reference.\n \n
", "smithy.api#required": {} } }, + "GatewayType": { + "target": "com.amazonaws.storagegateway#GatewayType", + "traits": { + "smithy.api#documentation": "A value that defines the type of gateway to activate. The type specified is critical to\n all later functions of the gateway and cannot be changed after activation. The default\n value is CACHED
.
Valid Values: STORED
| CACHED
| VTL
|\n FILE_S3
\n
The value that indicates the type of tape drive to use for tape gateway. This field is\n optional.
\n\nValid Values: IBM-ULT3580-TD5
\n
A value that indicates the time zone you want to set for the gateway. The time zone is\n of the format \"GMT-hr:mm\" or \"GMT+hr:mm\". For example, GMT-4:00 indicates the time is 4\n hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is\n used, for example, for scheduling snapshots and your gateway's maintenance\n schedule.
", - "smithy.api#required": {} + "smithy.api#documentation": "The value that indicates the type of medium changer to use for tape gateway. This field\n is optional.
\n\nValid Values: STK-L700
| AWS-Gateway-VTL
|\n IBM-03584L32-0402
\n
A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value\n pair.
\n\nValid characters for key and value are letters, spaces, and numbers that can be\n represented in UTF-8 format, and the following special characters: + - = . _ : / @. The\n maximum length of a tag's key is 128 characters, and the maximum length for a\n tag's value is 256 characters.
\nThe name you configured for your gateway.
", - "smithy.api#required": {} - } } }, "traits": { @@ -282,16 +282,16 @@ "com.amazonaws.storagegateway#AddUploadBufferInput": { "type": "structure", "members": { - "DiskIds": { - "target": "com.amazonaws.storagegateway#DiskIds", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "An array of strings that identify disks that are to be configured as working storage.\n Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs\n from the ListLocalDisks API.
", "smithy.api#required": {} } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "DiskIds": { + "target": "com.amazonaws.storagegateway#DiskIds", "traits": { + "smithy.api#documentation": "An array of strings that identify disks that are to be configured as working storage.\n Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs\n from the ListLocalDisks API.
", "smithy.api#required": {} } } @@ -328,16 +328,16 @@ "com.amazonaws.storagegateway#AddWorkingStorageInput": { "type": "structure", "members": { - "DiskIds": { - "target": "com.amazonaws.storagegateway#DiskIds", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "An array of strings that identify disks that are to be configured as working storage.\n Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs\n from the ListLocalDisks API.
", "smithy.api#required": {} } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "DiskIds": { + "target": "com.amazonaws.storagegateway#DiskIds", "traits": { + "smithy.api#documentation": "An array of strings that identify disks that are to be configured as working storage.\n Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs\n from the ListLocalDisks API.
", "smithy.api#required": {} } } @@ -380,17 +380,17 @@ "com.amazonaws.storagegateway#AssignTapePoolInput": { "type": "structure", "members": { - "PoolId": { - "target": "com.amazonaws.storagegateway#PoolId", + "TapeARN": { + "target": "com.amazonaws.storagegateway#TapeARN", "traits": { - "smithy.api#documentation": "The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
\n\nValid Values: GLACIER
| DEEP_ARCHIVE
\n
The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the\n tape pool.
", "smithy.api#required": {} } }, - "TapeARN": { - "target": "com.amazonaws.storagegateway#TapeARN", + "PoolId": { + "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "The unique Amazon Resource Name (ARN) of the virtual tape that you want to add to the\n tape pool.
", + "smithy.api#documentation": "The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
\n\nValid Values: GLACIER
| DEEP_ARCHIVE
\n
The unique device ID or other distinguishing data that identifies the local disk used to\n create the volume. This value is only required when you are attaching a stored\n volume.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway that you want to attach the volume\n to.
", + "smithy.api#required": {} } }, "TargetName": { @@ -462,11 +463,10 @@ "smithy.api#required": {} } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "DiskId": { + "target": "com.amazonaws.storagegateway#DiskId", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway that you want to attach the volume\n to.
", - "smithy.api#required": {} + "smithy.api#documentation": "The unique device ID or other distinguishing data that identifies the local disk used to\n create the volume. This value is only required when you are attaching a stored\n volume.
" } } }, @@ -516,14 +516,14 @@ "com.amazonaws.storagegateway#AutomaticTapeCreationPolicyInfo": { "type": "structure", "members": { - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" - }, "AutomaticTapeCreationRules": { "target": "com.amazonaws.storagegateway#AutomaticTapeCreationRules", "traits": { "smithy.api#documentation": "An automatic tape creation policy consists of a list of automatic tape creation rules.\n This returns the rules that determine when and how to automatically create new\n tapes.
" } + }, + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { @@ -539,31 +539,31 @@ "com.amazonaws.storagegateway#AutomaticTapeCreationRule": { "type": "structure", "members": { - "MinimumNumTapes": { - "target": "com.amazonaws.storagegateway#MinimumNumTapes", + "TapeBarcodePrefix": { + "target": "com.amazonaws.storagegateway#TapeBarcodePrefix", "traits": { - "smithy.api#documentation": "The minimum number of available virtual tapes that the gateway maintains at all times.\n If the number of tapes on the gateway goes below this value, the gateway creates as many\n new tapes as are needed to have MinimumNumTapes
on the gateway. For more\n information about automatic tape creation, see Creating Tapes Automatically.
A prefix that you append to the barcode of the virtual tape that you are creating. This\n prefix makes the barcode unique.
\n\nThe prefix must be 1-4 characters in length and must be one of the uppercase letters\n from A to Z.
\nThe size, in bytes, of the virtual tape capacity.
", + "smithy.api#documentation": "The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the Amazon S3 storage class that is associated with the pool. When you\n use your backup application to eject the tape, the tape is archived directly into the\n storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
\n\nValid Values: GLACIER
| DEEP_ARCHIVE
\n
A prefix that you append to the barcode of the virtual tape that you are creating. This\n prefix makes the barcode unique.
\n\nThe prefix must be 1-4 characters in length and must be one of the uppercase letters\n from A to Z.
\nThe size, in bytes, of the virtual tape capacity.
", "smithy.api#required": {} } }, - "PoolId": { - "target": "com.amazonaws.storagegateway#PoolId", + "MinimumNumTapes": { + "target": "com.amazonaws.storagegateway#MinimumNumTapes", "traits": { - "smithy.api#documentation": "The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the Amazon S3 storage class that is associated with the pool. When you\n use your backup application to eject the tape, the tape is archived directly into the\n storage class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
\n\nValid Values: GLACIER
| DEEP_ARCHIVE
\n
The minimum number of available virtual tapes that the gateway maintains at all times.\n If the number of tapes on the gateway goes below this value, the gateway creates as many\n new tapes as are needed to have MinimumNumTapes
on the gateway. For more\n information about automatic tape creation, see Creating Tapes Automatically.
\n The hour of the day to start the bandwidth rate limit interval.\n
", + "smithy.api#required": {} + } + }, + "StartMinuteOfHour": { + "target": "com.amazonaws.storagegateway#MinuteOfHour", + "traits": { + "smithy.api#documentation": "\n The minute of the hour to start the bandwidth rate limit interval.\n The interval begins at the start of that minute. To begin an interval exactly at \n the start of the hour, use the value 0
.\n
\n The hour of the day to end the bandwidth rate limit interval.\n
", + "smithy.api#required": {} + } + }, + "EndMinuteOfHour": { + "target": "com.amazonaws.storagegateway#MinuteOfHour", + "traits": { + "smithy.api#documentation": "\n The minute of the hour to end the bandwidth rate limit interval.\n
\n \n\n The bandwidth rate limit interval ends at the end of the minute. To end an interval\n at the end of an hour, use the value 59
.\n
\n The days of the week component of the bandwidth rate limit interval, \n represented as ordinal numbers from 0 to 6, where 0 represents Sunday and 6 Saturday. \n
", + "smithy.api#required": {} + } + }, + "AverageUploadRateLimitInBitsPerSec": { + "target": "com.amazonaws.storagegateway#BandwidthUploadRateLimit", + "traits": { + "smithy.api#documentation": "\n The average upload rate limit component of the bandwidth rate limit interval,\n in bits per second. This field does not appear in the response if the upload rate limit is not set. \n
" + } + }, + "AverageDownloadRateLimitInBitsPerSec": { + "target": "com.amazonaws.storagegateway#BandwidthDownloadRateLimit", + "traits": { + "smithy.api#documentation": "\n The average download rate limit component of the bandwidth rate limit interval, \n in bits per second. This field does not appear in the response if the download rate limit is not set. \n
" + } + } + }, + "traits": { + "smithy.api#documentation": "\n Describes a bandwidth rate limit interval for a gateway. A bandwidth\n rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit\n interval defines a period of time on one or more days of the week, during which bandwidth rate \n limits are specified for uploading, downloading, or both. \n
" + } + }, + "com.amazonaws.storagegateway#BandwidthRateLimitIntervals": { + "type": "list", + "member": { + "target": "com.amazonaws.storagegateway#BandwidthRateLimitInterval" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 20 + } + } + }, "com.amazonaws.storagegateway#BandwidthType": { "type": "string", "traits": { @@ -665,37 +732,28 @@ "com.amazonaws.storagegateway#CachediSCSIVolume": { "type": "structure", "members": { - "VolumeUsedInBytes": { - "target": "com.amazonaws.storagegateway#VolumeUsedInBytes", - "traits": { - "smithy.api#documentation": "The size of the data stored on the volume in bytes. This value is calculated based on\n the number of blocks that are touched, instead of the actual amount of data written. This\n value can be useful for sequential write patterns but less accurate for random write\n patterns. VolumeUsedInBytes
is different from the compressed size of the\n volume, which is the value that is used to calculate your bill.
This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.
\nThe name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName
as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume
.\n The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the storage volume.
" } }, - "VolumeStatus": { - "target": "com.amazonaws.storagegateway#VolumeStatus", + "VolumeId": { + "target": "com.amazonaws.storagegateway#VolumeId", "traits": { - "smithy.api#documentation": "One of the VolumeStatus values that indicates the state of the storage volume.
" + "smithy.api#documentation": "The unique identifier of the volume, e.g., vol-AE4B946D.
" } }, - "KMSKey": { - "target": "com.amazonaws.storagegateway#KMSKey" - }, - "VolumeiSCSIAttributes": { - "target": "com.amazonaws.storagegateway#VolumeiSCSIAttributes", + "VolumeType": { + "target": "com.amazonaws.storagegateway#VolumeType", "traits": { - "smithy.api#documentation": "An VolumeiSCSIAttributes object that represents a collection of iSCSI\n attributes for one stored volume.
" + "smithy.api#documentation": "One of the VolumeType enumeration values that describes the type of the volume.
" } }, - "CreatedDate": { - "target": "com.amazonaws.storagegateway#CreatedDate", + "VolumeStatus": { + "target": "com.amazonaws.storagegateway#VolumeStatus", "traits": { - "smithy.api#documentation": "The date the volume was created. Volumes created prior to March 28, 2017 don’t have this\n timestamp.
" + "smithy.api#documentation": "One of the VolumeStatus values that indicates the state of the storage volume.
" } }, "VolumeAttachmentStatus": { @@ -704,40 +762,49 @@ "smithy.api#documentation": "A value that indicates whether a storage volume is attached to or detached from a\n gateway. For more information, see Moving\n your volumes to a different gateway.
" } }, + "VolumeSizeInBytes": { + "target": "com.amazonaws.storagegateway#long", + "traits": { + "smithy.api#documentation": "The size, in bytes, of the volume capacity.
" + } + }, "VolumeProgress": { "target": "com.amazonaws.storagegateway#DoubleObject", "traits": { "smithy.api#documentation": "Represents the percentage complete if the volume is restoring or bootstrapping that\n represents the percent of data transferred. This field does not appear in the response if\n the cached volume is not restoring or bootstrapping.
" } }, - "VolumeSizeInBytes": { - "target": "com.amazonaws.storagegateway#long", + "SourceSnapshotId": { + "target": "com.amazonaws.storagegateway#SnapshotId", "traits": { - "smithy.api#documentation": "The size, in bytes, of the volume capacity.
" + "smithy.api#documentation": "If the cached volume was created from a snapshot, this field contains the snapshot ID\n used, e.g., snap-78e22663. Otherwise, this field is not included.
" } }, - "VolumeId": { - "target": "com.amazonaws.storagegateway#VolumeId", + "VolumeiSCSIAttributes": { + "target": "com.amazonaws.storagegateway#VolumeiSCSIAttributes", "traits": { - "smithy.api#documentation": "The unique identifier of the volume, e.g., vol-AE4B946D.
" + "smithy.api#documentation": "An VolumeiSCSIAttributes object that represents a collection of iSCSI\n attributes for one stored volume.
" } }, - "VolumeType": { - "target": "com.amazonaws.storagegateway#VolumeType", + "CreatedDate": { + "target": "com.amazonaws.storagegateway#CreatedDate", "traits": { - "smithy.api#documentation": "One of the VolumeType enumeration values that describes the type of the volume.
" + "smithy.api#documentation": "The date the volume was created. Volumes created prior to March 28, 2017 don’t have this\n timestamp.
" } }, - "SourceSnapshotId": { - "target": "com.amazonaws.storagegateway#SnapshotId", + "VolumeUsedInBytes": { + "target": "com.amazonaws.storagegateway#VolumeUsedInBytes", "traits": { - "smithy.api#documentation": "If the cached volume was created from a snapshot, this field contains the snapshot ID\n used, e.g., snap-78e22663. Otherwise, this field is not included.
" + "smithy.api#documentation": "The size of the data stored on the volume in bytes. This value is calculated based on\n the number of blocks that are touched, instead of the actual amount of data written. This\n value can be useful for sequential write patterns but less accurate for random write\n patterns. VolumeUsedInBytes
is different from the compressed size of the\n volume, which is the value that is used to calculate your bill.
This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.
\nThe Amazon Resource Name (ARN) of the storage volume.
" + "smithy.api#documentation": "The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName
as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume
.\n The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.
" } } }, @@ -829,16 +896,16 @@ "com.amazonaws.storagegateway#CancelRetrievalInput": { "type": "structure", "members": { - "TapeARN": { - "target": "com.amazonaws.storagegateway#TapeARN", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval\n for.
", "smithy.api#required": {} } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "TapeARN": { + "target": "com.amazonaws.storagegateway#TapeARN", "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape you want to cancel retrieval\n for.
", "smithy.api#required": {} } } @@ -883,28 +950,28 @@ "com.amazonaws.storagegateway#ChapInfo": { "type": "structure", "members": { - "SecretToAuthenticateTarget": { - "target": "com.amazonaws.storagegateway#ChapSecret", + "TargetARN": { + "target": "com.amazonaws.storagegateway#TargetARN", "traits": { - "smithy.api#documentation": "The secret key that the target must provide to participate in mutual CHAP with the\n initiator (e.g., Windows client).
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume.
\n\nValid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" } }, - "InitiatorName": { - "target": "com.amazonaws.storagegateway#IqnName", + "SecretToAuthenticateInitiator": { + "target": "com.amazonaws.storagegateway#ChapSecret", "traits": { - "smithy.api#documentation": "The iSCSI initiator that connects to the target.
" + "smithy.api#documentation": "The secret key that the initiator (for example, the Windows client) must provide to\n participate in mutual CHAP with the target.
" } }, - "TargetARN": { - "target": "com.amazonaws.storagegateway#TargetARN", + "InitiatorName": { + "target": "com.amazonaws.storagegateway#IqnName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume.
\n\nValid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" + "smithy.api#documentation": "The iSCSI initiator that connects to the target.
" } }, - "SecretToAuthenticateInitiator": { + "SecretToAuthenticateTarget": { "target": "com.amazonaws.storagegateway#ChapSecret", "traits": { - "smithy.api#documentation": "The secret key that the initiator (for example, the Windows client) must provide to\n participate in mutual CHAP with the target.
" + "smithy.api#documentation": "The secret key that the target must provide to participate in mutual CHAP with the\n initiator (e.g., Windows client).
" } } }, @@ -963,29 +1030,36 @@ "com.amazonaws.storagegateway#CreateCachediSCSIVolumeInput": { "type": "structure", "members": { - "SourceVolumeARN": { - "target": "com.amazonaws.storagegateway#VolumeARN", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "The ARN for an existing volume. Specifying this ARN makes the new volume into an exact\n copy of the specified existing volume's latest recovery point. The\n VolumeSizeInBytes
value for this new volume must be equal to or larger than\n the size of the existing volume, in bytes.
The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName
as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume
.\n The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.
", + "smithy.api#documentation": "The size of the volume in bytes.
", "smithy.api#required": {} } }, - "KMSEncrypted": { - "target": "com.amazonaws.storagegateway#Boolean", + "SnapshotId": { + "target": "com.amazonaws.storagegateway#SnapshotId", "traits": { - "smithy.api#documentation": "Set to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new cached\n volume. Specify this field if you want to create the iSCSI storage volume from a snapshot;\n otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API\n Reference.
" } }, - "KMSKey": { - "target": "com.amazonaws.storagegateway#KMSKey", + "TargetName": { + "target": "com.amazonaws.storagegateway#TargetName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted
is true
. Optional.
The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName
as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume
.\n The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.
", + "smithy.api#required": {} + } + }, + "SourceVolumeARN": { + "target": "com.amazonaws.storagegateway#VolumeARN", + "traits": { + "smithy.api#documentation": "The ARN for an existing volume. Specifying this ARN makes the new volume into an exact\n copy of the specified existing volume's latest recovery point. The\n VolumeSizeInBytes
value for this new volume must be equal to or larger than\n the size of the existing volume, in bytes.
A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value\n pair.
\n\nValid characters for key and value are letters, spaces, and numbers that you can\n represent in UTF-8 format, and the following special characters: + - = . _ : / @. The\n maximum length of a tag's key is 128 characters, and the maximum length for a\n tag's value is 256 characters.
\nThe snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new cached\n volume. Specify this field if you want to create the iSCSI storage volume from a snapshot;\n otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API\n Reference.
" + "smithy.api#documentation": "Set to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted
is true
. Optional.
The size of the volume in bytes.
", - "smithy.api#required": {} + "smithy.api#documentation": "A list of up to 50 tags that you can assign to a cached volume. Each tag is a key-value\n pair.
\n\nValid characters for key and value are letters, spaces, and numbers that you can\n represent in UTF-8 format, and the following special characters: + - = . _ : / @. The\n maximum length of a tag's key is 128 characters, and the maximum length for a\n tag's value is 256 characters.
\nThe default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
|\n S3_STANDARD_IA
| S3_ONEZONE_IA
\n
A unique string value that you supply that is used by file gateway to ensure idempotent\n file share creation.
", + "smithy.api#required": {} } }, - "ClientList": { - "target": "com.amazonaws.storagegateway#FileShareClientList", + "NFSFileShareDefaults": { + "target": "com.amazonaws.storagegateway#NFSFileShareDefaults", "traits": { - "smithy.api#documentation": "The list of clients that are allowed to access the file gateway. The list must contain\n either valid IP addresses or valid CIDR blocks.
" + "smithy.api#documentation": "File share default values. Optional.
" } }, - "ObjectACL": { - "target": "com.amazonaws.storagegateway#ObjectACL", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that a file gateway puts objects into. The default value is private
.
The Amazon Resource Name (ARN) of the file gateway on which you want to create a file\n share.
", + "smithy.api#required": {} } }, - "Squash": { - "target": "com.amazonaws.storagegateway#Squash", + "KMSEncrypted": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "A value that maps a user to anonymous user.
\n\nValid values are the following:
\n\n\n RootSquash
: Only root is mapped to anonymous user.
\n NoSquash
: No one is mapped to anonymous user.
\n AllSquash
: Everyone is mapped to anonymous user.
Set to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted
is true
. Optional.
Set to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
|\n S3_STANDARD_IA
| S3_ONEZONE_IA
\n
The name of the file share. Optional.
\n\n\n FileShareName
must be set if an S3 prefix name is set in\n LocationARN
.
A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that a file gateway puts objects into. The default value is private
.
A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true
, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.
\n RequesterPays
is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.
Valid Values: true
| false
\n
The list of clients that are allowed to access the file gateway. The list must contain\n either valid IP addresses or valid CIDR blocks.
" } }, - "GuessMIMETypeEnabled": { + "Squash": { + "target": "com.amazonaws.storagegateway#Squash", + "traits": { + "smithy.api#documentation": "A value that maps a user to anonymous user.
\n\nValid values are the following:
\n\n\n RootSquash
: Only root is mapped to anonymous user.
\n NoSquash
: No one is mapped to anonymous user.
\n AllSquash
: Everyone is mapped to anonymous user.
A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true
to enable MIME type guessing, otherwise set\n to false
. The default value is true
.
Valid Values: true
| false
\n
A value that sets the write status of a file share. Set this value to true
\n to set the write status to read-only, otherwise set to false
.
Valid Values: true
| false
\n
A unique string value that you supply that is used by file gateway to ensure idempotent\n file share creation.
", - "smithy.api#required": {} + "smithy.api#documentation": "A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true
to enable MIME type guessing, otherwise set\n to false
. The default value is true
.
Valid Values: true
| false
\n
Refresh cache information.
" + "smithy.api#documentation": "A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true
, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.
\n RequesterPays
is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.
Valid Values: true
| false
\n
A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a\n key-value pair.
\n\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nThe notification policy of the file share.
" - } - }, - "ReadOnly": { - "target": "com.amazonaws.storagegateway#Boolean", - "traits": { - "smithy.api#documentation": "A value that sets the write status of a file share. Set this value to true
\n to set the write status to read-only, otherwise set to false
.
Valid Values: true
| false
\n
The Amazon Resource Name (ARN) of the file gateway on which you want to create a file\n share.
", - "smithy.api#required": {} + "smithy.api#documentation": "The name of the file share. Optional.
\n\n\n FileShareName
must be set if an S3 prefix name is set in\n LocationARN
.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted
is true
. Optional.
Refresh cache information.
" } }, - "NFSFileShareDefaults": { - "target": "com.amazonaws.storagegateway#NFSFileShareDefaults", + "NotificationPolicy": { + "target": "com.amazonaws.storagegateway#NotificationPolicy", "traits": { - "smithy.api#documentation": "File share default values. Optional.
" + "smithy.api#documentation": "The notification policy of the file share.
" } } }, @@ -1223,23 +1290,24 @@ "com.amazonaws.storagegateway#CreateSMBFileShareInput": { "type": "structure", "members": { - "Role": { - "target": "com.amazonaws.storagegateway#Role", + "ClientToken": { + "target": "com.amazonaws.storagegateway#ClientToken", "traits": { - "smithy.api#documentation": "The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes\n when it accesses the underlying storage.
", + "smithy.api#documentation": "A unique string value that you supply that is used by file gateway to ensure idempotent\n file share creation.
", "smithy.api#required": {} } }, - "AuditDestinationARN": { - "target": "com.amazonaws.storagegateway#AuditDestinationARN", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the storage used for the audit logs.
" + "smithy.api#documentation": "The ARN of the file gateway on which you want to create a file share.
", + "smithy.api#required": {} } }, - "SMBACLEnabled": { + "KMSEncrypted": { "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "Set this value to true
to enable access control list (ACL) on the SMB file\n share. Set it to false
to map file and directory permissions to the POSIX\n permissions.
For more information, see Using Microsoft Windows ACLs to\n control access to an SMB file share in the AWS Storage Gateway User\n Guide.
\n\nValid Values: true
| false
\n
Set to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted
is true
. Optional.
The authentication method that users use to access the file share. The default is\n ActiveDirectory
.
Valid Values: ActiveDirectory
| GuestAccess
\n
The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
|\n S3_STANDARD_IA
| S3_ONEZONE_IA
\n
The ARN of the AWS Identity and Access Management (IAM) role that a file gateway assumes\n when it accesses the underlying storage.
", + "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", + "LocationARN": { + "target": "com.amazonaws.storagegateway#LocationARN", "traits": { - "smithy.api#documentation": "A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a\n key-value pair.
\n\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nThe ARN of the backend storage used for storing file data. A prefix name can be added to\n the S3 bucket name. It must end with a \"/\".
", + "smithy.api#required": {} } }, - "CacheAttributes": { - "target": "com.amazonaws.storagegateway#CacheAttributes", + "DefaultStorageClass": { + "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "Refresh cache information.
" + "smithy.api#documentation": "The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
|\n S3_STANDARD_IA
| S3_ONEZONE_IA
\n
A list of users or groups in the Active Directory that are allowed to access the file\n share. A group must be prefixed with the @ character. Acceptable formats\n include: DOMAIN\\User1
, user1
, @group1
, and\n @DOMAIN\\group1
. Can only be set if Authentication is set to\n ActiveDirectory
.
A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that a file gateway puts objects into. The default value is private
.
The ARN of the file gateway on which you want to create a file share.
", - "smithy.api#required": {} + "smithy.api#documentation": "A value that sets the write status of a file share. Set this value to true
\n to set the write status to read-only, otherwise set to false
.
Valid Values: true
| false
\n
The name of the file share. Optional.
\n\n\n FileShareName
must be set if an S3 prefix name is set in\n LocationARN
.
A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true
to enable MIME type guessing, otherwise set\n to false
. The default value is true
.
Valid Values: true
| false
\n
A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true
, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.
\n RequesterPays
is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.
Valid Values: true
| false
\n
A list of users or groups in the Active Directory that are not allowed to access the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1
, user1
, @group1
, and\n @DOMAIN\\group1
. Can only be set if Authentication is set to\n ActiveDirectory
.
Set this value to true
to enable access control list (ACL) on the SMB file\n share. Set it to false
to map file and directory permissions to the POSIX\n permissions.
For more information, see Using Microsoft Windows ACLs to\n control access to an SMB file share in the AWS Storage Gateway User\n Guide.
\n\nValid Values: true
| false
\n
The ARN of the backend storage used for storing file data. A prefix name can be added to\n the S3 bucket name. It must end with a \"/\".
", - "smithy.api#required": {} + "smithy.api#documentation": "The files and folders on this share will only be visible to users with read\n access.
" } }, "AdminUserList": { @@ -1316,29 +1378,28 @@ "smithy.api#documentation": "A list of users or groups in the Active Directory that will be granted administrator\n privileges on the file share. These users can do all file operations as the super-user.\n Acceptable formats include: DOMAIN\\User1
, user1
,\n @group1
, and @DOMAIN\\group1
.
Use this option very carefully, because any user in this list can do anything they\n like on the file share, regardless of file permissions.
\nA value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true
to enable MIME type guessing, otherwise set\n to false
. The default value is true
.
Valid Values: true
| false
\n
A list of users or groups in the Active Directory that are allowed to access the file\n share. A group must be prefixed with the @ character. Acceptable formats\n include: DOMAIN\\User1
, user1
, @group1
, and\n @DOMAIN\\group1
. Can only be set if Authentication is set to\n ActiveDirectory
.
Set to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
A list of users or groups in the Active Directory that are not allowed to access the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1
, user1
, @group1
, and\n @DOMAIN\\group1
. Can only be set if Authentication is set to\n ActiveDirectory
.
A unique string value that you supply that is used by file gateway to ensure idempotent\n file share creation.
", - "smithy.api#required": {} + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the storage used for the audit logs.
" } }, - "AccessBasedEnumeration": { - "target": "com.amazonaws.storagegateway#Boolean", + "Authentication": { + "target": "com.amazonaws.storagegateway#Authentication", "traits": { - "smithy.api#documentation": "The files and folders on this share will only be visible to users with read\n access.
" + "smithy.api#documentation": "The authentication method that users use to access the file share. The default is\n ActiveDirectory
.
Valid Values: ActiveDirectory
| GuestAccess
\n
The case of an object name in an Amazon S3 bucket. For ClientSpecified
, the\n client determines the case sensitivity. For CaseSensitive
, the gateway\n determines the case sensitivity. The default value is ClientSpecified
.
The notification policy of the file share.
" + "smithy.api#documentation": "A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a\n key-value pair.
\n\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nA value that sets the write status of a file share. Set this value to true
\n to set the write status to read-only, otherwise set to false
.
Valid Values: true
| false
\n
The name of the file share. Optional.
\n\n\n FileShareName
must be set if an S3 prefix name is set in\n LocationARN
.
A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that a file gateway puts objects into. The default value is private
.
Refresh cache information.
" + } + }, + "NotificationPolicy": { + "target": "com.amazonaws.storagegateway#NotificationPolicy", + "traits": { + "smithy.api#documentation": "The notification policy of the file share.
" } } }, @@ -1440,30 +1507,24 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", - "traits": { - "smithy.api#documentation": "A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value\n pair.
\n\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nTextual description of the snapshot that appears in the Amazon EC2 console, Elastic\n Block Store snapshots panel in the Description field, and\n in the AWS Storage Gateway snapshot Details pane,\n Description field.
", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", + "traits": { + "smithy.api#documentation": "A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value\n pair.
\n\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nThe time the volume was created from the recovery point.
" - } - }, "SnapshotId": { "target": "com.amazonaws.storagegateway#SnapshotId", "traits": { @@ -1475,6 +1536,12 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return to retrieve the TargetARN for\n specified VolumeARN.
" } + }, + "VolumeRecoveryPointTime": { + "target": "com.amazonaws.storagegateway#string", + "traits": { + "smithy.api#documentation": "The time the volume was created from the recovery point.
" + } } } }, @@ -1488,18 +1555,18 @@ "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", - "traits": { - "smithy.api#documentation": "A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value\n pair.
\n\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nTextual description of the snapshot that appears in the Amazon EC2 console, Elastic\n Block Store snapshots panel in the Description field, and\n in the AWS Storage Gateway snapshot Details pane,\n Description field.
", "smithy.api#required": {} } + }, + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", + "traits": { + "smithy.api#documentation": "A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value\n pair.
\n\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nSet to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
The network interface of the gateway on which to expose the iSCSI target. Only IPv4\n addresses are accepted. Use DescribeGatewayInformation to get a list of\n the network interfaces available on a gateway.
\n\nValid Values: A valid IP address.
", + "smithy.api#documentation": "The unique identifier for the gateway local disk that is configured as a stored volume.\n Use ListLocalDisks to\n list disk IDs for a gateway.
", "smithy.api#required": {} } }, + "SnapshotId": { + "target": "com.amazonaws.storagegateway#SnapshotId", + "traits": { + "smithy.api#documentation": "The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new stored\n volume. Specify this field if you want to create the iSCSI storage volume from a snapshot;\n otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API\n Reference.
" + } + }, "PreserveExistingData": { "target": "com.amazonaws.storagegateway#Boolean2", "traits": { @@ -1569,23 +1642,24 @@ "smithy.api#required": {} } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "TargetName": { + "target": "com.amazonaws.storagegateway#TargetName", "traits": { + "smithy.api#documentation": "The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName
as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume
.\n The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.
", "smithy.api#required": {} } }, - "DiskId": { - "target": "com.amazonaws.storagegateway#DiskId", + "NetworkInterfaceId": { + "target": "com.amazonaws.storagegateway#NetworkInterfaceId", "traits": { - "smithy.api#documentation": "The unique identifier for the gateway local disk that is configured as a stored volume.\n Use ListLocalDisks to\n list disk IDs for a gateway.
", + "smithy.api#documentation": "The network interface of the gateway on which to expose the iSCSI target. Only IPv4\n addresses are accepted. Use DescribeGatewayInformation to get a list of\n the network interfaces available on a gateway.
\n\nValid Values: A valid IP address.
", "smithy.api#required": {} } }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", + "KMSEncrypted": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value\n pair.
\n\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nSet to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted
is true
. Optional.
The snapshot ID (e.g. \"snap-1122aabb\") of the snapshot to restore as the new stored\n volume. Specify this field if you want to create the iSCSI storage volume from a snapshot;\n otherwise, do not include this field. To list snapshots for your account use DescribeSnapshots in the Amazon Elastic Compute Cloud API\n Reference.
" - } - }, - "TargetName": { - "target": "com.amazonaws.storagegateway#TargetName", + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", "traits": { - "smithy.api#documentation": "The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName
as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume
.\n The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.
", - "smithy.api#required": {} + "smithy.api#documentation": "A list of up to 50 tags that can be assigned to a stored volume. Each tag is a key-value\n pair.
\n\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nA list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value\n pair.
\n\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nTape retention lock time is set in days. Tape retention lock can be enabled for up to\n 100 years (36,500 days).
" + "smithy.api#documentation": "The storage class that is associated with the new custom pool. When you use your backup\n application to eject the tape, the tape is archived directly into the storage class (S3\n Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
", + "smithy.api#required": {} } }, "RetentionLockType": { @@ -1686,11 +1748,16 @@ "smithy.api#documentation": "Tape retention lock can be configured in two modes. When configured in governance mode,\n AWS accounts with specific IAM permissions are authorized to remove the tape retention lock\n from archived virtual tapes. When configured in compliance mode, the tape retention lock\n cannot be removed by any user, including the root AWS account.
" } }, - "StorageClass": { - "target": "com.amazonaws.storagegateway#TapeStorageClass", + "RetentionLockTimeInDays": { + "target": "com.amazonaws.storagegateway#RetentionLockTimeInDays", "traits": { - "smithy.api#documentation": "The storage class that is associated with the new custom pool. When you use your backup\n application to eject the tape, the tape is archived directly into the storage class (S3\n Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
", - "smithy.api#required": {} + "smithy.api#documentation": "Tape retention lock time is set in days. Tape retention lock can be enabled for up to\n 100 years (36,500 days).
" + } + }, + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", + "traits": { + "smithy.api#documentation": "A list of up to 50 tags that can be assigned to tape pool. Each tag is a key-value\n pair.
\n\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nSet to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
The unique Amazon Resource Name (ARN) that represents the gateway to associate the\n virtual tape with. Use the ListGateways operation to return a list of\n gateways for your account and AWS Region.
", + "smithy.api#required": {} } }, - "Worm": { - "target": "com.amazonaws.storagegateway#Boolean2", + "TapeSizeInBytes": { + "target": "com.amazonaws.storagegateway#TapeSize", "traits": { - "smithy.api#documentation": "Set to TRUE
if the tape you are creating is to be configured as a\n write-once-read-many (WORM) tape.
The size, in bytes, of the virtual tape that you want to create.
\n\nThe size must be aligned by gigabyte (1024*1024*1024 bytes).
\nThe Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted
is true
. Optional.
The barcode that you want to assign to the tape.
\n\nBarcodes cannot be reused. This includes barcodes used for tapes that have been\n deleted.
\nThe ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.
\n\nValid Values: GLACIER
| DEEP_ARCHIVE
\n
Set to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
The barcode that you want to assign to the tape.
\n\nBarcodes cannot be reused. This includes barcodes used for tapes that have been\n deleted.
\nThe Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted
is true
. Optional.
A list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each\n tag is a key-value pair.
\n\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nThe ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Deep Archive) that corresponds to the pool.
\n\nValid Values: GLACIER
| DEEP_ARCHIVE
\n
The unique Amazon Resource Name (ARN) that represents the gateway to associate the\n virtual tape with. Use the ListGateways operation to return a list of\n gateways for your account and AWS Region.
", - "smithy.api#required": {} + "smithy.api#documentation": "Set to TRUE
if the tape you are creating is to be configured as a\n write-once-read-many (WORM) tape.
The size, in bytes, of the virtual tape that you want to create.
\n\nThe size must be aligned by gigabyte (1024*1024*1024 bytes).
\nA list of up to 50 tags that can be assigned to a virtual tape that has a barcode. Each\n tag is a key-value pair.
\n\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nA unique identifier that you use to retry a request. If you retry a request, use the\n same ClientToken
you specified in the initial request.
Using the same ClientToken
prevents creating the tape multiple\n times.
The size, in bytes, of the virtual tapes that you want to create.
\n\nThe size must be aligned by gigabyte (1024*1024*1024 bytes).
\nSet to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
A unique identifier that you use to retry a request. If you retry a request, use the\n same ClientToken
you specified in the initial request.
Using the same ClientToken
prevents creating the tape multiple\n times.
A list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value\n pair.
\n\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nThe number of virtual tapes that you want to create.
", + "smithy.api#required": {} } }, - "Worm": { - "target": "com.amazonaws.storagegateway#Boolean2", + "TapeBarcodePrefix": { + "target": "com.amazonaws.storagegateway#TapeBarcodePrefix", "traits": { - "smithy.api#documentation": "Set to TRUE
if the tape you are creating is to be configured as a\n write-once-read-many (WORM) tape.
A prefix that you append to the barcode of the virtual tape you are creating. This\n prefix makes the barcode unique.
\n\nThe prefix must be 1 to 4 characters in length and must be one of the uppercase\n letters from A to Z.
\nThe ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
\n\nValid Values: GLACIER
| DEEP_ARCHIVE
\n
Set to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted
is true
. Optional.
The number of virtual tapes that you want to create.
", - "smithy.api#required": {} + "smithy.api#documentation": "The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
\n\nValid Values: GLACIER
| DEEP_ARCHIVE
\n
The size, in bytes, of the virtual tapes that you want to create.
\n\nThe size must be aligned by gigabyte (1024*1024*1024 bytes).
\nSet to TRUE
if the tape you are creating is to be configured as a\n write-once-read-many (WORM) tape.
A prefix that you append to the barcode of the virtual tape you are creating. This\n prefix makes the barcode unique.
\n\nThe prefix must be 1 to 4 characters in length and must be one of the uppercase\n letters from A to Z.
\nA list of up to 50 tags that can be assigned to a virtual tape. Each tag is a key-value\n pair.
\n\nValid characters for key and value are letters, spaces, and numbers representable in\n UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length\n of a tag's key is 128 characters, and the maximum length for a tag's value is\n 256.
\nSet to TRUE
to delete an archived tape that belongs to a custom pool with\n tape retention lock. Only archived tapes with tape retention lock set to\n governance
can be deleted. Archived tapes with tape retention lock set to\n compliance
can't be deleted.
The Amazon Resource Name (ARN) of the virtual tape to delete from the virtual tape shelf\n (VTS).
", "smithy.api#required": {} } + }, + "BypassGovernanceRetention": { + "target": "com.amazonaws.storagegateway#Boolean2", + "traits": { + "smithy.api#documentation": "Set to TRUE
to delete an archived tape that belongs to a custom pool with\n tape retention lock. Only archived tapes with tape retention lock set to\n governance
can be deleted. Archived tapes with tape retention lock set to\n compliance
can't be deleted.
Set to TRUE
to delete an archived tape that belongs to a custom pool with\n tape retention lock. Only archived tapes with tape retention lock set to\n governance
can be deleted. Archived tapes with tape retention lock set to\n compliance
can't be deleted.
The Amazon Resource Name (ARN) of the virtual tape to delete.
", "smithy.api#required": {} } + }, + "BypassGovernanceRetention": { + "target": "com.amazonaws.storagegateway#Boolean2", + "traits": { + "smithy.api#documentation": "Set to TRUE
to delete an archived tape that belongs to a custom pool with\n tape retention lock. Only archived tapes with tape retention lock set to\n governance
can be deleted. Archived tapes with tape retention lock set to\n compliance
can't be deleted.
The average download bandwidth rate limit in bits per second. This field does not appear\n in the response if the download rate limit is not set.
" - } + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" }, "AverageUploadRateLimitInBitsPerSec": { "target": "com.amazonaws.storagegateway#BandwidthUploadRateLimit", @@ -2543,14 +2619,62 @@ "smithy.api#documentation": "The average upload bandwidth rate limit in bits per second. This field does not appear\n in the response if the upload rate limit is not set.
" } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" + "AverageDownloadRateLimitInBitsPerSec": { + "target": "com.amazonaws.storagegateway#BandwidthDownloadRateLimit", + "traits": { + "smithy.api#documentation": "The average download bandwidth rate limit in bits per second. This field does not appear\n in the response if the download rate limit is not set.
" + } } }, "traits": { "smithy.api#documentation": "A JSON object containing the following fields:
" } }, + "com.amazonaws.storagegateway#DescribeBandwidthRateLimitSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.storagegateway#DescribeBandwidthRateLimitScheduleInput" + }, + "output": { + "target": "com.amazonaws.storagegateway#DescribeBandwidthRateLimitScheduleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.storagegateway#InternalServerError" + }, + { + "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" + } + ], + "traits": { + "smithy.api#documentation": "\n Returns information about the bandwidth rate limit schedule of a gateway. By default, gateways do \n not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect. This \n operation is supported only in the volume and tape gateway types.\n
\n \nThis operation returns information about a gateway's bandwidth rate limit schedule. A bandwidth\n rate limit schedule consists of one or more bandwidth rate limit intervals. A bandwidth rate limit\n interval defines a period of time on one or more days of the week, during which bandwidth rate \n limits are specified for uploading, downloading, or both. \n
\n \n\n A bandwidth rate limit interval consists of one or more days of the week, a start hour and minute, \n an ending hour and minute, and bandwidth rate limits for uploading and downloading\n
\n \n\n If no bandwidth rate limit schedule intervals are set for the gateway, this operation returns an \n empty response. To specify which gateway to describe, use the Amazon Resource Name (ARN)\n of the gateway in your request.
" + } + }, + "com.amazonaws.storagegateway#DescribeBandwidthRateLimitScheduleInput": { + "type": "structure", + "members": { + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", + "traits": { + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.storagegateway#DescribeBandwidthRateLimitScheduleOutput": { + "type": "structure", + "members": { + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" + }, + "BandwidthRateLimitIntervals": { + "target": "com.amazonaws.storagegateway#BandwidthRateLimitIntervals", + "traits": { + "smithy.api#documentation": "\n An array that contains the bandwidth rate limit intervals for a tape or volume gateway.\n
" + } + } + } + }, "com.amazonaws.storagegateway#DescribeCache": { "type": "operation", "input": { @@ -2585,22 +2709,25 @@ "com.amazonaws.storagegateway#DescribeCacheOutput": { "type": "structure", "members": { - "CacheUsedPercentage": { - "target": "com.amazonaws.storagegateway#double", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" + }, + "DiskIds": { + "target": "com.amazonaws.storagegateway#DiskIds", "traits": { - "smithy.api#documentation": "Percent use of the gateway's cache storage. This metric applies only to the\n gateway-cached volume setup. The sample is taken at the end of the reporting period.
" + "smithy.api#documentation": "An array of strings that identify disks that are to be configured as working storage.\n Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs\n from the ListLocalDisks API.
" } }, - "CacheHitPercentage": { - "target": "com.amazonaws.storagegateway#double", + "CacheAllocatedInBytes": { + "target": "com.amazonaws.storagegateway#long", "traits": { - "smithy.api#documentation": "Percent of application read operations from the file shares that are served from cache.\n The sample is taken at the end of the reporting period.
" + "smithy.api#documentation": "The amount of cache in bytes allocated to a gateway.
" } }, - "CacheMissPercentage": { + "CacheUsedPercentage": { "target": "com.amazonaws.storagegateway#double", "traits": { - "smithy.api#documentation": "Percent of application read operations from the file shares that are not served from\n cache. The sample is taken at the end of the reporting period.
" + "smithy.api#documentation": "Percent use of the gateway's cache storage. This metric applies only to the\n gateway-cached volume setup. The sample is taken at the end of the reporting period.
" } }, "CacheDirtyPercentage": { @@ -2609,19 +2736,16 @@ "smithy.api#documentation": "The file share's contribution to the overall percentage of the gateway's cache\n that has not been persisted to AWS. The sample is taken at the end of the reporting\n period.
" } }, - "CacheAllocatedInBytes": { - "target": "com.amazonaws.storagegateway#long", + "CacheHitPercentage": { + "target": "com.amazonaws.storagegateway#double", "traits": { - "smithy.api#documentation": "The amount of cache in bytes allocated to a gateway.
" + "smithy.api#documentation": "Percent of application read operations from the file shares that are served from cache.\n The sample is taken at the end of the reporting period.
" } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" - }, - "DiskIds": { - "target": "com.amazonaws.storagegateway#DiskIds", + "CacheMissPercentage": { + "target": "com.amazonaws.storagegateway#double", "traits": { - "smithy.api#documentation": "An array of strings that identify disks that are to be configured as working storage.\n Each string has a minimum length of 1 and maximum length of 300. You can get the disk IDs\n from the ListLocalDisks API.
" + "smithy.api#documentation": "Percent of application read operations from the file shares that are not served from\n cache. The sample is taken at the end of the reporting period.
" } } } @@ -2758,16 +2882,13 @@ "com.amazonaws.storagegateway#DescribeGatewayInformationOutput": { "type": "structure", "members": { - "EndpointType": { - "target": "com.amazonaws.storagegateway#EndpointType", - "traits": { - "smithy.api#documentation": "The type of endpoint for your gateway.
\n\nValid Values: STANDARD
| FIPS
\n
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to\n monitor events in the gateway.
" + "smithy.api#documentation": "The unique identifier assigned to your gateway during activation. This ID becomes part\n of the gateway Amazon Resource Name (ARN), which you use as input for other\n operations.
" } }, "GatewayName": { @@ -2776,10 +2897,10 @@ "smithy.api#documentation": "The name you configured for your gateway.
" } }, - "Ec2InstanceId": { - "target": "com.amazonaws.storagegateway#Ec2InstanceId", + "GatewayTimezone": { + "target": "com.amazonaws.storagegateway#GatewayTimezone", "traits": { - "smithy.api#documentation": "The ID of the Amazon EC2 instance that was used to launch the gateway.
" + "smithy.api#documentation": "A value that indicates the time zone configured for the gateway.
" } }, "GatewayState": { @@ -2788,40 +2909,34 @@ "smithy.api#documentation": "A value that indicates the operating state of the gateway.
" } }, - "GatewayTimezone": { - "target": "com.amazonaws.storagegateway#GatewayTimezone", - "traits": { - "smithy.api#documentation": "A value that indicates the time zone configured for the gateway.
" - } - }, "GatewayNetworkInterfaces": { "target": "com.amazonaws.storagegateway#GatewayNetworkInterfaces", "traits": { "smithy.api#documentation": "A NetworkInterface array that contains descriptions of the gateway\n network interfaces.
" } }, - "SoftwareUpdatesEndDate": { - "target": "com.amazonaws.storagegateway#SoftwareUpdatesEndDate", + "GatewayType": { + "target": "com.amazonaws.storagegateway#GatewayType", "traits": { - "smithy.api#documentation": "Date after which this gateway will not receive software updates for new features.
" + "smithy.api#documentation": "The type of the gateway.
" } }, - "DeprecationDate": { - "target": "com.amazonaws.storagegateway#DeprecationDate", + "NextUpdateAvailabilityDate": { + "target": "com.amazonaws.storagegateway#NextUpdateAvailabilityDate", "traits": { - "smithy.api#documentation": "Date after which this gateway will not receive software updates for new features and bug\n fixes.
" + "smithy.api#documentation": "The date on which an update to the gateway is available. This date is in the time zone\n of the gateway. If the gateway is not available for an update this field is not returned in\n the response.
" } }, - "VPCEndpoint": { - "target": "com.amazonaws.storagegateway#string", + "LastSoftwareUpdate": { + "target": "com.amazonaws.storagegateway#LastSoftwareUpdate", "traits": { - "smithy.api#documentation": "The configuration settings for the virtual private cloud (VPC) endpoint for your\n gateway.
" + "smithy.api#documentation": "The date on which the last software update was applied to the gateway. If the gateway\n has never been updated, this field does not return a value in the response.
" } }, - "HostEnvironment": { - "target": "com.amazonaws.storagegateway#HostEnvironment", + "Ec2InstanceId": { + "target": "com.amazonaws.storagegateway#Ec2InstanceId", "traits": { - "smithy.api#documentation": "The type of hypervisor environment used by the host.
" + "smithy.api#documentation": "The ID of the Amazon EC2 instance that was used to launch the gateway.
" } }, "Ec2InstanceRegion": { @@ -2830,37 +2945,46 @@ "smithy.api#documentation": "The AWS Region where the Amazon EC2 instance is located.
" } }, - "GatewayType": { - "target": "com.amazonaws.storagegateway#GatewayType", + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", "traits": { - "smithy.api#documentation": "The type of the gateway.
" + "smithy.api#documentation": "A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each\n tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all\n tags using the ListTagsForResource
API operation.
The configuration settings for the virtual private cloud (VPC) endpoint for your\n gateway.
" + } + }, + "CloudWatchLogGroupARN": { + "target": "com.amazonaws.storagegateway#CloudWatchLogGroupARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to\n monitor events in the gateway.
" + } }, - "GatewayId": { - "target": "com.amazonaws.storagegateway#GatewayId", + "HostEnvironment": { + "target": "com.amazonaws.storagegateway#HostEnvironment", "traits": { - "smithy.api#documentation": "The unique identifier assigned to your gateway during activation. This ID becomes part\n of the gateway Amazon Resource Name (ARN), which you use as input for other\n operations.
" + "smithy.api#documentation": "The type of hypervisor environment used by the host.
" } }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", + "EndpointType": { + "target": "com.amazonaws.storagegateway#EndpointType", "traits": { - "smithy.api#documentation": "A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each\n tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all\n tags using the ListTagsForResource
API operation.
The type of endpoint for your gateway.
\n\nValid Values: STANDARD
| FIPS
\n
The date on which the last software update was applied to the gateway. If the gateway\n has never been updated, this field does not return a value in the response.
" + "smithy.api#documentation": "Date after which this gateway will not receive software updates for new features.
" } }, - "NextUpdateAvailabilityDate": { - "target": "com.amazonaws.storagegateway#NextUpdateAvailabilityDate", + "DeprecationDate": { + "target": "com.amazonaws.storagegateway#DeprecationDate", "traits": { - "smithy.api#documentation": "The date on which an update to the gateway is available. This date is in the time zone\n of the gateway. If the gateway is not available for an update this field is not returned in\n the response.
" + "smithy.api#documentation": "Date after which this gateway will not receive software updates for new features and bug\n fixes.
" } } }, @@ -2905,21 +3029,9 @@ "com.amazonaws.storagegateway#DescribeMaintenanceStartTimeOutput": { "type": "structure", "members": { - "Timezone": { - "target": "com.amazonaws.storagegateway#GatewayTimezone", - "traits": { - "smithy.api#documentation": "A value that indicates the time zone that is set for the gateway. The start time and day\n of week specified should be in the time zone of the gateway.
" - } - }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, - "DayOfMonth": { - "target": "com.amazonaws.storagegateway#DayOfMonth", - "traits": { - "smithy.api#documentation": "The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month and 28 represents the\n last day of the month.
" - } - }, "HourOfDay": { "target": "com.amazonaws.storagegateway#HourOfDay", "traits": { @@ -2937,6 +3049,18 @@ "traits": { "smithy.api#documentation": "An ordinal number between 0 and 6 that represents the day of the week, where 0\n represents Sunday and 6 represents Saturday. The day of week is in the time zone of the\n gateway.
" } + }, + "DayOfMonth": { + "target": "com.amazonaws.storagegateway#DayOfMonth", + "traits": { + "smithy.api#documentation": "The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month and 28 represents the\n last day of the month.
" + } + }, + "Timezone": { + "target": "com.amazonaws.storagegateway#GatewayTimezone", + "traits": { + "smithy.api#documentation": "A value that indicates the time zone that is set for the gateway. The start time and day\n of week specified should be in the time zone of the gateway.
" + } } }, "traits": { @@ -3075,33 +3199,33 @@ "com.amazonaws.storagegateway#DescribeSMBSettingsOutput": { "type": "structure", "members": { - "SMBSecurityStrategy": { - "target": "com.amazonaws.storagegateway#SMBSecurityStrategy", - "traits": { - "smithy.api#documentation": "The type of security strategy that was specified for file gateway.
\n\n\n ClientSpecified
: If you use this option, requests are established\n based on what is negotiated by the client. This option is recommended when you want\n to maximize compatibility across different clients in your environment.
\n MandatorySigning
: If you use this option, file gateway only allows\n connections from SMBv2 or SMBv3 clients that have signing enabled. This option works\n with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
\n MandatoryEncryption
: If you use this option, file gateway only allows\n connections from SMBv3 clients that have encryption enabled. This option is highly\n recommended for environments that handle sensitive data. This option works with SMB\n clients on Microsoft Windows 8, Windows Server 2012 or newer.
Indicates the status of a gateway that is a member of the Active Directory\n domain.
\n\n\n ACCESS_DENIED
: Indicates that the JoinDomain
operation\n failed due to an authentication error.
\n DETACHED
: Indicates that gateway is not joined to a domain.
\n JOINED
: Indicates that the gateway has successfully joined a\n domain.
\n JOINING
: Indicates that a JoinDomain
operation is in\n progress.
\n NETWORK_ERROR
: Indicates that JoinDomain
operation\n failed due to a network or connectivity error.
\n TIMEOUT
: Indicates that the JoinDomain
operation failed\n because the operation didn't complete within the allotted time.
\n UNKNOWN_ERROR
: Indicates that the JoinDomain
operation\n failed due to another type of error.
The name of the domain that the gateway is joined to.
" } }, + "ActiveDirectoryStatus": { + "target": "com.amazonaws.storagegateway#ActiveDirectoryStatus", + "traits": { + "smithy.api#documentation": "Indicates the status of a gateway that is a member of the Active Directory\n domain.
\n\n\n ACCESS_DENIED
: Indicates that the JoinDomain
operation\n failed due to an authentication error.
\n DETACHED
: Indicates that gateway is not joined to a domain.
\n JOINED
: Indicates that the gateway has successfully joined a\n domain.
\n JOINING
: Indicates that a JoinDomain
operation is in\n progress.
\n NETWORK_ERROR
: Indicates that JoinDomain
operation\n failed due to a network or connectivity error.
\n TIMEOUT
: Indicates that the JoinDomain
operation failed\n because the operation didn't complete within the allotted time.
\n UNKNOWN_ERROR
: Indicates that the JoinDomain
operation\n failed due to another type of error.
This value is true
if a password for the guest user smbguest
\n is set, otherwise false
.
Valid Values: true
| false
\n
The type of security strategy that was specified for file gateway.
\n\n\n ClientSpecified
: If you use this option, requests are established\n based on what is negotiated by the client. This option is recommended when you want\n to maximize compatibility across different clients in your environment.
\n MandatorySigning
: If you use this option, file gateway only allows\n connections from SMBv2 or SMBv3 clients that have signing enabled. This option works\n with SMB clients on Microsoft Windows Vista, Windows Server 2008 or newer.
\n MandatoryEncryption
: If you use this option, file gateway only allows\n connections from SMBv3 clients that have encryption enabled. This option is highly\n recommended for environments that handle sensitive data. This option works with SMB\n clients on Microsoft Windows 8, Windows Server 2012 or newer.
The hour of the day at which the snapshot schedule begins represented as\n hh, where hh is the hour (0 to 23). The hour\n of the day is in the time zone of the gateway.
" - } - }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", - "traits": { - "smithy.api#documentation": "A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key\n name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can\n view all tags using the ListTagsForResource
API operation.
A value that indicates the time zone of the gateway.
" - } - }, "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume that was specified in the request.
" } }, + "StartAt": { + "target": "com.amazonaws.storagegateway#HourOfDay", + "traits": { + "smithy.api#documentation": "The hour of the day at which the snapshot schedule begins represented as\n hh, where hh is the hour (0 to 23). The hour\n of the day is in the time zone of the gateway.
" + } + }, "RecurrenceInHours": { "target": "com.amazonaws.storagegateway#RecurrenceInHours", "traits": { @@ -3183,6 +3295,18 @@ "traits": { "smithy.api#documentation": "The snapshot description.
" } + }, + "Timezone": { + "target": "com.amazonaws.storagegateway#GatewayTimezone", + "traits": { + "smithy.api#documentation": "A value that indicates the time zone of the gateway.
" + } + }, + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", + "traits": { + "smithy.api#documentation": "A list of up to 50 tags assigned to the snapshot schedule, sorted alphabetically by key\n name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can\n view all tags using the ListTagsForResource
API operation.
Specifies that the number of virtual tapes described be limited to the specified\n number.
" + "smithy.api#documentation": "Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual\n tapes you want to describe.
" } }, "Marker": { @@ -3273,10 +3397,10 @@ "smithy.api#documentation": "An opaque string that indicates the position at which to begin describing virtual\n tapes.
" } }, - "TapeARNs": { - "target": "com.amazonaws.storagegateway#TapeARNs", + "Limit": { + "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { - "smithy.api#documentation": "Specifies one or more unique Amazon Resource Names (ARNs) that represent the virtual\n tapes you want to describe.
" + "smithy.api#documentation": "Specifies that the number of virtual tapes described be limited to the specified\n number.
" } } }, @@ -3287,17 +3411,17 @@ "com.amazonaws.storagegateway#DescribeTapeArchivesOutput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.storagegateway#Marker", - "traits": { - "smithy.api#documentation": "An opaque string that indicates the position at which the virtual tapes that were\n fetched for description ended. Use this marker in your next request to fetch the next set\n of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to\n describe, this field does not appear in the response.
" - } - }, "TapeArchives": { "target": "com.amazonaws.storagegateway#TapeArchives", "traits": { "smithy.api#documentation": "An array of virtual tape objects in the virtual tape shelf (VTS). The description\n includes of the Amazon Resource Name (ARN) of the virtual tapes. The information returned\n includes the Amazon Resource Names (ARNs) of the tapes, size of the tapes, status of the\n tapes, progress of the description, and tape barcode.
" } + }, + "Marker": { + "target": "com.amazonaws.storagegateway#Marker", + "traits": { + "smithy.api#documentation": "An opaque string that indicates the position at which the virtual tapes that were\n fetched for description ended. Use this marker in your next request to fetch the next set\n of virtual tapes in the virtual tape shelf (VTS). If there are no more virtual tapes to\n describe, this field does not appear in the response.
" + } } }, "traits": { @@ -3333,10 +3457,10 @@ "com.amazonaws.storagegateway#DescribeTapeRecoveryPointsInput": { "type": "structure", "members": { - "Limit": { - "target": "com.amazonaws.storagegateway#PositiveIntObject", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "Specifies that the number of virtual tape recovery points that are described be limited\n to the specified number.
" + "smithy.api#required": {} } }, "Marker": { @@ -3345,10 +3469,10 @@ "smithy.api#documentation": "An opaque string that indicates the position at which to begin describing the virtual\n tape recovery points.
" } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "Limit": { + "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { - "smithy.api#required": {} + "smithy.api#documentation": "Specifies that the number of virtual tape recovery points that are described be limited\n to the specified number.
" } } }, @@ -3359,11 +3483,8 @@ "com.amazonaws.storagegateway#DescribeTapeRecoveryPointsOutput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.storagegateway#Marker", - "traits": { - "smithy.api#documentation": "An opaque string that indicates the position at which the virtual tape recovery points\n that were listed for description ended.
\n\nUse this marker in your next request to list the next set of virtual tape recovery\n points in the list. If there are no more recovery points to describe, this field does not\n appear in the response.
" - } + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" }, "TapeRecoveryPointInfos": { "target": "com.amazonaws.storagegateway#TapeRecoveryPointInfos", @@ -3371,8 +3492,11 @@ "smithy.api#documentation": "An array of TapeRecoveryPointInfos that are available for the specified gateway.
" } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" + "Marker": { + "target": "com.amazonaws.storagegateway#Marker", + "traits": { + "smithy.api#documentation": "An opaque string that indicates the position at which the virtual tape recovery points\n that were listed for description ended.
\n\nUse this marker in your next request to list the next set of virtual tape recovery\n points in the list. If there are no more recovery points to describe, this field does not\n appear in the response.
" + } } }, "traits": { @@ -3414,12 +3538,6 @@ "smithy.api#required": {} } }, - "Limit": { - "target": "com.amazonaws.storagegateway#PositiveIntObject", - "traits": { - "smithy.api#documentation": "Specifies that the number of virtual tapes described be limited to the specified\n number.
\n\nAmazon Web Services may impose its own limit, if this field is not set.
\nA marker value, obtained in a previous call to DescribeTapes
. This marker\n indicates which page of results to retrieve.
If not specified, the first page of results is retrieved.
" } + }, + "Limit": { + "target": "com.amazonaws.storagegateway#PositiveIntObject", + "traits": { + "smithy.api#documentation": "Specifies that the number of virtual tapes described be limited to the specified\n number.
\n\nAmazon Web Services may impose its own limit, if this field is not set.
\nThe total number of bytes allocated in the gateway's as upload buffer.
" - } - }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, @@ -3511,6 +3629,12 @@ "traits": { "smithy.api#documentation": "The total number of bytes being used in the gateway's upload buffer.
" } + }, + "UploadBufferAllocatedInBytes": { + "target": "com.amazonaws.storagegateway#long", + "traits": { + "smithy.api#documentation": "The total number of bytes allocated in the gateway's as upload buffer.
" + } } } }, @@ -3543,10 +3667,10 @@ "com.amazonaws.storagegateway#DescribeVTLDevicesInput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.storagegateway#Marker", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "An opaque string that indicates the position at which to begin describing the VTL\n devices.
" + "smithy.api#required": {} } }, "VTLDeviceARNs": { @@ -3555,10 +3679,10 @@ "smithy.api#documentation": "An array of strings, where each string represents the Amazon Resource Name (ARN) of a\n VTL device.
\n\nAll of the specified VTL devices must be from the same gateway. If no VTL devices are\n specified, the result will contain all devices on the specified gateway.
\nAn opaque string that indicates the position at which to begin describing the VTL\n devices.
" } }, "Limit": { @@ -3575,6 +3699,9 @@ "com.amazonaws.storagegateway#DescribeVTLDevicesOutput": { "type": "structure", "members": { + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" + }, "VTLDevices": { "target": "com.amazonaws.storagegateway#VTLDevices", "traits": { @@ -3586,9 +3713,6 @@ "traits": { "smithy.api#documentation": "An opaque string that indicates the position at which the VTL devices that were fetched\n for description ended. Use the marker in your next request to fetch the next set of VTL\n devices in the list. If there are no more VTL devices to describe, this field does not\n appear in the response.
" } - }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { @@ -3632,10 +3756,13 @@ "com.amazonaws.storagegateway#DescribeWorkingStorageOutput": { "type": "structure", "members": { - "WorkingStorageAllocatedInBytes": { - "target": "com.amazonaws.storagegateway#long", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" + }, + "DiskIds": { + "target": "com.amazonaws.storagegateway#DiskIds", "traits": { - "smithy.api#documentation": "The total working storage in bytes allocated for the gateway. If no working storage is\n configured for the gateway, this field returns 0.
" + "smithy.api#documentation": "An array of the gateway's local disk IDs that are configured as working storage.\n Each local disk ID is specified as a string (minimum length of 1 and maximum length of\n 300). If no local disks are configured as working storage, then the DiskIds array is\n empty.
" } }, "WorkingStorageUsedInBytes": { @@ -3644,14 +3771,11 @@ "smithy.api#documentation": "The total working storage in bytes in use by the gateway. If no working storage is\n configured for the gateway, this field returns 0.
" } }, - "DiskIds": { - "target": "com.amazonaws.storagegateway#DiskIds", + "WorkingStorageAllocatedInBytes": { + "target": "com.amazonaws.storagegateway#long", "traits": { - "smithy.api#documentation": "An array of the gateway's local disk IDs that are configured as working storage.\n Each local disk ID is specified as a string (minimum length of 1 and maximum length of\n 300). If no local disks are configured as working storage, then the DiskIds array is\n empty.
" + "smithy.api#documentation": "The total working storage in bytes allocated for the gateway. If no working storage is\n configured for the gateway, this field returns 0.
" } - }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { @@ -3734,28 +3858,28 @@ "com.amazonaws.storagegateway#DeviceiSCSIAttributes": { "type": "structure", "members": { - "ChapEnabled": { - "target": "com.amazonaws.storagegateway#Boolean2", - "traits": { - "smithy.api#documentation": "Indicates whether mutual CHAP is enabled for the iSCSI target.
" - } - }, "TargetARN": { "target": "com.amazonaws.storagegateway#TargetARN", "traits": { "smithy.api#documentation": "Specifies the unique Amazon Resource Name (ARN) that encodes the iSCSI qualified\n name(iqn) of a tape drive or media changer target.
" } }, + "NetworkInterfaceId": { + "target": "com.amazonaws.storagegateway#NetworkInterfaceId", + "traits": { + "smithy.api#documentation": "The network interface identifier of the VTL device.
" + } + }, "NetworkInterfacePort": { "target": "com.amazonaws.storagegateway#integer", "traits": { "smithy.api#documentation": "The port used to communicate with iSCSI VTL device targets.
" } }, - "NetworkInterfaceId": { - "target": "com.amazonaws.storagegateway#NetworkInterfaceId", + "ChapEnabled": { + "target": "com.amazonaws.storagegateway#Boolean2", "traits": { - "smithy.api#documentation": "The network interface identifier of the VTL device.
" + "smithy.api#documentation": "Indicates whether mutual CHAP is enabled for the iSCSI target.
" } } }, @@ -3814,10 +3938,28 @@ "com.amazonaws.storagegateway#Disk": { "type": "structure", "members": { + "DiskId": { + "target": "com.amazonaws.storagegateway#DiskId", + "traits": { + "smithy.api#documentation": "The unique device ID or other distinguishing data that identifies a local disk.
" + } + }, + "DiskPath": { + "target": "com.amazonaws.storagegateway#string", + "traits": { + "smithy.api#documentation": "The path of a local disk in the gateway virtual machine (VM).
" + } + }, "DiskNode": { "target": "com.amazonaws.storagegateway#string", "traits": { - "smithy.api#documentation": "The device node of a local disk as assigned by the virtualization environment.
" + "smithy.api#documentation": "The device node of a local disk as assigned by the virtualization environment.
" + } + }, + "DiskStatus": { + "target": "com.amazonaws.storagegateway#string", + "traits": { + "smithy.api#documentation": "A value that represents the status of a local disk.
" } }, "DiskSizeInBytes": { @@ -3826,35 +3968,17 @@ "smithy.api#documentation": "The local disk size in bytes.
" } }, - "DiskId": { - "target": "com.amazonaws.storagegateway#DiskId", - "traits": { - "smithy.api#documentation": "The unique device ID or other distinguishing data that identifies a local disk.
" - } - }, - "DiskAttributeList": { - "target": "com.amazonaws.storagegateway#DiskAttributeList" - }, - "DiskAllocationResource": { - "target": "com.amazonaws.storagegateway#string", - "traits": { - "smithy.api#documentation": "The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in\n the response if the local disk is not defined as an iSCSI target. The format of this field\n is targetIqn::LUNNumber::region-volumeId.
" - } - }, "DiskAllocationType": { "target": "com.amazonaws.storagegateway#DiskAllocationType" }, - "DiskStatus": { + "DiskAllocationResource": { "target": "com.amazonaws.storagegateway#string", "traits": { - "smithy.api#documentation": "A value that represents the status of a local disk.
" + "smithy.api#documentation": "The iSCSI qualified name (IQN) that is defined for a disk. This field is not included in\n the response if the local disk is not defined as an iSCSI target. The format of this field\n is targetIqn::LUNNumber::region-volumeId.
" } }, - "DiskPath": { - "target": "com.amazonaws.storagegateway#string", - "traits": { - "smithy.api#documentation": "The path of a local disk in the gateway virtual machine (VM).
" - } + "DiskAttributeList": { + "target": "com.amazonaws.storagegateway#DiskAttributeList" } }, "traits": { @@ -4207,11 +4331,8 @@ "com.amazonaws.storagegateway#FileShareInfo": { "type": "structure", "members": { - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" - }, - "FileShareStatus": { - "target": "com.amazonaws.storagegateway#FileShareStatus" + "FileShareType": { + "target": "com.amazonaws.storagegateway#FileShareType" }, "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN" @@ -4219,8 +4340,11 @@ "FileShareId": { "target": "com.amazonaws.storagegateway#FileShareId" }, - "FileShareType": { - "target": "com.amazonaws.storagegateway#FileShareType" + "FileShareStatus": { + "target": "com.amazonaws.storagegateway#FileShareStatus" + }, + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { @@ -4330,16 +4454,22 @@ "com.amazonaws.storagegateway#GatewayInfo": { "type": "structure", "members": { + "GatewayId": { + "target": "com.amazonaws.storagegateway#GatewayId", + "traits": { + "smithy.api#documentation": "The unique identifier assigned to your gateway during activation. This ID becomes part\n of the gateway Amazon Resource Name (ARN), which you use as input for other\n operations.
" + } + }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and AWS Region.
" } }, - "Ec2InstanceId": { - "target": "com.amazonaws.storagegateway#Ec2InstanceId", + "GatewayType": { + "target": "com.amazonaws.storagegateway#GatewayType", "traits": { - "smithy.api#documentation": "The ID of the Amazon EC2 instance that was used to launch the gateway.
" + "smithy.api#documentation": "The type of the gateway.
" } }, "GatewayOperationalState": { @@ -4348,28 +4478,22 @@ "smithy.api#documentation": "The state of the gateway.
\n\nValid Values: DISABLED
| ACTIVE
\n
The unique identifier assigned to your gateway during activation. This ID becomes part\n of the gateway Amazon Resource Name (ARN), which you use as input for other\n operations.
" - } - }, "GatewayName": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "The name of the gateway.
" } }, - "Ec2InstanceRegion": { - "target": "com.amazonaws.storagegateway#Ec2InstanceRegion", + "Ec2InstanceId": { + "target": "com.amazonaws.storagegateway#Ec2InstanceId", "traits": { - "smithy.api#documentation": "The AWS Region where the Amazon EC2 instance is located.
" + "smithy.api#documentation": "The ID of the Amazon EC2 instance that was used to launch the gateway.
" } }, - "GatewayType": { - "target": "com.amazonaws.storagegateway#GatewayType", + "Ec2InstanceRegion": { + "target": "com.amazonaws.storagegateway#Ec2InstanceRegion", "traits": { - "smithy.api#documentation": "The type of the gateway.
" + "smithy.api#documentation": "The AWS Region where the Amazon EC2 instance is located.
" } } }, @@ -4508,17 +4632,17 @@ "com.amazonaws.storagegateway#InternalServerError": { "type": "structure", "members": { - "error": { - "target": "com.amazonaws.storagegateway#StorageGatewayError", - "traits": { - "smithy.api#documentation": "A StorageGatewayError that provides more information about the cause\n of the error.
" - } - }, "message": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "A human-readable message describing the error that occurred.
" } + }, + "error": { + "target": "com.amazonaws.storagegateway#StorageGatewayError", + "traits": { + "smithy.api#documentation": "A StorageGatewayError that provides more information about the cause\n of the error.
" + } } }, "traits": { @@ -4530,17 +4654,17 @@ "com.amazonaws.storagegateway#InvalidGatewayRequestException": { "type": "structure", "members": { - "error": { - "target": "com.amazonaws.storagegateway#StorageGatewayError", - "traits": { - "smithy.api#documentation": "A StorageGatewayError that provides more detail about the cause of the\n error.
" - } - }, "message": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "A human-readable message describing the error that occurred.
" } + }, + "error": { + "target": "com.amazonaws.storagegateway#StorageGatewayError", + "traits": { + "smithy.api#documentation": "A StorageGatewayError that provides more detail about the cause of the\n error.
" + } } }, "traits": { @@ -4582,18 +4706,6 @@ "com.amazonaws.storagegateway#JoinDomainInput": { "type": "structure", "members": { - "TimeoutInSeconds": { - "target": "com.amazonaws.storagegateway#TimeoutInSeconds", - "traits": { - "smithy.api#documentation": "Specifies the time in seconds, in which the JoinDomain
operation must\n complete. The default is 20 seconds.
The organizational unit (OU) is a container in an Active Directory that can hold users,\n groups, computers, and other OUs and this parameter specifies the OU that the gateway will\n join within the AD domain.
" - } - }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { @@ -4601,24 +4713,29 @@ "smithy.api#required": {} } }, - "Password": { - "target": "com.amazonaws.storagegateway#DomainUserPassword", + "DomainName": { + "target": "com.amazonaws.storagegateway#DomainName", "traits": { - "smithy.api#documentation": "Sets the password of the user who has permission to add the gateway to the Active\n Directory domain.
", + "smithy.api#documentation": "The name of the domain that you want the gateway to join.
", "smithy.api#required": {} } }, + "OrganizationalUnit": { + "target": "com.amazonaws.storagegateway#OrganizationalUnit", + "traits": { + "smithy.api#documentation": "The organizational unit (OU) is a container in an Active Directory that can hold users,\n groups, computers, and other OUs and this parameter specifies the OU that the gateway will\n join within the AD domain.
" + } + }, "DomainControllers": { "target": "com.amazonaws.storagegateway#Hosts", "traits": { "smithy.api#documentation": "List of IPv4 addresses, NetBIOS names, or host names of your domain server. If you need\n to specify the port number include it after the colon (“:”). For example,\n mydc.mydomain.com:389
.
The name of the domain that you want the gateway to join.
", - "smithy.api#required": {} + "smithy.api#documentation": "Specifies the time in seconds, in which the JoinDomain
operation must\n complete. The default is 20 seconds.
Sets the user name of user who has permission to add the gateway to the Active Directory\n domain. The domain user account should be enabled to join computers to the domain. For\n example, you can use the domain administrator account or an account with delegated\n permissions to join computers to the domain.
", "smithy.api#required": {} } + }, + "Password": { + "target": "com.amazonaws.storagegateway#DomainUserPassword", + "traits": { + "smithy.api#documentation": "Sets the password of the user who has permission to add the gateway to the Active\n Directory domain.
", + "smithy.api#required": {} + } } }, "traits": { @@ -4741,6 +4865,12 @@ "com.amazonaws.storagegateway#ListFileSharesInput": { "type": "structure", "members": { + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway whose file shares you want to list. If\n this field is not present, all file shares under your account are listed.
" + } + }, "Limit": { "target": "com.amazonaws.storagegateway#PositiveIntObject", "traits": { @@ -4752,12 +4882,6 @@ "traits": { "smithy.api#documentation": "Opaque pagination token returned from a previous ListFileShares operation. If present,\n Marker
specifies where to continue the list from after a previous call to\n ListFileShares. Optional.
The Amazon Resource Name (ARN) of the gateway whose file shares you want to list. If\n this field is not present, all file shares under your account are listed.
" - } } }, "traits": { @@ -4767,16 +4891,16 @@ "com.amazonaws.storagegateway#ListFileSharesOutput": { "type": "structure", "members": { - "NextMarker": { + "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { - "smithy.api#documentation": "If a value is present, there are more file shares to return. In a subsequent request,\n use NextMarker
as the value for Marker
to retrieve the next set\n of file shares.
If the request includes Marker
, the response returns that value in this\n field.
If the request includes Marker
, the response returns that value in this\n field.
If a value is present, there are more file shares to return. In a subsequent request,\n use NextMarker
as the value for Marker
to retrieve the next set\n of file shares.
Specifies that the list of gateways returned be limited to the specified number of\n items.
" - } - }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "An opaque string that indicates the position at which to begin the returned list of\n gateways.
" } + }, + "Limit": { + "target": "com.amazonaws.storagegateway#PositiveIntObject", + "traits": { + "smithy.api#documentation": "Specifies that the list of gateways returned be limited to the specified number of\n items.
" + } } }, "traits": { @@ -4839,17 +4963,17 @@ "com.amazonaws.storagegateway#ListGatewaysOutput": { "type": "structure", "members": { - "Marker": { - "target": "com.amazonaws.storagegateway#Marker", - "traits": { - "smithy.api#documentation": "Use the marker in your next request to fetch the next set of gateways in the list. If\n there are no more gateways to list, this field does not appear in the response.
" - } - }, "Gateways": { "target": "com.amazonaws.storagegateway#Gateways", "traits": { "smithy.api#documentation": "An array of GatewayInfo objects.
" } + }, + "Marker": { + "target": "com.amazonaws.storagegateway#Marker", + "traits": { + "smithy.api#documentation": "Use the marker in your next request to fetch the next set of gateways in the list. If\n there are no more gateways to list, this field does not appear in the response.
" + } } } }, @@ -4937,17 +5061,17 @@ "smithy.api#required": {} } }, - "Limit": { - "target": "com.amazonaws.storagegateway#PositiveIntObject", - "traits": { - "smithy.api#documentation": "Specifies that the list of tags returned be limited to the specified number of\n items.
" - } - }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "An opaque string that indicates the position at which to begin returning the list of\n tags.
" } + }, + "Limit": { + "target": "com.amazonaws.storagegateway#PositiveIntObject", + "traits": { + "smithy.api#documentation": "Specifies that the list of tags returned be limited to the specified number of\n items.
" + } } }, "traits": { @@ -4963,17 +5087,17 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the resource for which you want to list tags.
" } }, - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", - "traits": { - "smithy.api#documentation": "An array that contains the tags for the specified resource.
" - } - }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { "smithy.api#documentation": "An opaque string that indicates the position at which to stop returning the list of\n tags.
" } + }, + "Tags": { + "target": "com.amazonaws.storagegateway#Tags", + "traits": { + "smithy.api#documentation": "An array that contains the tags for the specified resource.
" + } } }, "traits": { @@ -4997,7 +5121,13 @@ } ], "traits": { - "smithy.api#documentation": "Lists custom tape pools. You specify custom tape pools to list by specifying one or more\n custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN,\n the operation lists all custom tape pools.
\n\nThis operation supports pagination. You can optionally specify the Limit
\n parameter in the body to limit the number of tape pools in the response. If the number of\n tape pools returned in the response is truncated, the response includes a\n Marker
element that you can use in your subsequent request to retrieve the\n next set of tape pools.
Lists custom tape pools. You specify custom tape pools to list by specifying one or more\n custom tape pool Amazon Resource Names (ARNs). If you don't specify a custom tape pool ARN,\n the operation lists all custom tape pools.
\n\nThis operation supports pagination. You can optionally specify the Limit
\n parameter in the body to limit the number of tape pools in the response. If the number of\n tape pools returned in the response is truncated, the response includes a\n Marker
element that you can use in your subsequent request to retrieve the\n next set of tape pools.
A string that indicates the position at which to begin the returned list of tape pools.\n Use the marker in your next request to continue pagination of tape pools. If there are no\n more tape pools to list, this element does not appear in the response body.
" - } - }, "PoolInfos": { "target": "com.amazonaws.storagegateway#PoolInfos", "traits": { "smithy.api#documentation": "An array of PoolInfo
objects, where each object describes a single custom\n tape pool. If there are no custom tape pools, the PoolInfos
is an empty array.\n
A string that indicates the position at which to begin the returned list of tape pools.\n Use the marker in your next request to continue pagination of tape pools. If there are no\n more tape pools to list, this element does not appear in the response body.
" + } } } }, @@ -5229,6 +5359,9 @@ "com.amazonaws.storagegateway#ListVolumesInput": { "type": "structure", "members": { + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" + }, "Marker": { "target": "com.amazonaws.storagegateway#Marker", "traits": { @@ -5240,9 +5373,6 @@ "traits": { "smithy.api#documentation": "Specifies that the list of volumes returned be limited to the specified number of\n items.
" } - }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { @@ -5252,11 +5382,8 @@ "com.amazonaws.storagegateway#ListVolumesOutput": { "type": "structure", "members": { - "VolumeInfos": { - "target": "com.amazonaws.storagegateway#VolumeInfos", - "traits": { - "smithy.api#documentation": "An array of VolumeInfo objects, where each object describes an iSCSI\n volume. If no volumes are defined for the gateway, then VolumeInfos
is an\n empty array \"[]\".
Use the marker in your next request to continue pagination of iSCSI volumes. If there\n are no more volumes to list, this field does not appear in the response body.
" } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" + "VolumeInfos": { + "target": "com.amazonaws.storagegateway#VolumeInfos", + "traits": { + "smithy.api#documentation": "An array of VolumeInfo objects, where each object describes an iSCSI\n volume. If no volumes are defined for the gateway, then VolumeInfos
is an\n empty array \"[]\".
The default group ID for the file share (unless the files have another group ID\n specified). The default value is nfsnobody
.
The Unix file mode in the form \"nnnn\". For example, 0666
represents the\n default file mode inside the file share. The default value is 0666
.
The default owner ID for files in the file share (unless the files have another owner ID\n specified). The default value is nfsnobody
.
The Unix directory mode in the form \"nnnn\". For example, 0666
represents\n the default access mode for all directories inside the file share. The default value is\n 0777
.
The Unix file mode in the form \"nnnn\". For example, 0666
represents the\n default file mode inside the file share. The default value is 0666
.
The default group ID for the file share (unless the files have another group ID\n specified). The default value is nfsnobody
.
The Unix directory mode in the form \"nnnn\". For example, 0666
represents\n the default access mode for all directories inside the file share. The default value is\n 0777
.
The default owner ID for files in the file share (unless the files have another owner ID\n specified). The default value is nfsnobody
.
The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
|\n S3_STANDARD_IA
| S3_ONEZONE_IA
\n
Set to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
The name of the file share. Optional.
\n\n\n FileShareName
must be set if an S3 prefix name is set in\n LocationARN
.
The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
|\n S3_STANDARD_IA
| S3_ONEZONE_IA
\n
A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true
, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.
\n RequesterPays
is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.
Valid Values: true
| false
\n
A value that sets the write status of a file share. Set this value to true
\n to set the write status to read-only, otherwise set to false
.
Valid Values: true
| false
\n
A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true
to enable MIME type guessing, otherwise set\n to false
. The default value is true
.
Valid Values: true
| false
\n
The notification policy of the file share.
" - } - }, - "CacheAttributes": { - "target": "com.amazonaws.storagegateway#CacheAttributes", + "RequesterPays": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "Refresh cache information.
" + "smithy.api#documentation": "A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true
, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.
\n RequesterPays
is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.
Valid Values: true
| false
\n
A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key\n name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can\n view all tags using the ListTagsForResource
API operation.
The name of the file share. Optional.
\n\n\n FileShareName
must be set if an S3 prefix name is set in\n LocationARN
.
A value that sets the write status of a file share. Set this value to true
\n to set the write status to read-only, otherwise set to false
.
Valid Values: true
| false
\n
Refresh cache information.
" } }, - "NFSFileShareDefaults": { - "target": "com.amazonaws.storagegateway#NFSFileShareDefaults" + "NotificationPolicy": { + "target": "com.amazonaws.storagegateway#NotificationPolicy", + "traits": { + "smithy.api#documentation": "The notification policy of the file share.
" + } } }, "traits": { @@ -5470,22 +5600,22 @@ "com.amazonaws.storagegateway#NetworkInterface": { "type": "structure", "members": { - "MacAddress": { + "Ipv4Address": { "target": "com.amazonaws.storagegateway#string", "traits": { - "smithy.api#documentation": "The Media Access Control (MAC) address of the interface.
\n\nThis is currently unsupported and will not be returned in output.
\nThe Internet Protocol version 4 (IPv4) address of the interface.
" } }, - "Ipv6Address": { + "MacAddress": { "target": "com.amazonaws.storagegateway#string", "traits": { - "smithy.api#documentation": "The Internet Protocol version 6 (IPv6) address of the interface. Currently not\n supported.
" + "smithy.api#documentation": "The Media Access Control (MAC) address of the interface.
\n\nThis is currently unsupported and will not be returned in output.
\nThe Internet Protocol version 4 (IPv4) address of the interface.
" + "smithy.api#documentation": "The Internet Protocol version 6 (IPv6) address of the interface. Currently not\n supported.
" } } }, @@ -5562,11 +5692,11 @@ "com.amazonaws.storagegateway#NotifyWhenUploadedOutput": { "type": "structure", "members": { - "NotificationId": { - "target": "com.amazonaws.storagegateway#NotificationId" - }, "FileShareARN": { "target": "com.amazonaws.storagegateway#FileShareARN" + }, + "NotificationId": { + "target": "com.amazonaws.storagegateway#NotificationId" } } }, @@ -5671,22 +5801,10 @@ "com.amazonaws.storagegateway#PoolInfo": { "type": "structure", "members": { - "PoolStatus": { - "target": "com.amazonaws.storagegateway#PoolStatus", - "traits": { - "smithy.api#documentation": "Status of the custom tape pool. Pool can be ACTIVE
or\n DELETED
.
Tape retention lock type, which can be configured in two modes. When configured in\n governance mode, AWS accounts with specific IAM permissions are authorized to remove the\n tape retention lock from archived virtual tapes. When configured in compliance mode, the\n tape retention lock cannot be removed by any user, including the root AWS account.
" - } - }, - "RetentionLockTimeInDays": { - "target": "com.amazonaws.storagegateway#RetentionLockTimeInDays", + "PoolARN": { + "target": "com.amazonaws.storagegateway#PoolARN", "traits": { - "smithy.api#documentation": "Tape retention lock time is set in days. Tape retention lock can be enabled for up to\n 100 years (36,500 days).
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your\n account and AWS Region.
" } }, "PoolName": { @@ -5701,10 +5819,22 @@ "smithy.api#documentation": "The storage class that is associated with the custom pool. When you use your backup\n application to eject the tape, the tape is archived directly into the storage class (S3\n Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
" } }, - "PoolARN": { - "target": "com.amazonaws.storagegateway#PoolARN", + "RetentionLockType": { + "target": "com.amazonaws.storagegateway#RetentionLockType", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the custom tape pool. Use the ListTapePools operation to return a list of custom tape pools for your\n account and AWS Region.
" + "smithy.api#documentation": "Tape retention lock type, which can be configured in two modes. When configured in\n governance mode, AWS accounts with specific IAM permissions are authorized to remove the\n tape retention lock from archived virtual tapes. When configured in compliance mode, the\n tape retention lock cannot be removed by any user, including the root AWS account.
" + } + }, + "RetentionLockTimeInDays": { + "target": "com.amazonaws.storagegateway#RetentionLockTimeInDays", + "traits": { + "smithy.api#documentation": "Tape retention lock time is set in days. Tape retention lock can be enabled for up to\n 100 years (36,500 days).
" + } + }, + "PoolStatus": { + "target": "com.amazonaws.storagegateway#PoolStatus", + "traits": { + "smithy.api#documentation": "Status of the custom tape pool. Pool can be ACTIVE
or\n DELETED
.
A value that specifies whether to recursively refresh folders in the cache. The refresh\n includes folders that were in the cache the last time the gateway listed the folder's\n contents. If this value set to true
, each folder that is listed in\n FolderList
is recursively updated. Otherwise, subfolders listed in\n FolderList
are not refreshed. Only objects that are in folders listed\n directly under FolderList
are found and used for the update. The default is\n true
.
Valid Values: true
| false
\n
A comma-separated list of the paths of folders to refresh in the cache. The default is\n [\"/\"
]. The default refreshes objects and folders at the root of the Amazon\n S3 bucket. If Recursive
is set to true
, the entire S3 bucket that\n the file share has access to is refreshed.
A value that specifies whether to recursively refresh folders in the cache. The refresh\n includes folders that were in the cache the last time the gateway listed the folder's\n contents. If this value set to true
, each folder that is listed in\n FolderList
is recursively updated. Otherwise, subfolders listed in\n FolderList
are not refreshed. Only objects that are in folders listed\n directly under FolderList
are found and used for the update. The default is\n true
.
Valid Values: true
| false
\n
The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the\n recovery point.
", "smithy.api#required": {} } }, - "TapeARN": { - "target": "com.amazonaws.storagegateway#TapeARN", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape for which you want to retrieve the\n recovery point.
", "smithy.api#required": {} } } @@ -6085,49 +6215,43 @@ "com.amazonaws.storagegateway#SMBFileShareInfo": { "type": "structure", "members": { - "Tags": { - "target": "com.amazonaws.storagegateway#Tags", - "traits": { - "smithy.api#documentation": "A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key\n name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can\n view all tags using the ListTagsForResource
API operation.
Refresh cache information.
" - } + "FileShareId": { + "target": "com.amazonaws.storagegateway#FileShareId" }, - "AdminUserList": { - "target": "com.amazonaws.storagegateway#FileShareUserList", - "traits": { - "smithy.api#documentation": "A list of users or groups in the Active Directory that have administrator rights to the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1
, user1
, @group1
, and\n @DOMAIN\\group1
. Can only be set if Authentication is set to\n ActiveDirectory
.
The Amazon Resource Name (ARN) of the storage used for the audit logs.
" + "smithy.api#documentation": "Set to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
If this value is set to true
, it indicates that access control list (ACL)\n is enabled on the SMB file share. If it is set to false
, it indicates that\n file and directory permissions are mapped to the POSIX permission.
For more information, see Using Microsoft Windows ACLs to\n control access to an SMB file share in the AWS Storage Gateway User\n Guide.
" + "smithy.api#documentation": "The file share path used by the SMB client to identify the mount point.
" } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" + "Role": { + "target": "com.amazonaws.storagegateway#Role" }, - "FileShareId": { - "target": "com.amazonaws.storagegateway#FileShareId" + "LocationARN": { + "target": "com.amazonaws.storagegateway#LocationARN" }, - "Path": { - "target": "com.amazonaws.storagegateway#Path", + "DefaultStorageClass": { + "target": "com.amazonaws.storagegateway#StorageClass", "traits": { - "smithy.api#documentation": "The file share path used by the SMB client to identify the mount point.
" + "smithy.api#documentation": "The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
|\n S3_STANDARD_IA
| S3_ONEZONE_IA
\n
A value that sets the write status of a file share. Set this value to true
\n to set the write status to read-only, otherwise set to false
.
Valid Values: true
| false
\n
A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true
to enable MIME type guessing, otherwise set\n to false
. The default value is true
.
Valid Values: true
| false
\n
A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true
, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.
\n RequesterPays
is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.
Valid Values: true
| false
\n
If this value is set to true
, it indicates that access control list (ACL)\n is enabled on the SMB file share. If it is set to false
, it indicates that\n file and directory permissions are mapped to the POSIX permission.
For more information, see Using Microsoft Windows ACLs to\n control access to an SMB file share in the AWS Storage Gateway User\n Guide.
" + } + }, + "AccessBasedEnumeration": { + "target": "com.amazonaws.storagegateway#Boolean", + "traits": { + "smithy.api#documentation": "Indicates whether AccessBasedEnumeration
is enabled.
A list of users or groups in the Active Directory that are not allowed to access the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1
, user1
, @group1
, and\n @DOMAIN\\group1
. Can only be set if Authentication is set to\n ActiveDirectory
.
A list of users or groups in the Active Directory that have administrator rights to the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1
, user1
, @group1
, and\n @DOMAIN\\group1
. Can only be set if Authentication is set to\n ActiveDirectory
.
A list of users or groups in the Active Directory that are allowed to access the file\n share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1
, user1
, @group1
, and\n @DOMAIN\\group1
. Can only be set if Authentication is set to\n ActiveDirectory
.
A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true
, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.
\n RequesterPays
is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.
Valid Values: true
| false
\n
The name of the file share. Optional.
\n\n\n FileShareName
must be set if an S3 prefix name is set in\n LocationARN
.
A list of users or groups in the Active Directory that are not allowed to access the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1
, user1
, @group1
, and\n @DOMAIN\\group1
. Can only be set if Authentication is set to\n ActiveDirectory
.
Set to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
The Amazon Resource Name (ARN) of the storage used for the audit logs.
" } }, - "Role": { - "target": "com.amazonaws.storagegateway#Role" - }, - "LocationARN": { - "target": "com.amazonaws.storagegateway#LocationARN" - }, "Authentication": { "target": "com.amazonaws.storagegateway#Authentication" }, @@ -6187,31 +6320,28 @@ "smithy.api#documentation": "The case of an object name in an Amazon S3 bucket. For ClientSpecified
, the\n client determines the case sensitivity. For CaseSensitive
, the gateway\n determines the case sensitivity. The default value is ClientSpecified
.
Indicates whether AccessBasedEnumeration
is enabled.
A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key\n name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can\n view all tags using the ListTagsForResource
API operation.
The notification policy of the file share.
" + "smithy.api#documentation": "The name of the file share. Optional.
\n\n\n FileShareName
must be set if an S3 prefix name is set in\n LocationARN
.
The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
|\n S3_STANDARD_IA
| S3_ONEZONE_IA
\n
Refresh cache information.
" } }, - "GuessMIMETypeEnabled": { - "target": "com.amazonaws.storagegateway#Boolean", + "NotificationPolicy": { + "target": "com.amazonaws.storagegateway#NotificationPolicy", "traits": { - "smithy.api#documentation": "A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true
to enable MIME type guessing, otherwise set\n to false
. The default value is true
.
Valid Values: true
| false
\n
The notification policy of the file share.
" } } }, @@ -6346,17 +6476,17 @@ "com.amazonaws.storagegateway#SetSMBGuestPasswordInput": { "type": "structure", "members": { - "Password": { - "target": "com.amazonaws.storagegateway#SMBGuestPassword", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "The password that you want to set for your SMB server.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the file gateway the SMB file share is associated\n with.
", "smithy.api#required": {} } }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "Password": { + "target": "com.amazonaws.storagegateway#SMBGuestPassword", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the file gateway the SMB file share is associated\n with.
", + "smithy.api#documentation": "The password that you want to set for your SMB server.
", "smithy.api#required": {} } } @@ -6549,17 +6679,17 @@ "com.amazonaws.storagegateway#StorageGatewayError": { "type": "structure", "members": { - "errorDetails": { - "target": "com.amazonaws.storagegateway#errorDetails", - "traits": { - "smithy.api#documentation": "Human-readable text that provides detail about the error that occurred.
" - } - }, "errorCode": { "target": "com.amazonaws.storagegateway#ErrorCode", "traits": { "smithy.api#documentation": "Additional information about the error.
" } + }, + "errorDetails": { + "target": "com.amazonaws.storagegateway#errorDetails", + "traits": { + "smithy.api#documentation": "Human-readable text that provides detail about the error that occurred.
" + } } }, "traits": { @@ -6660,6 +6790,9 @@ { "target": "com.amazonaws.storagegateway#DescribeBandwidthRateLimit" }, + { + "target": "com.amazonaws.storagegateway#DescribeBandwidthRateLimitSchedule" + }, { "target": "com.amazonaws.storagegateway#DescribeCache" }, @@ -6786,6 +6919,9 @@ { "target": "com.amazonaws.storagegateway#UpdateBandwidthRateLimit" }, + { + "target": "com.amazonaws.storagegateway#UpdateBandwidthRateLimitSchedule" + }, { "target": "com.amazonaws.storagegateway#UpdateChapCredentials" }, @@ -6838,37 +6974,16 @@ "com.amazonaws.storagegateway#StorediSCSIVolume": { "type": "structure", "members": { - "VolumeId": { - "target": "com.amazonaws.storagegateway#VolumeId", - "traits": { - "smithy.api#documentation": "The unique identifier of the volume, e.g., vol-AE4B946D.
" - } - }, - "KMSKey": { - "target": "com.amazonaws.storagegateway#KMSKey" - }, "VolumeARN": { "target": "com.amazonaws.storagegateway#VolumeARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the storage volume.
" } }, - "VolumeiSCSIAttributes": { - "target": "com.amazonaws.storagegateway#VolumeiSCSIAttributes", - "traits": { - "smithy.api#documentation": "An VolumeiSCSIAttributes object that represents a collection of iSCSI\n attributes for one stored volume.
" - } - }, - "VolumeStatus": { - "target": "com.amazonaws.storagegateway#VolumeStatus", - "traits": { - "smithy.api#documentation": "One of the VolumeStatus values that indicates the state of the storage volume.
" - } - }, - "TargetName": { - "target": "com.amazonaws.storagegateway#TargetName", + "VolumeId": { + "target": "com.amazonaws.storagegateway#VolumeId", "traits": { - "smithy.api#documentation": "The name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName
as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume
.\n The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.
" + "smithy.api#documentation": "The unique identifier of the volume, e.g., vol-AE4B946D.
" } }, "VolumeType": { @@ -6877,6 +6992,12 @@ "smithy.api#documentation": "One of the VolumeType enumeration values describing the type of the volume.
" } }, + "VolumeStatus": { + "target": "com.amazonaws.storagegateway#VolumeStatus", + "traits": { + "smithy.api#documentation": "One of the VolumeStatus values that indicates the state of the storage volume.
" + } + }, "VolumeAttachmentStatus": { "target": "com.amazonaws.storagegateway#VolumeAttachmentStatus", "traits": { @@ -6889,6 +7010,12 @@ "smithy.api#documentation": "The size of the volume in bytes.
" } }, + "VolumeProgress": { + "target": "com.amazonaws.storagegateway#DoubleObject", + "traits": { + "smithy.api#documentation": "Represents the percentage complete if the volume is restoring or bootstrapping that\n represents the percent of data transferred. This field does not appear in the response if\n the stored volume is not restoring or bootstrapping.
" + } + }, "VolumeDiskId": { "target": "com.amazonaws.storagegateway#DiskId", "traits": { @@ -6901,16 +7028,16 @@ "smithy.api#documentation": "If the stored volume was created from a snapshot, this field contains the snapshot ID\n used, e.g. snap-78e22663. Otherwise, this field is not included.
" } }, - "VolumeUsedInBytes": { - "target": "com.amazonaws.storagegateway#VolumeUsedInBytes", + "PreservedExistingData": { + "target": "com.amazonaws.storagegateway#Boolean2", "traits": { - "smithy.api#documentation": "The size of the data stored on the volume in bytes. This value is calculated based on\n the number of blocks that are touched, instead of the actual amount of data written. This\n value can be useful for sequential write patterns but less accurate for random write\n patterns. VolumeUsedInBytes
is different from the compressed size of the\n volume, which is the value that is used to calculate your bill.
This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.
\nIndicates if when the stored volume was created, existing data on the underlying local\n disk was preserved.
\n\nValid Values: true
| false
\n
Represents the percentage complete if the volume is restoring or bootstrapping that\n represents the percent of data transferred. This field does not appear in the response if\n the stored volume is not restoring or bootstrapping.
" + "smithy.api#documentation": "An VolumeiSCSIAttributes object that represents a collection of iSCSI\n attributes for one stored volume.
" } }, "CreatedDate": { @@ -6919,10 +7046,19 @@ "smithy.api#documentation": "The date the volume was created. Volumes created prior to March 28, 2017 don’t have this\n timestamp.
" } }, - "PreservedExistingData": { - "target": "com.amazonaws.storagegateway#Boolean2", + "VolumeUsedInBytes": { + "target": "com.amazonaws.storagegateway#VolumeUsedInBytes", "traits": { - "smithy.api#documentation": "Indicates if when the stored volume was created, existing data on the underlying local\n disk was preserved.
\n\nValid Values: true
| false
\n
The size of the data stored on the volume in bytes. This value is calculated based on\n the number of blocks that are touched, instead of the actual amount of data written. This\n value can be useful for sequential write patterns but less accurate for random write\n patterns. VolumeUsedInBytes
is different from the compressed size of the\n volume, which is the value that is used to calculate your bill.
This value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.
\nThe name of the iSCSI target used by an initiator to connect to a volume and used as a\n suffix for the target ARN. For example, specifying TargetName
as\n myvolume results in the target ARN of\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/target/iqn.1997-05.com.amazon:myvolume
.\n The target name must be unique across all volumes on a gateway.
If you don't specify a value, Storage Gateway uses the value that was previously\n used for this volume as the new target name.
" } } }, @@ -6939,17 +7075,17 @@ "com.amazonaws.storagegateway#Tag": { "type": "structure", "members": { - "Value": { - "target": "com.amazonaws.storagegateway#TagValue", + "Key": { + "target": "com.amazonaws.storagegateway#TagKey", "traits": { - "smithy.api#documentation": "Value of the tag key.
", + "smithy.api#documentation": "Tag key. The key can't start with aws:.
", "smithy.api#required": {} } }, - "Key": { - "target": "com.amazonaws.storagegateway#TagKey", + "Value": { + "target": "com.amazonaws.storagegateway#TagValue", "traits": { - "smithy.api#documentation": "Tag key. The key can't start with aws:.
", + "smithy.api#documentation": "Value of the tag key.
", "smithy.api#required": {} } } @@ -6992,28 +7128,34 @@ "com.amazonaws.storagegateway#Tape": { "type": "structure", "members": { - "TapeStatus": { - "target": "com.amazonaws.storagegateway#TapeStatus", + "TapeARN": { + "target": "com.amazonaws.storagegateway#TapeARN", "traits": { - "smithy.api#documentation": "The current state of the virtual tape.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape.
" } }, - "TapeSizeInBytes": { - "target": "com.amazonaws.storagegateway#TapeSize", + "TapeBarcode": { + "target": "com.amazonaws.storagegateway#TapeBarcode", "traits": { - "smithy.api#documentation": "The size, in bytes, of the virtual tape capacity.
" + "smithy.api#documentation": "The barcode that identifies a specific virtual tape.
" } }, - "Progress": { - "target": "com.amazonaws.storagegateway#DoubleObject", + "TapeCreatedDate": { + "target": "com.amazonaws.storagegateway#Time", "traits": { - "smithy.api#documentation": "For archiving virtual tapes, indicates how much data remains to be uploaded before\n archiving is complete.
\n\nRange: 0 (not started) to 100 (complete).
" + "smithy.api#documentation": "The date the virtual tape was created.
" } }, - "TapeUsedInBytes": { - "target": "com.amazonaws.storagegateway#TapeUsage", + "TapeSizeInBytes": { + "target": "com.amazonaws.storagegateway#TapeSize", "traits": { - "smithy.api#documentation": "The size, in bytes, of data stored on the virtual tape.
\n\nThis value is not available for tapes created prior to May 13, 2015.
\nThe size, in bytes, of the virtual tape capacity.
" + } + }, + "TapeStatus": { + "target": "com.amazonaws.storagegateway#TapeStatus", + "traits": { + "smithy.api#documentation": "The current state of the virtual tape.
" } }, "VTLDevice": { @@ -7022,31 +7164,25 @@ "smithy.api#documentation": "The virtual tape library (VTL) device that the virtual tape is associated with.
" } }, - "PoolId": { - "target": "com.amazonaws.storagegateway#PoolId", + "Progress": { + "target": "com.amazonaws.storagegateway#DoubleObject", "traits": { - "smithy.api#documentation": "The ID of the pool that contains tapes that will be archived. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool. When you use your backup\n application to eject the tape, the tape is archived directly into the storage class (S3\n Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
\n\nValid Values: GLACIER
| DEEP_ARCHIVE
\n
For archiving virtual tapes, indicates how much data remains to be uploaded before\n archiving is complete.
\n\nRange: 0 (not started) to 100 (complete).
" } }, - "TapeARN": { - "target": "com.amazonaws.storagegateway#TapeARN", + "TapeUsedInBytes": { + "target": "com.amazonaws.storagegateway#TapeUsage", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape.
" + "smithy.api#documentation": "The size, in bytes, of data stored on the virtual tape.
\n\nThis value is not available for tapes created prior to May 13, 2015.
\nThe date the virtual tape was created.
" - } - }, - "RetentionStartDate": { - "target": "com.amazonaws.storagegateway#Time", + "PoolId": { + "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "The date that the tape is first archived with tape retention lock enabled.
" + "smithy.api#documentation": "The ID of the pool that contains tapes that will be archived. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool. When you use your backup\n application to eject the tape, the tape is archived directly into the storage class (S3\n Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
\n\nValid Values: GLACIER
| DEEP_ARCHIVE
\n
If the tape is archived as write-once-read-many (WORM), this value is\n true
.
The barcode that identifies a specific virtual tape.
" + "smithy.api#documentation": "The date that the tape is first archived with tape retention lock enabled.
" } }, "PoolEntryDate": { @@ -7094,6 +7230,12 @@ "com.amazonaws.storagegateway#TapeArchive": { "type": "structure", "members": { + "TapeARN": { + "target": "com.amazonaws.storagegateway#TapeARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of an archived virtual tape.
" + } + }, "TapeBarcode": { "target": "com.amazonaws.storagegateway#TapeBarcode", "traits": { @@ -7106,10 +7248,10 @@ "smithy.api#documentation": "The date the virtual tape was created.
" } }, - "TapeUsedInBytes": { - "target": "com.amazonaws.storagegateway#TapeUsage", + "TapeSizeInBytes": { + "target": "com.amazonaws.storagegateway#TapeSize", "traits": { - "smithy.api#documentation": "The size, in bytes, of data stored on the virtual tape.
\n\nThis value is not available for tapes created prior to May 13, 2015.
\nThe size, in bytes, of the archived virtual tape.
" } }, "CompletionTime": { @@ -7118,10 +7260,31 @@ "smithy.api#documentation": "The time that the archiving of the virtual tape was completed.
\n\nThe default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z'\n format.
" } }, - "RetrievedTo": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "RetrievedTo": { + "target": "com.amazonaws.storagegateway#GatewayARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being\n retrieved to.
\n\nThe virtual tape is retrieved from the virtual tape shelf (VTS).
" + } + }, + "TapeStatus": { + "target": "com.amazonaws.storagegateway#TapeArchiveStatus", + "traits": { + "smithy.api#documentation": "The current state of the archived virtual tape.
" + } + }, + "TapeUsedInBytes": { + "target": "com.amazonaws.storagegateway#TapeUsage", + "traits": { + "smithy.api#documentation": "The size, in bytes, of data stored on the virtual tape.
\n\nThis value is not available for tapes created prior to May 13, 2015.
\nThe Amazon Resource Name (ARN) of the tape gateway that the virtual tape is being\n retrieved to.
\n\nThe virtual tape is retrieved from the virtual tape shelf (VTS).
" + "smithy.api#documentation": "The ID of the pool that was used to archive the tape. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool.
\n\nValid Values: GLACIER
| DEEP_ARCHIVE
\n
Set to true
if the archived tape is stored as write-once-read-many\n (WORM).
If the archived tape is subject to tape retention lock, the date that the archived tape\n started being retained.
" } }, - "PoolId": { - "target": "com.amazonaws.storagegateway#PoolId", - "traits": { - "smithy.api#documentation": "The ID of the pool that was used to archive the tape. The tapes in this pool are\n archived in the S3 storage class that is associated with the pool.
\n\nValid Values: GLACIER
| DEEP_ARCHIVE
\n
The time that the tape entered the custom tape pool.
\n\nThe default timestamp format is in the ISO8601 extended YYYY-MM-DD'T'HH:MM:SS'Z'\n format.
" } - }, - "TapeSizeInBytes": { - "target": "com.amazonaws.storagegateway#TapeSize", - "traits": { - "smithy.api#documentation": "The size, in bytes, of the archived virtual tape.
" - } - }, - "TapeARN": { - "target": "com.amazonaws.storagegateway#TapeARN", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of an archived virtual tape.
" - } - }, - "TapeStatus": { - "target": "com.amazonaws.storagegateway#TapeArchiveStatus", - "traits": { - "smithy.api#documentation": "The current state of the archived virtual tape.
" - } } }, "traits": { @@ -7227,6 +7363,12 @@ "smithy.api#documentation": "The barcode that identifies a specific virtual tape.
" } }, + "TapeSizeInBytes": { + "target": "com.amazonaws.storagegateway#TapeSize", + "traits": { + "smithy.api#documentation": "The size, in bytes, of a virtual tape.
" + } + }, "TapeStatus": { "target": "com.amazonaws.storagegateway#TapeStatus", "traits": { @@ -7239,16 +7381,10 @@ "smithy.api#documentation": "The Amazon Resource Name (ARN) of the gateway. Use the ListGateways\n operation to return a list of gateways for your account and AWS Region.
" } }, - "PoolEntryDate": { - "target": "com.amazonaws.storagegateway#Time", - "traits": { - "smithy.api#documentation": "The date that the tape entered the custom tape pool with tape retention lock\n enabled.
" - } - }, - "TapeSizeInBytes": { - "target": "com.amazonaws.storagegateway#TapeSize", + "PoolId": { + "target": "com.amazonaws.storagegateway#PoolId", "traits": { - "smithy.api#documentation": "The size, in bytes, of a virtual tape.
" + "smithy.api#documentation": "The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
\n\nValid Values: GLACIER
| DEEP_ARCHIVE
\n
The date that the tape became subject to tape retention lock.
" } }, - "PoolId": { - "target": "com.amazonaws.storagegateway#PoolId", + "PoolEntryDate": { + "target": "com.amazonaws.storagegateway#Time", "traits": { - "smithy.api#documentation": "The ID of the pool that you want to add your tape to for archiving. The tape in this\n pool is archived in the S3 storage class that is associated with the pool. When you use\n your backup application to eject the tape, the tape is archived directly into the storage\n class (S3 Glacier or S3 Glacier Deep Archive) that corresponds to the pool.
\n\nValid Values: GLACIER
| DEEP_ARCHIVE
\n
The date that the tape entered the custom tape pool with tape retention lock\n enabled.
" } } }, @@ -7280,16 +7416,10 @@ "com.amazonaws.storagegateway#TapeRecoveryPointInfo": { "type": "structure", "members": { - "TapeSizeInBytes": { - "target": "com.amazonaws.storagegateway#TapeSize", - "traits": { - "smithy.api#documentation": "The size, in bytes, of the virtual tapes to recover.
" - } - }, - "TapeStatus": { - "target": "com.amazonaws.storagegateway#TapeRecoveryPointStatus", + "TapeARN": { + "target": "com.amazonaws.storagegateway#TapeARN", "traits": { - "smithy.api#documentation": "The status of the virtual tapes.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape.
" } }, "TapeRecoveryPointTime": { @@ -7298,10 +7428,16 @@ "smithy.api#documentation": "The time when the point-in-time view of the virtual tape was replicated for later\n recovery.
\n\nThe default timestamp format of the tape recovery point time is in the ISO8601 extended\n YYYY-MM-DD'T'HH:MM:SS'Z' format.
" } }, - "TapeARN": { - "target": "com.amazonaws.storagegateway#TapeARN", + "TapeSizeInBytes": { + "target": "com.amazonaws.storagegateway#TapeSize", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the virtual tape.
" + "smithy.api#documentation": "The size, in bytes, of the virtual tapes to recover.
" + } + }, + "TapeStatus": { + "target": "com.amazonaws.storagegateway#TapeRecoveryPointStatus", + "traits": { + "smithy.api#documentation": "The status of the virtual tapes.
" } } }, @@ -7407,16 +7543,16 @@ "com.amazonaws.storagegateway#UpdateAutomaticTapeCreationPolicyInput": { "type": "structure", "members": { - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", + "AutomaticTapeCreationRules": { + "target": "com.amazonaws.storagegateway#AutomaticTapeCreationRules", "traits": { + "smithy.api#documentation": "An automatic tape creation policy consists of a list of automatic tape creation rules.\n The rules determine when and how to automatically create new tapes.
", "smithy.api#required": {} } }, - "AutomaticTapeCreationRules": { - "target": "com.amazonaws.storagegateway#AutomaticTapeCreationRules", + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { - "smithy.api#documentation": "An automatic tape creation policy consists of a list of automatic tape creation rules.\n The rules determine when and how to automatically create new tapes.
", "smithy.api#required": {} } } @@ -7453,12 +7589,6 @@ "com.amazonaws.storagegateway#UpdateBandwidthRateLimitInput": { "type": "structure", "members": { - "AverageDownloadRateLimitInBitsPerSec": { - "target": "com.amazonaws.storagegateway#BandwidthDownloadRateLimit", - "traits": { - "smithy.api#documentation": "The average download bandwidth rate limit in bits per second.
" - } - }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN", "traits": { @@ -7470,6 +7600,12 @@ "traits": { "smithy.api#documentation": "The average upload bandwidth rate limit in bits per second.
" } + }, + "AverageDownloadRateLimitInBitsPerSec": { + "target": "com.amazonaws.storagegateway#BandwidthDownloadRateLimit", + "traits": { + "smithy.api#documentation": "The average download bandwidth rate limit in bits per second.
" + } } }, "traits": { @@ -7487,6 +7623,52 @@ "smithy.api#documentation": "A JSON object containing the Amazon Resource Name (ARN) of the gateway whose throttle\n information was updated.
" } }, + "com.amazonaws.storagegateway#UpdateBandwidthRateLimitSchedule": { + "type": "operation", + "input": { + "target": "com.amazonaws.storagegateway#UpdateBandwidthRateLimitScheduleInput" + }, + "output": { + "target": "com.amazonaws.storagegateway#UpdateBandwidthRateLimitScheduleOutput" + }, + "errors": [ + { + "target": "com.amazonaws.storagegateway#InternalServerError" + }, + { + "target": "com.amazonaws.storagegateway#InvalidGatewayRequestException" + } + ], + "traits": { + "smithy.api#documentation": "\n Updates the bandwidth rate limit schedule for a specified gateway. By default, gateways do \n not have bandwidth rate limit schedules, which means no bandwidth rate limiting is in effect.\n Use this to initiate or update a gateway's bandwidth rate limit schedule.\n This operation is supported in the volume and tape gateway types.\n
" + } + }, + "com.amazonaws.storagegateway#UpdateBandwidthRateLimitScheduleInput": { + "type": "structure", + "members": { + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", + "traits": { + "smithy.api#required": {} + } + }, + "BandwidthRateLimitIntervals": { + "target": "com.amazonaws.storagegateway#BandwidthRateLimitIntervals", + "traits": { + "smithy.api#documentation": "\n An array containing bandwidth rate limit schedule intervals for a gateway. \n When no bandwidth rate limit intervals have been scheduled, the array is empty.\n
", + "smithy.api#required": {} + } + } + } + }, + "com.amazonaws.storagegateway#UpdateBandwidthRateLimitScheduleOutput": { + "type": "structure", + "members": { + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" + } + } + }, "com.amazonaws.storagegateway#UpdateChapCredentials": { "type": "operation", "input": { @@ -7510,16 +7692,10 @@ "com.amazonaws.storagegateway#UpdateChapCredentialsInput": { "type": "structure", "members": { - "SecretToAuthenticateTarget": { - "target": "com.amazonaws.storagegateway#ChapSecret", - "traits": { - "smithy.api#documentation": "The secret key that the target must provide to participate in mutual CHAP with the\n initiator (e.g. Windows client).
\n\nByte constraints: Minimum bytes of 12. Maximum bytes of 16.
\n\nThe secret key must be between 12 and 16 bytes when encoded in UTF-8.
\nThe iSCSI initiator that connects to the target.
", + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified\n VolumeARN.
", "smithy.api#required": {} } }, @@ -7530,12 +7706,18 @@ "smithy.api#required": {} } }, - "TargetARN": { - "target": "com.amazonaws.storagegateway#TargetARN", + "InitiatorName": { + "target": "com.amazonaws.storagegateway#IqnName", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the iSCSI volume target. Use the DescribeStorediSCSIVolumes operation to return the TargetARN for specified\n VolumeARN.
", + "smithy.api#documentation": "The iSCSI initiator that connects to the target.
", "smithy.api#required": {} } + }, + "SecretToAuthenticateTarget": { + "target": "com.amazonaws.storagegateway#ChapSecret", + "traits": { + "smithy.api#documentation": "The secret key that the target must provide to participate in mutual CHAP with the\n initiator (e.g. Windows client).
\n\nByte constraints: Minimum bytes of 12. Maximum bytes of 16.
\n\nThe secret key must be between 12 and 16 bytes when encoded in UTF-8.
\nThe iSCSI initiator that connects to the target. This is the same initiator name\n specified in the request.
" - } - }, "TargetARN": { "target": "com.amazonaws.storagegateway#TargetARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the target. This is the same target specified in the\n request.
" } + }, + "InitiatorName": { + "target": "com.amazonaws.storagegateway#IqnName", + "traits": { + "smithy.api#documentation": "The iSCSI initiator that connects to the target. This is the same initiator name\n specified in the request.
" + } } }, "traits": { @@ -7585,6 +7767,12 @@ "com.amazonaws.storagegateway#UpdateGatewayInformationInput": { "type": "structure", "members": { + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", + "traits": { + "smithy.api#required": {} + } + }, "GatewayName": { "target": "com.amazonaws.storagegateway#GatewayName" }, @@ -7599,26 +7787,20 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use\n to monitor and log events in the gateway.
\n\nFor more information, see What is Amazon CloudWatch\n Logs?\n
" } - }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", - "traits": { - "smithy.api#required": {} - } } } }, "com.amazonaws.storagegateway#UpdateGatewayInformationOutput": { "type": "structure", "members": { + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN" + }, "GatewayName": { "target": "com.amazonaws.storagegateway#string", "traits": { "smithy.api#documentation": "The name you configured for your gateway.
" } - }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN" } }, "traits": { @@ -7693,6 +7875,19 @@ "com.amazonaws.storagegateway#UpdateMaintenanceStartTimeInput": { "type": "structure", "members": { + "GatewayARN": { + "target": "com.amazonaws.storagegateway#GatewayARN", + "traits": { + "smithy.api#required": {} + } + }, + "HourOfDay": { + "target": "com.amazonaws.storagegateway#HourOfDay", + "traits": { + "smithy.api#documentation": "The hour component of the maintenance start time represented as hh,\n where hh is the hour (00 to 23). The hour of the day is in the time\n zone of the gateway.
", + "smithy.api#required": {} + } + }, "MinuteOfHour": { "target": "com.amazonaws.storagegateway#MinuteOfHour", "traits": { @@ -7711,19 +7906,6 @@ "traits": { "smithy.api#documentation": "The day of the month component of the maintenance start time represented as an ordinal\n number from 1 to 28, where 1 represents the first day of the month and 28 represents the\n last day of the month.
" } - }, - "GatewayARN": { - "target": "com.amazonaws.storagegateway#GatewayARN", - "traits": { - "smithy.api#required": {} - } - }, - "HourOfDay": { - "target": "com.amazonaws.storagegateway#HourOfDay", - "traits": { - "smithy.api#documentation": "The hour component of the maintenance start time represented as hh,\n where hh is the hour (00 to 23). The hour of the day is in the time\n zone of the gateway.
", - "smithy.api#required": {} - } } }, "traits": { @@ -7764,41 +7946,59 @@ "com.amazonaws.storagegateway#UpdateNFSFileShareInput": { "type": "structure", "members": { - "ObjectACL": { - "target": "com.amazonaws.storagegateway#ObjectACL", + "FileShareARN": { + "target": "com.amazonaws.storagegateway#FileShareARN", "traits": { - "smithy.api#documentation": "A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that a file gateway puts objects into. The default value is private
.
The Amazon Resource Name (ARN) of the file share to be updated.
", + "smithy.api#required": {} } }, - "ClientList": { - "target": "com.amazonaws.storagegateway#FileShareClientList", + "KMSEncrypted": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "The list of clients that are allowed to access the file gateway. The list must contain\n either valid IP addresses or valid CIDR blocks.
" + "smithy.api#documentation": "Set to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted
is true
. Optional.
The default values for the file share. Optional.
" + } + }, + "DefaultStorageClass": { + "target": "com.amazonaws.storagegateway#StorageClass", + "traits": { + "smithy.api#documentation": "The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
|\n S3_STANDARD_IA
| S3_ONEZONE_IA
\n
A value that sets the write status of a file share. Set this value to true
\n to set the write status to read-only, otherwise set to false
.
Valid Values: true
| false
\n
A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that a file gateway puts objects into. The default value is private
.
Set to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
The list of clients that are allowed to access the file gateway. The list must contain\n either valid IP addresses or valid CIDR blocks.
" } }, - "FileShareARN": { - "target": "com.amazonaws.storagegateway#FileShareARN", + "Squash": { + "target": "com.amazonaws.storagegateway#Squash", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the file share to be updated.
", - "smithy.api#required": {} + "smithy.api#documentation": "The user mapped to anonymous user.
\n\nValid values are the following:
\n\n\n RootSquash
: Only root is mapped to anonymous user.
\n NoSquash
: No one is mapped to anonymous user.
\n AllSquash
: Everyone is mapped to anonymous user.
The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
|\n S3_STANDARD_IA
| S3_ONEZONE_IA
\n
A value that sets the write status of a file share. Set this value to true
\n to set the write status to read-only, otherwise set to false
.
Valid Values: true
| false
\n
A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true
to enable MIME type guessing, otherwise set\n to false
. The default value is true
.
Valid Values: true
| false
\n
The name of the file share. Optional.
\n\n\n FileShareName
must be set if an S3 prefix name is set in\n LocationARN
.
A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true
, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.
\n RequesterPays
is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.
Valid Values: true
| false
\n
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted
is true
. Optional.
The name of the file share. Optional.
\n\n\n FileShareName
must be set if an S3 prefix name is set in\n LocationARN
.
Refresh cache information.
" } }, - "Squash": { - "target": "com.amazonaws.storagegateway#Squash", - "traits": { - "smithy.api#documentation": "The user mapped to anonymous user.
\n\nValid values are the following:
\n\n\n RootSquash
: Only root is mapped to anonymous user.
\n NoSquash
: No one is mapped to anonymous user.
\n AllSquash
: Everyone is mapped to anonymous user.
The notification policy of the file share.
" } - }, - "NFSFileShareDefaults": { - "target": "com.amazonaws.storagegateway#NFSFileShareDefaults", - "traits": { - "smithy.api#documentation": "The default values for the file share. Optional.
" - } } }, "traits": { @@ -7891,46 +8073,47 @@ "com.amazonaws.storagegateway#UpdateSMBFileShareInput": { "type": "structure", "members": { - "DefaultStorageClass": { - "target": "com.amazonaws.storagegateway#StorageClass", + "FileShareARN": { + "target": "com.amazonaws.storagegateway#FileShareARN", "traits": { - "smithy.api#documentation": "The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
|\n S3_STANDARD_IA
| S3_ONEZONE_IA
\n
The Amazon Resource Name (ARN) of the SMB file share that you want to update.
", + "smithy.api#required": {} } }, - "ValidUserList": { - "target": "com.amazonaws.storagegateway#FileShareUserList", + "KMSEncrypted": { + "target": "com.amazonaws.storagegateway#Boolean", "traits": { - "smithy.api#documentation": "A list of users or groups in the Active Directory that are allowed to access the file\n share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1
, user1
, @group1
, and\n @DOMAIN\\group1
. Can only be set if Authentication is set to\n ActiveDirectory
.
Set to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that a file gateway puts objects into. The default value is private
.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted
is true
. Optional.
A list of users or groups in the Active Directory that are not allowed to access the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1
, user1
, @group1
, and\n @DOMAIN\\group1
. Can only be set if Authentication is set to\n ActiveDirectory
.
The default storage class for objects put into an Amazon S3 bucket by the file gateway.\n The default value is S3_INTELLIGENT_TIERING
. Optional.
Valid Values: S3_STANDARD
| S3_INTELLIGENT_TIERING
|\n S3_STANDARD_IA
| S3_ONEZONE_IA
\n
A list of users or groups in the Active Directory that have administrator rights to the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1
, user1
, @group1
, and\n @DOMAIN\\group1
. Can only be set if Authentication is set to\n ActiveDirectory
.
A value that sets the access control list (ACL) permission for objects in the S3 bucket\n that a file gateway puts objects into. The default value is private
.
Set to true
to use Amazon S3 server-side encryption with your own AWS KMS\n key, or false
to use a key managed by Amazon S3. Optional.
Valid Values: true
| false
\n
A value that sets the write status of a file share. Set this value to true
\n to set write status to read-only, otherwise set to false
.
Valid Values: true
| false
\n
The name of the file share. Optional.
\n\n\n FileShareName
must be set if an S3 prefix name is set in\n LocationARN
.
A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true
to enable MIME type guessing, otherwise set\n to false
. The default value is true
.
Valid Values: true
| false
\n
A value that sets who pays the cost of the request and the cost associated with data\n download from the S3 bucket. If this value is set to true
, the requester pays\n the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays\n the cost of storing data.
\n RequesterPays
is a configuration for the S3 bucket that backs the file\n share, so make sure that the configuration on the file share is the same as the S3\n bucket configuration.
Valid Values: true
| false
\n
A value that enables guessing of the MIME type for uploaded objects based on file\n extensions. Set this value to true
to enable MIME type guessing, otherwise set\n to false
. The default value is true
.
Valid Values: true
| false
\n
Set this value to true
to enable access control list (ACL) on the SMB file\n share. Set it to false
to map file and directory permissions to the POSIX\n permissions.
For more information, see Using Microsoft Windows ACLs to\n control access to an SMB file share in the AWS Storage Gateway User\n Guide.
\n\nValid Values: true
| false
\n
The Amazon Resource Name (ARN) of the SMB file share that you want to update.
", - "smithy.api#required": {} + "smithy.api#documentation": "The files and folders on this share will only be visible to users with read\n access.
" } }, - "CaseSensitivity": { - "target": "com.amazonaws.storagegateway#CaseSensitivity", + "AdminUserList": { + "target": "com.amazonaws.storagegateway#FileShareUserList", "traits": { - "smithy.api#documentation": "The case of an object name in an Amazon S3 bucket. For ClientSpecified
, the\n client determines the case sensitivity. For CaseSensitive
, the gateway\n determines the case sensitivity. The default value is ClientSpecified
.
A list of users or groups in the Active Directory that have administrator rights to the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1
, user1
, @group1
, and\n @DOMAIN\\group1
. Can only be set if Authentication is set to\n ActiveDirectory
.
The files and folders on this share will only be visible to users with read\n access.
" + "smithy.api#documentation": "A list of users or groups in the Active Directory that are allowed to access the file\n share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1
, user1
, @group1
, and\n @DOMAIN\\group1
. Can only be set if Authentication is set to\n ActiveDirectory
.
Refresh cache information.
" + "smithy.api#documentation": "A list of users or groups in the Active Directory that are not allowed to access the\n file share. A group must be prefixed with the @ character. Acceptable formats include:\n DOMAIN\\User1
, user1
, @group1
, and\n @DOMAIN\\group1
. Can only be set if Authentication is set to\n ActiveDirectory
.
The notification policy of the file share.
" + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the storage used for the audit logs.
" } }, - "ReadOnly": { - "target": "com.amazonaws.storagegateway#Boolean", + "CaseSensitivity": { + "target": "com.amazonaws.storagegateway#CaseSensitivity", "traits": { - "smithy.api#documentation": "A value that sets the write status of a file share. Set this value to true
\n to set write status to read-only, otherwise set to false
.
Valid Values: true
| false
\n
The case of an object name in an Amazon S3 bucket. For ClientSpecified
, the\n client determines the case sensitivity. For CaseSensitive
, the gateway\n determines the case sensitivity. The default value is ClientSpecified
.
Set this value to true
to enable access control list (ACL) on the SMB file\n share. Set it to false
to map file and directory permissions to the POSIX\n permissions.
For more information, see Using Microsoft Windows ACLs to\n control access to an SMB file share in the AWS Storage Gateway User\n Guide.
\n\nValid Values: true
| false
\n
The name of the file share. Optional.
\n\n\n FileShareName
must be set if an S3 prefix name is set in\n LocationARN
.
The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon\n S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can\n only be set when KMSEncrypted
is true
. Optional.
Refresh cache information.
" } }, - "AuditDestinationARN": { - "target": "com.amazonaws.storagegateway#AuditDestinationARN", + "NotificationPolicy": { + "target": "com.amazonaws.storagegateway#NotificationPolicy", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the storage used for the audit logs.
" + "smithy.api#documentation": "The notification policy of the file share.
" } } }, @@ -8141,10 +8323,11 @@ "smithy.api#required": {} } }, - "Description": { - "target": "com.amazonaws.storagegateway#Description", + "StartAt": { + "target": "com.amazonaws.storagegateway#HourOfDay", "traits": { - "smithy.api#documentation": "Optional description of the snapshot that overwrites the existing description.
" + "smithy.api#documentation": "The hour of the day at which the snapshot schedule begins represented as\n hh, where hh is the hour (0 to 23). The hour\n of the day is in the time zone of the gateway.
", + "smithy.api#required": {} } }, "RecurrenceInHours": { @@ -8154,11 +8337,10 @@ "smithy.api#required": {} } }, - "StartAt": { - "target": "com.amazonaws.storagegateway#HourOfDay", + "Description": { + "target": "com.amazonaws.storagegateway#Description", "traits": { - "smithy.api#documentation": "The hour of the day at which the snapshot schedule begins represented as\n hh, where hh is the hour (0 to 23). The hour\n of the day is in the time zone of the gateway.
", - "smithy.api#required": {} + "smithy.api#documentation": "Optional description of the snapshot that overwrites the existing description.
" } }, "Tags": { @@ -8209,17 +8391,17 @@ "com.amazonaws.storagegateway#UpdateVTLDeviceTypeInput": { "type": "structure", "members": { - "DeviceType": { - "target": "com.amazonaws.storagegateway#DeviceType", + "VTLDeviceARN": { + "target": "com.amazonaws.storagegateway#VTLDeviceARN", "traits": { - "smithy.api#documentation": "The type of medium changer you want to select.
\n\nValid Values: STK-L700
| AWS-Gateway-VTL
|\n IBM-03584L32-0402
\n
The Amazon Resource Name (ARN) of the medium changer you want to select.
", "smithy.api#required": {} } }, - "VTLDeviceARN": { - "target": "com.amazonaws.storagegateway#VTLDeviceARN", + "DeviceType": { + "target": "com.amazonaws.storagegateway#DeviceType", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the medium changer you want to select.
", + "smithy.api#documentation": "The type of medium changer you want to select.
\n\nValid Values: STK-L700
| AWS-Gateway-VTL
|\n IBM-03584L32-0402
\n
Specifies the unique Amazon Resource Name (ARN) of the device (tape drive or media\n changer).
" } }, - "VTLDeviceProductIdentifier": { - "target": "com.amazonaws.storagegateway#VTLDeviceProductIdentifier", + "VTLDeviceType": { + "target": "com.amazonaws.storagegateway#VTLDeviceType", "traits": { - "smithy.api#documentation": "Specifies the model number of device that the VTL device emulates.
" + "smithy.api#documentation": "Specifies the type of device that the VTL device emulates.
" } }, "VTLDeviceVendor": { @@ -8260,10 +8442,10 @@ "smithy.api#documentation": "Specifies the vendor of the device that the VTL device object emulates.
" } }, - "VTLDeviceType": { - "target": "com.amazonaws.storagegateway#VTLDeviceType", + "VTLDeviceProductIdentifier": { + "target": "com.amazonaws.storagegateway#VTLDeviceProductIdentifier", "traits": { - "smithy.api#documentation": "Specifies the type of device that the VTL device emulates.
" + "smithy.api#documentation": "Specifies the model number of device that the VTL device emulates.
" } }, "DeviceiSCSIAttributes": { @@ -8343,6 +8525,18 @@ "com.amazonaws.storagegateway#VolumeInfo": { "type": "structure", "members": { + "VolumeARN": { + "target": "com.amazonaws.storagegateway#VolumeARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) for the storage volume. For example, the following is a\n valid ARN:
\n\n\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB
\n
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" + } + }, + "VolumeId": { + "target": "com.amazonaws.storagegateway#VolumeId", + "traits": { + "smithy.api#documentation": "The unique identifier assigned to the volume. This ID becomes part of the volume Amazon\n Resource Name (ARN), which you use as input for other operations.
\n\nValid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" + } + }, "GatewayARN": { "target": "com.amazonaws.storagegateway#GatewayARN" }, @@ -8352,10 +8546,10 @@ "smithy.api#documentation": "The unique identifier assigned to your gateway during activation. This ID becomes part\n of the gateway Amazon Resource Name (ARN), which you use as input for other\n operations.
\n\nValid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" } }, - "VolumeAttachmentStatus": { - "target": "com.amazonaws.storagegateway#VolumeAttachmentStatus", + "VolumeType": { + "target": "com.amazonaws.storagegateway#VolumeType", "traits": { - "smithy.api#documentation": "One of the VolumeStatus values that indicates the state of the storage volume.
" + "smithy.api#documentation": "One of the VolumeType enumeration values describing the type of the volume.
" } }, "VolumeSizeInBytes": { @@ -8364,22 +8558,10 @@ "smithy.api#documentation": "The size of the volume in bytes.
\n\nValid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" } }, - "VolumeARN": { - "target": "com.amazonaws.storagegateway#VolumeARN", - "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) for the storage volume. For example, the following is a\n valid ARN:
\n\n\n arn:aws:storagegateway:us-east-2:111122223333:gateway/sgw-12A3456B/volume/vol-1122AABB
\n
Valid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" - } - }, - "VolumeId": { - "target": "com.amazonaws.storagegateway#VolumeId", - "traits": { - "smithy.api#documentation": "The unique identifier assigned to the volume. This ID becomes part of the volume Amazon\n Resource Name (ARN), which you use as input for other operations.
\n\nValid Values: 50 to 500 lowercase letters, numbers, periods (.), and hyphens (-).
" - } - }, - "VolumeType": { - "target": "com.amazonaws.storagegateway#VolumeType", + "VolumeAttachmentStatus": { + "target": "com.amazonaws.storagegateway#VolumeAttachmentStatus", "traits": { - "smithy.api#documentation": "One of the VolumeType enumeration values describing the type of the volume.
" + "smithy.api#documentation": "One of the VolumeStatus values that indicates the state of the storage volume.
" } } }, @@ -8396,6 +8578,12 @@ "com.amazonaws.storagegateway#VolumeRecoveryPointInfo": { "type": "structure", "members": { + "VolumeARN": { + "target": "com.amazonaws.storagegateway#VolumeARN", + "traits": { + "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume target.
" + } + }, "VolumeSizeInBytes": { "target": "com.amazonaws.storagegateway#long", "traits": { @@ -8408,12 +8596,6 @@ "smithy.api#documentation": "The size of the data stored on the volume in bytes.
\n\nThis value is not available for volumes created prior to May 13, 2015, until you\n store data on the volume.
\nThe Amazon Resource Name (ARN) of the volume target.
" - } - }, "VolumeRecoveryPointTime": { "target": "com.amazonaws.storagegateway#string", "traits": { @@ -8458,28 +8640,22 @@ "com.amazonaws.storagegateway#VolumeiSCSIAttributes": { "type": "structure", "members": { - "NetworkInterfaceId": { - "target": "com.amazonaws.storagegateway#NetworkInterfaceId", - "traits": { - "smithy.api#documentation": "The network interface identifier.
" - } - }, "TargetARN": { "target": "com.amazonaws.storagegateway#TargetARN", "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the volume target.
" } }, - "NetworkInterfacePort": { - "target": "com.amazonaws.storagegateway#integer", + "NetworkInterfaceId": { + "target": "com.amazonaws.storagegateway#NetworkInterfaceId", "traits": { - "smithy.api#documentation": "The port used to communicate with iSCSI targets.
" + "smithy.api#documentation": "The network interface identifier.
" } }, - "ChapEnabled": { - "target": "com.amazonaws.storagegateway#Boolean2", + "NetworkInterfacePort": { + "target": "com.amazonaws.storagegateway#integer", "traits": { - "smithy.api#documentation": "Indicates whether mutual CHAP is enabled for the iSCSI target.
" + "smithy.api#documentation": "The port used to communicate with iSCSI targets.
" } }, "LunNumber": { @@ -8487,6 +8663,12 @@ "traits": { "smithy.api#documentation": "The logical disk number.
" } + }, + "ChapEnabled": { + "target": "com.amazonaws.storagegateway#Boolean2", + "traits": { + "smithy.api#documentation": "Indicates whether mutual CHAP is enabled for the iSCSI target.
" + } } }, "traits": { From 5a9222461e7de75241292415cedeb0250bd63e8e Mon Sep 17 00:00:00 2001 From: Trivikram Kamat <16024985+trivikr@users.noreply.github.com> Date: Thu, 12 Nov 2020 00:24:46 +0000 Subject: [PATCH 2/7] feat: update clients as of 11/11 --- .../ListAnalyzedResourcesPaginator.ts | 2 +- .../pagination/ListAnalyzersPaginator.ts | 2 +- .../pagination/ListArchiveRulesPaginator.ts | 2 +- .../pagination/ListFindingsPaginator.ts | 2 +- .../ListCertificateAuthoritiesPaginator.ts | 2 +- .../pagination/ListPermissionsPaginator.ts | 2 +- .../pagination/ListTagsPaginator.ts | 2 +- .../pagination/ListCertificatesPaginator.ts | 2 +- .../ListBusinessReportSchedulesPaginator.ts | 2 +- .../ListConferenceProvidersPaginator.ts | 2 +- .../pagination/ListDeviceEventsPaginator.ts | 2 +- .../pagination/ListGatewayGroupsPaginator.ts | 2 +- .../pagination/ListGatewaysPaginator.ts | 2 +- .../pagination/ListSkillsPaginator.ts | 2 +- .../ListSkillsStoreCategoriesPaginator.ts | 2 +- ...istSkillsStoreSkillsByCategoryPaginator.ts | 2 +- .../ListSmartHomeAppliancesPaginator.ts | 2 +- .../pagination/ListTagsPaginator.ts | 2 +- .../pagination/SearchAddressBooksPaginator.ts | 2 +- .../pagination/SearchContactsPaginator.ts | 2 +- .../pagination/SearchDevicesPaginator.ts | 2 +- .../SearchNetworkProfilesPaginator.ts | 2 +- .../pagination/SearchProfilesPaginator.ts | 2 +- .../pagination/SearchRoomsPaginator.ts | 2 +- .../pagination/SearchSkillGroupsPaginator.ts | 2 +- .../pagination/SearchUsersPaginator.ts | 2 +- clients/client-amplify/models/models_0.ts | 1001 +-- .../client-amplify/protocols/Aws_restJson1.ts | 138 +- .../pagination/GetApiKeysPaginator.ts | 2 +- .../GetBasePathMappingsPaginator.ts | 2 +- .../GetClientCertificatesPaginator.ts | 2 +- .../pagination/GetDeploymentsPaginator.ts | 2 +- .../pagination/GetDomainNamesPaginator.ts | 2 +- .../pagination/GetModelsPaginator.ts | 2 +- .../pagination/GetResourcesPaginator.ts | 2 +- .../pagination/GetRestApisPaginator.ts | 2 +- .../pagination/GetUsagePaginator.ts | 2 +- .../pagination/GetUsagePlanKeysPaginator.ts | 2 +- .../pagination/GetUsagePlansPaginator.ts | 2 +- .../pagination/GetVpcLinksPaginator.ts | 2 +- .../pagination/ListGatewayRoutesPaginator.ts | 2 +- .../pagination/ListMeshesPaginator.ts | 2 +- .../pagination/ListRoutesPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- .../ListVirtualGatewaysPaginator.ts | 2 +- .../pagination/ListVirtualNodesPaginator.ts | 2 +- .../pagination/ListVirtualRoutersPaginator.ts | 2 +- .../ListVirtualServicesPaginator.ts | 2 +- .../pagination/ListApplicationsPaginator.ts | 2 +- .../ListConfigurationProfilesPaginator.ts | 2 +- .../ListDeploymentStrategiesPaginator.ts | 2 +- .../pagination/ListDeploymentsPaginator.ts | 2 +- .../pagination/ListEnvironmentsPaginator.ts | 2 +- ...istHostedConfigurationVersionsPaginator.ts | 2 +- .../DescribeConnectorProfilesPaginator.ts | 2 +- .../pagination/DescribeConnectorsPaginator.ts | 2 +- .../DescribeFlowExecutionRecordsPaginator.ts | 2 +- .../pagination/ListFlowsPaginator.ts | 2 +- .../DescribeScalableTargetsPaginator.ts | 2 +- .../DescribeScalingActivitiesPaginator.ts | 2 +- .../DescribeScalingPoliciesPaginator.ts | 2 +- .../DescribeScheduledActionsPaginator.ts | 2 +- .../DescribeContinuousExportsPaginator.ts | 2 +- .../DescribeImportTasksPaginator.ts | 2 +- .../pagination/ListApplicationsPaginator.ts | 2 +- .../pagination/ListComponentsPaginator.ts | 2 +- .../ListConfigurationHistoryPaginator.ts | 2 +- .../pagination/ListLogPatternSetsPaginator.ts | 2 +- .../pagination/ListLogPatternsPaginator.ts | 2 +- .../pagination/ListProblemsPaginator.ts | 2 +- .../DescribeImagePermissionsPaginator.ts | 2 +- .../pagination/DescribeImagesPaginator.ts | 2 +- .../pagination/GetQueryResultsPaginator.ts | 2 +- .../pagination/ListDataCatalogsPaginator.ts | 2 +- .../pagination/ListDatabasesPaginator.ts | 2 +- .../pagination/ListNamedQueriesPaginator.ts | 2 +- .../ListQueryExecutionsPaginator.ts | 2 +- .../pagination/ListTableMetadataPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- .../pagination/ListWorkGroupsPaginator.ts | 2 +- clients/client-auto-scaling/AutoScaling.ts | 105 +- .../client-auto-scaling/models/models_0.ts | 2464 +++--- .../DescribeAutoScalingGroupsPaginator.ts | 2 +- .../DescribeAutoScalingInstancesPaginator.ts | 2 +- .../DescribeLaunchConfigurationsPaginator.ts | 2 +- ...ribeNotificationConfigurationsPaginator.ts | 2 +- .../pagination/DescribePoliciesPaginator.ts | 2 +- .../DescribeScalingActivitiesPaginator.ts | 2 +- .../DescribeScheduledActionsPaginator.ts | 2 +- .../pagination/DescribeTagsPaginator.ts | 2 +- .../protocols/Aws_query.ts | 1512 ++-- .../pagination/ListBackupJobsPaginator.ts | 2 +- .../ListBackupPlanTemplatesPaginator.ts | 2 +- .../ListBackupPlanVersionsPaginator.ts | 2 +- .../pagination/ListBackupPlansPaginator.ts | 2 +- .../ListBackupSelectionsPaginator.ts | 2 +- .../pagination/ListBackupVaultsPaginator.ts | 2 +- .../pagination/ListCopyJobsPaginator.ts | 2 +- .../ListProtectedResourcesPaginator.ts | 2 +- ...istRecoveryPointsByBackupVaultPaginator.ts | 2 +- .../ListRecoveryPointsByResourcePaginator.ts | 2 +- .../pagination/ListRestoreJobsPaginator.ts | 2 +- .../pagination/ListTagsPaginator.ts | 2 +- .../DescribeComputeEnvironmentsPaginator.ts | 2 +- .../DescribeJobDefinitionsPaginator.ts | 2 +- .../pagination/DescribeJobQueuesPaginator.ts | 2 +- .../pagination/ListJobsPaginator.ts | 2 +- .../pagination/SearchDevicesPaginator.ts | 2 +- .../pagination/SearchQuantumTasksPaginator.ts | 2 +- .../DescribeBudgetActionHistoriesPaginator.ts | 2 +- ...escribeBudgetActionsForAccountPaginator.ts | 2 +- ...DescribeBudgetActionsForBudgetPaginator.ts | 2 +- .../pagination/DescribeBudgetsPaginator.ts | 2 +- ...DescribeNotificationsForBudgetPaginator.ts | 2 +- ...ribeSubscribersForNotificationPaginator.ts | 2 +- .../pagination/ListAccountsPaginator.ts | 2 +- .../pagination/ListAttendeesPaginator.ts | 2 +- .../pagination/ListBotsPaginator.ts | 2 +- .../pagination/ListMeetingsPaginator.ts | 2 +- .../ListPhoneNumberOrdersPaginator.ts | 2 +- .../pagination/ListPhoneNumbersPaginator.ts | 2 +- .../pagination/ListProxySessionsPaginator.ts | 2 +- .../ListRoomMembershipsPaginator.ts | 2 +- .../pagination/ListRoomsPaginator.ts | 2 +- .../pagination/ListUsersPaginator.ts | 2 +- .../ListVoiceConnectorGroupsPaginator.ts | 2 +- .../ListVoiceConnectorsPaginator.ts | 2 +- ...DescribeEnvironmentMembershipsPaginator.ts | 2 +- .../pagination/ListEnvironmentsPaginator.ts | 2 +- .../ListAppliedSchemaArnsPaginator.ts | 2 +- .../ListAttachedIndicesPaginator.ts | 2 +- .../ListDevelopmentSchemaArnsPaginator.ts | 2 +- .../pagination/ListDirectoriesPaginator.ts | 2 +- .../ListFacetAttributesPaginator.ts | 2 +- .../pagination/ListFacetNamesPaginator.ts | 2 +- .../pagination/ListIndexPaginator.ts | 2 +- .../ListManagedSchemaArnsPaginator.ts | 2 +- .../ListObjectAttributesPaginator.ts | 2 +- .../pagination/ListObjectChildrenPaginator.ts | 2 +- .../ListObjectParentPathsPaginator.ts | 2 +- .../pagination/ListObjectParentsPaginator.ts | 2 +- .../pagination/ListObjectPoliciesPaginator.ts | 2 +- .../ListPolicyAttachmentsPaginator.ts | 2 +- .../ListPublishedSchemaArnsPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- .../ListTypedLinkFacetAttributesPaginator.ts | 2 +- .../ListTypedLinkFacetNamesPaginator.ts | 2 +- .../pagination/LookupPolicyPaginator.ts | 2 +- .../DescribeAccountLimitsPaginator.ts | 2 +- .../DescribeStackEventsPaginator.ts | 2 +- .../DescribeStackResourceDriftsPaginator.ts | 2 +- .../pagination/DescribeStacksPaginator.ts | 2 +- .../pagination/ListChangeSetsPaginator.ts | 2 +- .../pagination/ListExportsPaginator.ts | 2 +- .../pagination/ListImportsPaginator.ts | 2 +- .../pagination/ListStackInstancesPaginator.ts | 2 +- .../pagination/ListStackResourcesPaginator.ts | 2 +- .../ListStackSetOperationResultsPaginator.ts | 2 +- .../ListStackSetOperationsPaginator.ts | 2 +- .../pagination/ListStackSetsPaginator.ts | 2 +- .../pagination/ListStacksPaginator.ts | 2 +- .../ListTypeRegistrationsPaginator.ts | 2 +- .../pagination/ListTypeVersionsPaginator.ts | 2 +- .../pagination/ListTypesPaginator.ts | 2 +- .../pagination/DescribeBackupsPaginator.ts | 2 +- .../pagination/DescribeClustersPaginator.ts | 2 +- .../pagination/ListTagsPaginator.ts | 2 +- .../pagination/ListPublicKeysPaginator.ts | 2 +- .../pagination/ListTagsPaginator.ts | 2 +- .../pagination/ListTrailsPaginator.ts | 2 +- .../pagination/LookupEventsPaginator.ts | 2 +- .../DescribeDestinationsPaginator.ts | 2 +- .../pagination/DescribeLogGroupsPaginator.ts | 2 +- .../pagination/DescribeLogStreamsPaginator.ts | 2 +- .../DescribeMetricFiltersPaginator.ts | 2 +- .../DescribeSubscriptionFiltersPaginator.ts | 2 +- .../pagination/FilterLogEventsPaginator.ts | 2 +- .../pagination/GetLogEventsPaginator.ts | 2 +- .../DescribeAlarmHistoryPaginator.ts | 2 +- .../pagination/DescribeAlarmsPaginator.ts | 2 +- .../DescribeInsightRulesPaginator.ts | 2 +- .../pagination/GetMetricDataPaginator.ts | 2 +- .../pagination/ListDashboardsPaginator.ts | 2 +- .../pagination/ListMetricsPaginator.ts | 2 +- .../pagination/ListDomainsPaginator.ts | 2 +- .../ListPackageVersionAssetsPaginator.ts | 2 +- .../ListPackageVersionsPaginator.ts | 2 +- .../pagination/ListPackagesPaginator.ts | 2 +- .../ListRepositoriesInDomainPaginator.ts | 2 +- .../pagination/ListRepositoriesPaginator.ts | 2 +- .../DescribeCodeCoveragesPaginator.ts | 2 +- .../pagination/DescribeTestCasesPaginator.ts | 2 +- .../ListBuildBatchesForProjectPaginator.ts | 2 +- .../pagination/ListBuildBatchesPaginator.ts | 2 +- .../ListBuildsForProjectPaginator.ts | 2 +- .../pagination/ListBuildsPaginator.ts | 2 +- .../pagination/ListProjectsPaginator.ts | 2 +- .../pagination/ListReportGroupsPaginator.ts | 2 +- .../ListReportsForReportGroupPaginator.ts | 2 +- .../pagination/ListReportsPaginator.ts | 2 +- .../pagination/ListSharedProjectsPaginator.ts | 2 +- .../ListSharedReportGroupsPaginator.ts | 2 +- .../DescribeMergeConflictsPaginator.ts | 2 +- .../DescribePullRequestEventsPaginator.ts | 2 +- .../GetCommentReactionsPaginator.ts | 2 +- .../GetCommentsForComparedCommitPaginator.ts | 2 +- .../GetCommentsForPullRequestPaginator.ts | 2 +- .../pagination/GetDifferencesPaginator.ts | 2 +- .../pagination/GetMergeConflictsPaginator.ts | 2 +- .../ListApprovalRuleTemplatesPaginator.ts | 2 +- ...ovalRuleTemplatesForRepositoryPaginator.ts | 2 +- .../pagination/ListBranchesPaginator.ts | 2 +- .../pagination/ListPullRequestsPaginator.ts | 2 +- ...itoriesForApprovalRuleTemplatePaginator.ts | 2 +- .../pagination/ListRepositoriesPaginator.ts | 2 +- .../ListApplicationRevisionsPaginator.ts | 2 +- .../pagination/ListApplicationsPaginator.ts | 2 +- .../ListDeploymentConfigsPaginator.ts | 2 +- .../ListDeploymentGroupsPaginator.ts | 2 +- .../ListDeploymentInstancesPaginator.ts | 2 +- .../pagination/ListDeploymentsPaginator.ts | 2 +- .../pagination/ListCodeReviewsPaginator.ts | 2 +- .../ListRecommendationFeedbackPaginator.ts | 2 +- .../ListRecommendationsPaginator.ts | 2 +- .../ListRepositoryAssociationsPaginator.ts | 2 +- .../pagination/ListProfileTimesPaginator.ts | 2 +- .../ListProfilingGroupsPaginator.ts | 2 +- .../ListActionExecutionsPaginator.ts | 2 +- .../pagination/ListActionTypesPaginator.ts | 2 +- .../ListPipelineExecutionsPaginator.ts | 2 +- .../pagination/ListPipelinesPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- .../pagination/ListWebhooksPaginator.ts | 2 +- .../pagination/ListConnectionsPaginator.ts | 2 +- .../pagination/ListHostsPaginator.ts | 2 +- .../pagination/ListEventTypesPaginator.ts | 2 +- .../ListNotificationRulesPaginator.ts | 2 +- .../pagination/ListTargetsPaginator.ts | 2 +- .../AdminListGroupsForUserPaginator.ts | 2 +- .../AdminListUserAuthEventsPaginator.ts | 2 +- .../pagination/ListGroupsPaginator.ts | 2 +- .../ListIdentityProvidersPaginator.ts | 2 +- .../ListResourceServersPaginator.ts | 2 +- .../ListUserPoolClientsPaginator.ts | 2 +- .../pagination/ListUsersInGroupPaginator.ts | 2 +- .../pagination/ListUsersPaginator.ts | 2 +- ...ListDocumentClassificationJobsPaginator.ts | 2 +- .../ListDocumentClassifiersPaginator.ts | 2 +- ...tDominantLanguageDetectionJobsPaginator.ts | 2 +- .../ListEntitiesDetectionJobsPaginator.ts | 2 +- .../ListEntityRecognizersPaginator.ts | 2 +- .../ListKeyPhrasesDetectionJobsPaginator.ts | 2 +- .../ListSentimentDetectionJobsPaginator.ts | 2 +- .../ListTopicsDetectionJobsPaginator.ts | 2 +- .../DescribeRemediationExceptionsPaginator.ts | 2 +- ...ribeRemediationExecutionStatusPaginator.ts | 2 +- .../GetResourceConfigHistoryPaginator.ts | 2 +- .../SelectAggregateResourceConfigPaginator.ts | 2 +- .../GetCurrentMetricDataPaginator.ts | 2 +- .../pagination/GetMetricDataPaginator.ts | 2 +- .../pagination/ListContactFlowsPaginator.ts | 2 +- .../ListHoursOfOperationsPaginator.ts | 2 +- .../pagination/ListPhoneNumbersPaginator.ts | 2 +- .../pagination/ListPromptsPaginator.ts | 2 +- .../pagination/ListQueuesPaginator.ts | 2 +- .../ListRoutingProfileQueuesPaginator.ts | 2 +- .../ListRoutingProfilesPaginator.ts | 2 +- .../ListSecurityProfilesPaginator.ts | 2 +- .../ListUserHierarchyGroupsPaginator.ts | 2 +- .../pagination/ListUsersPaginator.ts | 2 +- .../pagination/GetTranscriptPaginator.ts | 2 +- .../DescribeReportDefinitionsPaginator.ts | 2 +- .../GetSavingsPlansCoveragePaginator.ts | 2 +- ...SavingsPlansUtilizationDetailsPaginator.ts | 2 +- .../ListCostCategoryDefinitionsPaginator.ts | 2 +- .../pagination/DescribeObjectsPaginator.ts | 2 +- .../pagination/ListPipelinesPaginator.ts | 2 +- .../pagination/QueryObjectsPaginator.ts | 2 +- ...pplicableIndividualAssessmentsPaginator.ts | 2 +- .../DescribeCertificatesPaginator.ts | 2 +- .../DescribeConnectionsPaginator.ts | 2 +- .../DescribeEndpointTypesPaginator.ts | 2 +- .../pagination/DescribeEndpointsPaginator.ts | 2 +- .../DescribeEventSubscriptionsPaginator.ts | 2 +- .../pagination/DescribeEventsPaginator.ts | 2 +- ...eOrderableReplicationInstancesPaginator.ts | 2 +- ...cribePendingMaintenanceActionsPaginator.ts | 2 +- ...ibeReplicationInstanceTaskLogsPaginator.ts | 2 +- .../DescribeReplicationInstancesPaginator.ts | 2 +- ...escribeReplicationSubnetGroupsPaginator.ts | 2 +- ...plicationTaskAssessmentResultsPaginator.ts | 2 +- ...eReplicationTaskAssessmentRunsPaginator.ts | 2 +- ...ationTaskIndividualAssessmentsPaginator.ts | 2 +- .../DescribeReplicationTasksPaginator.ts | 2 +- .../pagination/DescribeSchemasPaginator.ts | 2 +- .../DescribeTableStatisticsPaginator.ts | 2 +- clients/client-databrew/.gitignore | 14 + clients/client-databrew/.npmignore | 4 + clients/client-databrew/DataBrew.ts | 1346 ++++ clients/client-databrew/DataBrewClient.ts | 333 + clients/client-databrew/LICENSE | 201 + clients/client-databrew/README.md | 6 + .../BatchDeleteRecipeVersionCommand.ts | 82 + .../commands/CreateDatasetCommand.ts | 82 + .../commands/CreateProfileJobCommand.ts | 82 + .../commands/CreateProjectCommand.ts | 82 + .../commands/CreateRecipeCommand.ts | 82 + .../commands/CreateRecipeJobCommand.ts | 82 + .../commands/CreateScheduleCommand.ts | 82 + .../commands/DeleteDatasetCommand.ts | 82 + .../commands/DeleteJobCommand.ts | 82 + .../commands/DeleteProjectCommand.ts | 82 + .../commands/DeleteRecipeVersionCommand.ts | 82 + .../commands/DeleteScheduleCommand.ts | 82 + .../commands/DescribeDatasetCommand.ts | 82 + .../commands/DescribeJobCommand.ts | 82 + .../commands/DescribeProjectCommand.ts | 82 + .../commands/DescribeRecipeCommand.ts | 82 + .../commands/DescribeScheduleCommand.ts | 82 + .../commands/ListDatasetsCommand.ts | 82 + .../commands/ListJobRunsCommand.ts | 82 + .../commands/ListJobsCommand.ts | 82 + .../commands/ListProjectsCommand.ts | 82 + .../commands/ListRecipeVersionsCommand.ts | 82 + .../commands/ListRecipesCommand.ts | 82 + .../commands/ListSchedulesCommand.ts | 82 + .../commands/ListTagsForResourceCommand.ts | 82 + .../commands/PublishRecipeCommand.ts | 82 + .../SendProjectSessionActionCommand.ts | 82 + .../commands/StartJobRunCommand.ts | 82 + .../commands/StartProjectSessionCommand.ts | 82 + .../commands/StopJobRunCommand.ts | 82 + .../commands/TagResourceCommand.ts | 82 + .../commands/UntagResourceCommand.ts | 82 + .../commands/UpdateDatasetCommand.ts | 82 + .../commands/UpdateProfileJobCommand.ts | 82 + .../commands/UpdateProjectCommand.ts | 82 + .../commands/UpdateRecipeCommand.ts | 82 + .../commands/UpdateRecipeJobCommand.ts | 82 + .../commands/UpdateScheduleCommand.ts | 82 + clients/client-databrew/endpoints.ts | 81 + clients/client-databrew/index.ts | 49 + clients/client-databrew/models/index.ts | 1 + clients/client-databrew/models/models_0.ts | 2941 +++++++ clients/client-databrew/package.json | 83 + .../client-databrew/pagination/Interfaces.ts | 7 + .../pagination/ListDatasetsPaginator.ts | 51 + .../pagination/ListJobRunsPaginator.ts | 47 + .../pagination/ListJobsPaginator.ts | 47 + .../pagination/ListProjectsPaginator.ts | 51 + .../pagination/ListRecipeVersionsPaginator.ts | 51 + .../pagination/ListRecipesPaginator.ts | 47 + .../pagination/ListSchedulesPaginator.ts | 51 + .../protocols/Aws_restJson1.ts | 4748 +++++++++++ .../client-databrew/runtimeConfig.browser.ts | 31 + .../client-databrew/runtimeConfig.native.ts | 14 + .../client-databrew/runtimeConfig.shared.ts | 10 + clients/client-databrew/runtimeConfig.ts | 33 + clients/client-databrew/tsconfig.es.json | 12 + clients/client-databrew/tsconfig.json | 28 + .../ListDataSetRevisionsPaginator.ts | 2 +- .../pagination/ListDataSetsPaginator.ts | 2 +- .../pagination/ListJobsPaginator.ts | 2 +- .../pagination/ListRevisionAssetsPaginator.ts | 2 +- clients/client-datasync/DataSync.ts | 49 +- clients/client-datasync/DataSyncClient.ts | 10 +- .../commands/UpdateTaskExecutionCommand.ts | 82 + clients/client-datasync/index.ts | 1 + clients/client-datasync/models/models_0.ts | 1002 +-- .../pagination/ListAgentsPaginator.ts | 2 +- .../pagination/ListLocationsPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- .../pagination/ListTaskExecutionsPaginator.ts | 2 +- .../pagination/ListTasksPaginator.ts | 2 +- .../client-datasync/protocols/Aws_json1_1.ts | 99 + .../pagination/ListGraphsPaginator.ts | 2 +- .../pagination/ListInvitationsPaginator.ts | 2 +- .../pagination/ListMembersPaginator.ts | 2 +- .../pagination/GetOfferingStatusPaginator.ts | 2 +- .../pagination/ListArtifactsPaginator.ts | 2 +- .../pagination/ListDevicePoolsPaginator.ts | 2 +- .../pagination/ListDevicesPaginator.ts | 2 +- .../pagination/ListJobsPaginator.ts | 2 +- .../ListOfferingTransactionsPaginator.ts | 2 +- .../pagination/ListOfferingsPaginator.ts | 2 +- .../pagination/ListProjectsPaginator.ts | 2 +- .../pagination/ListRunsPaginator.ts | 2 +- .../pagination/ListSamplesPaginator.ts | 2 +- .../pagination/ListSuitesPaginator.ts | 2 +- .../ListTestGridProjectsPaginator.ts | 2 +- .../ListTestGridSessionActionsPaginator.ts | 2 +- .../ListTestGridSessionArtifactsPaginator.ts | 2 +- .../ListTestGridSessionsPaginator.ts | 2 +- .../pagination/ListTestsPaginator.ts | 2 +- .../pagination/ListUniqueProblemsPaginator.ts | 2 +- .../pagination/ListUploadsPaginator.ts | 2 +- .../DescribeDomainControllersPaginator.ts | 2 +- .../DescribeCertificatesPaginator.ts | 2 +- ...scribeDBClusterParameterGroupsPaginator.ts | 2 +- .../DescribeDBClusterParametersPaginator.ts | 2 +- .../DescribeDBClusterSnapshotsPaginator.ts | 2 +- .../pagination/DescribeDBClustersPaginator.ts | 2 +- .../DescribeDBEngineVersionsPaginator.ts | 2 +- .../DescribeDBInstancesPaginator.ts | 2 +- .../DescribeDBSubnetGroupsPaginator.ts | 2 +- .../pagination/DescribeEventsPaginator.ts | 2 +- ...ribeOrderableDBInstanceOptionsPaginator.ts | 2 +- ...cribePendingMaintenanceActionsPaginator.ts | 2 +- clients/client-dynamodb/DynamoDB.ts | 103 + clients/client-dynamodb/DynamoDBClient.ts | 12 + .../commands/DescribeExportCommand.ts | 82 + .../ExportTableToPointInTimeCommand.ts | 82 + .../commands/ListExportsCommand.ts | 82 + clients/client-dynamodb/index.ts | 4 + clients/client-dynamodb/models/models_0.ts | 395 +- .../ListContributorInsightsPaginator.ts | 2 +- .../pagination/ListExportsPaginator.ts | 47 + .../pagination/ListTablesPaginator.ts | 2 +- .../client-dynamodb/protocols/Aws_json1_0.ts | 467 ++ .../pagination/ListChangedBlocksPaginator.ts | 2 +- .../pagination/ListSnapshotBlocksPaginator.ts | 2 +- clients/client-ec2/EC2.ts | 30 +- clients/client-ec2/models/models_1.ts | 27 +- clients/client-ec2/models/models_3.ts | 9 + clients/client-ec2/models/models_4.ts | 25 +- .../DescribeCapacityReservationsPaginator.ts | 2 +- .../DescribeCarrierGatewaysPaginator.ts | 2 +- .../DescribeClassicLinkInstancesPaginator.ts | 2 +- ...ibeClientVpnAuthorizationRulesPaginator.ts | 2 +- .../DescribeClientVpnConnectionsPaginator.ts | 2 +- .../DescribeClientVpnEndpointsPaginator.ts | 2 +- .../DescribeClientVpnRoutesPaginator.ts | 2 +- ...escribeClientVpnTargetNetworksPaginator.ts | 2 +- .../pagination/DescribeCoipPoolsPaginator.ts | 2 +- .../DescribeDhcpOptionsPaginator.ts | 2 +- ...ribeEgressOnlyInternetGatewaysPaginator.ts | 2 +- .../DescribeExportImageTasksPaginator.ts | 2 +- .../DescribeFastSnapshotRestoresPaginator.ts | 2 +- .../pagination/DescribeFleetsPaginator.ts | 2 +- .../pagination/DescribeFlowLogsPaginator.ts | 2 +- .../pagination/DescribeFpgaImagesPaginator.ts | 2 +- ...scribeHostReservationOfferingsPaginator.ts | 2 +- .../DescribeHostReservationsPaginator.ts | 2 +- .../pagination/DescribeHostsPaginator.ts | 2 +- ...IamInstanceProfileAssociationsPaginator.ts | 2 +- .../DescribeImportImageTasksPaginator.ts | 2 +- .../DescribeImportSnapshotTasksPaginator.ts | 2 +- ...beInstanceCreditSpecificationsPaginator.ts | 2 +- .../DescribeInstanceStatusPaginator.ts | 2 +- .../DescribeInstanceTypeOfferingsPaginator.ts | 2 +- .../DescribeInstanceTypesPaginator.ts | 2 +- .../pagination/DescribeInstancesPaginator.ts | 2 +- .../DescribeInternetGatewaysPaginator.ts | 2 +- .../pagination/DescribeIpv6PoolsPaginator.ts | 2 +- ...DescribeLaunchTemplateVersionsPaginator.ts | 2 +- .../DescribeLaunchTemplatesPaginator.ts | 2 +- ...tualInterfaceGroupAssociationsPaginator.ts | 2 +- ...tewayRouteTableVpcAssociationsPaginator.ts | 2 +- ...escribeLocalGatewayRouteTablesPaginator.ts | 2 +- ...lGatewayVirtualInterfaceGroupsPaginator.ts | 2 +- ...eLocalGatewayVirtualInterfacesPaginator.ts | 2 +- .../DescribeLocalGatewaysPaginator.ts | 2 +- .../DescribeManagedPrefixListsPaginator.ts | 2 +- .../DescribeMovingAddressesPaginator.ts | 2 +- .../DescribeNatGatewaysPaginator.ts | 2 +- .../DescribeNetworkAclsPaginator.ts | 2 +- ...ibeNetworkInterfacePermissionsPaginator.ts | 2 +- .../DescribeNetworkInterfacesPaginator.ts | 2 +- .../DescribePrefixListsPaginator.ts | 2 +- .../DescribePrincipalIdFormatPaginator.ts | 2 +- .../DescribePublicIpv4PoolsPaginator.ts | 2 +- ...ReservedInstancesModificationsPaginator.ts | 2 +- ...ribeReservedInstancesOfferingsPaginator.ts | 2 +- .../DescribeRouteTablesPaginator.ts | 2 +- ...eScheduledInstanceAvailabilityPaginator.ts | 2 +- .../DescribeScheduledInstancesPaginator.ts | 2 +- .../DescribeSecurityGroupsPaginator.ts | 2 +- .../pagination/DescribeSnapshotsPaginator.ts | 2 +- .../DescribeSpotFleetRequestsPaginator.ts | 2 +- .../DescribeSpotInstanceRequestsPaginator.ts | 2 +- .../DescribeSpotPriceHistoryPaginator.ts | 2 +- .../DescribeStaleSecurityGroupsPaginator.ts | 2 +- .../pagination/DescribeSubnetsPaginator.ts | 2 +- .../pagination/DescribeTagsPaginator.ts | 2 +- .../DescribeTrafficMirrorFiltersPaginator.ts | 2 +- .../DescribeTrafficMirrorSessionsPaginator.ts | 2 +- .../DescribeTrafficMirrorTargetsPaginator.ts | 2 +- ...cribeTransitGatewayAttachmentsPaginator.ts | 2 +- ...TransitGatewayMulticastDomainsPaginator.ts | 2 +- ...ansitGatewayPeeringAttachmentsPaginator.ts | 2 +- ...cribeTransitGatewayRouteTablesPaginator.ts | 2 +- ...beTransitGatewayVpcAttachmentsPaginator.ts | 2 +- .../DescribeTransitGatewaysPaginator.ts | 2 +- .../DescribeVolumeStatusPaginator.ts | 2 +- .../DescribeVolumesModificationsPaginator.ts | 2 +- .../pagination/DescribeVolumesPaginator.ts | 2 +- ...scribeVpcClassicLinkDnsSupportPaginator.ts | 2 +- ...ndpointConnectionNotificationsPaginator.ts | 2 +- ...DescribeVpcEndpointConnectionsPaginator.ts | 2 +- ...cEndpointServiceConfigurationsPaginator.ts | 2 +- ...eVpcEndpointServicePermissionsPaginator.ts | 2 +- .../DescribeVpcEndpointsPaginator.ts | 2 +- .../DescribeVpcPeeringConnectionsPaginator.ts | 2 +- .../pagination/DescribeVpcsPaginator.ts | 2 +- .../GetAssociatedIpv6PoolCidrsPaginator.ts | 2 +- ...etGroupsForCapacityReservationPaginator.ts | 2 +- ...tManagedPrefixListAssociationsPaginator.ts | 2 +- .../GetManagedPrefixListEntriesPaginator.ts | 2 +- ...tGatewayAttachmentPropagationsPaginator.ts | 2 +- ...wayMulticastDomainAssociationsPaginator.ts | 2 +- ...sitGatewayPrefixListReferencesPaginator.ts | 2 +- ...tGatewayRouteTableAssociationsPaginator.ts | 2 +- ...tGatewayRouteTablePropagationsPaginator.ts | 2 +- .../SearchLocalGatewayRoutesPaginator.ts | 2 +- ...hTransitGatewayMulticastGroupsPaginator.ts | 2 +- clients/client-ec2/protocols/Aws_ec2.ts | 47 + .../DescribeImageScanFindingsPaginator.ts | 2 +- .../pagination/DescribeImagesPaginator.ts | 2 +- .../DescribeRepositoriesPaginator.ts | 2 +- .../GetLifecyclePolicyPreviewPaginator.ts | 2 +- .../pagination/ListImagesPaginator.ts | 2 +- clients/client-ecs/ECS.ts | 988 +-- clients/client-ecs/ECSClient.ts | 28 +- clients/client-ecs/models/models_0.ts | 6913 +++++++++-------- .../ListAccountSettingsPaginator.ts | 2 +- .../pagination/ListAttributesPaginator.ts | 2 +- .../pagination/ListClustersPaginator.ts | 2 +- .../ListContainerInstancesPaginator.ts | 2 +- .../pagination/ListServicesPaginator.ts | 2 +- .../ListTaskDefinitionFamiliesPaginator.ts | 2 +- .../ListTaskDefinitionsPaginator.ts | 2 +- .../pagination/ListTasksPaginator.ts | 2 +- clients/client-ecs/protocols/Aws_json1_1.ts | 70 + .../DescribeAccessPointsPaginator.ts | 2 +- .../DescribeFileSystemsPaginator.ts | 2 +- .../pagination/DescribeTagsPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- .../pagination/ListClustersPaginator.ts | 2 +- .../ListFargateProfilesPaginator.ts | 2 +- .../pagination/ListNodegroupsPaginator.ts | 2 +- .../pagination/ListUpdatesPaginator.ts | 2 +- ...nvironmentManagedActionHistoryPaginator.ts | 2 +- .../pagination/DescribeEventsPaginator.ts | 2 +- .../ListPlatformBranchesPaginator.ts | 2 +- .../ListPlatformVersionsPaginator.ts | 2 +- .../DescribeAcceleratorsPaginator.ts | 2 +- .../ElasticLoadBalancingV2.ts | 278 +- .../ElasticLoadBalancingV2Client.ts | 23 +- .../models/models_0.ts | 1289 ++- .../pagination/DescribeListenersPaginator.ts | 2 +- .../DescribeLoadBalancersPaginator.ts | 2 +- .../DescribeTargetGroupsPaginator.ts | 2 +- .../protocols/Aws_query.ts | 984 +-- .../DescribeLoadBalancersPaginator.ts | 2 +- .../pagination/ListJobsByPipelinePaginator.ts | 2 +- .../pagination/ListJobsByStatusPaginator.ts | 2 +- .../pagination/ListPipelinesPaginator.ts | 2 +- .../pagination/ListPresetsPaginator.ts | 2 +- .../DescribeCacheClustersPaginator.ts | 2 +- .../DescribeCacheEngineVersionsPaginator.ts | 2 +- .../DescribeCacheParameterGroupsPaginator.ts | 2 +- .../DescribeCacheParametersPaginator.ts | 2 +- .../DescribeCacheSecurityGroupsPaginator.ts | 2 +- .../DescribeCacheSubnetGroupsPaginator.ts | 2 +- ...escribeEngineDefaultParametersPaginator.ts | 2 +- .../pagination/DescribeEventsPaginator.ts | 2 +- ...escribeGlobalReplicationGroupsPaginator.ts | 2 +- .../DescribeReplicationGroupsPaginator.ts | 2 +- ...ibeReservedCacheNodesOfferingsPaginator.ts | 2 +- .../DescribeReservedCacheNodesPaginator.ts | 2 +- .../DescribeServiceUpdatesPaginator.ts | 2 +- .../pagination/DescribeSnapshotsPaginator.ts | 2 +- .../DescribeUpdateActionsPaginator.ts | 2 +- .../pagination/DescribeUserGroupsPaginator.ts | 2 +- .../pagination/DescribeUsersPaginator.ts | 2 +- .../ElasticsearchService.ts | 74 + .../ElasticsearchServiceClient.ts | 9 + .../GetPackageVersionHistoryCommand.ts | 86 + .../commands/UpdatePackageCommand.ts | 86 + clients/client-elasticsearch-service/index.ts | 3 + .../models/models_0.ts | 145 + ...dCrossClusterSearchConnectionsPaginator.ts | 2 +- ...dCrossClusterSearchConnectionsPaginator.ts | 2 +- .../pagination/DescribePackagesPaginator.ts | 2 +- ...ElasticsearchInstanceOfferingsPaginator.ts | 2 +- ...ReservedElasticsearchInstancesPaginator.ts | 2 +- .../GetPackageVersionHistoryPaginator.ts | 51 + .../pagination/GetUpgradeHistoryPaginator.ts | 2 +- .../ListDomainsForPackagePaginator.ts | 2 +- ...ListElasticsearchInstanceTypesPaginator.ts | 2 +- .../ListElasticsearchVersionsPaginator.ts | 2 +- .../ListPackagesForDomainPaginator.ts | 2 +- .../protocols/Aws_restJson1.ts | 293 + .../ListBootstrapActionsPaginator.ts | 2 +- .../pagination/ListClustersPaginator.ts | 2 +- .../pagination/ListInstanceFleetsPaginator.ts | 2 +- .../pagination/ListInstanceGroupsPaginator.ts | 2 +- .../pagination/ListInstancesPaginator.ts | 2 +- .../ListNotebookExecutionsPaginator.ts | 2 +- .../ListSecurityConfigurationsPaginator.ts | 2 +- .../pagination/ListStepsPaginator.ts | 2 +- .../ListComplianceStatusPaginator.ts | 2 +- .../pagination/ListMemberAccountsPaginator.ts | 2 +- .../pagination/ListPoliciesPaginator.ts | 2 +- clients/client-forecast/Forecast.ts | 34 +- clients/client-forecast/models/models_0.ts | 1348 ++-- .../pagination/ListDatasetGroupsPaginator.ts | 2 +- .../ListDatasetImportJobsPaginator.ts | 2 +- .../pagination/ListDatasetsPaginator.ts | 2 +- .../ListForecastExportJobsPaginator.ts | 2 +- .../pagination/ListForecastsPaginator.ts | 2 +- .../pagination/ListPredictorsPaginator.ts | 2 +- .../client-forecast/protocols/Aws_json1_1.ts | 24 + .../DescribeModelVersionsPaginator.ts | 2 +- .../pagination/GetDetectorsPaginator.ts | 2 +- .../pagination/GetEntityTypesPaginator.ts | 2 +- .../pagination/GetEventTypesPaginator.ts | 2 +- .../pagination/GetExternalModelsPaginator.ts | 2 +- .../pagination/GetLabelsPaginator.ts | 2 +- .../pagination/GetModelsPaginator.ts | 2 +- .../pagination/GetOutcomesPaginator.ts | 2 +- .../pagination/GetRulesPaginator.ts | 2 +- .../pagination/GetVariablesPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- clients/client-fsx/FSx.ts | 131 + clients/client-fsx/FSxClient.ts | 18 + .../AssociateFileSystemAliasesCommand.ts | 85 + .../DescribeFileSystemAliasesCommand.ts | 85 + .../DisassociateFileSystemAliasesCommand.ts | 85 + clients/client-fsx/index.ts | 4 + clients/client-fsx/models/models_0.ts | 1645 ++-- .../pagination/DescribeBackupsPaginator.ts | 2 +- .../DescribeDataRepositoryTasksPaginator.ts | 2 +- .../DescribeFileSystemAliasesPaginator.ts | 51 + .../DescribeFileSystemsPaginator.ts | 2 +- clients/client-fsx/protocols/Aws_json1_1.ts | 362 + .../DescribeFleetAttributesPaginator.ts | 2 +- .../DescribeFleetCapacityPaginator.ts | 2 +- .../DescribeFleetEventsPaginator.ts | 2 +- .../DescribeFleetUtilizationPaginator.ts | 2 +- .../DescribeGameServerInstancesPaginator.ts | 2 +- .../DescribeGameSessionDetailsPaginator.ts | 2 +- .../DescribeGameSessionQueuesPaginator.ts | 2 +- .../DescribeGameSessionsPaginator.ts | 2 +- .../pagination/DescribeInstancesPaginator.ts | 2 +- ...cribeMatchmakingConfigurationsPaginator.ts | 2 +- .../DescribeMatchmakingRuleSetsPaginator.ts | 2 +- .../DescribePlayerSessionsPaginator.ts | 2 +- .../DescribeScalingPoliciesPaginator.ts | 2 +- .../pagination/ListAliasesPaginator.ts | 2 +- .../pagination/ListBuildsPaginator.ts | 2 +- .../pagination/ListFleetsPaginator.ts | 2 +- .../ListGameServerGroupsPaginator.ts | 2 +- .../pagination/ListGameServersPaginator.ts | 2 +- .../pagination/ListScriptsPaginator.ts | 2 +- .../pagination/SearchGameSessionsPaginator.ts | 2 +- .../pagination/GetClassifiersPaginator.ts | 2 +- .../pagination/GetConnectionsPaginator.ts | 2 +- .../pagination/GetCrawlerMetricsPaginator.ts | 2 +- .../pagination/GetCrawlersPaginator.ts | 2 +- .../pagination/GetDatabasesPaginator.ts | 2 +- .../pagination/GetDevEndpointsPaginator.ts | 2 +- .../pagination/GetJobRunsPaginator.ts | 2 +- .../pagination/GetJobsPaginator.ts | 2 +- .../pagination/GetMLTaskRunsPaginator.ts | 2 +- .../pagination/GetMLTransformsPaginator.ts | 2 +- .../GetPartitionIndexesPaginator.ts | 2 +- .../pagination/GetPartitionsPaginator.ts | 2 +- .../GetSecurityConfigurationsPaginator.ts | 2 +- .../pagination/GetTableVersionsPaginator.ts | 2 +- .../pagination/GetTablesPaginator.ts | 2 +- .../pagination/GetTriggersPaginator.ts | 2 +- .../GetUserDefinedFunctionsPaginator.ts | 2 +- .../pagination/GetWorkflowRunsPaginator.ts | 2 +- .../pagination/ListCrawlersPaginator.ts | 2 +- .../pagination/ListDevEndpointsPaginator.ts | 2 +- .../pagination/ListJobsPaginator.ts | 2 +- .../pagination/ListMLTransformsPaginator.ts | 2 +- .../pagination/ListTriggersPaginator.ts | 2 +- .../pagination/ListWorkflowsPaginator.ts | 2 +- .../pagination/SearchTablesPaginator.ts | 2 +- .../pagination/ListConfigsPaginator.ts | 2 +- .../pagination/ListContactsPaginator.ts | 2 +- .../ListDataflowEndpointGroupsPaginator.ts | 2 +- .../pagination/ListGroundStationsPaginator.ts | 2 +- .../ListMissionProfilesPaginator.ts | 2 +- .../pagination/ListSatellitesPaginator.ts | 2 +- .../pagination/GetUsageStatisticsPaginator.ts | 2 +- .../pagination/ListDetectorsPaginator.ts | 2 +- .../pagination/ListFiltersPaginator.ts | 2 +- .../pagination/ListFindingsPaginator.ts | 2 +- .../pagination/ListIPSetsPaginator.ts | 2 +- .../pagination/ListInvitationsPaginator.ts | 2 +- .../pagination/ListMembersPaginator.ts | 2 +- .../ListOrganizationAdminAccountsPaginator.ts | 2 +- .../ListPublishingDestinationsPaginator.ts | 2 +- .../ListThreatIntelSetsPaginator.ts | 2 +- ...ffectedAccountsForOrganizationPaginator.ts | 2 +- ...ffectedEntitiesForOrganizationPaginator.ts | 2 +- .../DescribeAffectedEntitiesPaginator.ts | 2 +- .../DescribeEventAggregatesPaginator.ts | 2 +- .../pagination/DescribeEventTypesPaginator.ts | 2 +- .../DescribeEventsForOrganizationPaginator.ts | 2 +- .../pagination/DescribeEventsPaginator.ts | 2 +- ...GetAccountAuthorizationDetailsPaginator.ts | 2 +- .../pagination/GetGroupPaginator.ts | 2 +- .../pagination/ListAccessKeysPaginator.ts | 2 +- .../pagination/ListAccountAliasesPaginator.ts | 2 +- .../ListAttachedGroupPoliciesPaginator.ts | 2 +- .../ListAttachedRolePoliciesPaginator.ts | 2 +- .../ListAttachedUserPoliciesPaginator.ts | 2 +- .../ListEntitiesForPolicyPaginator.ts | 2 +- .../pagination/ListGroupPoliciesPaginator.ts | 2 +- .../pagination/ListGroupsForUserPaginator.ts | 2 +- .../pagination/ListGroupsPaginator.ts | 2 +- .../ListInstanceProfilesForRolePaginator.ts | 2 +- .../ListInstanceProfilesPaginator.ts | 2 +- .../pagination/ListMFADevicesPaginator.ts | 2 +- .../pagination/ListPoliciesPaginator.ts | 2 +- .../pagination/ListPolicyVersionsPaginator.ts | 2 +- .../pagination/ListRolePoliciesPaginator.ts | 2 +- .../pagination/ListRolesPaginator.ts | 2 +- .../pagination/ListSSHPublicKeysPaginator.ts | 2 +- .../ListServerCertificatesPaginator.ts | 2 +- .../ListSigningCertificatesPaginator.ts | 2 +- .../pagination/ListUserPoliciesPaginator.ts | 2 +- .../pagination/ListUsersPaginator.ts | 2 +- .../ListVirtualMFADevicesPaginator.ts | 2 +- .../SimulateCustomPolicyPaginator.ts | 2 +- .../SimulatePrincipalPolicyPaginator.ts | 2 +- .../pagination/ListGroupsPaginator.ts | 2 +- .../pagination/ListUsersPaginator.ts | 2 +- .../ListComponentBuildVersionsPaginator.ts | 2 +- .../pagination/ListComponentsPaginator.ts | 2 +- ...ListDistributionConfigurationsPaginator.ts | 2 +- .../ListImageBuildVersionsPaginator.ts | 2 +- .../ListImagePipelineImagesPaginator.ts | 2 +- .../pagination/ListImagePipelinesPaginator.ts | 2 +- .../pagination/ListImageRecipesPaginator.ts | 2 +- .../pagination/ListImagesPaginator.ts | 2 +- ...stInfrastructureConfigurationsPaginator.ts | 2 +- .../GetExclusionsPreviewPaginator.ts | 2 +- .../ListAssessmentRunAgentsPaginator.ts | 2 +- .../pagination/ListAssessmentRunsPaginator.ts | 2 +- .../ListAssessmentTargetsPaginator.ts | 2 +- .../ListAssessmentTemplatesPaginator.ts | 2 +- .../ListEventSubscriptionsPaginator.ts | 2 +- .../pagination/ListExclusionsPaginator.ts | 2 +- .../pagination/ListFindingsPaginator.ts | 2 +- .../pagination/ListRulesPackagesPaginator.ts | 2 +- .../pagination/PreviewAgentsPaginator.ts | 2 +- .../pagination/ListPlacementsPaginator.ts | 2 +- .../pagination/ListProjectsPaginator.ts | 2 +- .../ListActiveViolationsPaginator.ts | 2 +- .../ListAttachedPoliciesPaginator.ts | 2 +- .../pagination/ListAuditFindingsPaginator.ts | 2 +- ...ditMitigationActionsExecutionsPaginator.ts | 2 +- ...istAuditMitigationActionsTasksPaginator.ts | 2 +- .../ListAuditSuppressionsPaginator.ts | 2 +- .../pagination/ListAuditTasksPaginator.ts | 2 +- .../pagination/ListAuthorizersPaginator.ts | 2 +- .../pagination/ListBillingGroupsPaginator.ts | 2 +- .../pagination/ListCACertificatesPaginator.ts | 2 +- .../ListCertificatesByCAPaginator.ts | 2 +- .../pagination/ListCertificatesPaginator.ts | 2 +- .../pagination/ListDimensionsPaginator.ts | 2 +- .../ListDomainConfigurationsPaginator.ts | 2 +- .../pagination/ListIndicesPaginator.ts | 2 +- .../ListJobExecutionsForJobPaginator.ts | 2 +- .../ListJobExecutionsForThingPaginator.ts | 2 +- .../pagination/ListJobsPaginator.ts | 2 +- .../ListMitigationActionsPaginator.ts | 2 +- .../pagination/ListOTAUpdatesPaginator.ts | 2 +- .../ListOutgoingCertificatesPaginator.ts | 2 +- .../pagination/ListPoliciesPaginator.ts | 2 +- .../ListPolicyPrincipalsPaginator.ts | 2 +- .../ListPrincipalPoliciesPaginator.ts | 2 +- .../ListPrincipalThingsPaginator.ts | 2 +- ...stProvisioningTemplateVersionsPaginator.ts | 2 +- .../ListProvisioningTemplatesPaginator.ts | 2 +- .../pagination/ListRoleAliasesPaginator.ts | 2 +- .../ListScheduledAuditsPaginator.ts | 2 +- .../ListSecurityProfilesForTargetPaginator.ts | 2 +- .../ListSecurityProfilesPaginator.ts | 2 +- .../pagination/ListStreamsPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- .../ListTargetsForPolicyPaginator.ts | 2 +- .../ListTargetsForSecurityProfilePaginator.ts | 2 +- .../ListThingGroupsForThingPaginator.ts | 2 +- .../pagination/ListThingGroupsPaginator.ts | 2 +- .../ListThingPrincipalsPaginator.ts | 2 +- ...stThingRegistrationTaskReportsPaginator.ts | 2 +- .../ListThingRegistrationTasksPaginator.ts | 2 +- .../pagination/ListThingTypesPaginator.ts | 2 +- .../ListThingsInBillingGroupPaginator.ts | 2 +- .../ListThingsInThingGroupPaginator.ts | 2 +- .../pagination/ListThingsPaginator.ts | 2 +- .../ListTopicRuleDestinationsPaginator.ts | 2 +- .../pagination/ListTopicRulesPaginator.ts | 2 +- .../ListV2LoggingLevelsPaginator.ts | 2 +- .../ListViolationEventsPaginator.ts | 2 +- clients/client-iotanalytics/IoTAnalytics.ts | 39 +- .../client-iotanalytics/models/models_0.ts | 1337 ++-- .../pagination/ListChannelsPaginator.ts | 2 +- .../ListDatasetContentsPaginator.ts | 2 +- .../pagination/ListDatasetsPaginator.ts | 2 +- .../pagination/ListDatastoresPaginator.ts | 2 +- .../pagination/ListPipelinesPaginator.ts | 2 +- .../protocols/Aws_restJson1.ts | 117 +- .../pagination/ListTunnelsPaginator.ts | 2 +- .../GetAssetPropertyAggregatesPaginator.ts | 2 +- .../GetAssetPropertyValueHistoryPaginator.ts | 2 +- .../pagination/ListAccessPoliciesPaginator.ts | 2 +- .../pagination/ListAssetModelsPaginator.ts | 2 +- .../pagination/ListAssetsPaginator.ts | 2 +- .../ListAssociatedAssetsPaginator.ts | 2 +- .../pagination/ListDashboardsPaginator.ts | 2 +- .../pagination/ListGatewaysPaginator.ts | 2 +- .../pagination/ListPortalsPaginator.ts | 2 +- .../pagination/ListProjectAssetsPaginator.ts | 2 +- .../pagination/ListProjectsPaginator.ts | 2 +- .../GetFlowTemplateRevisionsPaginator.ts | 2 +- .../GetSystemTemplateRevisionsPaginator.ts | 2 +- .../ListFlowExecutionMessagesPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- .../pagination/SearchEntitiesPaginator.ts | 2 +- .../SearchFlowExecutionsPaginator.ts | 2 +- .../SearchFlowTemplatesPaginator.ts | 2 +- .../SearchSystemInstancesPaginator.ts | 2 +- .../SearchSystemTemplatesPaginator.ts | 2 +- .../pagination/SearchThingsPaginator.ts | 2 +- .../pagination/ListChannelsPaginator.ts | 2 +- .../ListPlaybackKeyPairsPaginator.ts | 2 +- .../pagination/ListStreamKeysPaginator.ts | 2 +- .../pagination/ListStreamsPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- .../ListClusterOperationsPaginator.ts | 2 +- .../pagination/ListClustersPaginator.ts | 2 +- .../ListConfigurationRevisionsPaginator.ts | 2 +- .../pagination/ListConfigurationsPaginator.ts | 2 +- .../pagination/ListKafkaVersionsPaginator.ts | 2 +- .../pagination/ListNodesPaginator.ts | 2 +- .../pagination/ListScramSecretsPaginator.ts | 2 +- .../ListDataSourceSyncJobsPaginator.ts | 2 +- .../pagination/ListDataSourcesPaginator.ts | 2 +- .../pagination/ListIndicesPaginator.ts | 2 +- .../ListSignalingChannelsPaginator.ts | 2 +- .../pagination/ListStreamsPaginator.ts | 2 +- .../ListStreamConsumersPaginator.ts | 2 +- .../pagination/ListAliasesPaginator.ts | 2 +- .../pagination/ListGrantsPaginator.ts | 2 +- .../pagination/ListKeyPoliciesPaginator.ts | 2 +- .../pagination/ListKeysPaginator.ts | 2 +- ...GetEffectivePermissionsForPathPaginator.ts | 2 +- .../pagination/ListPermissionsPaginator.ts | 2 +- .../pagination/ListResourcesPaginator.ts | 2 +- .../pagination/ListAliasesPaginator.ts | 2 +- .../ListEventSourceMappingsPaginator.ts | 2 +- ...ListFunctionEventInvokeConfigsPaginator.ts | 2 +- .../pagination/ListFunctionsPaginator.ts | 2 +- .../pagination/ListLayerVersionsPaginator.ts | 2 +- .../pagination/ListLayersPaginator.ts | 2 +- ...tProvisionedConcurrencyConfigsPaginator.ts | 2 +- .../ListVersionsByFunctionPaginator.ts | 2 +- .../pagination/GetBotAliasesPaginator.ts | 2 +- .../GetBotChannelAssociationsPaginator.ts | 2 +- .../pagination/GetBotVersionsPaginator.ts | 2 +- .../pagination/GetBotsPaginator.ts | 2 +- .../pagination/GetBuiltinIntentsPaginator.ts | 2 +- .../GetBuiltinSlotTypesPaginator.ts | 2 +- .../pagination/GetIntentVersionsPaginator.ts | 2 +- .../pagination/GetIntentsPaginator.ts | 2 +- .../GetSlotTypeVersionsPaginator.ts | 2 +- .../pagination/GetSlotTypesPaginator.ts | 2 +- .../DescribeBatchPredictionsPaginator.ts | 2 +- .../DescribeDataSourcesPaginator.ts | 2 +- .../DescribeEvaluationsPaginator.ts | 2 +- .../pagination/DescribeMLModelsPaginator.ts | 2 +- .../pagination/ListMemberAccountsPaginator.ts | 2 +- .../pagination/ListS3ResourcesPaginator.ts | 2 +- clients/client-macie2/models/models_0.ts | 1423 ++-- .../pagination/DescribeBucketsPaginator.ts | 2 +- .../pagination/GetUsageStatisticsPaginator.ts | 2 +- .../ListClassificationJobsPaginator.ts | 2 +- .../ListCustomDataIdentifiersPaginator.ts | 2 +- .../ListFindingsFiltersPaginator.ts | 2 +- .../pagination/ListFindingsPaginator.ts | 2 +- .../pagination/ListInvitationsPaginator.ts | 2 +- .../pagination/ListMembersPaginator.ts | 2 +- .../ListOrganizationAdminAccountsPaginator.ts | 2 +- .../client-macie2/protocols/Aws_restJson1.ts | 5 +- .../pagination/ListInvitationsPaginator.ts | 2 +- .../pagination/ListMembersPaginator.ts | 2 +- .../pagination/ListNetworksPaginator.ts | 2 +- .../pagination/ListNodesPaginator.ts | 2 +- .../pagination/ListProposalVotesPaginator.ts | 2 +- .../pagination/ListProposalsPaginator.ts | 2 +- .../pagination/ListChangeSetsPaginator.ts | 2 +- .../pagination/ListEntitiesPaginator.ts | 2 +- .../pagination/ListEntitlementsPaginator.ts | 2 +- .../pagination/ListFlowsPaginator.ts | 2 +- .../pagination/ListOfferingsPaginator.ts | 2 +- .../pagination/ListReservationsPaginator.ts | 2 +- .../client-mediaconvert/models/models_0.ts | 1791 ++--- .../client-mediaconvert/models/models_1.ts | 1514 ++-- .../pagination/DescribeEndpointsPaginator.ts | 2 +- .../pagination/ListJobTemplatesPaginator.ts | 2 +- .../pagination/ListJobsPaginator.ts | 2 +- .../pagination/ListPresetsPaginator.ts | 2 +- .../pagination/ListQueuesPaginator.ts | 2 +- .../protocols/Aws_restJson1.ts | 70 +- .../pagination/DescribeSchedulePaginator.ts | 2 +- .../pagination/ListChannelsPaginator.ts | 2 +- .../ListInputDeviceTransfersPaginator.ts | 2 +- .../pagination/ListInputDevicesPaginator.ts | 2 +- .../ListInputSecurityGroupsPaginator.ts | 2 +- .../pagination/ListInputsPaginator.ts | 2 +- .../ListMultiplexProgramsPaginator.ts | 2 +- .../pagination/ListMultiplexesPaginator.ts | 2 +- .../pagination/ListOfferingsPaginator.ts | 2 +- .../pagination/ListReservationsPaginator.ts | 2 +- .../pagination/ListAssetsPaginator.ts | 2 +- .../ListPackagingConfigurationsPaginator.ts | 2 +- .../ListPackagingGroupsPaginator.ts | 2 +- .../pagination/ListChannelsPaginator.ts | 2 +- .../pagination/ListHarvestJobsPaginator.ts | 2 +- .../ListOriginEndpointsPaginator.ts | 2 +- .../pagination/ListContainersPaginator.ts | 2 +- .../ListApplicationStatesPaginator.ts | 2 +- .../ListCreatedArtifactsPaginator.ts | 2 +- .../ListDiscoveredResourcesPaginator.ts | 2 +- .../pagination/ListMigrationTasksPaginator.ts | 2 +- .../ListProgressUpdateStreamsPaginator.ts | 2 +- .../DescribeHomeRegionControlsPaginator.ts | 2 +- .../pagination/ListBundlesPaginator.ts | 2 +- .../pagination/ListProjectsPaginator.ts | 2 +- .../pagination/ListBrokersPaginator.ts | 2 +- .../ListAssignmentsForHITPaginator.ts | 2 +- .../pagination/ListBonusPaymentsPaginator.ts | 2 +- .../ListHITsForQualificationTypePaginator.ts | 2 +- .../pagination/ListHITsPaginator.ts | 2 +- .../ListQualificationRequestsPaginator.ts | 2 +- .../ListQualificationTypesPaginator.ts | 2 +- .../ListReviewPolicyResultsForHITPaginator.ts | 2 +- .../pagination/ListReviewableHITsPaginator.ts | 2 +- .../pagination/ListWorkerBlocksPaginator.ts | 2 +- ...stWorkersWithQualificationTypePaginator.ts | 2 +- .../DescribeDBClusterEndpointsPaginator.ts | 2 +- .../DescribeDBEngineVersionsPaginator.ts | 2 +- .../DescribeDBInstancesPaginator.ts | 2 +- .../DescribeDBParameterGroupsPaginator.ts | 2 +- .../DescribeDBParametersPaginator.ts | 2 +- .../DescribeDBSubnetGroupsPaginator.ts | 2 +- ...escribeEngineDefaultParametersPaginator.ts | 2 +- .../DescribeEventSubscriptionsPaginator.ts | 2 +- .../pagination/DescribeEventsPaginator.ts | 2 +- ...ribeOrderableDBInstanceOptionsPaginator.ts | 2 +- .../DescribeGlobalNetworksPaginator.ts | 2 +- ...GetCustomerGatewayAssociationsPaginator.ts | 2 +- .../pagination/GetDevicesPaginator.ts | 2 +- .../GetLinkAssociationsPaginator.ts | 2 +- .../pagination/GetLinksPaginator.ts | 2 +- .../pagination/GetSitesPaginator.ts | 2 +- ...GetTransitGatewayRegistrationsPaginator.ts | 2 +- .../DescribeEcsClustersPaginator.ts | 2 +- .../pagination/DescribeBackupsPaginator.ts | 2 +- .../pagination/DescribeEventsPaginator.ts | 2 +- .../pagination/DescribeServersPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- ...WSServiceAccessForOrganizationPaginator.ts | 2 +- .../ListAccountsForParentPaginator.ts | 2 +- .../pagination/ListAccountsPaginator.ts | 2 +- .../pagination/ListChildrenPaginator.ts | 2 +- .../ListCreateAccountStatusPaginator.ts | 2 +- .../ListDelegatedAdministratorsPaginator.ts | 2 +- ...istDelegatedServicesForAccountPaginator.ts | 2 +- .../ListHandshakesForAccountPaginator.ts | 2 +- .../ListHandshakesForOrganizationPaginator.ts | 2 +- ...stOrganizationalUnitsForParentPaginator.ts | 2 +- .../pagination/ListParentsPaginator.ts | 2 +- .../ListPoliciesForTargetPaginator.ts | 2 +- .../pagination/ListPoliciesPaginator.ts | 2 +- .../pagination/ListRootsPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- .../ListTargetsForPolicyPaginator.ts | 2 +- .../pagination/ListOutpostsPaginator.ts | 2 +- .../pagination/ListSitesPaginator.ts | 2 +- .../ListBatchInferenceJobsPaginator.ts | 2 +- .../pagination/ListCampaignsPaginator.ts | 2 +- .../pagination/ListDatasetGroupsPaginator.ts | 2 +- .../ListDatasetImportJobsPaginator.ts | 2 +- .../pagination/ListDatasetsPaginator.ts | 2 +- .../pagination/ListEventTrackersPaginator.ts | 2 +- .../pagination/ListRecipesPaginator.ts | 2 +- .../pagination/ListSchemasPaginator.ts | 2 +- .../ListSolutionVersionsPaginator.ts | 2 +- .../pagination/ListSolutionsPaginator.ts | 2 +- .../pagination/GetDedicatedIpsPaginator.ts | 2 +- .../ListConfigurationSetsPaginator.ts | 2 +- .../ListDedicatedIpPoolsPaginator.ts | 2 +- .../ListDeliverabilityTestReportsPaginator.ts | 2 +- ...tDomainDeliverabilityCampaignsPaginator.ts | 2 +- .../ListEmailIdentitiesPaginator.ts | 2 +- .../ListSpeechSynthesisTasksPaginator.ts | 2 +- .../pagination/DescribeServicesPaginator.ts | 2 +- .../pagination/GetAttributeValuesPaginator.ts | 2 +- .../pagination/GetProductsPaginator.ts | 2 +- ...JournalKinesisStreamsForLedgerPaginator.ts | 2 +- .../ListJournalS3ExportsForLedgerPaginator.ts | 2 +- .../ListJournalS3ExportsPaginator.ts | 2 +- .../pagination/ListLedgersPaginator.ts | 2 +- clients/client-quicksight/QuickSight.ts | 9 +- .../commands/ListTagsForResourceCommand.ts | 3 +- .../commands/ListTemplateAliasesCommand.ts | 3 +- clients/client-quicksight/models/models_0.ts | 2810 +++---- clients/client-quicksight/models/models_1.ts | 1202 +-- .../pagination/ListAnalysesPaginator.ts | 2 +- .../ListDashboardVersionsPaginator.ts | 2 +- .../pagination/ListDashboardsPaginator.ts | 2 +- .../pagination/ListDataSetsPaginator.ts | 2 +- .../pagination/ListDataSourcesPaginator.ts | 2 +- .../pagination/ListIngestionsPaginator.ts | 2 +- .../pagination/ListNamespacesPaginator.ts | 2 +- .../ListTemplateAliasesPaginator.ts | 2 +- .../ListTemplateVersionsPaginator.ts | 2 +- .../pagination/ListTemplatesPaginator.ts | 2 +- .../pagination/SearchAnalysesPaginator.ts | 2 +- .../pagination/SearchDashboardsPaginator.ts | 2 +- .../protocols/Aws_restJson1.ts | 1085 +-- .../GetResourcePoliciesPaginator.ts | 2 +- .../GetResourceShareAssociationsPaginator.ts | 2 +- .../GetResourceShareInvitationsPaginator.ts | 2 +- .../pagination/GetResourceSharesPaginator.ts | 2 +- ...ListPendingInvitationResourcesPaginator.ts | 2 +- .../pagination/ListPrincipalsPaginator.ts | 2 +- .../pagination/ListResourcesPaginator.ts | 2 +- .../DescribeCertificatesPaginator.ts | 2 +- ...escribeCustomAvailabilityZonesPaginator.ts | 2 +- .../DescribeDBClusterBacktracksPaginator.ts | 2 +- .../DescribeDBClusterEndpointsPaginator.ts | 2 +- ...scribeDBClusterParameterGroupsPaginator.ts | 2 +- .../DescribeDBClusterParametersPaginator.ts | 2 +- .../DescribeDBClusterSnapshotsPaginator.ts | 2 +- .../pagination/DescribeDBClustersPaginator.ts | 2 +- .../DescribeDBEngineVersionsPaginator.ts | 2 +- ...ribeDBInstanceAutomatedBackupsPaginator.ts | 2 +- .../DescribeDBInstancesPaginator.ts | 2 +- .../pagination/DescribeDBLogFilesPaginator.ts | 2 +- .../DescribeDBParameterGroupsPaginator.ts | 2 +- .../DescribeDBParametersPaginator.ts | 2 +- .../pagination/DescribeDBProxiesPaginator.ts | 2 +- .../DescribeDBProxyTargetGroupsPaginator.ts | 2 +- .../DescribeDBProxyTargetsPaginator.ts | 2 +- .../DescribeDBSecurityGroupsPaginator.ts | 2 +- .../DescribeDBSnapshotsPaginator.ts | 2 +- .../DescribeDBSubnetGroupsPaginator.ts | 2 +- ...escribeEngineDefaultParametersPaginator.ts | 2 +- .../DescribeEventSubscriptionsPaginator.ts | 2 +- .../pagination/DescribeEventsPaginator.ts | 2 +- .../DescribeExportTasksPaginator.ts | 2 +- .../DescribeGlobalClustersPaginator.ts | 2 +- .../DescribeInstallationMediaPaginator.ts | 2 +- .../DescribeOptionGroupOptionsPaginator.ts | 2 +- .../DescribeOptionGroupsPaginator.ts | 2 +- ...ribeOrderableDBInstanceOptionsPaginator.ts | 2 +- ...cribePendingMaintenanceActionsPaginator.ts | 2 +- ...beReservedDBInstancesOfferingsPaginator.ts | 2 +- .../DescribeReservedDBInstancesPaginator.ts | 2 +- .../DescribeSourceRegionsPaginator.ts | 2 +- .../pagination/DescribeTablePaginator.ts | 2 +- .../pagination/GetStatementResultPaginator.ts | 2 +- .../pagination/ListDatabasesPaginator.ts | 2 +- .../pagination/ListSchemasPaginator.ts | 2 +- .../pagination/ListStatementsPaginator.ts | 2 +- .../pagination/ListTablesPaginator.ts | 2 +- ...DescribeClusterParameterGroupsPaginator.ts | 2 +- .../DescribeClusterParametersPaginator.ts | 2 +- .../DescribeClusterSecurityGroupsPaginator.ts | 2 +- .../DescribeClusterSnapshotsPaginator.ts | 2 +- .../DescribeClusterSubnetGroupsPaginator.ts | 2 +- .../DescribeClusterVersionsPaginator.ts | 2 +- .../pagination/DescribeClustersPaginator.ts | 2 +- ...scribeDefaultClusterParametersPaginator.ts | 2 +- .../DescribeEventSubscriptionsPaginator.ts | 2 +- .../pagination/DescribeEventsPaginator.ts | 2 +- .../DescribeHsmClientCertificatesPaginator.ts | 2 +- .../DescribeHsmConfigurationsPaginator.ts | 2 +- ...scribeNodeConfigurationOptionsPaginator.ts | 2 +- ...escribeOrderableClusterOptionsPaginator.ts | 2 +- .../DescribeReservedNodeOfferingsPaginator.ts | 2 +- .../DescribeReservedNodesPaginator.ts | 2 +- .../DescribeScheduledActionsPaginator.ts | 2 +- .../DescribeUsageLimitsPaginator.ts | 2 +- .../DescribeProjectVersionsPaginator.ts | 2 +- .../pagination/DescribeProjectsPaginator.ts | 2 +- .../GetCelebrityRecognitionPaginator.ts | 2 +- .../GetContentModerationPaginator.ts | 2 +- .../pagination/GetFaceDetectionPaginator.ts | 2 +- .../pagination/GetFaceSearchPaginator.ts | 2 +- .../pagination/GetLabelDetectionPaginator.ts | 2 +- .../pagination/GetPersonTrackingPaginator.ts | 2 +- .../GetSegmentDetectionPaginator.ts | 2 +- .../pagination/GetTextDetectionPaginator.ts | 2 +- .../pagination/ListCollectionsPaginator.ts | 2 +- .../pagination/ListFacesPaginator.ts | 2 +- .../ListStreamProcessorsPaginator.ts | 2 +- .../GetComplianceSummaryPaginator.ts | 2 +- .../pagination/GetResourcesPaginator.ts | 2 +- .../pagination/GetTagKeysPaginator.ts | 2 +- .../pagination/GetTagValuesPaginator.ts | 2 +- .../pagination/ListGroupResourcesPaginator.ts | 2 +- .../pagination/ListGroupsPaginator.ts | 2 +- .../pagination/SearchResourcesPaginator.ts | 2 +- .../pagination/ListDeploymentJobsPaginator.ts | 2 +- .../pagination/ListFleetsPaginator.ts | 2 +- .../ListRobotApplicationsPaginator.ts | 2 +- .../pagination/ListRobotsPaginator.ts | 2 +- .../ListSimulationApplicationsPaginator.ts | 2 +- .../ListSimulationJobBatchesPaginator.ts | 2 +- .../pagination/ListSimulationJobsPaginator.ts | 2 +- .../ListWorldExportJobsPaginator.ts | 2 +- .../ListWorldGenerationJobsPaginator.ts | 2 +- .../pagination/ListWorldTemplatesPaginator.ts | 2 +- .../pagination/ListWorldsPaginator.ts | 2 +- .../pagination/ListDomainsPaginator.ts | 2 +- .../pagination/ListOperationsPaginator.ts | 2 +- ...istResolverEndpointIpAddressesPaginator.ts | 2 +- .../ListResolverEndpointsPaginator.ts | 2 +- ...lverQueryLogConfigAssociationsPaginator.ts | 2 +- .../ListResolverQueryLogConfigsPaginator.ts | 2 +- .../ListResolverRuleAssociationsPaginator.ts | 2 +- .../pagination/ListResolverRulesPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- .../pagination/ListAccessPointsPaginator.ts | 2 +- .../pagination/ListJobsPaginator.ts | 2 +- .../ListRegionalBucketsPaginator.ts | 2 +- clients/client-s3/S3.ts | 2389 ++++-- clients/client-s3/S3Client.ts | 24 + ...tIntelligentTieringConfigurationCommand.ts | 93 + ...tIntelligentTieringConfigurationCommand.ts | 97 + ...IntelligentTieringConfigurationsCommand.ts | 97 + ...tIntelligentTieringConfigurationCommand.ts | 93 + clients/client-s3/index.ts | 5 + clients/client-s3/models/models_0.ts | 5428 +++++++------ clients/client-s3/models/models_1.ts | 829 +- .../pagination/ListObjectsV2Paginator.ts | 2 +- .../pagination/ListPartsPaginator.ts | 47 + clients/client-s3/protocols/Aws_restXml.ts | 2764 ++++--- .../pagination/ListEndpointsPaginator.ts | 2 +- .../pagination/ListHumanLoopsPaginator.ts | 2 +- .../pagination/ListAlgorithmsPaginator.ts | 2 +- .../pagination/ListAppsPaginator.ts | 2 +- .../pagination/ListAutoMLJobsPaginator.ts | 2 +- .../ListCandidatesForAutoMLJobPaginator.ts | 2 +- .../ListCodeRepositoriesPaginator.ts | 2 +- .../ListCompilationJobsPaginator.ts | 2 +- .../pagination/ListDomainsPaginator.ts | 2 +- .../ListEndpointConfigsPaginator.ts | 2 +- .../pagination/ListEndpointsPaginator.ts | 2 +- .../pagination/ListExperimentsPaginator.ts | 2 +- .../ListFlowDefinitionsPaginator.ts | 2 +- .../pagination/ListHumanTaskUisPaginator.ts | 2 +- .../ListHyperParameterTuningJobsPaginator.ts | 2 +- .../pagination/ListImageVersionsPaginator.ts | 2 +- .../pagination/ListImagesPaginator.ts | 2 +- .../ListLabelingJobsForWorkteamPaginator.ts | 2 +- .../pagination/ListLabelingJobsPaginator.ts | 2 +- .../pagination/ListModelPackagesPaginator.ts | 2 +- .../pagination/ListModelsPaginator.ts | 2 +- .../ListMonitoringExecutionsPaginator.ts | 2 +- .../ListMonitoringSchedulesPaginator.ts | 2 +- ...tebookInstanceLifecycleConfigsPaginator.ts | 2 +- .../ListNotebookInstancesPaginator.ts | 2 +- .../pagination/ListProcessingJobsPaginator.ts | 2 +- .../ListSubscribedWorkteamsPaginator.ts | 2 +- .../pagination/ListTagsPaginator.ts | 2 +- ...JobsForHyperParameterTuningJobPaginator.ts | 2 +- .../pagination/ListTrainingJobsPaginator.ts | 2 +- .../pagination/ListTransformJobsPaginator.ts | 2 +- .../ListTrialComponentsPaginator.ts | 2 +- .../pagination/ListTrialsPaginator.ts | 2 +- .../pagination/ListUserProfilesPaginator.ts | 2 +- .../pagination/ListWorkforcesPaginator.ts | 2 +- .../pagination/ListWorkteamsPaginator.ts | 2 +- .../pagination/SearchPaginator.ts | 2 +- .../pagination/ListDiscoverersPaginator.ts | 2 +- .../pagination/ListRegistriesPaginator.ts | 2 +- .../pagination/ListSchemaVersionsPaginator.ts | 2 +- .../pagination/ListSchemasPaginator.ts | 2 +- .../pagination/SearchSchemasPaginator.ts | 2 +- .../ListSecretVersionIdsPaginator.ts | 2 +- .../pagination/ListSecretsPaginator.ts | 2 +- .../DescribeActionTargetsPaginator.ts | 2 +- .../pagination/DescribeProductsPaginator.ts | 2 +- .../DescribeStandardsControlsPaginator.ts | 2 +- .../pagination/DescribeStandardsPaginator.ts | 2 +- .../GetEnabledStandardsPaginator.ts | 2 +- .../pagination/GetFindingsPaginator.ts | 2 +- .../pagination/GetInsightsPaginator.ts | 2 +- .../ListEnabledProductsForImportPaginator.ts | 2 +- .../pagination/ListInvitationsPaginator.ts | 2 +- .../pagination/ListMembersPaginator.ts | 2 +- .../ListApplicationDependenciesPaginator.ts | 2 +- .../ListApplicationVersionsPaginator.ts | 2 +- .../pagination/ListApplicationsPaginator.ts | 2 +- .../client-service-catalog/models/models_0.ts | 3104 ++++---- .../GetProvisionedProductOutputsPaginator.ts | 2 +- .../ListAcceptedPortfolioSharesPaginator.ts | 2 +- .../ListBudgetsForResourcePaginator.ts | 2 +- .../ListConstraintsForPortfolioPaginator.ts | 2 +- .../pagination/ListLaunchPathsPaginator.ts | 2 +- ...istOrganizationPortfolioAccessPaginator.ts | 2 +- .../ListPortfolioAccessPaginator.ts | 2 +- .../ListPortfoliosForProductPaginator.ts | 2 +- .../pagination/ListPortfoliosPaginator.ts | 2 +- .../ListPrincipalsForPortfolioPaginator.ts | 2 +- ...oningArtifactsForServiceActionPaginator.ts | 2 +- .../ListResourcesForTagOptionPaginator.ts | 2 +- ...ActionsForProvisioningArtifactPaginator.ts | 2 +- .../pagination/ListServiceActionsPaginator.ts | 2 +- .../pagination/ListTagOptionsPaginator.ts | 2 +- .../SearchProductsAsAdminPaginator.ts | 2 +- .../pagination/SearchProductsPaginator.ts | 2 +- .../SearchProvisionedProductsPaginator.ts | 2 +- .../ListAWSDefaultServiceQuotasPaginator.ts | 2 +- ...rviceQuotaChangeHistoryByQuotaPaginator.ts | 2 +- ...estedServiceQuotaChangeHistoryPaginator.ts | 2 +- ...uotaIncreaseRequestsInTemplatePaginator.ts | 2 +- .../pagination/ListServiceQuotasPaginator.ts | 2 +- .../pagination/ListServicesPaginator.ts | 2 +- .../GetInstancesHealthStatusPaginator.ts | 2 +- .../pagination/ListInstancesPaginator.ts | 2 +- .../pagination/ListNamespacesPaginator.ts | 2 +- .../pagination/ListOperationsPaginator.ts | 2 +- .../pagination/ListServicesPaginator.ts | 2 +- ...stomVerificationEmailTemplatesPaginator.ts | 2 +- .../pagination/ListIdentitiesPaginator.ts | 2 +- .../pagination/GetDedicatedIpsPaginator.ts | 2 +- .../ListConfigurationSetsPaginator.ts | 2 +- .../pagination/ListContactListsPaginator.ts | 2 +- .../pagination/ListContactsPaginator.ts | 2 +- ...stomVerificationEmailTemplatesPaginator.ts | 2 +- .../ListDedicatedIpPoolsPaginator.ts | 2 +- .../ListDeliverabilityTestReportsPaginator.ts | 2 +- ...tDomainDeliverabilityCampaignsPaginator.ts | 2 +- .../ListEmailIdentitiesPaginator.ts | 2 +- .../pagination/ListEmailTemplatesPaginator.ts | 2 +- .../pagination/ListImportJobsPaginator.ts | 2 +- .../ListSuppressedDestinationsPaginator.ts | 2 +- .../GetExecutionHistoryPaginator.ts | 2 +- .../pagination/ListActivitiesPaginator.ts | 2 +- .../pagination/ListExecutionsPaginator.ts | 2 +- .../pagination/ListStateMachinesPaginator.ts | 2 +- .../pagination/ListAttacksPaginator.ts | 2 +- .../pagination/ListProtectionsPaginator.ts | 2 +- .../pagination/ListSigningJobsPaginator.ts | 2 +- .../ListSigningPlatformsPaginator.ts | 2 +- .../ListSigningProfilesPaginator.ts | 2 +- .../pagination/GetConnectorsPaginator.ts | 2 +- .../pagination/GetReplicationJobsPaginator.ts | 2 +- .../pagination/GetReplicationRunsPaginator.ts | 2 +- .../pagination/GetServersPaginator.ts | 2 +- .../pagination/DescribeAddressesPaginator.ts | 2 +- .../pagination/ListJobsPaginator.ts | 2 +- ...EndpointsByPlatformApplicationPaginator.ts | 2 +- .../ListPlatformApplicationsPaginator.ts | 2 +- .../ListSubscriptionsByTopicPaginator.ts | 2 +- .../pagination/ListSubscriptionsPaginator.ts | 2 +- .../pagination/ListTopicsPaginator.ts | 2 +- .../ListDeadLetterSourceQueuesPaginator.ts | 2 +- .../pagination/ListQueuesPaginator.ts | 2 +- clients/client-ssm/models/models_0.ts | 5 + .../DescribeActivationsPaginator.ts | 2 +- ...ibeAssociationExecutionTargetsPaginator.ts | 2 +- .../DescribeAssociationExecutionsPaginator.ts | 2 +- .../DescribeAutomationExecutionsPaginator.ts | 2 +- ...scribeAutomationStepExecutionsPaginator.ts | 2 +- .../DescribeAvailablePatchesPaginator.ts | 2 +- ...eEffectiveInstanceAssociationsPaginator.ts | 2 +- ...fectivePatchesForPatchBaselinePaginator.ts | 2 +- ...ribeInstanceAssociationsStatusPaginator.ts | 2 +- .../DescribeInstanceInformationPaginator.ts | 2 +- ...stancePatchStatesForPatchGroupPaginator.ts | 2 +- .../DescribeInstancePatchStatesPaginator.ts | 2 +- .../DescribeInstancePatchesPaginator.ts | 2 +- .../DescribeInventoryDeletionsPaginator.ts | 2 +- ...WindowExecutionTaskInvocationsPaginator.ts | 2 +- ...aintenanceWindowExecutionTasksPaginator.ts | 2 +- ...ibeMaintenanceWindowExecutionsPaginator.ts | 2 +- ...cribeMaintenanceWindowSchedulePaginator.ts | 2 +- ...scribeMaintenanceWindowTargetsPaginator.ts | 2 +- ...DescribeMaintenanceWindowTasksPaginator.ts | 2 +- ...ibeMaintenanceWindowsForTargetPaginator.ts | 2 +- .../DescribeMaintenanceWindowsPaginator.ts | 2 +- .../pagination/DescribeOpsItemsPaginator.ts | 2 +- .../pagination/DescribeParametersPaginator.ts | 2 +- .../DescribePatchBaselinesPaginator.ts | 2 +- .../DescribePatchGroupsPaginator.ts | 2 +- .../DescribePatchPropertiesPaginator.ts | 2 +- .../pagination/DescribeSessionsPaginator.ts | 2 +- .../pagination/GetInventoryPaginator.ts | 2 +- .../pagination/GetInventorySchemaPaginator.ts | 2 +- .../pagination/GetOpsSummaryPaginator.ts | 2 +- .../GetParameterHistoryPaginator.ts | 2 +- .../GetParametersByPathPaginator.ts | 2 +- .../ListAssociationVersionsPaginator.ts | 2 +- .../pagination/ListAssociationsPaginator.ts | 2 +- .../ListCommandInvocationsPaginator.ts | 2 +- .../pagination/ListCommandsPaginator.ts | 2 +- .../ListComplianceItemsPaginator.ts | 2 +- .../ListComplianceSummariesPaginator.ts | 2 +- .../ListDocumentVersionsPaginator.ts | 2 +- .../pagination/ListDocumentsPaginator.ts | 2 +- ...istResourceComplianceSummariesPaginator.ts | 2 +- .../ListResourceDataSyncPaginator.ts | 2 +- ...ccountAssignmentCreationStatusPaginator.ts | 2 +- ...ccountAssignmentDeletionStatusPaginator.ts | 2 +- .../ListAccountAssignmentsPaginator.ts | 2 +- ...ntsForProvisionedPermissionSetPaginator.ts | 2 +- .../pagination/ListInstancesPaginator.ts | 2 +- ...ManagedPoliciesInPermissionSetPaginator.ts | 2 +- ...ermissionSetProvisioningStatusPaginator.ts | 2 +- .../pagination/ListPermissionSetsPaginator.ts | 2 +- ...issionSetsProvisionedToAccountPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- .../pagination/ListAccountRolesPaginator.ts | 2 +- .../pagination/ListAccountsPaginator.ts | 2 +- .../client-storage-gateway/StorageGateway.ts | 99 + .../StorageGatewayClient.ts | 12 + ...scribeBandwidthRateLimitScheduleCommand.ts | 89 + ...UpdateBandwidthRateLimitScheduleCommand.ts | 88 + clients/client-storage-gateway/index.ts | 3 + .../client-storage-gateway/models/models_0.ts | 3140 ++++---- .../DescribeTapeArchivesPaginator.ts | 2 +- .../DescribeTapeRecoveryPointsPaginator.ts | 2 +- .../pagination/DescribeTapesPaginator.ts | 2 +- .../pagination/DescribeVTLDevicesPaginator.ts | 2 +- .../pagination/ListFileSharesPaginator.ts | 2 +- .../pagination/ListGatewaysPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- .../pagination/ListTapePoolsPaginator.ts | 51 + .../pagination/ListTapesPaginator.ts | 2 +- .../pagination/ListVolumesPaginator.ts | 2 +- .../protocols/Aws_json1_1.ts | 281 + .../pagination/DescribeCasesPaginator.ts | 2 +- .../DescribeCommunicationsPaginator.ts | 2 +- .../GetWorkflowExecutionHistoryPaginator.ts | 2 +- .../pagination/ListActivityTypesPaginator.ts | 2 +- .../ListClosedWorkflowExecutionsPaginator.ts | 2 +- .../pagination/ListDomainsPaginator.ts | 2 +- .../ListOpenWorkflowExecutionsPaginator.ts | 2 +- .../pagination/ListWorkflowTypesPaginator.ts | 2 +- .../PollForDecisionTaskPaginator.ts | 2 +- .../DescribeCanariesLastRunPaginator.ts | 2 +- .../pagination/DescribeCanariesPaginator.ts | 2 +- .../DescribeRuntimeVersionsPaginator.ts | 2 +- .../pagination/GetCanaryRunsPaginator.ts | 2 +- .../pagination/QueryPaginator.ts | 2 +- .../pagination/ListDatabasesPaginator.ts | 2 +- .../pagination/ListTablesPaginator.ts | 2 +- .../pagination/ListLanguageModelsPaginator.ts | 2 +- .../ListMedicalTranscriptionJobsPaginator.ts | 2 +- .../ListMedicalVocabulariesPaginator.ts | 2 +- .../ListTranscriptionJobsPaginator.ts | 2 +- .../pagination/ListVocabulariesPaginator.ts | 2 +- .../ListVocabularyFiltersPaginator.ts | 2 +- .../ListSecurityPoliciesPaginator.ts | 2 +- .../pagination/ListServersPaginator.ts | 2 +- .../ListTagsForResourcePaginator.ts | 2 +- .../pagination/ListUsersPaginator.ts | 2 +- .../pagination/ListTerminologiesPaginator.ts | 2 +- .../ListTextTranslationJobsPaginator.ts | 2 +- .../DescribeDocumentVersionsPaginator.ts | 2 +- .../DescribeFolderContentsPaginator.ts | 2 +- .../pagination/DescribeUsersPaginator.ts | 2 +- .../pagination/ListDevicesPaginator.ts | 2 +- .../pagination/ListDomainsPaginator.ts | 2 +- .../pagination/ListFleetsPaginator.ts | 2 +- ...tWebsiteAuthorizationProvidersPaginator.ts | 2 +- ...tWebsiteCertificateAuthoritiesPaginator.ts | 2 +- .../pagination/ListAliasesPaginator.ts | 2 +- .../pagination/ListGroupMembersPaginator.ts | 2 +- .../pagination/ListGroupsPaginator.ts | 2 +- .../ListMailboxExportJobsPaginator.ts | 2 +- .../ListMailboxPermissionsPaginator.ts | 2 +- .../pagination/ListOrganizationsPaginator.ts | 2 +- .../ListResourceDelegatesPaginator.ts | 2 +- .../pagination/ListResourcesPaginator.ts | 2 +- .../pagination/ListUsersPaginator.ts | 2 +- .../DescribeWorkspaceBundlesPaginator.ts | 2 +- .../DescribeWorkspaceDirectoriesPaginator.ts | 2 +- .../pagination/DescribeWorkspacesPaginator.ts | 2 +- .../pagination/BatchGetTracesPaginator.ts | 2 +- .../pagination/GetGroupsPaginator.ts | 2 +- .../pagination/GetInsightEventsPaginator.ts | 2 +- .../GetInsightSummariesPaginator.ts | 2 +- .../pagination/GetSamplingRulesPaginator.ts | 2 +- .../GetSamplingStatisticSummariesPaginator.ts | 2 +- .../pagination/GetServiceGraphPaginator.ts | 2 +- ...GetTimeSeriesServiceStatisticsPaginator.ts | 2 +- .../pagination/GetTraceGraphPaginator.ts | 2 +- .../pagination/GetTraceSummariesPaginator.ts | 2 +- 1402 files changed, 45128 insertions(+), 23988 deletions(-) create mode 100644 clients/client-databrew/.gitignore create mode 100644 clients/client-databrew/.npmignore create mode 100644 clients/client-databrew/DataBrew.ts create mode 100644 clients/client-databrew/DataBrewClient.ts create mode 100644 clients/client-databrew/LICENSE create mode 100644 clients/client-databrew/README.md create mode 100644 clients/client-databrew/commands/BatchDeleteRecipeVersionCommand.ts create mode 100644 clients/client-databrew/commands/CreateDatasetCommand.ts create mode 100644 clients/client-databrew/commands/CreateProfileJobCommand.ts create mode 100644 clients/client-databrew/commands/CreateProjectCommand.ts create mode 100644 clients/client-databrew/commands/CreateRecipeCommand.ts create mode 100644 clients/client-databrew/commands/CreateRecipeJobCommand.ts create mode 100644 clients/client-databrew/commands/CreateScheduleCommand.ts create mode 100644 clients/client-databrew/commands/DeleteDatasetCommand.ts create mode 100644 clients/client-databrew/commands/DeleteJobCommand.ts create mode 100644 clients/client-databrew/commands/DeleteProjectCommand.ts create mode 100644 clients/client-databrew/commands/DeleteRecipeVersionCommand.ts create mode 100644 clients/client-databrew/commands/DeleteScheduleCommand.ts create mode 100644 clients/client-databrew/commands/DescribeDatasetCommand.ts create mode 100644 clients/client-databrew/commands/DescribeJobCommand.ts create mode 100644 clients/client-databrew/commands/DescribeProjectCommand.ts create mode 100644 clients/client-databrew/commands/DescribeRecipeCommand.ts create mode 100644 clients/client-databrew/commands/DescribeScheduleCommand.ts create mode 100644 clients/client-databrew/commands/ListDatasetsCommand.ts create mode 100644 clients/client-databrew/commands/ListJobRunsCommand.ts create mode 100644 clients/client-databrew/commands/ListJobsCommand.ts create mode 100644 clients/client-databrew/commands/ListProjectsCommand.ts create mode 100644 clients/client-databrew/commands/ListRecipeVersionsCommand.ts create mode 100644 clients/client-databrew/commands/ListRecipesCommand.ts create mode 100644 clients/client-databrew/commands/ListSchedulesCommand.ts create mode 100644 clients/client-databrew/commands/ListTagsForResourceCommand.ts create mode 100644 clients/client-databrew/commands/PublishRecipeCommand.ts create mode 100644 clients/client-databrew/commands/SendProjectSessionActionCommand.ts create mode 100644 clients/client-databrew/commands/StartJobRunCommand.ts create mode 100644 clients/client-databrew/commands/StartProjectSessionCommand.ts create mode 100644 clients/client-databrew/commands/StopJobRunCommand.ts create mode 100644 clients/client-databrew/commands/TagResourceCommand.ts create mode 100644 clients/client-databrew/commands/UntagResourceCommand.ts create mode 100644 clients/client-databrew/commands/UpdateDatasetCommand.ts create mode 100644 clients/client-databrew/commands/UpdateProfileJobCommand.ts create mode 100644 clients/client-databrew/commands/UpdateProjectCommand.ts create mode 100644 clients/client-databrew/commands/UpdateRecipeCommand.ts create mode 100644 clients/client-databrew/commands/UpdateRecipeJobCommand.ts create mode 100644 clients/client-databrew/commands/UpdateScheduleCommand.ts create mode 100644 clients/client-databrew/endpoints.ts create mode 100644 clients/client-databrew/index.ts create mode 100644 clients/client-databrew/models/index.ts create mode 100644 clients/client-databrew/models/models_0.ts create mode 100644 clients/client-databrew/package.json create mode 100644 clients/client-databrew/pagination/Interfaces.ts create mode 100644 clients/client-databrew/pagination/ListDatasetsPaginator.ts create mode 100644 clients/client-databrew/pagination/ListJobRunsPaginator.ts create mode 100644 clients/client-databrew/pagination/ListJobsPaginator.ts create mode 100644 clients/client-databrew/pagination/ListProjectsPaginator.ts create mode 100644 clients/client-databrew/pagination/ListRecipeVersionsPaginator.ts create mode 100644 clients/client-databrew/pagination/ListRecipesPaginator.ts create mode 100644 clients/client-databrew/pagination/ListSchedulesPaginator.ts create mode 100644 clients/client-databrew/protocols/Aws_restJson1.ts create mode 100644 clients/client-databrew/runtimeConfig.browser.ts create mode 100644 clients/client-databrew/runtimeConfig.native.ts create mode 100644 clients/client-databrew/runtimeConfig.shared.ts create mode 100644 clients/client-databrew/runtimeConfig.ts create mode 100644 clients/client-databrew/tsconfig.es.json create mode 100644 clients/client-databrew/tsconfig.json create mode 100644 clients/client-datasync/commands/UpdateTaskExecutionCommand.ts create mode 100644 clients/client-dynamodb/commands/DescribeExportCommand.ts create mode 100644 clients/client-dynamodb/commands/ExportTableToPointInTimeCommand.ts create mode 100644 clients/client-dynamodb/commands/ListExportsCommand.ts create mode 100644 clients/client-dynamodb/pagination/ListExportsPaginator.ts create mode 100644 clients/client-elasticsearch-service/commands/GetPackageVersionHistoryCommand.ts create mode 100644 clients/client-elasticsearch-service/commands/UpdatePackageCommand.ts create mode 100644 clients/client-elasticsearch-service/pagination/GetPackageVersionHistoryPaginator.ts create mode 100644 clients/client-fsx/commands/AssociateFileSystemAliasesCommand.ts create mode 100644 clients/client-fsx/commands/DescribeFileSystemAliasesCommand.ts create mode 100644 clients/client-fsx/commands/DisassociateFileSystemAliasesCommand.ts create mode 100644 clients/client-fsx/pagination/DescribeFileSystemAliasesPaginator.ts create mode 100644 clients/client-s3/commands/DeleteBucketIntelligentTieringConfigurationCommand.ts create mode 100644 clients/client-s3/commands/GetBucketIntelligentTieringConfigurationCommand.ts create mode 100644 clients/client-s3/commands/ListBucketIntelligentTieringConfigurationsCommand.ts create mode 100644 clients/client-s3/commands/PutBucketIntelligentTieringConfigurationCommand.ts create mode 100644 clients/client-s3/pagination/ListPartsPaginator.ts create mode 100644 clients/client-storage-gateway/commands/DescribeBandwidthRateLimitScheduleCommand.ts create mode 100644 clients/client-storage-gateway/commands/UpdateBandwidthRateLimitScheduleCommand.ts create mode 100644 clients/client-storage-gateway/pagination/ListTapePoolsPaginator.ts diff --git a/clients/client-accessanalyzer/pagination/ListAnalyzedResourcesPaginator.ts b/clients/client-accessanalyzer/pagination/ListAnalyzedResourcesPaginator.ts index 7eccc4c93dc4..b3a510716962 100644 --- a/clients/client-accessanalyzer/pagination/ListAnalyzedResourcesPaginator.ts +++ b/clients/client-accessanalyzer/pagination/ListAnalyzedResourcesPaginator.ts @@ -14,7 +14,7 @@ const makePagedClientRequest = async ( ...args: any ): PromiseThe environment variables for the autocreated branch.
+ *Describes the current stage for the autocreated branch.
*/ - environmentVariables?: { [key: string]: string }; + stage?: Stage | string; + + /** + *The framework for the autocreated branch.
+ */ + framework?: string; /** *Enables auto building for the autocreated branch.
@@ -39,9 +44,9 @@ export interface AutoBranchCreationConfig { enableAutoBuild?: boolean; /** - *The framework for the autocreated branch.
+ *The environment variables for the autocreated branch.
*/ - framework?: string; + environmentVariables?: { [key: string]: string }; /** *The basic authorization credentials for the autocreated branch.
@@ -49,22 +54,23 @@ export interface AutoBranchCreationConfig { basicAuthCredentials?: string; /** - *Describes the current stage for the autocreated branch.
+ *Enables basic authorization for the autocreated branch.
*/ - stage?: Stage | string; + enableBasicAuth?: boolean; /** - *The build specification (build spec) for the autocreated branch.
+ *Enables performance mode for the branch.
+ *Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
*/ - buildSpec?: string; + enablePerformanceMode?: boolean; /** - *Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.
+ *The build specification (build spec) for the autocreated branch.
*/ - enablePerformanceMode?: boolean; + buildSpec?: string; /** - *Enables pull request preview for the autocreated branch.
+ *Enables pull request previews for the autocreated branch.
*/ enablePullRequestPreview?: boolean; @@ -72,11 +78,6 @@ export interface AutoBranchCreationConfig { *The Amplify environment name for the pull request.
*/ pullRequestEnvironmentName?: string; - - /** - *Enables basic authorization for the autocreated branch.
- */ - enableBasicAuth?: boolean; } export namespace AutoBranchCreationConfig { @@ -91,14 +92,14 @@ export namespace AutoBranchCreationConfig { */ export interface CustomRule { /** - *The target pattern for a URL rewrite or redirect rule.
+ *The source pattern for a URL rewrite or redirect rule.
*/ - target: string | undefined; + source: string | undefined; /** - *The condition for a URL rewrite or redirect rule, such as a country code.
+ *The target pattern for a URL rewrite or redirect rule.
*/ - condition?: string; + target: string | undefined; /** *The status code for a URL rewrite or redirect rule.
@@ -129,9 +130,9 @@ export interface CustomRule { status?: string; /** - *The source pattern for a URL rewrite or redirect rule.
+ *The condition for a URL rewrite or redirect rule, such as a country code.
*/ - source: string | undefined; + condition?: string; } export namespace CustomRule { @@ -149,26 +150,37 @@ export enum Platform { */ export interface CreateAppRequest { /** - *Enables automated branch creation for the Amplify app.
+ *The name for an Amplify app.
*/ - enableAutoBranchCreation?: boolean; + name: string | undefined; /** - *Enables basic authorization for an Amplify app. This will apply to all branches that - * are part of this app.
+ *The description for an Amplify app.
*/ - enableBasicAuth?: boolean; + description?: string; /** - *The description for an Amplify app.
+ *The repository for an Amplify app.
*/ - description?: string; + repository?: string; /** *The platform or framework for an Amplify app.
*/ platform?: Platform | string; + /** + *The AWS Identity and Access Management (IAM) service role for an Amplify app.
+ */ + iamServiceRoleArn?: string; + + /** + *The OAuth token for a third-party source control system for an Amplify app. The OAuth + * token is used to create a webhook and a read-only deploy key. The OAuth token is not + * stored.
+ */ + oauthToken?: string; + /** *The personal access token for a third-party source control system for an Amplify app. * The personal access token is used to create a webhook and a read-only deploy key. The @@ -177,9 +189,9 @@ export interface CreateAppRequest { accessToken?: string; /** - *
The repository for an Amplify app.
+ *The environment variables map for an Amplify app.
*/ - repository?: string; + environmentVariables?: { [key: string]: string }; /** *Enables the auto building of branches for an Amplify app.
@@ -187,21 +199,21 @@ export interface CreateAppRequest { enableBranchAutoBuild?: boolean; /** - *The tag for an Amplify app.
+ *Automatically disconnects a branch in the Amplify Console when you delete a branch + * from your Git repository.
*/ - tags?: { [key: string]: string }; + enableBranchAutoDeletion?: boolean; /** - *The OAuth token for a third-party source control system for an Amplify app. The OAuth - * token is used to create a webhook and a read-only deploy key. The OAuth token is not - * stored.
+ *Enables basic authorization for an Amplify app. This will apply to all branches that + * are part of this app.
*/ - oauthToken?: string; + enableBasicAuth?: boolean; /** - *The automated branch creation glob patterns for the Amplify app.
+ *The credentials for basic authorization for an Amplify app.
*/ - autoBranchCreationPatterns?: string[]; + basicAuthCredentials?: string; /** *The custom rewrite and redirect rules for an Amplify app.
@@ -209,14 +221,9 @@ export interface CreateAppRequest { customRules?: CustomRule[]; /** - *The environment variables map for an Amplify app.
- */ - environmentVariables?: { [key: string]: string }; - - /** - *The AWS Identity and Access Management (IAM) service role for an Amplify app.
+ *The tag for an Amplify app.
*/ - iamServiceRoleArn?: string; + tags?: { [key: string]: string }; /** *The build specification (build spec) for an Amplify app.
@@ -224,36 +231,35 @@ export interface CreateAppRequest { buildSpec?: string; /** - *The automated branch creation configuration for the Amplify app.
+ *The custom HTTP headers for an Amplify app.
*/ - autoBranchCreationConfig?: AutoBranchCreationConfig; + customHeaders?: string; /** - *The credentials for basic authorization for an Amplify app.
+ *Enables automated branch creation for an Amplify app.
*/ - basicAuthCredentials?: string; + enableAutoBranchCreation?: boolean; /** - *The name for the Amplify app.
+ *The automated branch creation glob patterns for an Amplify app.
*/ - name: string | undefined; + autoBranchCreationPatterns?: string[]; /** - *Automatically disconnects a branch in the Amplify Console when you delete a branch - * from your Git repository.
+ *The automated branch creation configuration for an Amplify app.
*/ - enableBranchAutoDeletion?: boolean; + autoBranchCreationConfig?: AutoBranchCreationConfig; } export namespace CreateAppRequest { export const filterSensitiveLog = (obj: CreateAppRequest): any => ({ ...obj, - ...(obj.accessToken && { accessToken: SENSITIVE_STRING }), ...(obj.oauthToken && { oauthToken: SENSITIVE_STRING }), + ...(obj.accessToken && { accessToken: SENSITIVE_STRING }), + ...(obj.basicAuthCredentials && { basicAuthCredentials: SENSITIVE_STRING }), ...(obj.autoBranchCreationConfig && { autoBranchCreationConfig: AutoBranchCreationConfig.filterSensitiveLog(obj.autoBranchCreationConfig), }), - ...(obj.basicAuthCredentials && { basicAuthCredentials: SENSITIVE_STRING }), }); } @@ -261,11 +267,6 @@ export namespace CreateAppRequest { *Describes the information about a production branch for an Amplify app.
*/ export interface ProductionBranch { - /** - *The branch name for the production branch.
- */ - branchName?: string; - /** *The last deploy time of the production branch.
*/ @@ -280,6 +281,11 @@ export interface ProductionBranch { *The thumbnail URL for the production branch.
*/ thumbnailUrl?: string; + + /** + *The branch name for the production branch.
+ */ + branchName?: string; } export namespace ProductionBranch { @@ -299,85 +305,91 @@ export interface App { appId: string | undefined; /** - *Describes the automated branch creation glob patterns for the Amplify app.
+ *The Amazon Resource Name (ARN) of the Amplify app.
*/ - autoBranchCreationPatterns?: string[]; + appArn: string | undefined; /** - *Describes the custom redirect and rewrite rules for the Amplify app.
+ *The name for the Amplify app.
*/ - customRules?: CustomRule[]; + name: string | undefined; /** - *The environment variables for the Amplify app.
+ *The tag for the Amplify app.
*/ - environmentVariables: { [key: string]: string } | undefined; + tags?: { [key: string]: string }; /** - *Describes the automated branch creation configuration for the Amplify app.
+ *The description for the Amplify app.
*/ - autoBranchCreationConfig?: AutoBranchCreationConfig; + description: string | undefined; /** - *The AWS Identity and Access Management (IAM) service role for the Amazon Resource - * Name (ARN) of the Amplify app.
+ *The repository for the Amplify app.
*/ - iamServiceRoleArn?: string; + repository: string | undefined; /** - *Enables automated branch creation for the Amplify app.
+ *The platform for the Amplify app.
*/ - enableAutoBranchCreation?: boolean; + platform: Platform | string | undefined; /** - *The default domain for the Amplify app.
+ *Creates a date and time for the Amplify app.
*/ - defaultDomain: string | undefined; + createTime: Date | undefined; /** - *Enables basic authorization for the Amplify app's branches.
+ *Updates the date and time for the Amplify app.
*/ - enableBasicAuth: boolean | undefined; + updateTime: Date | undefined; /** - *Enables the auto-building of branches for the Amplify app.
+ *The AWS Identity and Access Management (IAM) service role for the Amazon Resource + * Name (ARN) of the Amplify app.
*/ - enableBranchAutoBuild: boolean | undefined; + iamServiceRoleArn?: string; /** - *The repository for the Amplify app.
+ *The environment variables for the Amplify app.
*/ - repository: string | undefined; + environmentVariables: { [key: string]: string } | undefined; /** - *The platform for the Amplify app.
+ *The default domain for the Amplify app.
*/ - platform: Platform | string | undefined; + defaultDomain: string | undefined; /** - *The description for the Amplify app.
+ *Enables the auto-building of branches for the Amplify app.
*/ - description: string | undefined; + enableBranchAutoBuild: boolean | undefined; /** - *Updates the date and time for the Amplify app.
+ *Automatically disconnect a branch in the Amplify Console when you delete a branch + * from your Git repository.
*/ - updateTime: Date | undefined; + enableBranchAutoDeletion?: boolean; /** - *The tag for the Amplify app.
+ *Enables basic authorization for the Amplify app's branches.
*/ - tags?: { [key: string]: string }; + enableBasicAuth: boolean | undefined; /** - *Describes the information about a production branch of the Amplify app.
+ *The basic authorization credentials for branches for the Amplify app.
*/ - productionBranch?: ProductionBranch; + basicAuthCredentials?: string; /** - *The Amazon Resource Name (ARN) of the Amplify app.
+ *Describes the custom redirect and rewrite rules for the Amplify app.
*/ - appArn: string | undefined; + customRules?: CustomRule[]; + + /** + *Describes the information about a production branch of the Amplify app.
+ */ + productionBranch?: ProductionBranch; /** *Describes the content of the build specification (build spec) for the Amplify app. @@ -386,34 +398,33 @@ export interface App { buildSpec?: string; /** - *
The basic authorization credentials for branches for the Amplify app.
+ *Describes the custom HTTP headers for the Amplify app.
*/ - basicAuthCredentials?: string; + customHeaders?: string; /** - *The name for the Amplify app.
+ *Enables automated branch creation for the Amplify app.
*/ - name: string | undefined; + enableAutoBranchCreation?: boolean; /** - *Automatically disconnect a branch in the Amplify Console when you delete a branch - * from your Git repository.
+ *Describes the automated branch creation glob patterns for the Amplify app.
*/ - enableBranchAutoDeletion?: boolean; + autoBranchCreationPatterns?: string[]; /** - *Creates a date and time for the Amplify app.
+ *Describes the automated branch creation configuration for the Amplify app.
*/ - createTime: Date | undefined; + autoBranchCreationConfig?: AutoBranchCreationConfig; } export namespace App { export const filterSensitiveLog = (obj: App): any => ({ ...obj, + ...(obj.basicAuthCredentials && { basicAuthCredentials: SENSITIVE_STRING }), ...(obj.autoBranchCreationConfig && { autoBranchCreationConfig: AutoBranchCreationConfig.filterSensitiveLog(obj.autoBranchCreationConfig), }), - ...(obj.basicAuthCredentials && { basicAuthCredentials: SENSITIVE_STRING }), }); } @@ -507,14 +518,14 @@ export interface CreateBackendEnvironmentRequest { environmentName: string | undefined; /** - *The name of deployment artifacts.
+ *The AWS CloudFormation stack name of a backend environment.
*/ - deploymentArtifacts?: string; + stackName?: string; /** - *The AWS CloudFormation stack name of a backend environment.
+ *The name of deployment artifacts.
*/ - stackName?: string; + deploymentArtifacts?: string; } export namespace CreateBackendEnvironmentRequest { @@ -527,12 +538,6 @@ export namespace CreateBackendEnvironmentRequest { *Describes the backend environment for an Amplify app.
*/ export interface BackendEnvironment { - /** - *The creation date and time for a backend environment that is part of an Amplify app. - *
- */ - createTime: Date | undefined; - /** *The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify * app.
@@ -540,10 +545,9 @@ export interface BackendEnvironment { backendEnvironmentArn: string | undefined; /** - *The last updated date and time for a backend environment that is part of an Amplify - * app.
+ *The name for a backend environment that is part of an Amplify app.
*/ - updateTime: Date | undefined; + environmentName: string | undefined; /** *The AWS CloudFormation stack name of a backend environment.
@@ -551,14 +555,21 @@ export interface BackendEnvironment { stackName?: string; /** - *The name for a backend environment that is part of an Amplify app.
+ *The name of deployment artifacts.
*/ - environmentName: string | undefined; + deploymentArtifacts?: string; /** - *The name of deployment artifacts.
+ *The creation date and time for a backend environment that is part of an Amplify app. + *
*/ - deploymentArtifacts?: string; + createTime: Date | undefined; + + /** + *The last updated date and time for a backend environment that is part of an Amplify + * app.
+ */ + updateTime: Date | undefined; } export namespace BackendEnvironment { @@ -603,19 +614,19 @@ export namespace NotFoundException { */ export interface CreateBranchRequest { /** - *Enables notifications for the branch.
+ *The unique ID for an Amplify app.
*/ - enableNotification?: boolean; + appId: string | undefined; /** - *Enables basic authorization for the branch.
+ *The name for the branch.
*/ - enableBasicAuth?: boolean; + branchName: string | undefined; /** - *Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.
+ *The description for the branch.
*/ - enablePerformanceMode?: boolean; + description?: string; /** *Describes the current stage for the branch.
@@ -623,55 +634,45 @@ export interface CreateBranchRequest { stage?: Stage | string; /** - *Enables pull request preview for this branch.
+ *The framework for the branch.
*/ - enablePullRequestPreview?: boolean; + framework?: string; /** - *The environment variables for the branch.
- */ - environmentVariables?: { [key: string]: string }; - - /** - *The unique ID for an Amplify app.
- */ - appId: string | undefined; - - /** - *The content Time To Live (TTL) for the website in seconds.
+ *Enables notifications for the branch.
*/ - ttl?: string; + enableNotification?: boolean; /** - *The tag for the branch.
+ *Enables auto building for the branch.
*/ - tags?: { [key: string]: string }; + enableAutoBuild?: boolean; /** - *The framework for the branch.
+ *The environment variables for the branch.
*/ - framework?: string; + environmentVariables?: { [key: string]: string }; /** - *The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify - * app.
+ *The basic authorization credentials for the branch.
*/ - backendEnvironmentArn?: string; + basicAuthCredentials?: string; /** - *The description for the branch.
+ *Enables basic authorization for the branch.
*/ - description?: string; + enableBasicAuth?: boolean; /** - *The basic authorization credentials for the branch.
+ *Enables performance mode for the branch.
+ *Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
*/ - basicAuthCredentials?: string; + enablePerformanceMode?: boolean; /** - *The name for the branch.
+ *The tag for the branch.
*/ - branchName: string | undefined; + tags?: { [key: string]: string }; /** *The build specification (build spec) for the branch.
@@ -679,19 +680,30 @@ export interface CreateBranchRequest { buildSpec?: string; /** - *Enables auto building for the branch.
+ *The content Time To Live (TTL) for the website in seconds.
*/ - enableAutoBuild?: boolean; + ttl?: string; /** *The display name for a branch. This is used as the default domain prefix.
*/ displayName?: string; + /** + *Enables pull request previews for this branch.
+ */ + enablePullRequestPreview?: boolean; + /** *The Amplify environment name for the pull request.
*/ pullRequestEnvironmentName?: string; + + /** + *The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify + * app.
+ */ + backendEnvironmentArn?: string; } export namespace CreateBranchRequest { @@ -706,80 +718,79 @@ export namespace CreateBranchRequest { */ export interface Branch { /** - *Enables auto-building on push for a branch of an Amplify app.
+ *The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
*/ - enableAutoBuild: boolean | undefined; + branchArn: string | undefined; /** - *The tag for the branch of an Amplify app.
+ *The name for the branch that is part of an Amplify app.
*/ - tags?: { [key: string]: string }; + branchName: string | undefined; /** - *The total number of jobs that are part of an Amplify app.
+ *The description for the branch that is part of an Amplify app.
*/ - totalNumberOfJobs: string | undefined; + description: string | undefined; /** - *The source branch if the branch is a pull request branch.
+ *The tag for the branch of an Amplify app.
*/ - sourceBranch?: string; + tags?: { [key: string]: string }; /** - *The thumbnail URL for the branch of an Amplify app.
+ *The current stage for the branch that is part of an Amplify app.
*/ - thumbnailUrl?: string; + stage: Stage | string | undefined; /** - *The Amplify environment name for the pull request.
+ *The display name for the branch. This is used as the default domain prefix.
*/ - pullRequestEnvironmentName?: string; + displayName: string | undefined; /** - *The destination branch if the branch is a pull request branch.
+ *Enables notifications for a branch that is part of an Amplify app.
*/ - destinationBranch?: string; + enableNotification: boolean | undefined; /** - *The ID of the active job for a branch of an Amplify app.
+ *The creation date and time for a branch that is part of an Amplify app.
*/ - activeJobId: string | undefined; + createTime: Date | undefined; /** - *The current stage for the branch that is part of an Amplify app.
+ *The last updated date and time for a branch that is part of an Amplify app.
*/ - stage: Stage | string | undefined; + updateTime: Date | undefined; /** - *Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.
+ *The environment variables specific to a branch of an Amplify app.
*/ - enablePerformanceMode?: boolean; + environmentVariables: { [key: string]: string } | undefined; /** - *A list of custom resources that are linked to this branch.
+ *Enables auto-building on push for a branch of an Amplify app.
*/ - associatedResources?: string[]; + enableAutoBuild: boolean | undefined; /** - *The creation date and time for a branch that is part of an Amplify app.
+ *The custom domains for a branch of an Amplify app.
*/ - createTime: Date | undefined; + customDomains: string[] | undefined; /** - *The build specification (build spec) content for the branch of an Amplify app. - *
+ *The framework for a branch of an Amplify app.
*/ - buildSpec?: string; + framework: string | undefined; /** - *The last updated date and time for a branch that is part of an Amplify app.
+ *The ID of the active job for a branch of an Amplify app.
*/ - updateTime: Date | undefined; + activeJobId: string | undefined; /** - *The framework for a branch of an Amplify app.
+ *The total number of jobs that are part of an Amplify app.
*/ - framework: string | undefined; + totalNumberOfJobs: string | undefined; /** *Enables basic authorization for a branch of an Amplify app.
@@ -787,14 +798,15 @@ export interface Branch { enableBasicAuth: boolean | undefined; /** - *The display name for the branch. This is used as the default domain prefix.
+ *Enables performance mode for the branch.
+ *Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
*/ - displayName: string | undefined; + enablePerformanceMode?: boolean; /** - *The description for the branch that is part of an Amplify app.
+ *The thumbnail URL for the branch of an Amplify app.
*/ - description: string | undefined; + thumbnailUrl?: string; /** *The basic authorization credentials for a branch of an Amplify app.
@@ -802,39 +814,40 @@ export interface Branch { basicAuthCredentials?: string; /** - *The custom domains for a branch of an Amplify app.
+ *The build specification (build spec) content for the branch of an Amplify app. + *
*/ - customDomains: string[] | undefined; + buildSpec?: string; /** - *The environment variables specific to a branch of an Amplify app.
+ *The content Time to Live (TTL) for the website in seconds.
*/ - environmentVariables: { [key: string]: string } | undefined; + ttl: string | undefined; /** - *Enables notifications for a branch that is part of an Amplify app.
+ *A list of custom resources that are linked to this branch.
*/ - enableNotification: boolean | undefined; + associatedResources?: string[]; /** - *Enables pull request preview for the branch.
+ *Enables pull request previews for the branch.
*/ enablePullRequestPreview: boolean | undefined; /** - *The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.
+ *The Amplify environment name for the pull request.
*/ - branchArn: string | undefined; + pullRequestEnvironmentName?: string; /** - *The name for the branch that is part of an Amplify app.
+ *The destination branch if the branch is a pull request branch.
*/ - branchName: string | undefined; + destinationBranch?: string; /** - *The content Time to Live (TTL) for the website in seconds.
+ *The source branch if the branch is a pull request branch.
*/ - ttl: string | undefined; + sourceBranch?: string; /** *The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify @@ -906,17 +919,17 @@ export interface CreateDeploymentResult { */ jobId?: string; - /** - *
When the fileMap
argument is not provided in the request, this
- * zipUploadUrl
is returned.
When the fileMap
argument is provided in the request,
* fileUploadUrls
will contain a map of file names to upload URLs.
When the fileMap
argument is not provided in the request, this
+ * zipUploadUrl
is returned.
The branch name setting for the subdomain.
+ *The prefix setting for the subdomain.
*/ - branchName: string | undefined; + prefix: string | undefined; /** - *The prefix setting for the subdomain.
+ *The branch name setting for the subdomain.
*/ - prefix: string | undefined; + branchName: string | undefined; } export namespace SubDomainSetting { @@ -951,29 +964,29 @@ export namespace SubDomainSetting { */ export interface CreateDomainAssociationRequest { /** - *The domain name for the domain association.
+ *The unique ID for an Amplify app.
*/ - domainName: string | undefined; + appId: string | undefined; /** - *The setting for the subdomain.
+ *The domain name for the domain association.
*/ - subDomainSettings: SubDomainSetting[] | undefined; + domainName: string | undefined; /** - *Sets the branch patterns for automatic subdomain creation.
+ *Enables the automated creation of subdomains for branches.
*/ - autoSubDomainCreationPatterns?: string[]; + enableAutoSubDomain?: boolean; /** - *The unique ID for an Amplify app.
+ *The setting for the subdomain.
*/ - appId: string | undefined; + subDomainSettings: SubDomainSetting[] | undefined; /** - *Enables the automated creation of subdomains for branches.
+ *Sets the branch patterns for automatic subdomain creation.
*/ - enableAutoSubDomain?: boolean; + autoSubDomainCreationPatterns?: string[]; /** *The required AWS Identity and Access Management (IAM) service role for the Amazon @@ -1031,14 +1044,14 @@ export namespace SubDomain { */ export interface DomainAssociation { /** - *
The DNS record for certificate verification.
+ *The Amazon Resource Name (ARN) for the domain association.
*/ - certificateVerificationDNSRecord?: string; + domainAssociationArn: string | undefined; /** - *The current status of the domain association.
+ *The name of the domain.
*/ - domainStatus: DomainStatus | string | undefined; + domainName: string | undefined; /** *Enables the automated creation of subdomains for branches.
@@ -1046,35 +1059,35 @@ export interface DomainAssociation { enableAutoSubDomain: boolean | undefined; /** - *The required AWS Identity and Access Management (IAM) service role for the Amazon - * Resource Name (ARN) for automatically creating subdomains.
+ *Sets branch patterns for automatic subdomain creation.
*/ - autoSubDomainIAMRole?: string; + autoSubDomainCreationPatterns?: string[]; /** - *The subdomains for the domain association.
+ *The required AWS Identity and Access Management (IAM) service role for the Amazon + * Resource Name (ARN) for automatically creating subdomains.
*/ - subDomains: SubDomain[] | undefined; + autoSubDomainIAMRole?: string; /** - *The Amazon Resource Name (ARN) for the domain association.
+ *The current status of the domain association.
*/ - domainAssociationArn: string | undefined; + domainStatus: DomainStatus | string | undefined; /** - *The name of the domain.
+ *The reason for the current status of the domain association.
*/ - domainName: string | undefined; + statusReason: string | undefined; /** - *The reason for the current status of the domain association.
+ *The DNS record for certificate verification.
*/ - statusReason: string | undefined; + certificateVerificationDNSRecord?: string; /** - *Sets branch patterns for automatic subdomain creation.
+ *The subdomains for the domain association.
*/ - autoSubDomainCreationPatterns?: string[]; + subDomains: SubDomain[] | undefined; } export namespace DomainAssociation { @@ -1110,14 +1123,14 @@ export interface CreateWebhookRequest { appId: string | undefined; /** - *The description for a webhook.
+ *The name for a branch that is part of an Amplify app.
*/ - description?: string; + branchName: string | undefined; /** - *The name for a branch that is part of an Amplify app.
+ *The description for a webhook.
*/ - branchName: string | undefined; + description?: string; } export namespace CreateWebhookRequest { @@ -1156,14 +1169,14 @@ export interface Webhook { description: string | undefined; /** - *Updates the date and time for a webhook.
+ *The create date and time for a webhook.
*/ - updateTime: Date | undefined; + createTime: Date | undefined; /** - *The create date and time for a webhook.
+ *Updates the date and time for a webhook.
*/ - createTime: Date | undefined; + updateTime: Date | undefined; } export namespace Webhook { @@ -1264,14 +1277,14 @@ export namespace DeleteBackendEnvironmentResult { */ export interface DeleteBranchRequest { /** - *The name for the branch.
+ *The unique ID for an Amplify app.
*/ - branchName: string | undefined; + appId: string | undefined; /** - *The unique ID for an Amplify app.
+ *The name for the branch.
*/ - appId: string | undefined; + branchName: string | undefined; } export namespace DeleteBranchRequest { @@ -1302,14 +1315,14 @@ export namespace DeleteBranchResult { */ export interface DeleteDomainAssociationRequest { /** - *The name of the domain.
+ *The unique id for an Amplify app.
*/ - domainName: string | undefined; + appId: string | undefined; /** - *The unique id for an Amplify app.
+ *The name of the domain.
*/ - appId: string | undefined; + domainName: string | undefined; } export namespace DeleteDomainAssociationRequest { @@ -1336,18 +1349,18 @@ export namespace DeleteDomainAssociationResult { *The request structure for the delete job request.
*/ export interface DeleteJobRequest { - /** - *The name for the branch, for the job.
- */ - branchName: string | undefined; - /** *The unique ID for an Amplify app.
*/ appId: string | undefined; /** - *The unique ID for the job.
+ *The name for the branch, for the job.
+ */ + branchName: string | undefined; + + /** + *The unique ID for the job.
*/ jobId: string | undefined; } @@ -1385,19 +1398,14 @@ export interface JobSummary { jobArn: string | undefined; /** - *The end date and time for the job.
- */ - endTime?: Date; - - /** - *The current status for the job.
+ *The unique ID for the job.
*/ - status: JobStatus | string | undefined; + jobId: string | undefined; /** - *The start date and time for the job.
+ *The commit ID from a third-party repository provider for the job.
*/ - startTime: Date | undefined; + commitId: string | undefined; /** *The commit message from a third-party repository provider for the job.
@@ -1410,9 +1418,19 @@ export interface JobSummary { commitTime: Date | undefined; /** - *The unique ID for the job.
+ *The start date and time for the job.
*/ - jobId: string | undefined; + startTime: Date | undefined; + + /** + *The current status for the job.
+ */ + status: JobStatus | string | undefined; + + /** + *The end date and time for the job.
+ */ + endTime?: Date; /** * The type for the job. If the value is RELEASE
, the job was manually
@@ -1422,11 +1440,6 @@ export interface JobSummary {
* webhooks.
The commit ID from a third-party repository provider for the job.
- */ - commitId: string | undefined; } export namespace JobSummary { @@ -1605,14 +1618,14 @@ export namespace GetArtifactUrlResult { */ export interface GetBackendEnvironmentRequest { /** - *The name for the backend environment.
+ *The unique id for an Amplify app.
*/ - environmentName: string | undefined; + appId: string | undefined; /** - *The unique id for an Amplify app.
+ *The name for the backend environment.
*/ - appId: string | undefined; + environmentName: string | undefined; } export namespace GetBackendEnvironmentRequest { @@ -1741,14 +1754,14 @@ export namespace GetJobRequest { */ export interface Step { /** - *The URL to the logs for the execution step.
+ *The name of the execution step.
*/ - logUrl?: string; + stepName: string | undefined; /** - *The URL to the test configuration for the execution step.
+ *The start date and time of the execution step.
*/ - testConfigUrl?: string; + startTime: Date | undefined; /** *The status of the execution step.
@@ -1761,9 +1774,14 @@ export interface Step { endTime: Date | undefined; /** - *The list of screenshot URLs for the execution step, if relevant.
+ *The URL to the logs for the execution step.
*/ - screenshots?: { [key: string]: string }; + logUrl?: string; + + /** + *The URL to the artifact for the execution step.
+ */ + artifactsUrl?: string; /** *The URL to the test artifact for the execution step.
@@ -1771,15 +1789,14 @@ export interface Step { testArtifactsUrl?: string; /** - *The start date and time of the execution step.
+ *The URL to the test configuration for the execution step.
*/ - startTime: Date | undefined; + testConfigUrl?: string; /** - *The context for the current step. Includes a build image if the step is build. - *
+ *The list of screenshot URLs for the execution step, if relevant.
*/ - context?: string; + screenshots?: { [key: string]: string }; /** *The reason for the current step status.
@@ -1787,14 +1804,10 @@ export interface Step { statusReason?: string; /** - *The URL to the artifact for the execution step.
- */ - artifactsUrl?: string; - - /** - *The name of the execution step.
+ *The context for the current step. Includes a build image if the step is build. + *
*/ - stepName: string | undefined; + context?: string; } export namespace Step { @@ -1873,16 +1886,16 @@ export namespace GetWebhookResult { *The request structure for the list apps request.
*/ export interface ListAppsRequest { - /** - *The maximum number of records to list in a single response.
- */ - maxResults?: number; - /** *A pagination token. If non-null, the pagination token is returned in a result. Pass * its value in another request to retrieve more entries.
*/ nextToken?: string; + + /** + *The maximum number of records to list in a single response.
+ */ + maxResults?: number; } export namespace ListAppsRequest { @@ -1920,11 +1933,9 @@ export namespace ListAppsResult { */ export interface ListArtifactsRequest { /** - *A pagination token. Set to null to start listing artifacts from start. If a non-null - * pagination token is returned in a result, pass its value in here to list more artifacts. - *
+ *The unique ID for an Amplify app.
*/ - nextToken?: string; + appId: string | undefined; /** *The name of a branch that is part of an Amplify app.
@@ -1932,19 +1943,21 @@ export interface ListArtifactsRequest { branchName: string | undefined; /** - *The maximum number of records to list in a single response.
+ *The unique ID for a job.
*/ - maxResults?: number; + jobId: string | undefined; /** - *The unique ID for a job.
+ *A pagination token. Set to null to start listing artifacts from start. If a non-null + * pagination token is returned in a result, pass its value in here to list more artifacts. + *
*/ - jobId: string | undefined; + nextToken?: string; /** - *The unique ID for an Amplify app.
+ *The maximum number of records to list in a single response.
*/ - appId: string | undefined; + maxResults?: number; } export namespace ListArtifactsRequest { @@ -1958,14 +1971,14 @@ export namespace ListArtifactsRequest { */ export interface Artifact { /** - *The unique ID for the artifact.
+ *The file name for the artifact.
*/ - artifactId: string | undefined; + artifactFileName: string | undefined; /** - *The file name for the artifact.
+ *The unique ID for the artifact.
*/ - artifactFileName: string | undefined; + artifactId: string | undefined; } export namespace Artifact { @@ -2001,26 +2014,26 @@ export namespace ListArtifactsResult { */ export interface ListBackendEnvironmentsRequest { /** - *A pagination token. Set to null to start listing backend environments from the start. - * If a non-null pagination token is returned in a result, pass its value in here to list - * more backend environments.
+ *The unique ID for an Amplify app.
*/ - nextToken?: string; + appId: string | undefined; /** - *The unique ID for an Amplify app.
+ *The name of the backend environment
*/ - appId: string | undefined; + environmentName?: string; /** - *The maximum number of records to list in a single response.
+ *A pagination token. Set to null to start listing backend environments from the start. + * If a non-null pagination token is returned in a result, pass its value in here to list + * more backend environments.
*/ - maxResults?: number; + nextToken?: string; /** - *The name of the backend environment
+ *The maximum number of records to list in a single response.
*/ - environmentName?: string; + maxResults?: number; } export namespace ListBackendEnvironmentsRequest { @@ -2034,15 +2047,15 @@ export namespace ListBackendEnvironmentsRequest { */ export interface ListBackendEnvironmentsResult { /** - *A pagination token. If a non-null pagination token is returned in a result, pass its - * value in another request to retrieve more entries.
+ *The list of backend environments for an Amplify app.
*/ - nextToken?: string; + backendEnvironments: BackendEnvironment[] | undefined; /** - *The list of backend environments for an Amplify app.
+ *A pagination token. If a non-null pagination token is returned in a result, pass its + * value in another request to retrieve more entries.
*/ - backendEnvironments: BackendEnvironment[] | undefined; + nextToken?: string; } export namespace ListBackendEnvironmentsResult { @@ -2055,6 +2068,11 @@ export namespace ListBackendEnvironmentsResult { *The request structure for the list branches request.
*/ export interface ListBranchesRequest { + /** + *The unique ID for an Amplify app.
+ */ + appId: string | undefined; + /** *A pagination token. Set to null to start listing branches from the start. If a * non-null pagination token is returned in a result, pass its value in here to list more @@ -2066,11 +2084,6 @@ export interface ListBranchesRequest { *
The maximum number of records to list in a single response.
*/ maxResults?: number; - - /** - *The unique ID for an Amplify app.
- */ - appId: string | undefined; } export namespace ListBranchesRequest { @@ -2111,17 +2124,17 @@ export interface ListDomainAssociationsRequest { */ appId: string | undefined; - /** - *The maximum number of records to list in a single response.
- */ - maxResults?: number; - /** *A pagination token. Set to null to start listing apps from the start. If non-null, a * pagination token is returned in a result. Pass its value in here to list more projects. *
*/ nextToken?: string; + + /** + *The maximum number of records to list in a single response.
+ */ + maxResults?: number; } export namespace ListDomainAssociationsRequest { @@ -2161,6 +2174,11 @@ export interface ListJobsRequest { */ appId: string | undefined; + /** + *The name for a branch.
+ */ + branchName: string | undefined; + /** *A pagination token. Set to null to start listing steps from the start. If a non-null * pagination token is returned in a result, pass its value in here to list more steps. @@ -2172,11 +2190,6 @@ export interface ListJobsRequest { *
The maximum number of records to list in a single response.
*/ maxResults?: number; - - /** - *The name for a branch.
- */ - branchName: string | undefined; } export namespace ListJobsRequest { @@ -2190,15 +2203,15 @@ export namespace ListJobsRequest { */ export interface ListJobsResult { /** - *A pagination token. If non-null the pagination token is returned in a result. Pass - * its value in another request to retrieve more entries.
+ *The result structure for the list job result request.
*/ - nextToken?: string; + jobSummaries: JobSummary[] | undefined; /** - *The result structure for the list job result request.
+ *A pagination token. If non-null the pagination token is returned in a result. Pass + * its value in another request to retrieve more entries.
*/ - jobSummaries: JobSummary[] | undefined; + nextToken?: string; } export namespace ListJobsResult { @@ -2245,8 +2258,8 @@ export namespace ListTagsForResourceResponse { export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer { name: "ResourceNotFoundException"; $fault: "client"; - message: string | undefined; code: string | undefined; + message: string | undefined; } export namespace ResourceNotFoundException { @@ -2259,11 +2272,6 @@ export namespace ResourceNotFoundException { *The request structure for the list webhooks request.
*/ export interface ListWebhooksRequest { - /** - *The maximum number of records to list in a single response.
- */ - maxResults?: number; - /** *The unique ID for an Amplify app.
*/ @@ -2275,6 +2283,11 @@ export interface ListWebhooksRequest { * more webhooks. */ nextToken?: string; + + /** + *The maximum number of records to list in a single response.
+ */ + maxResults?: number; } export namespace ListWebhooksRequest { @@ -2288,15 +2301,15 @@ export namespace ListWebhooksRequest { */ export interface ListWebhooksResult { /** - *A pagination token. If non-null, the pagination token is returned in a result. Pass - * its value in another request to retrieve more entries.
+ *A list of webhooks.
*/ - nextToken?: string; + webhooks: Webhook[] | undefined; /** - *A list of webhooks.
+ *A pagination token. If non-null, the pagination token is returned in a result. Pass + * its value in another request to retrieve more entries.
*/ - webhooks: Webhook[] | undefined; + nextToken?: string; } export namespace ListWebhooksResult { @@ -2310,26 +2323,26 @@ export namespace ListWebhooksResult { */ export interface StartDeploymentRequest { /** - *The name for the branch, for the job.
+ *The unique ID for an Amplify app.
*/ - branchName: string | undefined; + appId: string | undefined; /** - *The source URL for this deployment, used when calling start deployment without create - * deployment. The source URL can be any HTTP GET URL that is publicly accessible and - * downloads a single .zip file.
+ *The name for the branch, for the job.
*/ - sourceUrl?: string; + branchName: string | undefined; /** - *The unique ID for an Amplify app.
+ *The job ID for this deployment, generated by the create deployment request.
*/ - appId: string | undefined; + jobId?: string; /** - *The job ID for this deployment, generated by the create deployment request.
+ *The source URL for this deployment, used when calling start deployment without create + * deployment. The source URL can be any HTTP GET URL that is publicly accessible and + * downloads a single .zip file.
*/ - jobId?: string; + sourceUrl?: string; } export namespace StartDeploymentRequest { @@ -2359,49 +2372,49 @@ export namespace StartDeploymentResult { */ export interface StartJobRequest { /** - *The commit message from a third-party repository provider for the job.
+ *The unique ID for an Amplify app.
*/ - commitMessage?: string; + appId: string | undefined; /** - *A descriptive reason for starting this job.
+ *The branch name for the job.
*/ - jobReason?: string; + branchName: string | undefined; /** - *The commit ID from a third-party repository provider for the job.
+ * The unique ID for an existing job. This is required if the value of
+ * jobType
is RETRY
.
The commit date and time for the job.
+ * Describes the type for the job. The job type RELEASE
starts a new job
+ * with the latest change from the specified branch. This value is available only for apps
+ * that are connected to a repository. The job type RETRY
retries an existing
+ * job. If the job type value is RETRY
, the jobId
is also
+ * required.
The unique ID for an Amplify app.
+ *A descriptive reason for starting this job.
*/ - appId: string | undefined; + jobReason?: string; /** - * The unique ID for an existing job. This is required if the value of
- * jobType
is RETRY
.
The commit ID from a third-party repository provider for the job.
*/ - jobId?: string; + commitId?: string; /** - *The branch name for the job.
+ *The commit message from a third-party repository provider for the job.
*/ - branchName: string | undefined; + commitMessage?: string; /** - * Describes the type for the job. The job type RELEASE
starts a new job
- * with the latest change from the specified branch. This value is available only for apps
- * that are connected to a repository. The job type RETRY
retries an existing
- * job. If the job type value is RETRY
, the jobId
is also
- * required.
The commit date and time for the job.
*/ - jobType: JobType | string | undefined; + commitTime?: Date; } export namespace StartJobRequest { @@ -2430,6 +2443,11 @@ export namespace StartJobResult { *The request structure for the stop job request.
*/ export interface StopJobRequest { + /** + *The unique ID for an Amplify app.
+ */ + appId: string | undefined; + /** *The name for the branch, for the job.
*/ @@ -2439,11 +2457,6 @@ export interface StopJobRequest { *The unique id for the job.
*/ jobId: string | undefined; - - /** - *The unique ID for an Amplify app.
- */ - appId: string | undefined; } export namespace StopJobRequest { @@ -2473,14 +2486,14 @@ export namespace StopJobResult { */ export interface TagResourceRequest { /** - *The tags used to tag the resource.
+ *The Amazon Resource Name (ARN) to use to tag a resource.
*/ - tags: { [key: string]: string } | undefined; + resourceArn: string | undefined; /** - *The Amazon Resource Name (ARN) to use to tag a resource.
+ *The tags used to tag the resource.
*/ - resourceArn: string | undefined; + tags: { [key: string]: string } | undefined; } export namespace TagResourceRequest { @@ -2537,27 +2550,14 @@ export namespace UntagResourceResponse { */ export interface UpdateAppRequest { /** - *The personal access token for a third-party source control system for an Amplify app. - * The token is used to create webhook and a read-only deploy key. The token is not stored. - *
- */ - accessToken?: string; - - /** - *Automatically disconnects a branch in the Amplify Console when you delete a branch - * from your Git repository.
- */ - enableBranchAutoDeletion?: boolean; - - /** - *Enables branch auto-building for an Amplify app.
+ *The unique ID for an Amplify app.
*/ - enableBranchAutoBuild?: boolean; + appId: string | undefined; /** - *The name of the repository for an Amplify app
+ *The name for an Amplify app.
*/ - repository?: string; + name?: string; /** *The description for an Amplify app.
@@ -2565,9 +2565,9 @@ export interface UpdateAppRequest { description?: string; /** - *The name for an Amplify app.
+ *The platform for an Amplify app.
*/ - name?: string; + platform?: Platform | string; /** *The AWS Identity and Access Management (IAM) service role for an Amplify app.
@@ -2580,9 +2580,25 @@ export interface UpdateAppRequest { environmentVariables?: { [key: string]: string }; /** - *The automated branch creation configuration for the Amplify app.
+ *Enables branch auto-building for an Amplify app.
*/ - autoBranchCreationConfig?: AutoBranchCreationConfig; + enableBranchAutoBuild?: boolean; + + /** + *Automatically disconnects a branch in the Amplify Console when you delete a branch + * from your Git repository.
+ */ + enableBranchAutoDeletion?: boolean; + + /** + *Enables basic authorization for an Amplify app.
+ */ + enableBasicAuth?: boolean; + + /** + *The basic authorization credentials for an Amplify app.
+ */ + basicAuthCredentials?: string; /** *The custom redirect and rewrite rules for an Amplify app.
@@ -2590,57 +2606,59 @@ export interface UpdateAppRequest { customRules?: CustomRule[]; /** - *Describes the automated branch creation glob patterns for the Amplify app.
+ *The build specification (build spec) for an Amplify app.
*/ - autoBranchCreationPatterns?: string[]; + buildSpec?: string; /** - *The OAuth token for a third-party source control system for an Amplify app. The token - * is used to create a webhook and a read-only deploy key. The OAuth token is not stored. - *
+ *The custom HTTP headers for an Amplify app.
*/ - oauthToken?: string; + customHeaders?: string; /** - *The platform for an Amplify app.
+ *Enables automated branch creation for an Amplify app.
*/ - platform?: Platform | string; + enableAutoBranchCreation?: boolean; /** - *The basic authorization credentials for an Amplify app.
+ *Describes the automated branch creation glob patterns for an Amplify app.
*/ - basicAuthCredentials?: string; + autoBranchCreationPatterns?: string[]; /** - *Enables basic authorization for an Amplify app.
+ *The automated branch creation configuration for an Amplify app.
*/ - enableBasicAuth?: boolean; + autoBranchCreationConfig?: AutoBranchCreationConfig; /** - *Enables automated branch creation for the Amplify app.
+ *The name of the repository for an Amplify app
*/ - enableAutoBranchCreation?: boolean; + repository?: string; /** - *The build specification (build spec) for an Amplify app.
+ *The OAuth token for a third-party source control system for an Amplify app. The token + * is used to create a webhook and a read-only deploy key. The OAuth token is not stored. + *
*/ - buildSpec?: string; + oauthToken?: string; /** - *The unique ID for an Amplify app.
+ *The personal access token for a third-party source control system for an Amplify app. + * The token is used to create webhook and a read-only deploy key. The token is not stored. + *
*/ - appId: string | undefined; + accessToken?: string; } export namespace UpdateAppRequest { export const filterSensitiveLog = (obj: UpdateAppRequest): any => ({ ...obj, - ...(obj.accessToken && { accessToken: SENSITIVE_STRING }), + ...(obj.basicAuthCredentials && { basicAuthCredentials: SENSITIVE_STRING }), ...(obj.autoBranchCreationConfig && { autoBranchCreationConfig: AutoBranchCreationConfig.filterSensitiveLog(obj.autoBranchCreationConfig), }), ...(obj.oauthToken && { oauthToken: SENSITIVE_STRING }), - ...(obj.basicAuthCredentials && { basicAuthCredentials: SENSITIVE_STRING }), + ...(obj.accessToken && { accessToken: SENSITIVE_STRING }), }); } @@ -2666,90 +2684,91 @@ export namespace UpdateAppResult { */ export interface UpdateBranchRequest { /** - *Enables notifications for the branch.
+ *The unique ID for an Amplify app.
*/ - enableNotification?: boolean; + appId: string | undefined; /** - *The environment variables for the branch.
+ *The name for the branch.
*/ - environmentVariables?: { [key: string]: string }; + branchName: string | undefined; /** - *Enables basic authorization for the branch.
+ *The description for the branch.
*/ - enableBasicAuth?: boolean; + description?: string; /** - *The build specification (build spec) for the branch.
+ *The framework for the branch.
*/ - buildSpec?: string; + framework?: string; /** - *The content Time to Live (TTL) for the website in seconds.
+ *Describes the current stage for the branch.
*/ - ttl?: string; + stage?: Stage | string; /** - *The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify - * app.
+ *Enables notifications for the branch.
*/ - backendEnvironmentArn?: string; + enableNotification?: boolean; /** - *The unique ID for an Amplify app.
+ *Enables auto building for the branch.
*/ - appId: string | undefined; + enableAutoBuild?: boolean; /** - *Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. Enabling performance mode will mean that hosting configuration or code changes can take up to 10 minutes to roll out.
+ *The environment variables for the branch.
*/ - enablePerformanceMode?: boolean; + environmentVariables?: { [key: string]: string }; /** - *The framework for the branch.
+ *The basic authorization credentials for the branch.
*/ - framework?: string; + basicAuthCredentials?: string; /** - *Enables pull request preview for this branch.
+ *Enables basic authorization for the branch.
*/ - enablePullRequestPreview?: boolean; + enableBasicAuth?: boolean; /** - *Describes the current stage for the branch.
+ *Enables performance mode for the branch.
+ *Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
*/ - stage?: Stage | string; + enablePerformanceMode?: boolean; /** - *The basic authorization credentials for the branch.
+ *The build specification (build spec) for the branch.
*/ - basicAuthCredentials?: string; + buildSpec?: string; /** - *Enables auto building for the branch.
+ *The content Time to Live (TTL) for the website in seconds.
*/ - enableAutoBuild?: boolean; + ttl?: string; /** - *The name for the branch.
+ *The display name for a branch. This is used as the default domain prefix.
*/ - branchName: string | undefined; + displayName?: string; /** - *The Amplify environment name for the pull request.
+ *Enables pull request previews for this branch.
*/ - pullRequestEnvironmentName?: string; + enablePullRequestPreview?: boolean; /** - *The description for the branch.
+ *The Amplify environment name for the pull request.
*/ - description?: string; + pullRequestEnvironmentName?: string; /** - *The display name for a branch. This is used as the default domain prefix.
+ *The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify + * app.
*/ - displayName?: string; + backendEnvironmentArn?: string; } export namespace UpdateBranchRequest { @@ -2786,9 +2805,9 @@ export interface UpdateDomainAssociationRequest { appId: string | undefined; /** - *Sets the branch patterns for automatic subdomain creation.
+ *The name of the domain.
*/ - autoSubDomainCreationPatterns?: string[]; + domainName: string | undefined; /** *Enables the automated creation of subdomains for branches.
@@ -2801,9 +2820,9 @@ export interface UpdateDomainAssociationRequest { subDomainSettings: SubDomainSetting[] | undefined; /** - *The name of the domain.
+ *Sets the branch patterns for automatic subdomain creation.
*/ - domainName: string | undefined; + autoSubDomainCreationPatterns?: string[]; /** *The required AWS Identity and Access Management (IAM) service role for the Amazon @@ -2845,14 +2864,14 @@ export interface UpdateWebhookRequest { webhookId: string | undefined; /** - *
The description for a webhook.
+ *The name for a branch that is part of an Amplify app.
*/ - description?: string; + branchName?: string; /** - *The name for a branch that is part of an Amplify app.
+ *The description for a webhook.
*/ - branchName?: string; + description?: string; } export namespace UpdateWebhookRequest { diff --git a/clients/client-amplify/protocols/Aws_restJson1.ts b/clients/client-amplify/protocols/Aws_restJson1.ts index 9e3adcbac470..36579f845ec3 100644 --- a/clients/client-amplify/protocols/Aws_restJson1.ts +++ b/clients/client-amplify/protocols/Aws_restJson1.ts @@ -122,6 +122,7 @@ export const serializeAws_restJson1CreateAppCommand = async ( }), ...(input.basicAuthCredentials !== undefined && { basicAuthCredentials: input.basicAuthCredentials }), ...(input.buildSpec !== undefined && { buildSpec: input.buildSpec }), + ...(input.customHeaders !== undefined && { customHeaders: input.customHeaders }), ...(input.customRules !== undefined && { customRules: serializeAws_restJson1CustomRules(input.customRules, context), }), @@ -437,15 +438,6 @@ export const serializeAws_restJson1DeleteBranchCommand = async ( "Content-Type": "", }; let resolvedPath = "/apps/{appId}/branches/{branchName}"; - if (input.branchName !== undefined) { - const labelValue: string = input.branchName; - if (labelValue.length <= 0) { - throw new Error("Empty value provided for input HTTP label: branchName."); - } - resolvedPath = resolvedPath.replace("{branchName}", __extendedEncodeURIComponent(labelValue)); - } else { - throw new Error("No value provided for input HTTP label: branchName."); - } if (input.appId !== undefined) { const labelValue: string = input.appId; if (labelValue.length <= 0) { @@ -455,6 +447,15 @@ export const serializeAws_restJson1DeleteBranchCommand = async ( } else { throw new Error("No value provided for input HTTP label: appId."); } + if (input.branchName !== undefined) { + const labelValue: string = input.branchName; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: branchName."); + } + resolvedPath = resolvedPath.replace("{branchName}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: branchName."); + } let body: any; const { hostname, protocol = "https", port } = await context.endpoint(); return new __HttpRequest({ @@ -476,15 +477,6 @@ export const serializeAws_restJson1DeleteDomainAssociationCommand = async ( "Content-Type": "", }; let resolvedPath = "/apps/{appId}/domains/{domainName}"; - if (input.domainName !== undefined) { - const labelValue: string = input.domainName; - if (labelValue.length <= 0) { - throw new Error("Empty value provided for input HTTP label: domainName."); - } - resolvedPath = resolvedPath.replace("{domainName}", __extendedEncodeURIComponent(labelValue)); - } else { - throw new Error("No value provided for input HTTP label: domainName."); - } if (input.appId !== undefined) { const labelValue: string = input.appId; if (labelValue.length <= 0) { @@ -494,6 +486,15 @@ export const serializeAws_restJson1DeleteDomainAssociationCommand = async ( } else { throw new Error("No value provided for input HTTP label: appId."); } + if (input.domainName !== undefined) { + const labelValue: string = input.domainName; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: domainName."); + } + resolvedPath = resolvedPath.replace("{domainName}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: domainName."); + } let body: any; const { hostname, protocol = "https", port } = await context.endpoint(); return new __HttpRequest({ @@ -515,15 +516,6 @@ export const serializeAws_restJson1DeleteJobCommand = async ( "Content-Type": "", }; let resolvedPath = "/apps/{appId}/branches/{branchName}/jobs/{jobId}"; - if (input.branchName !== undefined) { - const labelValue: string = input.branchName; - if (labelValue.length <= 0) { - throw new Error("Empty value provided for input HTTP label: branchName."); - } - resolvedPath = resolvedPath.replace("{branchName}", __extendedEncodeURIComponent(labelValue)); - } else { - throw new Error("No value provided for input HTTP label: branchName."); - } if (input.appId !== undefined) { const labelValue: string = input.appId; if (labelValue.length <= 0) { @@ -533,6 +525,15 @@ export const serializeAws_restJson1DeleteJobCommand = async ( } else { throw new Error("No value provided for input HTTP label: appId."); } + if (input.branchName !== undefined) { + const labelValue: string = input.branchName; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: branchName."); + } + resolvedPath = resolvedPath.replace("{branchName}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: branchName."); + } if (input.jobId !== undefined) { const labelValue: string = input.jobId; if (labelValue.length <= 0) { @@ -688,15 +689,6 @@ export const serializeAws_restJson1GetBackendEnvironmentCommand = async ( "Content-Type": "", }; let resolvedPath = "/apps/{appId}/backendenvironments/{environmentName}"; - if (input.environmentName !== undefined) { - const labelValue: string = input.environmentName; - if (labelValue.length <= 0) { - throw new Error("Empty value provided for input HTTP label: environmentName."); - } - resolvedPath = resolvedPath.replace("{environmentName}", __extendedEncodeURIComponent(labelValue)); - } else { - throw new Error("No value provided for input HTTP label: environmentName."); - } if (input.appId !== undefined) { const labelValue: string = input.appId; if (labelValue.length <= 0) { @@ -706,6 +698,15 @@ export const serializeAws_restJson1GetBackendEnvironmentCommand = async ( } else { throw new Error("No value provided for input HTTP label: appId."); } + if (input.environmentName !== undefined) { + const labelValue: string = input.environmentName; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: environmentName."); + } + resolvedPath = resolvedPath.replace("{environmentName}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: environmentName."); + } let body: any; const { hostname, protocol = "https", port } = await context.endpoint(); return new __HttpRequest({ @@ -884,8 +885,8 @@ export const serializeAws_restJson1ListAppsCommand = async ( }; let resolvedPath = "/apps"; const query: any = { - ...(input.maxResults !== undefined && { maxResults: input.maxResults.toString() }), ...(input.nextToken !== undefined && { nextToken: input.nextToken }), + ...(input.maxResults !== undefined && { maxResults: input.maxResults.toString() }), }; let body: any; const { hostname, protocol = "https", port } = await context.endpoint(); @@ -909,6 +910,15 @@ export const serializeAws_restJson1ListArtifactsCommand = async ( "Content-Type": "", }; let resolvedPath = "/apps/{appId}/branches/{branchName}/jobs/{jobId}/artifacts"; + if (input.appId !== undefined) { + const labelValue: string = input.appId; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: appId."); + } + resolvedPath = resolvedPath.replace("{appId}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: appId."); + } if (input.branchName !== undefined) { const labelValue: string = input.branchName; if (labelValue.length <= 0) { @@ -927,15 +937,6 @@ export const serializeAws_restJson1ListArtifactsCommand = async ( } else { throw new Error("No value provided for input HTTP label: jobId."); } - if (input.appId !== undefined) { - const labelValue: string = input.appId; - if (labelValue.length <= 0) { - throw new Error("Empty value provided for input HTTP label: appId."); - } - resolvedPath = resolvedPath.replace("{appId}", __extendedEncodeURIComponent(labelValue)); - } else { - throw new Error("No value provided for input HTTP label: appId."); - } const query: any = { ...(input.nextToken !== undefined && { nextToken: input.nextToken }), ...(input.maxResults !== undefined && { maxResults: input.maxResults.toString() }), @@ -972,9 +973,9 @@ export const serializeAws_restJson1ListBackendEnvironmentsCommand = async ( throw new Error("No value provided for input HTTP label: appId."); } const query: any = { + ...(input.environmentName !== undefined && { environmentName: input.environmentName }), ...(input.nextToken !== undefined && { nextToken: input.nextToken }), ...(input.maxResults !== undefined && { maxResults: input.maxResults.toString() }), - ...(input.environmentName !== undefined && { environmentName: input.environmentName }), }; let body: any; const { hostname, protocol = "https", port } = await context.endpoint(); @@ -1043,8 +1044,8 @@ export const serializeAws_restJson1ListDomainAssociationsCommand = async ( throw new Error("No value provided for input HTTP label: appId."); } const query: any = { - ...(input.maxResults !== undefined && { maxResults: input.maxResults.toString() }), ...(input.nextToken !== undefined && { nextToken: input.nextToken }), + ...(input.maxResults !== undefined && { maxResults: input.maxResults.toString() }), }; let body: any; const { hostname, protocol = "https", port } = await context.endpoint(); @@ -1152,8 +1153,8 @@ export const serializeAws_restJson1ListWebhooksCommand = async ( throw new Error("No value provided for input HTTP label: appId."); } const query: any = { - ...(input.maxResults !== undefined && { maxResults: input.maxResults.toString() }), ...(input.nextToken !== undefined && { nextToken: input.nextToken }), + ...(input.maxResults !== undefined && { maxResults: input.maxResults.toString() }), }; let body: any; const { hostname, protocol = "https", port } = await context.endpoint(); @@ -1177,15 +1178,6 @@ export const serializeAws_restJson1StartDeploymentCommand = async ( "Content-Type": "application/json", }; let resolvedPath = "/apps/{appId}/branches/{branchName}/deployments/start"; - if (input.branchName !== undefined) { - const labelValue: string = input.branchName; - if (labelValue.length <= 0) { - throw new Error("Empty value provided for input HTTP label: branchName."); - } - resolvedPath = resolvedPath.replace("{branchName}", __extendedEncodeURIComponent(labelValue)); - } else { - throw new Error("No value provided for input HTTP label: branchName."); - } if (input.appId !== undefined) { const labelValue: string = input.appId; if (labelValue.length <= 0) { @@ -1195,6 +1187,15 @@ export const serializeAws_restJson1StartDeploymentCommand = async ( } else { throw new Error("No value provided for input HTTP label: appId."); } + if (input.branchName !== undefined) { + const labelValue: string = input.branchName; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: branchName."); + } + resolvedPath = resolvedPath.replace("{branchName}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: branchName."); + } let body: any; body = JSON.stringify({ ...(input.jobId !== undefined && { jobId: input.jobId }), @@ -1267,6 +1268,15 @@ export const serializeAws_restJson1StopJobCommand = async ( "Content-Type": "", }; let resolvedPath = "/apps/{appId}/branches/{branchName}/jobs/{jobId}/stop"; + if (input.appId !== undefined) { + const labelValue: string = input.appId; + if (labelValue.length <= 0) { + throw new Error("Empty value provided for input HTTP label: appId."); + } + resolvedPath = resolvedPath.replace("{appId}", __extendedEncodeURIComponent(labelValue)); + } else { + throw new Error("No value provided for input HTTP label: appId."); + } if (input.branchName !== undefined) { const labelValue: string = input.branchName; if (labelValue.length <= 0) { @@ -1285,15 +1295,6 @@ export const serializeAws_restJson1StopJobCommand = async ( } else { throw new Error("No value provided for input HTTP label: jobId."); } - if (input.appId !== undefined) { - const labelValue: string = input.appId; - if (labelValue.length <= 0) { - throw new Error("Empty value provided for input HTTP label: appId."); - } - resolvedPath = resolvedPath.replace("{appId}", __extendedEncodeURIComponent(labelValue)); - } else { - throw new Error("No value provided for input HTTP label: appId."); - } let body: any; const { hostname, protocol = "https", port } = await context.endpoint(); return new __HttpRequest({ @@ -1405,6 +1406,7 @@ export const serializeAws_restJson1UpdateAppCommand = async ( }), ...(input.basicAuthCredentials !== undefined && { basicAuthCredentials: input.basicAuthCredentials }), ...(input.buildSpec !== undefined && { buildSpec: input.buildSpec }), + ...(input.customHeaders !== undefined && { customHeaders: input.customHeaders }), ...(input.customRules !== undefined && { customRules: serializeAws_restJson1CustomRules(input.customRules, context), }), @@ -4891,6 +4893,8 @@ const deserializeAws_restJson1App = (output: any, context: __SerdeContext): App output.createTime !== undefined && output.createTime !== null ? new Date(Math.round(output.createTime * 1000)) : undefined, + customHeaders: + output.customHeaders !== undefined && output.customHeaders !== null ? output.customHeaders : undefined, customRules: output.customRules !== undefined && output.customRules !== null ? deserializeAws_restJson1CustomRules(output.customRules, context) diff --git a/clients/client-api-gateway/pagination/GetApiKeysPaginator.ts b/clients/client-api-gateway/pagination/GetApiKeysPaginator.ts index 5552bd3d58ce..60aa0ef760b6 100644 --- a/clients/client-api-gateway/pagination/GetApiKeysPaginator.ts +++ b/clients/client-api-gateway/pagination/GetApiKeysPaginator.ts @@ -10,7 +10,7 @@ const makePagedClientRequest = async ( ...args: any ): PromiseIf there is a Classic Load Balancer attached to your Auto Scaling group, the instances are * also registered with the load balancer. If there are target groups attached to your Auto Scaling * group, the instances are also registered with the target groups.
- *For more information, see Attach EC2 Instances to - * Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
+ *For more information, see Attach EC2 instances to + * your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
*/ public attachInstances( args: AttachInstancesCommandInput, @@ -337,8 +337,8 @@ export class AutoScaling extends AutoScalingClient { * registers the running instances with these Classic Load Balancers. *To describe the load balancers for an Auto Scaling group, call the DescribeLoadBalancers API. To detach the load balancer from the Auto Scaling * group, call the DetachLoadBalancers API.
- *For more information, see Attaching a Load - * Balancer to Your Auto Scaling Group in the + *
For more information, see Attaching a load + * balancer to your Auto Scaling group in the * Amazon EC2 Auto Scaling User Guide.
*/ public attachLoadBalancers( @@ -376,8 +376,8 @@ export class AutoScaling extends AutoScalingClient { * the Auto Scaling group, call the DetachLoadBalancerTargetGroups API. *With Application Load Balancers and Network Load Balancers, instances are registered * as targets with a target group. With Classic Load Balancers, instances are registered - * with the load balancer. For more information, see Attaching a Load - * Balancer to Your Auto Scaling Group in the + * with the load balancer. For more information, see Attaching a load + * balancer to your Auto Scaling group in the * Amazon EC2 Auto Scaling User Guide.
*/ public attachLoadBalancerTargetGroups( @@ -542,8 +542,8 @@ export class AutoScaling extends AutoScalingClient { * * * - *For more information, see Amazon EC2 Auto Scaling Lifecycle - * Hooks in the Amazon EC2 Auto Scaling User Guide.
+ *For more information, see Amazon EC2 Auto Scaling lifecycle + * hooks in the Amazon EC2 Auto Scaling User Guide.
*/ public completeLifecycleAction( args: CompleteLifecycleActionCommandInput, @@ -578,13 +578,13 @@ export class AutoScaling extends AutoScalingClient { *Creates an Auto Scaling group with the specified name and attributes.
*If you exceed your maximum limit of Auto Scaling groups, the call fails. To query this limit, * call the DescribeAccountLimits API. For information about updating - * this limit, see Amazon EC2 Auto Scaling Service - * Quotas in the Amazon EC2 Auto Scaling User Guide.
- *For introductory exercises for creating an Auto Scaling group, see Getting Started with - * Amazon EC2 Auto Scaling and Tutorial: Set Up a - * Scaled and Load-Balanced Application in the + * this limit, see Amazon EC2 Auto Scaling service + * quotas in the Amazon EC2 Auto Scaling User Guide.
+ *For introductory exercises for creating an Auto Scaling group, see Getting started with + * Amazon EC2 Auto Scaling and Tutorial: Set up a + * scaled and load-balanced application in the * Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling - * Groups in the Amazon EC2 Auto Scaling User Guide.
+ * groups in the Amazon EC2 Auto Scaling User Guide. *Every Auto Scaling group has three size parameters (DesiredCapacity
,
* MaxSize
, and MinSize
). Usually, you set these sizes based
* on a specific number of instances. However, if you configure a mixed instances policy
@@ -624,10 +624,10 @@ export class AutoScaling extends AutoScalingClient {
*
Creates a launch configuration.
*If you exceed your maximum limit of launch configurations, the call fails. To query * this limit, call the DescribeAccountLimits API. For information about - * updating this limit, see Amazon EC2 Auto Scaling Service - * Quotas in the Amazon EC2 Auto Scaling User Guide.
+ * updating this limit, see Amazon EC2 Auto Scaling service + * quotas in the Amazon EC2 Auto Scaling User Guide. *For more information, see Launch - * Configurations in the Amazon EC2 Auto Scaling User Guide.
+ * configurations in the Amazon EC2 Auto Scaling User Guide. */ public createLaunchConfiguration( args: CreateLaunchConfigurationCommandInput, @@ -662,8 +662,8 @@ export class AutoScaling extends AutoScalingClient { *Creates or updates tags for the specified Auto Scaling group.
*When you specify a tag with a key that already exists, the operation overwrites the * previous tag definition, and you do not get an error message.
- *For more information, see Tagging Auto Scaling Groups and - * Instances in the Amazon EC2 Auto Scaling User Guide.
+ *For more information, see Tagging Auto Scaling groups and + * instances in the Amazon EC2 Auto Scaling User Guide.
*/ public createOrUpdateTags( args: CreateOrUpdateTagsCommandInput, @@ -841,8 +841,8 @@ export class AutoScaling extends AutoScalingClient { *Deleting either a step scaling policy or a simple scaling policy deletes the * underlying alarm action, but does not delete the alarm, even if it no longer has an * associated action.
- *For more information, see Deleting a Scaling - * Policy in the Amazon EC2 Auto Scaling User Guide.
+ *For more information, see Deleting a scaling + * policy in the Amazon EC2 Auto Scaling User Guide.
*/ public deletePolicy( args: DeletePolicyCommandInput, @@ -930,8 +930,8 @@ export class AutoScaling extends AutoScalingClient { /** *Describes the current Amazon EC2 Auto Scaling resource quotas for your AWS account.
- *For information about requesting an increase, see Amazon EC2 Auto Scaling Service - * Quotas in the Amazon EC2 Auto Scaling User Guide.
+ *For information about requesting an increase, see Amazon EC2 Auto Scaling service + * quotas in the Amazon EC2 Auto Scaling User Guide.
*/ public describeAccountLimits( args: DescribeAccountLimitsCommandInput, @@ -1545,8 +1545,8 @@ export class AutoScaling extends AutoScalingClient { *You can also specify multiple filters. The result includes information for a * particular tag only if it matches all the filters. If there's no match, no special * message is returned.
- *For more information, see Tagging Auto Scaling Groups and - * Instances in the Amazon EC2 Auto Scaling User Guide.
+ *For more information, see Tagging Auto Scaling groups and + * instances in the Amazon EC2 Auto Scaling User Guide.
*/ public describeTags( args: DescribeTagsCommandInput, @@ -1576,8 +1576,8 @@ export class AutoScaling extends AutoScalingClient { /** *Describes the termination policies supported by Amazon EC2 Auto Scaling.
- *For more information, see Controlling Which Auto Scaling - * Instances Terminate During Scale In in the + *
For more information, see Controlling which Auto Scaling + * instances terminate during scale in in the * Amazon EC2 Auto Scaling User Guide.
*/ public describeTerminationPolicyTypes( @@ -1618,8 +1618,8 @@ export class AutoScaling extends AutoScalingClient { *If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are * deregistered from the load balancer. If there are target groups attached to the Auto Scaling * group, the instances are deregistered from the target groups.
- *For more information, see Detach EC2 Instances from - * Your Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
+ *For more information, see Detach EC2 instances from + * your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
*/ public detachInstances( args: DetachInstancesCommandInput, @@ -1752,7 +1752,7 @@ export class AutoScaling extends AutoScalingClient { } /** - *Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring Your Auto Scaling Groups and Instances in the + *
Enables group metrics for the specified Auto Scaling group. For more information, see Monitoring CloudWatch metrics for your Auto Scaling groups and instances in the * Amazon EC2 Auto Scaling User Guide.
*/ public enableMetricsCollection( @@ -1792,8 +1792,8 @@ export class AutoScaling extends AutoScalingClient { * group. *If you choose not to decrement the desired capacity of the Auto Scaling group, the Auto Scaling group * launches new instances to replace the instances on standby.
- *For more information, see Temporarily Removing - * Instances from Your Auto Scaling Group in the + *
For more information, see Temporarily removing + * instances from your Auto Scaling group in the * Amazon EC2 Auto Scaling User Guide.
*/ public enterStandby( @@ -1859,8 +1859,8 @@ export class AutoScaling extends AutoScalingClient { *Moves the specified instances out of the standby state.
*After you put the instances back in service, the desired capacity is * incremented.
- *For more information, see Temporarily Removing - * Instances from Your Auto Scaling Group in the + *
For more information, see Temporarily removing + * instances from your Auto Scaling group in the * Amazon EC2 Auto Scaling User Guide.
*/ public exitStandby(args: ExitStandbyCommandInput, options?: __HttpHandlerOptions): PromiseFor more information, see Amazon EC2 Auto Scaling Lifecycle - * Hooks in the Amazon EC2 Auto Scaling User Guide.
+ *For more information, see Amazon EC2 Auto Scaling lifecycle + * hooks in the Amazon EC2 Auto Scaling User Guide.
*If you exceed your maximum limit of lifecycle hooks, which by default is 50 per Auto Scaling * group, the call fails.
*You can view the lifecycle hooks for an Auto Scaling group using the DescribeLifecycleHooks API call. If you are no longer using a lifecycle @@ -1961,7 +1961,7 @@ export class AutoScaling extends AutoScalingClient { * web server or an email address.
*This configuration overwrites any existing configuration.
*For more information, see Getting Amazon SNS - * Notifications When Your Auto Scaling Group Scales in the + * notifications when your Auto Scaling group scales in the * Amazon EC2 Auto Scaling User Guide.
*If you exceed your maximum limit of SNS topics, which is 10 per Auto Scaling group, the call * fails.
@@ -1997,8 +1997,8 @@ export class AutoScaling extends AutoScalingClient { /** *Creates or updates a scaling policy for an Auto Scaling group.
- *For more information about using scaling policies to scale your Auto Scaling group, see Target Tracking Scaling Policies and Step and Simple Scaling - * Policies in the Amazon EC2 Auto Scaling User Guide.
+ *For more information about using scaling policies to scale your Auto Scaling group, see Target tracking scaling policies and Step and simple scaling + * policies in the Amazon EC2 Auto Scaling User Guide.
*/ public putScalingPolicy( args: PutScalingPolicyCommandInput, @@ -2033,7 +2033,7 @@ export class AutoScaling extends AutoScalingClient { *Creates or updates a scheduled scaling action for an Auto Scaling group. If you leave a * parameter unspecified when updating a scheduled scaling action, the corresponding value * remains unchanged.
- *For more information, see Scheduled Scaling in the + *
For more information, see Scheduled scaling in the * Amazon EC2 Auto Scaling User Guide.
*/ public putScheduledUpdateGroupAction( @@ -2098,7 +2098,7 @@ export class AutoScaling extends AutoScalingClient { * * *For more information, see Auto Scaling - * Lifecycle in the Amazon EC2 Auto Scaling User Guide.
+ * lifecycle in the Amazon EC2 Auto Scaling User Guide. */ public recordLifecycleActionHeartbeat( args: RecordLifecycleActionHeartbeatCommandInput, @@ -2130,10 +2130,10 @@ export class AutoScaling extends AutoScalingClient { } /** - *Resumes the specified suspended automatic scaling processes, or all suspended process, - * for the specified Auto Scaling group.
+ *Resumes the specified suspended auto scaling processes, or all suspended process, for + * the specified Auto Scaling group.
*For more information, see Suspending and - * Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
+ * resuming scaling processes in the Amazon EC2 Auto Scaling User Guide. */ public resumeProcesses( args: ResumeProcessesCommandInput, @@ -2169,7 +2169,7 @@ export class AutoScaling extends AutoScalingClient { *If a scale-in activity occurs as a result of a new DesiredCapacity
value
* that is lower than the current size of the group, the Auto Scaling group uses its termination
* policy to determine which instances to terminate.
For more information, see Manual Scaling in the + *
For more information, see Manual scaling in the * Amazon EC2 Auto Scaling User Guide.
*/ public setDesiredCapacity( @@ -2203,8 +2203,8 @@ export class AutoScaling extends AutoScalingClient { /** *Sets the health status of the specified instance.
- *For more information, see Health Checks for Auto Scaling - * Instances in the Amazon EC2 Auto Scaling User Guide.
+ *For more information, see Health checks for Auto Scaling + * instances in the Amazon EC2 Auto Scaling User Guide.
*/ public setInstanceHealth( args: SetInstanceHealthCommandInput, @@ -2238,7 +2238,8 @@ export class AutoScaling extends AutoScalingClient { /** *Updates the instance protection settings of the specified instances.
*For more information about preventing instances that are part of an Auto Scaling group from - * terminating on scale in, see Instance Protection in the Amazon EC2 Auto Scaling User Guide.
+ * terminating on scale in, see Instance scale-in protection in the + * Amazon EC2 Auto Scaling User Guide. *If you exceed your maximum limit of instance IDs, which is 50 per Auto Scaling group, the call * fails.
*/ @@ -2312,12 +2313,12 @@ export class AutoScaling extends AutoScalingClient { } /** - *Suspends the specified automatic scaling processes, or all processes, for the - * specified Auto Scaling group.
+ *Suspends the specified auto scaling processes, or all processes, for the specified + * Auto Scaling group.
*If you suspend either the Launch
or Terminate
process types,
* it can prevent other process types from functioning properly. For more information, see
* Suspending and
- * Resuming Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
To resume processes that have been suspended, call the ResumeProcesses API.
*/ public suspendProcesses( @@ -2360,7 +2361,7 @@ export class AutoScaling extends AutoScalingClient { *By default, Amazon EC2 Auto Scaling balances instances across all Availability Zones. If you * decrement the desired capacity, your Auto Scaling group can become unbalanced between * Availability Zones. Amazon EC2 Auto Scaling tries to rebalance the group, and rebalancing might - * terminate instances in other zones. For more information, see Rebalancing Activities in the Amazon EC2 Auto Scaling User Guide.
+ * terminate instances in other zones. For more information, see Rebalancing activities in the Amazon EC2 Auto Scaling User Guide. */ public terminateInstanceInAutoScalingGroup( args: TerminateInstanceInAutoScalingGroupCommandInput, diff --git a/clients/client-auto-scaling/models/models_0.ts b/clients/client-auto-scaling/models/models_0.ts index 75c1201cb034..132ffcc55094 100644 --- a/clients/client-auto-scaling/models/models_0.ts +++ b/clients/client-auto-scaling/models/models_0.ts @@ -37,30 +37,20 @@ export enum ScalingActivityStatusCode { * to your Auto Scaling group, such as changing its size or replacing an instance. */ export interface Activity { - /** - *A friendly, more verbose description of the activity.
- */ - Description?: string; - /** *The ID of the activity.
*/ ActivityId: string | undefined; - /** - *The end time of the activity.
- */ - EndTime?: Date; - /** *The name of the Auto Scaling group.
*/ AutoScalingGroupName: string | undefined; /** - *A value between 0 and 100 that indicates the progress of the activity.
+ *A friendly, more verbose description of the activity.
*/ - Progress?: number; + Description?: string; /** *The reason the activity began.
@@ -68,14 +58,14 @@ export interface Activity { Cause: string | undefined; /** - *A friendly, more verbose description of the activity status.
+ *The start time of the activity.
*/ - StatusMessage?: string; + StartTime: Date | undefined; /** - *The details about the activity.
+ *The end time of the activity.
*/ - Details?: string; + EndTime?: Date; /** *The current status of the activity.
@@ -83,9 +73,19 @@ export interface Activity { StatusCode: ScalingActivityStatusCode | string | undefined; /** - *The start time of the activity.
+ *A friendly, more verbose description of the activity status.
*/ - StartTime: Date | undefined; + StatusMessage?: string; + + /** + *A value between 0 and 100 that indicates the progress of the activity.
+ */ + Progress?: number; + + /** + *The details about the activity.
+ */ + Details?: string; } export namespace Activity { @@ -151,14 +151,14 @@ export namespace AdjustmentType { */ export interface Alarm { /** - *The Amazon Resource Name (ARN) of the alarm.
+ *The name of the alarm.
*/ - AlarmARN?: string; + AlarmName?: string; /** - *The name of the alarm.
+ *The Amazon Resource Name (ARN) of the alarm.
*/ - AlarmName?: string; + AlarmARN?: string; } export namespace Alarm { @@ -273,15 +273,15 @@ export namespace AttachLoadBalancerTargetGroupsResultType { export interface AttachLoadBalancerTargetGroupsType { /** - *The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target - * groups.
+ *The name of the Auto Scaling group.
*/ - TargetGroupARNs: string[] | undefined; + AutoScalingGroupName: string | undefined; /** - *The name of the Auto Scaling group.
+ *The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target + * groups.
*/ - AutoScalingGroupName: string | undefined; + TargetGroupARNs: string[] | undefined; } export namespace AttachLoadBalancerTargetGroupsType { @@ -294,11 +294,6 @@ export namespace AttachLoadBalancerTargetGroupsType { *Describes a scheduled action that could not be created, updated, or deleted.
*/ export interface FailedScheduledUpdateGroupActionRequest { - /** - *The error message accompanying the error code.
- */ - ErrorMessage?: string; - /** *The name of the scheduled action.
*/ @@ -308,6 +303,11 @@ export interface FailedScheduledUpdateGroupActionRequest { *The error code.
*/ ErrorCode?: string; + + /** + *The error message accompanying the error code.
+ */ + ErrorMessage?: string; } export namespace FailedScheduledUpdateGroupActionRequest { @@ -370,9 +370,9 @@ export namespace BatchPutScheduledUpdateGroupActionAnswer { */ export interface ScheduledUpdateGroupActionRequest { /** - *The minimum size of the Auto Scaling group.
+ *The name of the scaling action.
*/ - MinSize?: number; + ScheduledActionName: string | undefined; /** *The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT @@ -385,16 +385,6 @@ export interface ScheduledUpdateGroupActionRequest { */ StartTime?: Date; - /** - *
The name of the scaling action.
- */ - ScheduledActionName: string | undefined; - - /** - *The maximum size of the Auto Scaling group.
- */ - MaxSize?: number; - /** *The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the * action after this time.
@@ -412,6 +402,16 @@ export interface ScheduledUpdateGroupActionRequest { */ Recurrence?: string; + /** + *The minimum size of the Auto Scaling group.
+ */ + MinSize?: number; + + /** + *The maximum size of the Auto Scaling group.
+ */ + MaxSize?: number; + /** *The desired capacity is the initial capacity of the Auto Scaling group after the scheduled * action runs and the capacity it attempts to maintain.
@@ -427,14 +427,14 @@ export namespace ScheduledUpdateGroupActionRequest { export interface BatchPutScheduledUpdateGroupActionType { /** - *One or more scheduled actions. The maximum number allowed is 50.
+ *The name of the Auto Scaling group.
*/ - ScheduledUpdateGroupActions: ScheduledUpdateGroupActionRequest[] | undefined; + AutoScalingGroupName: string | undefined; /** - *The name of the Auto Scaling group.
+ *One or more scheduled actions. The maximum number allowed is 50.
*/ - AutoScalingGroupName: string | undefined; + ScheduledUpdateGroupActions: ScheduledUpdateGroupActionRequest[] | undefined; } export namespace BatchPutScheduledUpdateGroupActionType { @@ -500,20 +500,14 @@ export namespace CompleteLifecycleActionAnswer { export interface CompleteLifecycleActionType { /** - *The action for the group to take. This parameter can be either CONTINUE
- * or ABANDON
.
The ID of the instance.
+ *The name of the lifecycle hook.
*/ - InstanceId?: string; + LifecycleHookName: string | undefined; /** - *The name of the lifecycle hook.
+ *The name of the Auto Scaling group.
*/ - LifecycleHookName: string | undefined; + AutoScalingGroupName: string | undefined; /** *A universally unique identifier (UUID) that identifies a specific lifecycle action @@ -523,9 +517,15 @@ export interface CompleteLifecycleActionType { LifecycleActionToken?: string; /** - *
The name of the Auto Scaling group.
+ *The action for the group to take. This parameter can be either CONTINUE
+ * or ABANDON
.
The ID of the instance.
+ */ + InstanceId?: string; } export namespace CompleteLifecycleActionType { @@ -538,34 +538,33 @@ export namespace CompleteLifecycleActionType { *Describes the Amazon EC2 launch template and the launch template version that can be used * by an Auto Scaling group to configure Amazon EC2 instances.
*The launch template that is specified must be configured for use with an Auto Scaling group. - * For more information, see Creating a Launch - * Template for an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
+ * For more information, see Creating a launch + * template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. */ export interface LaunchTemplateSpecification { + /** + *The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created
+ * using the Amazon EC2 CreateLaunchTemplate API. You must specify either a
+ * LaunchTemplateId
or a LaunchTemplateName
.
The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created - * using the Amazon EC2 CreateLaunchTemplate API.
- *You must specify either a template ID or a template name.
+ * using the Amazon EC2 CreateLaunchTemplate API. You must specify either a + *LaunchTemplateId
or a LaunchTemplateName
.
*/
LaunchTemplateName?: string;
/**
* The version number, $Latest
, or $Default
. To get the version
* number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions
- * can be created using the Amazon EC2 CreateLaunchTemplateVersion API.
If the value is $Latest
, Amazon EC2 Auto Scaling selects the latest version of the
- * launch template when launching instances. If the value is $Default
,
- * Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances.
- * The default value is $Default
.
$Latest
,
+ * Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If
+ * the value is $Default
, Amazon EC2 Auto Scaling selects the default version of the launch
+ * template when launching instances. The default value is $Default
.
*/
Version?: string;
-
- /**
- * The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created - * using the Amazon EC2 CreateLaunchTemplate API.
- *You must specify either a template ID or a template name.
- */ - LaunchTemplateId?: string; } export namespace LaunchTemplateSpecification { @@ -608,10 +607,15 @@ export namespace LaunchTemplateSpecification { * action. * * - *For more information, see Amazon EC2 Auto Scaling Lifecycle - * Hooks in the Amazon EC2 Auto Scaling User Guide.
+ *For more information, see Amazon EC2 Auto Scaling lifecycle + * hooks in the Amazon EC2 Auto Scaling User Guide.
*/ export interface LifecycleHookSpecification { + /** + *The name of the lifecycle hook.
+ */ + LifecycleHookName: string | undefined; + /** *The state of the EC2 instance to which you want to attach the lifecycle hook. The * valid values are:
@@ -633,9 +637,13 @@ export interface LifecycleHookSpecification { NotificationMetadata?: string; /** - *The name of the lifecycle hook.
+ *The maximum time, in seconds, that can elapse before the lifecycle hook times + * out.
+ *If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in
+ * the DefaultResult
parameter. You can prevent the lifecycle hook from timing
+ * out by calling RecordLifecycleActionHeartbeat.
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses @@ -656,15 +664,6 @@ export interface LifecycleHookSpecification { * notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
*/ RoleARN?: string; - - /** - *The maximum time, in seconds, that can elapse before the lifecycle hook times - * out.
- *If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in
- * the DefaultResult
parameter. You can prevent the lifecycle hook from timing
- * out by calling RecordLifecycleActionHeartbeat.
Describes an instances distribution for an Auto Scaling group with a MixedInstancesPolicy.
*The instances distribution specifies the distribution of On-Demand Instances and Spot * Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates - * instance types to fulfill On-Demand and Spot capacity.
+ * instance types to fulfill On-Demand and Spot capacities. *When you update SpotAllocationStrategy
, SpotInstancePools
,
* or SpotMaxPrice
, this update action does not deploy any changes across the
* running Amazon EC2 instances in the group. Your existing Spot Instances continue to run
@@ -688,75 +687,58 @@ export namespace LifecycleHookSpecification {
*/
export interface InstancesDistribution {
/**
- *
Indicates how to allocate instance types to fulfill On-Demand capacity.
- *The only valid value is prioritized
, which is also the default value.
- * This strategy uses the order of instance type overrides for the LaunchTemplate to define the launch priority of each instance type. The
- * first instance type in the array is prioritized higher than the last. If all your
- * On-Demand capacity cannot be fulfilled using your highest priority instance, then the
- * Auto Scaling groups launches the remaining capacity using the second priority instance type, and
- * so on.
Indicates how to allocate instance types to fulfill On-Demand capacity. The only valid
+ * value is prioritized
, which is also the default value. This strategy uses
+ * the order of instance types in the overrides to define the launch priority of each
+ * instance type. The first instance type in the array is prioritized higher than the last.
+ * If all your On-Demand capacity cannot be fulfilled using your highest priority instance,
+ * then the Auto Scaling groups launches the remaining capacity using the second priority instance
+ * type, and so on.
The number of Spot Instance pools across which to allocate your Spot Instances. The - * Spot pools are determined from the different instance types in the Overrides array of - * LaunchTemplate. Default if not set is 2.
- *Used only when the Spot allocation strategy is lowest-price
.
Valid Range: Minimum value of 1. Maximum value of 20.
+ *The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand
+ * Instances. This base portion is provisioned first as your group scales. Defaults to 0 if
+ * not specified. If you specify weights for the instance types in the overrides, set the
+ * value of OnDemandBaseCapacity
in terms of the number of capacity units, and
+ * not the number of instances.
Controls the percentages of On-Demand Instances and Spot Instances for your additional
- * capacity beyond OnDemandBaseCapacity
.
Default if not set is 100. If you leave it set to 100, the percentages are 100% for - * On-Demand Instances and 0% for Spot Instances.
- *An update to this setting means a gradual replacement of instances to maintain the - * percentage of On-Demand Instances for your additional capacity above the base - * capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before - * terminating the old ones.
- *Valid Range: Minimum value of 0. Maximum value of 100.
+ * capacity beyondOnDemandBaseCapacity
. Expressed as a number (for example,
+ * 20 specifies 20% On-Demand Instances, 80% Spot Instances). Defaults to 100 if not
+ * specified. If set to 100, only On-Demand Instances are provisioned.
*/
OnDemandPercentageAboveBaseCapacity?: number;
/**
- * The minimum amount of the Auto Scaling group's capacity that must be fulfilled by On-Demand - * Instances. This base portion is provisioned first as your group scales.
- *Default if not set is 0. If you leave it set to 0, On-Demand Instances are launched as
- * a percentage of the Auto Scaling group's desired capacity, per the
- * OnDemandPercentageAboveBaseCapacity
setting.
An update to this setting means a gradual replacement of instances to maintain the - * specified number of On-Demand Instances for your base capacity. When replacing - * instances, Amazon EC2 Auto Scaling launches new instances before terminating the old ones.
- *Indicates how to allocate instances across Spot Instance pools. If the allocation
+ * strategy is lowest-price
, the Auto Scaling group launches instances using the Spot
+ * pools with the lowest price, and evenly allocates your instances across the number of
+ * Spot pools that you specify. If the allocation strategy is
+ * capacity-optimized
, the Auto Scaling group launches instances using Spot pools
+ * that are optimally chosen based on the available Spot capacity. Defaults to
+ * lowest-price
if not specified.
Indicates how to allocate instances across Spot Instance pools.
- *If the allocation strategy is lowest-price
, the Auto Scaling group launches
- * instances using the Spot pools with the lowest price, and evenly allocates your
- * instances across the number of Spot pools that you specify. If the allocation strategy
- * is capacity-optimized
, the Auto Scaling group launches instances using Spot pools
- * that are optimally chosen based on the available Spot capacity.
The default Spot allocation strategy for calls that you make through the API, the AWS
- * CLI, or the AWS SDKs is lowest-price
. The default Spot allocation strategy
- * for the AWS Management Console is capacity-optimized
.
Valid values: lowest-price
| capacity-optimized
- *
The number of Spot Instance pools across which to allocate your Spot Instances. The
+ * Spot pools are determined from the different instance types in the overrides. Defaults
+ * to 2 if not specified. Valid only when the Spot allocation strategy is
+ * lowest-price
.
Valid Range: Minimum value of 1. Maximum value of 20.
*/ - SpotAllocationStrategy?: string; + SpotInstancePools?: number; /** *The maximum price per unit hour that you are willing to pay for a Spot Instance. If * you leave the value of this parameter blank (which is the default), the maximum Spot - * price is set at the On-Demand price.
- *To remove a value that you previously set, include the parameter but leave the value - * blank.
+ * price is set at the On-Demand price. To remove a value that you previously set, include + * the parameter but leave the value blank. */ SpotMaxPrice?: string; } @@ -775,23 +757,24 @@ export namespace InstancesDistribution { */ export interface LaunchTemplateOverrides { /** - *The instance type. You must use an instance type that is supported in your requested - * Region and Availability Zones.
- *For information about available instance types, see Available - * Instance Types in the Amazon Elastic Compute Cloud User + *
The instance type, such as m3.xlarge
. You must use an instance type that
+ * is supported in your requested Region and Availability Zones. For information about
+ * available instance types, see Available
+ * instance types in the Amazon Elastic Compute Cloud User
* Guide.
*
The number of capacity units, which gives the instance type a proportional weight to - * other instance types. For example, larger instance types are generally weighted more - * than smaller instance types. These are the same units that you chose to set the desired - * capacity in terms of instances, or a performance attribute such as vCPUs, memory, or - * I/O.
- *For more information, see Instance Weighting for - * Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
+ *The number of capacity units provided by the specified instance type in terms of
+ * virtual CPUs, memory, storage, throughput, or other relative performance characteristic.
+ * When a Spot or On-Demand Instance is provisioned, the capacity units count toward the
+ * desired capacity. Amazon EC2 Auto Scaling provisions instances until the desired capacity is totally
+ * fulfilled, even if this results in an overage. For example, if there are 2 units
+ * remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only provision an instance with a
+ * WeightedCapacity
of 5 units, the instance is provisioned, and the
+ * desired capacity is exceeded by 3 units. For more information, see Instance weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Valid Range: Minimum value of 1. Maximum value of 999.
*/ WeightedCapacity?: string; @@ -815,19 +798,17 @@ export namespace LaunchTemplateOverrides { */ export interface LaunchTemplate { /** - *Any parameters that you specify override the same parameters in the launch template. - * Currently, the only supported override is instance type. You can specify between 1 and - * 20 instance types.
- *If not provided, Amazon EC2 Auto Scaling will use the instance type specified in the launch template - * to launch instances.
+ *The launch template to use.
*/ - Overrides?: LaunchTemplateOverrides[]; + LaunchTemplateSpecification?: LaunchTemplateSpecification; /** - *The launch template to use. You must specify either the launch template ID or launch - * template name in the request.
+ *Any parameters that you specify override the same parameters in the launch template. + * Currently, the only supported override is instance type. You can specify between 1 and + * 20 instance types. If not provided, Amazon EC2 Auto Scaling will use the instance type specified in the + * launch template when it launches an instance.
*/ - LaunchTemplateSpecification?: LaunchTemplateSpecification; + Overrides?: LaunchTemplateOverrides[]; } export namespace LaunchTemplate { @@ -844,22 +825,21 @@ export namespace LaunchTemplate { * Guide. *You can create a mixed instances policy for a new Auto Scaling group, or you can create it for
* an existing group by updating the group to specify MixedInstancesPolicy
as
- * the top-level parameter instead of a launch configuration or launch template. For more
- * information, see CreateAutoScalingGroup and UpdateAutoScalingGroup.
The instances distribution to use.
- *If you leave this parameter unspecified, the value for each parameter in
- * InstancesDistribution
uses a default value.
Specifies the launch template to use and optionally the instance types (overrides) + * that are used to provision EC2 instances to fulfill On-Demand and Spot capacities. + * Required when creating a mixed instances policy.
*/ - InstancesDistribution?: InstancesDistribution; + LaunchTemplate?: LaunchTemplate; /** - *The launch template and instance types (overrides).
- *Required when creating a mixed instances policy.
+ *Specifies the instances distribution. If not provided, the value for each parameter in
+ * InstancesDistribution
uses a default value.
The tag key.
+ *The type of resource. The only supported value is
+ * auto-scaling-group
.
Determines whether the tag is added to new instances as they are launched in the - * group.
+ *The tag key.
*/ - PropagateAtLaunch?: boolean; + Key: string | undefined; /** *The tag value.
@@ -894,10 +874,10 @@ export interface Tag { Value?: string; /** - *The type of resource. The only supported value is
- * auto-scaling-group
.
Determines whether the tag is added to new instances as they are launched in the + * group.
*/ - ResourceType?: string; + PropagateAtLaunch?: boolean; } export namespace Tag { @@ -908,22 +888,63 @@ export namespace Tag { export interface CreateAutoScalingGroupType { /** - *Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling - * when scaling in.
- *For more information about preventing instances from terminating on scale in, see - * Instance Protection in the Amazon EC2 Auto Scaling User Guide.
+ *The name of the Auto Scaling group. This name must be unique per Region per account.
*/ - NewInstancesProtectedFromScaleIn?: boolean; + AutoScalingGroupName: string | undefined; /** - *The desired capacity is the initial capacity of the Auto Scaling group at the time of its - * creation and the capacity it attempts to maintain. It can scale beyond this capacity if - * you configure automatic scaling.
- *This number must be greater than or equal to the minimum size of the group and less - * than or equal to the maximum size of the group. If you do not specify a desired - * capacity, the default is the minimum size of the group.
+ *The name of the launch configuration to use to launch instances.
+ *Conditional: You must specify either a launch template (LaunchTemplate
or
+ * MixedInstancesPolicy
) or a launch configuration
+ * (LaunchConfigurationName
or InstanceId
).
Parameters used to specify the launch + * template and version to use to launch instances.
+ *Conditional: You must specify either a launch template (LaunchTemplate
or
+ * MixedInstancesPolicy
) or a launch configuration
+ * (LaunchConfigurationName
or InstanceId
).
The launch template that is specified must be configured for use with an Auto Scaling + * group. For more information, see Creating a launch + * template for an Auto Scaling group in the + * Amazon EC2 Auto Scaling User Guide.
+ *An embedded object that specifies a mixed instances policy. The required parameters + * must be specified. If optional parameters are unspecified, their default values are + * used.
+ *The policy includes parameters that not only define the distribution of On-Demand + * Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the + * Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the + * parameters that specify the instance configuration information—the launch template and + * instance types. The policy can also include a weight for each instance type. For more + * information, see Auto Scaling groups with multiple + * instance types and purchase options in the Amazon EC2 Auto Scaling User + * Guide.
+ *Conditional: You must specify either a launch template (LaunchTemplate
or
+ * MixedInstancesPolicy
) or a launch configuration
+ * (LaunchConfigurationName
or InstanceId
).
The ID of the instance used to base the launch configuration on. If specified, Amazon + * EC2 Auto Scaling uses the configuration values from the specified instance to create a + * new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Creating an Auto Scaling group using an EC2 instance in the + * Amazon EC2 Auto Scaling User Guide.
+ */ + InstanceId?: string; + + /** + *The minimum size of the group.
+ */ + MinSize: number | undefined; /** *The maximum size of the group.
@@ -937,69 +958,69 @@ export interface CreateAutoScalingGroupType { */ MaxSize: number | undefined; + /** + *The desired capacity is the initial capacity of the Auto Scaling group at the time of its + * creation and the capacity it attempts to maintain. It can scale beyond this capacity if + * you configure auto scaling. This number must be greater than or equal to the minimum + * size of the group and less than or equal to the maximum size of the group. If you do not + * specify a desired capacity, the default is the minimum size of the group.
+ */ + DesiredCapacity?: number; + /** *The amount of time, in seconds, after a scaling activity completes before another
- * scaling activity can start. The default value is 300
.
This setting applies when using simple scaling policies, but not when using other - * scaling policies or scheduled scaling. For more information, see Scaling Cooldowns - * for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
+ * scaling activity can start. The default value is300
. This setting applies
+ * when using simple scaling policies, but not when using other scaling policies or
+ * scheduled scaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling
+ * in the Amazon EC2 Auto Scaling User Guide.
*/
DefaultCooldown?: number;
/**
- * The service to use for the health checks. The valid values are EC2
and
- * ELB
. The default value is EC2
. If you configure an Auto Scaling
- * group to use ELB health checks, it considers the instance unhealthy if it fails either
- * the EC2 status checks or the load balancer health checks.
For more information, see Health Checks for Auto Scaling - * Instances in the Amazon EC2 Auto Scaling User Guide.
+ *A list of Availability Zones where instances in the Auto Scaling group can be created. This
+ * parameter is optional if you specify one or more subnets for
+ * VPCZoneIdentifier
.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required + * to launch instances into EC2-Classic.
*/ - HealthCheckType?: string; + AvailabilityZones?: string[]; /** - *One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 - * instances it launches.
- *Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the - * tags in a launch template but use caution. If the launch template specifies an instance - * tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value - * of that instance tag with the value specified by the Auto Scaling group.
- *For more information, see Tagging Auto Scaling Groups and - * Instances in the Amazon EC2 Auto Scaling User Guide.
+ *A list of Classic Load Balancers associated with this Auto Scaling group. For
+ * Application Load Balancers and Network Load Balancers, specify
+ * TargetGroupARNs
instead.
Parameters used to specify the launch template and version to use when an instance is - * launched.
- *For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API - * Reference.
- *You can alternatively associate a launch template to the Auto Scaling group by using the
- * MixedInstancesPolicy
parameter.
You must specify one of the following parameters in your request:
- * LaunchConfigurationName
, LaunchTemplate
,
- * InstanceId
, or MixedInstancesPolicy
.
The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group. + * Instances are registered as targets in a target group, and traffic is routed to the + * target group. For more information, see Elastic Load + * Balancing and Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
+ */ + TargetGroupARNs?: string[]; /** - *One or more lifecycle hooks.
+ *The service to use for the health checks. The valid values are EC2
+ * (default) and ELB
. If you configure an Auto Scaling group to use load balancer
+ * (ELB) health checks, it considers the instance unhealthy if it fails either the EC2
+ * status checks or the load balancer health checks. For more information, see Health checks
+ * for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide.
The ID of the instance used to create a launch configuration for the group. To get the - * instance ID, use the Amazon EC2 DescribeInstances API operation.
- *When you specify an ID of an instance, Amazon EC2 Auto Scaling creates a new launch configuration and - * associates it with the group. This launch configuration derives its attributes from the - * specified instance, except for the block device mapping.
- *You must specify one of the following parameters in your request:
- * LaunchConfigurationName
, LaunchTemplate
,
- * InstanceId
, or MixedInstancesPolicy
.
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status
+ * of an EC2 instance that has come into service. During this time, any health check
+ * failures for the instance are ignored. The default value is 0
. For more
+ * information, see Health
+ * check grace period in the Amazon EC2 Auto Scaling User Guide.
Conditional: Required if you are adding an ELB
health check.
The name of the placement group into which to launch your instances, if any. A + *
The name of an existing placement group into which to launch your instances, if any. A * placement group is a logical grouping of instances within a single Availability Zone. * You cannot specify multiple Availability Zones and a placement group. For more * information, see Placement Groups in the @@ -1008,133 +1029,75 @@ export interface CreateAutoScalingGroupType { PlacementGroup?: string; /** - *
A comma-separated list of subnet IDs for your virtual private cloud (VPC).
- *If you specify VPCZoneIdentifier
with AvailabilityZones
, the
- * subnets that you specify for this parameter must reside in those Availability
- * Zones.
A comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances
+ * in the Auto Scaling group can be created. If you specify VPCZoneIdentifier
with
+ * AvailabilityZones
, the subnets that you specify for this parameter must
+ * reside in those Availability Zones.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required * to launch instances into a VPC.
*/ VPCZoneIdentifier?: string; /** - *The Amazon Resource Names (ARN) of the target groups to associate with the Auto Scaling group. - * Instances are registered as targets in a target group, and traffic is routed to the - * target group.
- *For more information, see Using a Load Balancer - * with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
- */ - TargetGroupARNs?: string[]; - - /** - *The maximum amount of time, in seconds, that an instance can be in service. The - * default is null.
- *This parameter is optional, but if you specify a value for it, you must specify a - * value of at least 604,800 seconds (7 days). To clear a previously set value, specify a - * new value of 0.
- *For more information, see Replacing Auto Scaling - * Instances Based on Maximum Instance Lifetime in the - * Amazon EC2 Auto Scaling User Guide.
- *Valid Range: Minimum value of 0.
- */ - MaxInstanceLifetime?: number; - - /** - *An embedded object that specifies a mixed instances policy. The required parameters - * must be specified. If optional parameters are unspecified, their default values are - * used.
- *The policy includes parameters that not only define the distribution of On-Demand - * Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the - * Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity, but also the - * parameters that specify the instance configuration information—the launch template and - * instance types.
- * - *For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and - * Auto Scaling Groups with Multiple - * Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User - * Guide.
- *You must specify one of the following parameters in your request:
- * LaunchConfigurationName
, LaunchTemplate
,
- * InstanceId
, or MixedInstancesPolicy
.
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status
- * of an EC2 instance that has come into service. During this time, any health check
- * failures for the instance are ignored. The default value is 0
.
For more information, see Health - * Check Grace Period in the Amazon EC2 Auto Scaling User Guide.
- *Required if you are adding an ELB
health check.
The name of the launch configuration to use when an instance is launched. To get the - * launch configuration name, use the DescribeLaunchConfigurations API - * operation. New launch configurations can be created with the CreateLaunchConfiguration API.
- *You must specify one of the following parameters in your request:
- * LaunchConfigurationName
, LaunchTemplate
,
- * InstanceId
, or MixedInstancesPolicy
.
Indicates whether capacity rebalance is enabled. Otherwise, capacity rebalance is - * disabled.
- *You can enable capacity rebalancing for your Auto Scaling groups when using Spot Instances. - * When you turn on capacity rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance - * whenever Amazon EC2 predicts that a Spot Instance is at an elevated risk of interruption. - * After launching a new instance, it then terminates an old instance. For more - * information, see Amazon EC2 Auto Scaling capacity - * rebalancing in the Amazon EC2 Auto Scaling User Guide.
- */ - CapacityRebalance?: boolean; - - /** - *One or more termination policies used to select the instance to terminate. These - * policies are executed in the order that they are listed.
- *For more information, see Controlling Which - * Instances Auto Scaling Terminates During Scale In in the + *
A policy or a list of policies that are used to select the instance to terminate. + * These policies are executed in the order that you list them. For more information, see + * Controlling which Auto Scaling + * instances terminate during scale in in the * Amazon EC2 Auto Scaling User Guide.
*/ TerminationPolicies?: string[]; /** - *The name of the Auto Scaling group. This name must be unique per Region per account.
+ *Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling + * when scaling in. For more information about preventing instances from terminating on + * scale in, see Instance scale-in protection in the + * Amazon EC2 Auto Scaling User Guide.
*/ - AutoScalingGroupName: string | undefined; + NewInstancesProtectedFromScaleIn?: boolean; /** - *A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load
- * Balancers and Network Load Balancers, specify a list of target groups using the
- * TargetGroupARNs
property instead.
For more information, see Using a Load Balancer - * with an Auto Scaling Group in the Amazon EC2 Auto Scaling User Guide.
+ *Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is + * disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot + * Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of + * interruption. After launching a new instance, it then terminates an old instance. For + * more information, see Amazon EC2 Auto Scaling Capacity + * Rebalancing in the Amazon EC2 Auto Scaling User Guide.
*/ - LoadBalancerNames?: string[]; + CapacityRebalance?: boolean; /** - *One or more Availability Zones for the group. This parameter is optional if you
- * specify one or more subnets for VPCZoneIdentifier
.
Conditional: If your account supports EC2-Classic and VPC, this parameter is required - * to launch instances into EC2-Classic.
+ *One or more lifecycle hooks for the group, which specify actions to perform when + * Amazon EC2 Auto Scaling launches or terminates instances.
*/ - AvailabilityZones?: string[]; + LifecycleHookSpecificationList?: LifecycleHookSpecification[]; /** - *The minimum size of the group.
+ *One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 + * instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS + * volumes, specify the tags in a launch template but use caution. If the launch template + * specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling + * overrides the value of that instance tag with the value specified by the Auto Scaling group. For + * more information, see Tagging Auto Scaling groups and + * instances in the Amazon EC2 Auto Scaling User Guide.
*/ - MinSize: number | undefined; + Tags?: Tag[]; /** *The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to * call other AWS services on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role * named AWSServiceRoleForAutoScaling, which it creates if it does not exist. For more - * information, see Service-Linked - * Roles in the Amazon EC2 Auto Scaling User Guide.
+ * information, see Service-linked + * roles in the Amazon EC2 Auto Scaling User Guide. */ ServiceLinkedRoleARN?: string; + + /** + *The maximum amount of time, in seconds, that an instance can be in service. The + * default is null. If specified, the value must be either 0 or a number equal to or + * greater than 86,400 seconds (1 day). For more information, see Replacing Auto Scaling instances based on maximum instance lifetime in the + * Amazon EC2 Auto Scaling User Guide.
+ */ + MaxInstanceLifetime?: number; } export namespace CreateAutoScalingGroupType { @@ -1148,6 +1111,26 @@ export namespace CreateAutoScalingGroupType { * mapping. */ export interface Ebs { + /** + *The snapshot ID of the volume to use.
+ *You must specify either a VolumeSize
or a SnapshotId
.
The volume size, in Gibibytes (GiB).
+ *This can be a number from 1-1,024 for standard
, 4-16,384 for
+ * io1
, 1-16,384 for gp2
, and 500-16,384 for st1
+ * and sc1
. If you specify a snapshot, the volume size must be equal to or
+ * larger than the snapshot size.
Default: If you create a volume from a snapshot and you don't specify a volume size, + * the default is the snapshot size.
+ *You must specify either a VolumeSize
or a SnapshotId
. If you
+ * specify both SnapshotId
and VolumeSize
, the volume size must
+ * be equal or greater than the size of the snapshot.
The volume type, which can be standard
for Magnetic, io1
for
* Provisioned IOPS SSD, gp2
for General Purpose SSD, st1
for
@@ -1161,6 +1144,22 @@ export interface Ebs {
*/
VolumeType?: string;
+ /**
+ *
Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the
+ * default value is true
.
The number of I/O operations per second (IOPS) to provision for the volume. The + * maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, see Amazon EBS + * Volume Types in the Amazon EC2 User Guide for Linux Instances.
+ *Required when the volume type is io1
. (Not used with
+ * standard
, gp2
, st1
, or sc1
+ * volumes.)
Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be * attached to instances that support Amazon EBS encryption. For more information, see @@ -1182,46 +1181,10 @@ export interface Ebs { *
For more information, see Using Encryption with EBS-Backed * AMIs in the Amazon EC2 User Guide for Linux Instances * and Required - * CMK Key Policy for Use with Encrypted Volumes in the + * CMK key policy for use with encrypted volumes in the * Amazon EC2 Auto Scaling User Guide.
*/ Encrypted?: boolean; - - /** - *Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the
- * default value is true
.
The volume size, in Gibibytes (GiB).
- *This can be a number from 1-1,024 for standard
, 4-16,384 for
- * io1
, 1-16,384 for gp2
, and 500-16,384 for st1
- * and sc1
. If you specify a snapshot, the volume size must be equal to or
- * larger than the snapshot size.
Default: If you create a volume from a snapshot and you don't specify a volume size, - * the default is the snapshot size.
- *You must specify either a VolumeSize
or a SnapshotId
. If you
- * specify both SnapshotId
and VolumeSize
, the volume size must
- * be equal or greater than the size of the snapshot.
The snapshot ID of the volume to use.
- *You must specify either a VolumeSize
or a SnapshotId
.
The number of I/O operations per second (IOPS) to provision for the volume. The - * maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, see Amazon EBS - * Volume Types in the Amazon EC2 User Guide for Linux Instances.
- *Required when the volume type is io1
. (Not used with
- * standard
, gp2
, st1
, or sc1
- * volumes.)
Describes a block device mapping.
*/ export interface BlockDeviceMapping { + /** + *The name of the virtual device (for example, ephemeral0
).
You can specify either VirtualName
or Ebs
, but not
+ * both.
The device name exposed to the EC2 instance (for example, If you specify The name of the virtual device (for example, You can specify either /dev/sdh
or
* xvdh
). For more information, see Device Naming on Linux
@@ -1258,13 +1228,6 @@ export interface BlockDeviceMapping {
* NoDevice
, you cannot specify Ebs
.ephemeral0
).VirtualName
or Ebs
, but not
- * both.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the - * number, the further instance metadata requests can travel.
- *Default: 1
- *Possible values: Integers from 1 to 64
- */ - HttpPutResponseHopLimit?: number; - /** *The state of token usage for your instance metadata requests. If the parameter is not
* specified in the request, the default state is optional
.
The desired HTTP PUT response hop limit for instance metadata requests. The larger the + * number, the further instance metadata requests can travel.
+ *Default: 1
+ *Possible values: Integers from 1 to 64
+ */ + HttpPutResponseHopLimit?: number; + /** *This parameter enables or disables the HTTP metadata endpoint on your instances. If
* the parameter is not specified, the default state is enabled
.
The ID of the RAM disk to select.
- */ - RamdiskId?: string; - - /** - *The name of the key pair. For more information, see Amazon EC2 Key Pairs in the - * Amazon EC2 User Guide for Linux Instances.
- */ - KeyName?: string; - - /** - *The maximum hourly price to be paid for any Spot Instance launched to fulfill the - * request. Spot Instances are launched when the price you specify exceeds the current Spot - * price. For more information, see Launching Spot - * Instances in Your Auto Scaling Group in the - * Amazon EC2 Auto Scaling User Guide.
- *When you change your maximum price by creating a new launch configuration, running - * instances will continue to run as long as the maximum price for those running - * instances is higher than the current Spot price.
- *Specifies whether the launch configuration is optimized for EBS I/O
- * (true
) or not (false
). The optimization provides dedicated
- * throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O
- * performance. This optimization is not available with all instance types. Additional fees
- * are incurred when you enable EBS optimization for an instance type that is not
- * EBS-optimized by default. For more information, see Amazon EBS-Optimized
- * Instances in the Amazon EC2 User Guide for Linux
- * Instances.
The default value is false
.
The name of the launch configuration. This name must be unique per Region per + * account.
*/ - EbsOptimized?: boolean; + LaunchConfigurationName: string | undefined; /** *The ID of the Amazon Machine Image (AMI) that was assigned during registration. For @@ -1394,46 +1325,37 @@ export interface CreateLaunchConfigurationType { ImageId?: string; /** - *
Controls whether instances in this group are launched with detailed
- * (true
) or basic (false
) monitoring.
The default value is true
(enabled).
When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and - * your account is charged a fee. When you disable detailed monitoring, CloudWatch generates - * metrics every 5 minutes. For more information, see Configure - * Monitoring for Auto Scaling Instances in the - * Amazon EC2 Auto Scaling User Guide.
- *The name of the key pair. For more information, see Amazon EC2 Key Pairs in the + * Amazon EC2 User Guide for Linux Instances.
*/ - InstanceMonitoring?: InstanceMonitoring; + KeyName?: string; /** - *A block device mapping, which specifies the block devices for the instance. You can - * specify virtual devices and EBS volumes. For more information, see Block Device - * Mapping in the Amazon EC2 User Guide for Linux - * Instances.
+ *A list that contains the security groups to assign to the instances in the Auto Scaling + * group.
+ *[EC2-VPC] Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud + * User Guide.
+ *[EC2-Classic] Specify either the security group names or the security group IDs. For + * more information, see Amazon EC2 Security + * Groups in the Amazon EC2 User Guide for Linux + * Instances.
*/ - BlockDeviceMappings?: BlockDeviceMapping[]; + SecurityGroups?: string[]; /** - *The ID of the instance to use to create the launch configuration. The new launch - * configuration derives attributes from the instance, except for the block device - * mapping.
- *To create a launch configuration with a block device mapping or override any other - * instance attributes, specify them as part of the same request.
- *For more information, see Create a Launch - * Configuration Using an EC2 Instance in the - * Amazon EC2 Auto Scaling User Guide.
- *If you do not specify InstanceId
, you must specify both
- * ImageId
and InstanceType
.
The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more + * information, see ClassicLink in the + * Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic + * instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
+ *This parameter can only be used if you are launching EC2-Classic instances.
*/ - InstanceId?: string; + ClassicLinkVPCId?: string; /** *The IDs of one or more security groups for the specified ClassicLink-enabled VPC. For * more information, see ClassicLink in the * Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic - * Instances to a VPC in the Amazon EC2 Auto Scaling User Guide.
+ * instances to a VPC in the Amazon EC2 Auto Scaling User Guide. *If you specify the ClassicLinkVPCId
parameter, you must specify this
* parameter.
The Base64-encoded user data to make available to the launched EC2 instances. For more - * information, see Instance Metadata and User - * Data in the Amazon EC2 User Guide for Linux Instances.
+ * information, see Instance metadata and user + * data in the Amazon EC2 User Guide for Linux Instances. */ UserData?: string; + /** + *The ID of the instance to use to create the launch configuration. The new launch + * configuration derives attributes from the instance, except for the block device + * mapping.
+ *To create a launch configuration with a block device mapping or override any other + * instance attributes, specify them as part of the same request.
+ *For more information, see Creating a launch + * configuration using an EC2 instance in the + * Amazon EC2 Auto Scaling User Guide.
+ *If you do not specify InstanceId
, you must specify both
+ * ImageId
and InstanceType
.
Specifies the instance type of the EC2 instance.
*For information about available instance types, see Available
@@ -1458,71 +1394,76 @@ export interface CreateLaunchConfigurationType {
InstanceType?: string;
/**
- * The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more
- * information, see ClassicLink in the
- * Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic
- * Instances to a VPC in the Amazon EC2 Auto Scaling User Guide. This parameter can only be used if you are launching EC2-Classic instances. The tenancy of the instance. An instance with To launch dedicated instances into a shared tenancy VPC (a VPC with the instance
- * placement tenancy attribute set to If you specify For more information, see Instance Placement
- * Tenancy in the Amazon EC2 Auto Scaling User Guide. Valid Values: The ID of the kernel associated with the AMI. The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the
- * Amazon EC2 Auto Scaling User Guide. The ID of the RAM disk to select. The ID of the kernel associated with the AMI. A block device mapping, which specifies the block devices for the instance. You can
+ * specify virtual devices and EBS volumes. For more information, see Block Device
+ * Mapping in the Amazon EC2 User Guide for Linux
+ * Instances. A list that contains the security groups to assign to the instances in the Auto Scaling
- * group. [EC2-VPC] Specify the security group IDs. For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud
- * User Guide. [EC2-Classic] Specify either the security group names or the security group IDs. For
- * more information, see Amazon EC2 Security
- * Groups in the Amazon EC2 User Guide for Linux
- * Instances. Controls whether instances in this group are launched with detailed
+ * ( The default value is When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and
+ * your account is charged a fee. When you disable detailed monitoring, CloudWatch generates
+ * metrics every 5 minutes. For more information, see Configure
+ * Monitoring for Auto Scaling Instances in the
+ * Amazon EC2 Auto Scaling User Guide. The name of the launch configuration. This name must be unique per Region per
- * account. The maximum hourly price to be paid for any Spot Instance launched to fulfill the
+ * request. Spot Instances are launched when the price you specify exceeds the current Spot
+ * price. For more information, see Requesting Spot
+ * Instances in the Amazon EC2 Auto Scaling User Guide. When you change your maximum price by creating a new launch configuration, running
+ * instances will continue to run as long as the maximum price for those running
+ * instances is higher than the current Spot price. The name or the Amazon Resource Name (ARN) of the instance profile associated with the
* IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM Role for Applications That Run
- * on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide. For more information, see IAM role for applications that run
+ * on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide. Specifies whether the launch configuration is optimized for EBS I/O
+ * ( The default value is For Auto Scaling groups that are running in a virtual private cloud (VPC), specifies whether
* to assign a public IP address to the group's instances. If you specify
* If you specify this parameter, you must specify at least one subnet for
* The tenancy of the instance. An instance with To launch dedicated instances into a shared tenancy VPC (a VPC with the instance
+ * placement tenancy attribute set to If you specify For more information, see Configuring instance tenancy with Amazon EC2 Auto Scaling in the
+ * Amazon EC2 Auto Scaling User Guide. Valid Values: The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the
+ * Amazon EC2 Auto Scaling User Guide. The name of the action to delete. The name of the Auto Scaling group. The name of the Auto Scaling group. The name of the action to delete. The current number of groups for your AWS account. The maximum number of launch configurations allowed for your AWS account. The default
* is 200 launch configurations per AWS Region. The current number of groups for your AWS account. The current number of launch configurations for your AWS account. The token for the next set of items to return. (You received this token from a
- * previous call.) The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can
+ * optionally increase this limit using the If you omit this parameter, all Auto Scaling groups are described. The names of the Auto Scaling groups. Each name can be a maximum of 1600 characters. By
- * default, you can only specify up to 50 names. You can optionally increase this limit
- * using the If you omit this parameter, all Auto Scaling groups are described. The token for the next set of items to return. (You received this token from a
+ * previous call.) The maximum number of items to return with this call. The default value is
@@ -1899,28 +1860,27 @@ export enum LifecycleState {
* Describes an EC2 instance. The instance type of the EC2 instance. The ID of the instance. The number of capacity units contributed by the instance based on its instance
- * type. Valid Range: Minimum value of 1. Maximum value of 999. The instance type of the EC2 instance. The Availability Zone in which the instance is running. A description of the current lifecycle state. The The last reported health status of the instance. "Healthy" means that the instance is
* healthy and should remain in service. "Unhealthy" means that the instance is unhealthy
@@ -1929,10 +1889,9 @@ export interface Instance {
HealthStatus: string | undefined;
/**
- * A description of the current lifecycle state. The The launch configuration associated with the instance. The launch template for the instance. The launch configuration associated with the instance. The number of capacity units contributed by the instance based on its instance
+ * type. Valid Range: Minimum value of 1. Maximum value of 999. Describes an automatic scaling process that has been suspended. For more information, see Scaling Processes in the Amazon EC2 Auto Scaling User Guide. Describes an auto scaling process that has been suspended. For more information, see Scaling processes in the Amazon EC2 Auto Scaling User Guide. The reason that the process was suspended. The name of the suspended process. The name of the suspended process. The reason that the process was suspended. The tag value. The name of the group. The tag key. The type of resource. The only supported value is
+ * Determines whether the tag is added to new instances as they are launched in the
- * group. The tag key. The name of the group. The tag value. The type of resource. The only supported value is
- * Determines whether the tag is added to new instances as they are launched in the
+ * group. Describes an Auto Scaling group. One or more subnet IDs, if applicable, separated by commas. The metrics enabled for the group. The name of the Auto Scaling group. The Amazon Resource Name (ARN) of the Auto Scaling group. The duration of the default cooldown period, in seconds. The name of the associated launch configuration. The maximum size of the group. The launch template for the group. The name of the Auto Scaling group. The mixed instances policy for the group. The Amazon Resource Names (ARN) of the target groups for your load balancer. The minimum size of the group. One or more Availability Zones for the group. The maximum size of the group. The current state of the group when the DeleteAutoScalingGroup
- * operation is in progress. The desired size of the group. Indicates whether capacity rebalance is enabled. The duration of the default cooldown period, in seconds. The termination policies for the group. One or more Availability Zones for the group. The name of the placement group into which to launch your instances, if any. One or more load balancers associated with the group. The maximum amount of time, in seconds, that an instance can be in service. Valid Range: Minimum value of 0. The Amazon Resource Names (ARN) of the target groups for your load balancer. The service to use for the health checks. The valid values are Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling
- * when scaling in. The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status
+ * of an EC2 instance that has come into service. The desired size of the group. The EC2 instances associated with the group. The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to
- * call other AWS services on your behalf. The date and time the group was created. The minimum size of the group. The suspended processes associated with the group. The launch template for the group. The name of the placement group into which to launch your instances, if any. The EC2 instances associated with the group. One or more subnet IDs, if applicable, separated by commas. The date and time the group was created. The metrics enabled for the group. The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status
- * of an EC2 instance that has come into service. The current state of the group when the DeleteAutoScalingGroup
+ * operation is in progress. The mixed instances policy for the group. The tags for the group. One or more load balancers associated with the group. The termination policies for the group. The tags for the group. Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling
+ * when scaling in. The suspended processes associated with the group. The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to
+ * call other AWS services on your behalf. The name of the associated launch configuration. The maximum amount of time, in seconds, that an instance can be in service. Valid Range: Minimum value of 0. Indicates whether Capacity Rebalancing is enabled. The groups. A string that indicates that the response contains more items than can be returned in
* a single response. To receive additional items, specify this string for the
@@ -2179,11 +2145,6 @@ export interface AutoScalingGroupsType {
* null when there are no more items to return. The groups. The name of the Auto Scaling group for the instance. The ID of the instance. The number of capacity units contributed by the instance based on its instance
- * type. Valid Range: Minimum value of 1. Maximum value of 999. The instance type of the EC2 instance. The instance type of the EC2 instance. The name of the Auto Scaling group for the instance. The Availability Zone for the instance. The launch template for the instance. The lifecycle state for the instance. The last reported health status of this instance. "Healthy" means that the instance is
@@ -2249,14 +2208,15 @@ export interface AutoScalingInstanceDetails {
HealthStatus: string | undefined;
/**
- * The lifecycle state for the instance. The launch configuration used to launch the instance. This value is not available if
+ * you attached the instance to the Auto Scaling group. The ID of the instance. The launch template for the instance. Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling
@@ -2265,10 +2225,11 @@ export interface AutoScalingInstanceDetails {
ProtectedFromScaleIn: boolean | undefined;
/**
- * The launch configuration used to launch the instance. This value is not available if
- * you attached the instance to the Auto Scaling group. The number of capacity units contributed by the instance based on its instance
+ * type. Valid Range: Minimum value of 1. Maximum value of 999. The token for the next set of items to return. (You received this token from a
- * previous call.) The maximum number of items to return with this call. The default value is
* The token for the next set of items to return. (You received this token from a
+ * previous call.) Describes an instance refresh for an Auto Scaling group. The instance refresh ID. The name of the Auto Scaling group. The current status for the instance refresh operation: The number of instances remaining to update before the instance refresh is
- * complete. The instance refresh ID. Provides more details about the current status of the instance refresh. The percentage of the instance refresh that is complete. For each instance
- * replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the
- * instance's health status changes to healthy and the specified warm-up time passes, the
- * instance is considered updated and added to the percentage complete. The date and time at which the instance refresh began. The date and time at which the instance refresh ended. Provides more details about the current status of the instance refresh. The date and time at which the instance refresh began. The percentage of the instance refresh that is complete. For each instance
+ * replacement, Amazon EC2 Auto Scaling tracks the instance's health status and warm-up time. When the
+ * instance's health status changes to healthy and the specified warm-up time passes, the
+ * instance is considered updated and added to the percentage complete. The name of the Auto Scaling group. The number of instances remaining to update before the instance refresh is
+ * complete. The name of the Auto Scaling group. One or more instance refresh IDs. The name of the Auto Scaling group. The maximum number of items to return with this call. The default value is
* The token for the next set of items to return. (You received this token from a
- * previous call.) The launch configuration names. If you omit this parameter, all launch configurations
* are described. The token for the next set of items to return. (You received this token from a
+ * previous call.) The maximum number of items to return with this call. The default value is
* The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more information, see ClassicLink in the
- * Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic
- * Instances to a VPC in the Amazon EC2 Auto Scaling User Guide. The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the
- * Amazon EC2 Auto Scaling User Guide. A list that contains the security groups to assign to the instances in the Auto Scaling
- * group. For more information, see Security Groups for Your
- * VPC in the Amazon Virtual Private Cloud User
- * Guide. The Amazon Resource Name (ARN) of the launch configuration. The tenancy of the instance, either For more information, see Instance Placement
- * Tenancy in the Amazon EC2 Auto Scaling User Guide. The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more
+ * information, see Finding an AMI in the
+ * Amazon EC2 User Guide for Linux Instances. The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see Finding an AMI in the
+ * The name of the key pair. For more information, see Amazon EC2 Key Pairs in the
* Amazon EC2 User Guide for Linux Instances. The Base64-encoded user data to make available to the launched EC2 instances. For more information, see Instance Metadata and User
- * Data in the Amazon EC2 User Guide for Linux Instances. A list that contains the security groups to assign to the instances in the Auto Scaling group.
+ * For more information, see Security Groups for Your
+ * VPC in the Amazon Virtual Private Cloud User
+ * Guide. The name or the Amazon Resource Name (ARN) of the instance profile associated with the
- * IAM role for the instance. The instance profile contains the IAM role. For more information, see IAM Role for Applications That Run
- * on Amazon EC2 Instances in the Amazon EC2 Auto Scaling User Guide. The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. For more
+ * information, see ClassicLink in the
+ * Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic
+ * instances to a VPC in the Amazon EC2 Auto Scaling User Guide. The IDs of one or more security groups for the VPC specified in
* For more information, see ClassicLink in the
- * Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the
+ * Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic instances to a VPC in the
* Amazon EC2 Auto Scaling User Guide. For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP
- * address to the group's instances. For more information, see Launching Auto Scaling Instances in a
- * VPC in the Amazon EC2 Auto Scaling User Guide. The Base64-encoded user data to make available to the launched EC2 instances. For more
+ * information, see Instance metadata and user
+ * data in the Amazon EC2 User Guide for Linux Instances. A block device mapping, which specifies the block devices for the instance. For more information, see Block Device
- * Mapping in the Amazon EC2 User Guide for Linux
- * Instances. The instance type for the instances. For information about available instance types, see Available
+ * Instance Types in the Amazon EC2 User Guide for Linux
+ * Instances.
+ * The ID of the kernel associated with the AMI. The creation date and time for the launch configuration. The ID of the RAM disk associated with the AMI. Specifies whether the launch configuration is optimized for EBS I/O
- * ( For more information, see Amazon EBS-Optimized
- * Instances in the Amazon EC2 User Guide for Linux
+ * A block device mapping, which specifies the block devices for the instance. For more
+ * information, see Block Device
+ * Mapping in the Amazon EC2 User Guide for Linux
* Instances. The name of the key pair. For more information, see Amazon EC2 Key Pairs in the
- * Amazon EC2 User Guide for Linux Instances. Controls whether instances in this group are launched with detailed
@@ -2633,33 +2567,56 @@ export interface LaunchConfiguration {
InstanceMonitoring?: InstanceMonitoring;
/**
- * The instance type for the instances. For information about available instance types, see Available
- * Instance Types in the Amazon EC2 User Guide for Linux
- * Instances.
- * The maximum hourly price to be paid for any Spot Instance launched to fulfill the
+ * request. Spot Instances are launched when the price you specify exceeds the current Spot
+ * price. For more information, see Requesting Spot
+ * Instances in the Amazon EC2 Auto Scaling User Guide. The Amazon Resource Name (ARN) of the launch configuration. The name or the Amazon Resource Name (ARN) of the instance profile associated with the
+ * IAM role for the instance. The instance profile contains the IAM role. For more
+ * information, see IAM role for applications that run
+ * on Amazon EC2 instances in the Amazon EC2 Auto Scaling User Guide. The maximum hourly price to be paid for any Spot Instance launched to fulfill the
- * request. Spot Instances are launched when the price you specify exceeds the current Spot
- * price. For more information, see Launching Spot
- * Instances in Your Auto Scaling Group in the
+ * The creation date and time for the launch configuration. Specifies whether the launch configuration is optimized for EBS I/O
+ * ( For Auto Scaling groups that are running in a VPC, specifies whether to assign a public IP
+ * address to the group's instances. For more information, see Launching Auto Scaling instances in a
+ * VPC in the Amazon EC2 Auto Scaling User Guide. The tenancy of the instance, either For more information, see Configuring
+ * instance tenancy with Amazon EC2 Auto Scaling in the
* Amazon EC2 Auto Scaling User Guide. The ID of the RAM disk associated with the AMI. The metadata options for the instances. For more information, see Configuring the Instance Metadata Options in the
+ * Amazon EC2 Auto Scaling User Guide. The launch configurations. A string that indicates that the response contains more items than can be returned in
* a single response. To receive additional items, specify this string for the
@@ -2676,11 +2638,6 @@ export interface LaunchConfigurationsType {
* null when there are no more items to return. The launch configurations.dedicated
tenancy runs on
- * isolated, single-tenant hardware and can only be launched into a VPC.default
), you must set the value of this
- * parameter to dedicated
.PlacementTenancy
, you must specify at least one subnet for
- * VPCZoneIdentifier
when you create your group.default
| dedicated
- * true
) or basic (false
) monitoring.true
(enabled).true
) or not (false
). The optimization provides dedicated
+ * throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O
+ * performance. This optimization is not available with all instance types. Additional fees
+ * are incurred when you enable EBS optimization for an instance type that is not
+ * EBS-optimized by default. For more information, see Amazon EBS-Optimized
+ * Instances in the Amazon EC2 User Guide for Linux
+ * Instances.false
.true
, each instance in the Auto Scaling group receives a unique public IP address.
- * For more information, see Launching Auto Scaling Instances in a
+ * For more information, see Launching Auto Scaling instances in a
* VPC in the Amazon EC2 Auto Scaling User Guide.VPCZoneIdentifier
when you create your group.dedicated
tenancy runs on
+ * isolated, single-tenant hardware and can only be launched into a VPC.default
), you must set the value of this
+ * parameter to dedicated
.PlacementTenancy
, you must specify at least one subnet for
+ * VPCZoneIdentifier
when you create your group.default
| dedicated
+ * MaxRecords
parameter.MaxRecords
parameter.Quarantined
state is
+ * not used.Quarantined
state is
- * not used.auto-scaling-group
.auto-scaling-group
.EC2
and
@@ -2097,72 +2051,79 @@ export interface AutoScalingGroup {
HealthCheckType: string | undefined;
/**
- * 50
and the maximum value is 50
.
@@ -2387,23 +2358,14 @@ export interface InstanceRefresh {
Status?: InstanceRefreshStatus | string;
/**
- *
50
and the maximum value is 100
.50
and the maximum value is 100
.default
or dedicated
. An
- * instance with dedicated
tenancy runs on isolated, single-tenant hardware
- * and can only be launched into a VPC.ClassicLinkVPCId
.true
) or not (false
).true
) or not (false
). For more information, see Amazon
+ * EBS-Optimized Instances in the Amazon EC2 User Guide for Linux
+ * Instances.default
or dedicated
. An
+ * instance with dedicated
tenancy runs on isolated, single-tenant hardware
+ * and can only be launched into a VPC.
The name of the lifecycle hook.
+ */ + LifecycleHookName?: string; + + /** + *The name of the Auto Scaling group for the lifecycle hook.
+ */ + AutoScalingGroupName?: string; + /** *The state of the EC2 instance to which to attach the lifecycle hook. The following are * possible values:
@@ -2709,13 +2676,6 @@ export interface LifecycleHook { */ LifecycleTransition?: string; - /** - *The maximum time, in seconds, that can elapse before the lifecycle hook times out. If
- * the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the
- * DefaultResult
parameter.
The ARN of the target that Amazon EC2 Auto Scaling sends notifications to when an instance is in the * transition state for the lifecycle hook. The notification target can be either an SQS @@ -2723,12 +2683,6 @@ export interface LifecycleHook { */ NotificationTargetARN?: string; - /** - *
Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the - * notification target.
- */ - NotificationMetadata?: string; - /** *The ARN of the IAM role that allows the Auto Scaling group to publish to the specified * notification target.
@@ -2736,21 +2690,17 @@ export interface LifecycleHook { RoleARN?: string; /** - *The name of the Auto Scaling group for the lifecycle hook.
- */ - AutoScalingGroupName?: string; - - /** - *Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses
- * or if an unexpected failure occurs. The possible values are CONTINUE
and
- * ABANDON
.
Additional information that is included any time Amazon EC2 Auto Scaling sends a message to the + * notification target.
*/ - DefaultResult?: string; + NotificationMetadata?: string; /** - *The name of the lifecycle hook.
+ *The maximum time, in seconds, that can elapse before the lifecycle hook times out. If
+ * the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in the
+ * DefaultResult
parameter.
The maximum time, in seconds, that an instance can remain in a @@ -2759,6 +2709,13 @@ export interface LifecycleHook { * smaller.
*/ GlobalTimeout?: number; + + /** + *Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses
+ * or if an unexpected failure occurs. The possible values are CONTINUE
and
+ * ABANDON
.
The maximum number of items to return with this call. The default value is
- * 100
and the maximum value is 100
.
The name of the Auto Scaling group.
*/ @@ -2829,6 +2780,12 @@ export interface DescribeLoadBalancersRequest { * previous call.) */ NextToken?: string; + + /** + *The maximum number of items to return with this call. The default value is
+ * 100
and the maximum value is 100
.
Added
state.
*/
export interface LoadBalancerState {
+ /**
+ * The name of the load balancer.
+ */ + LoadBalancerName?: string; + /** *One of the following load balancer states:
*The name of the load balancer.
- */ - LoadBalancerName?: string; } export namespace LoadBalancerState { @@ -2919,15 +2876,15 @@ export namespace DescribeLoadBalancersResponse { export interface DescribeLoadBalancerTargetGroupsRequest { /** - *The token for the next set of items to return. (You received this token from a - * previous call.)
+ *The name of the Auto Scaling group.
*/ - NextToken?: string; + AutoScalingGroupName: string | undefined; /** - *The name of the Auto Scaling group.
+ *The token for the next set of items to return. (You received this token from a + * previous call.)
*/ - AutoScalingGroupName: string | undefined; + NextToken?: string; /** *The maximum number of items to return with this call. The default value is @@ -3119,14 +3076,14 @@ export namespace MetricCollectionType { export interface DescribeMetricCollectionTypesAnswer { /** - *
The granularities for the metrics.
+ *One or more metrics.
*/ - Granularities?: MetricGranularityType[]; + Metrics?: MetricCollectionType[]; /** - *One or more metrics.
+ *The granularities for the metrics.
*/ - Metrics?: MetricCollectionType[]; + Granularities?: MetricGranularityType[]; } export namespace DescribeMetricCollectionTypesAnswer { @@ -3139,6 +3096,17 @@ export namespace DescribeMetricCollectionTypesAnswer { *Describes a notification.
*/ export interface NotificationConfiguration { + /** + *The name of the Auto Scaling group.
+ */ + AutoScalingGroupName?: string; + + /** + *The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) + * topic.
+ */ + TopicARN?: string; + /** *One of the following event notification types:
*The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) - * topic.
- */ - TopicARN?: string; - - /** - *The name of the Auto Scaling group.
- */ - AutoScalingGroupName?: string; } export namespace NotificationConfiguration { @@ -3190,6 +3147,11 @@ export namespace NotificationConfiguration { } export interface DescribeNotificationConfigurationsAnswer { + /** + *The notification configurations.
+ */ + NotificationConfigurations: NotificationConfiguration[] | undefined; + /** *A string that indicates that the response contains more items than can be returned in * a single response. To receive additional items, specify this string for the @@ -3197,11 +3159,6 @@ export interface DescribeNotificationConfigurationsAnswer { * null when there are no more items to return.
*/ NextToken?: string; - - /** - *The notification configurations.
- */ - NotificationConfigurations: NotificationConfiguration[] | undefined; } export namespace DescribeNotificationConfigurationsAnswer { @@ -3212,15 +3169,15 @@ export namespace DescribeNotificationConfigurationsAnswer { export interface DescribeNotificationConfigurationsType { /** - *The token for the next set of items to return. (You received this token from a - * previous call.)
+ *The name of the Auto Scaling group.
*/ - NextToken?: string; + AutoScalingGroupNames?: string[]; /** - *The name of the Auto Scaling group.
+ *The token for the next set of items to return. (You received this token from a + * previous call.)
*/ - AutoScalingGroupNames?: string[]; + NextToken?: string; /** *The maximum number of items to return with this call. The default value is @@ -3242,16 +3199,12 @@ export interface DescribePoliciesType { AutoScalingGroupName?: string; /** - *
The maximum number of items to be returned with each call. The default value is
- * 50
and the maximum value is 100
.
The token for the next set of items to return. (You received this token from a - * previous call.)
+ *The names of one or more policies. If you omit this parameter, all policies are + * described. If a group name is provided, the results are limited to that group. This list + * is limited to 50 items. If you specify an unknown policy name, it is ignored with no + * error.
*/ - NextToken?: string; + PolicyNames?: string[]; /** *One or more policy types. The valid values are SimpleScaling
,
@@ -3260,12 +3213,16 @@ export interface DescribePoliciesType {
PolicyTypes?: string[];
/**
- *
The names of one or more policies. If you omit this parameter, all policies are - * described. If a group name is provided, the results are limited to that group. This list - * is limited to 50 items. If you specify an unknown policy name, it is ignored with no - * error.
+ *The token for the next set of items to return. (You received this token from a + * previous call.)
+ */ + NextToken?: string; + + /** + *The maximum number of items to be returned with each call. The default value is
+ * 50
and the maximum value is 100
.
For more information, see Step - * Adjustments in the Amazon EC2 Auto Scaling User Guide.
+ * adjustments in the Amazon EC2 Auto Scaling User Guide. */ export interface StepAdjustment { /** @@ -3321,13 +3278,6 @@ export interface StepAdjustment { */ MetricIntervalLowerBound?: number; - /** - *The amount by which to scale, based on the specified adjustment type. A positive value - * adds to the current capacity while a negative number removes from the current - * capacity.
- */ - ScalingAdjustment: number | undefined; - /** *The upper bound for the difference between the alarm threshold and the CloudWatch metric. If * the metric value is above the breach threshold, the upper bound is exclusive (the metric @@ -3337,6 +3287,13 @@ export interface StepAdjustment { *
The upper bound must be greater than the lower bound.
*/ MetricIntervalUpperBound?: number; + + /** + *The amount by which to scale, based on the specified adjustment type. A positive value + * adds to the current capacity while a negative number removes from the current + * capacity.
+ */ + ScalingAdjustment: number | undefined; } export namespace StepAdjustment { @@ -3397,6 +3354,16 @@ export enum MetricStatistic { * Concepts. */ export interface CustomizedMetricSpecification { + /** + *The name of the metric.
+ */ + MetricName: string | undefined; + + /** + *The namespace of the metric.
+ */ + Namespace: string | undefined; + /** *The dimensions of the metric.
*Conditional: If you published your metric with dimensions, you must specify the same @@ -3413,16 +3380,6 @@ export interface CustomizedMetricSpecification { *
The unit of the metric.
*/ Unit?: string; - - /** - *The namespace of the metric.
- */ - Namespace: string | undefined; - - /** - *The name of the metric.
- */ - MetricName: string | undefined; } export namespace CustomizedMetricSpecification { @@ -3514,12 +3471,10 @@ export interface TargetTrackingConfiguration { PredefinedMetricSpecification?: PredefinedMetricSpecification; /** - *Indicates whether scaling in by the target tracking scaling policy is disabled. If
- * scaling in is disabled, the target tracking scaling policy doesn't remove instances from
- * the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from
- * the Auto Scaling group. The default is false
.
A customized metric. You must specify either a predefined metric or a customized + * metric.
*/ - DisableScaleIn?: boolean; + CustomizedMetricSpecification?: CustomizedMetricSpecification; /** *The target value for the metric.
@@ -3527,10 +3482,12 @@ export interface TargetTrackingConfiguration { TargetValue: number | undefined; /** - *A customized metric. You must specify either a predefined metric or a customized - * metric.
+ *Indicates whether scaling in by the target tracking scaling policy is disabled. If
+ * scaling in is disabled, the target tracking scaling policy doesn't remove instances from
+ * the Auto Scaling group. Otherwise, the target tracking scaling policy can remove instances from
+ * the Auto Scaling group. The default is false
.
The CloudWatch alarms related to the policy.
+ *The name of the Auto Scaling group.
*/ - Alarms?: Alarm[]; + AutoScalingGroupName?: string; /** - *The estimated time, in seconds, until a newly launched instance can contribute to the - * CloudWatch metrics.
+ *The name of the scaling policy.
*/ - EstimatedInstanceWarmup?: number; + PolicyName?: string; + + /** + *The Amazon Resource Name (ARN) of the policy.
+ */ + PolicyARN?: string; + + /** + *One of the following policy types:
+ *
+ * TargetTrackingScaling
+ *
+ * StepScaling
+ *
+ * SimpleScaling
(default)
For more information, see Target tracking + * scaling policies and Step and simple scaling + * policies in the Amazon EC2 Auto Scaling User Guide.
+ */ + PolicyType?: string; /** *Specifies how the scaling adjustment is interpreted (for example, an absolute number @@ -3561,25 +3546,12 @@ export interface ScalingPolicy { */ AdjustmentType?: string; - /** - *
The amount by which to scale, based on the specified adjustment type. A positive value - * adds to the current capacity while a negative number removes from the current - * capacity.
- */ - ScalingAdjustment?: number; - /** *Available for backward compatibility. Use MinAdjustmentMagnitude
* instead.
Indicates whether the policy is enabled (true
) or disabled
- * (false
).
The minimum value to scale by when the adjustment type is
* PercentChangeInCapacity
.
The name of the scaling policy.
- */ - PolicyName?: string; - - /** - *The name of the Auto Scaling group.
+ *The amount by which to scale, based on the specified adjustment type. A positive value + * adds to the current capacity while a negative number removes from the current + * capacity.
*/ - AutoScalingGroupName?: string; + ScalingAdjustment?: number; /** - *The Amazon Resource Name (ARN) of the policy.
+ *The duration of the policy's cooldown period, in seconds.
*/ - PolicyARN?: string; + Cooldown?: number; /** - *A target tracking scaling policy.
+ *A set of adjustments that enable you to scale based on the size of the alarm + * breach.
*/ - TargetTrackingConfiguration?: TargetTrackingConfiguration; + StepAdjustments?: StepAdjustment[]; /** *The aggregation type for the CloudWatch metrics. The valid values are Minimum
,
@@ -3613,39 +3583,26 @@ export interface ScalingPolicy {
MetricAggregationType?: string;
/**
- *
One of the following policy types:
- *
- * TargetTrackingScaling
- *
- * StepScaling
- *
- * SimpleScaling
(default)
For more information, see Target Tracking - * Scaling Policies and Step and Simple Scaling - * Policies in the Amazon EC2 Auto Scaling User Guide.
+ *The estimated time, in seconds, until a newly launched instance can contribute to the + * CloudWatch metrics.
*/ - PolicyType?: string; + EstimatedInstanceWarmup?: number; /** - *A set of adjustments that enable you to scale based on the size of the alarm - * breach.
+ *The CloudWatch alarms related to the policy.
*/ - StepAdjustments?: StepAdjustment[]; + Alarms?: Alarm[]; /** - *The duration of the policy's cooldown period, in seconds.
+ *A target tracking scaling policy.
*/ - Cooldown?: number; + TargetTrackingConfiguration?: TargetTrackingConfiguration; + + /** + *Indicates whether the policy is enabled (true
) or disabled
+ * (false
).
The token for the next set of items to return. (You received this token from a - * previous call.)
- */ - NextToken?: string; - /** *The activity IDs of the desired scaling activities. You can specify up to 50 IDs. If
* you omit this parameter, all activities for the past six weeks are described. If unknown
@@ -3700,6 +3651,12 @@ export interface DescribeScalingActivitiesType {
* 100
and the maximum value is 100
.
The token for the next set of items to return. (You received this token from a + * previous call.)
+ */ + NextToken?: string; } export namespace DescribeScalingActivitiesType { @@ -3710,7 +3667,7 @@ export namespace DescribeScalingActivitiesType { /** *Describes a process type.
- *For more information, see Scaling Processes in the Amazon EC2 Auto Scaling User Guide.
+ *For more information, see Scaling processes in the Amazon EC2 Auto Scaling User Guide.
*/ export interface ProcessType { /** @@ -3786,12 +3743,6 @@ export namespace ProcessesType { } export interface DescribeScheduledActionsType { - /** - *The token for the next set of items to return. (You received this token from a - * previous call.)
- */ - NextToken?: string; - /** *The name of the Auto Scaling group.
*/ @@ -3805,10 +3756,10 @@ export interface DescribeScheduledActionsType { ScheduledActionNames?: string[]; /** - *The maximum number of items to return with this call. The default value is
- * 50
and the maximum value is 100
.
The earliest scheduled start time to return. If scheduled action names are provided, + * this parameter is ignored.
*/ - MaxRecords?: number; + StartTime?: Date; /** *The latest scheduled start time to return. If scheduled action names are provided, @@ -3817,10 +3768,16 @@ export interface DescribeScheduledActionsType { EndTime?: Date; /** - *
The earliest scheduled start time to return. If scheduled action names are provided, - * this parameter is ignored.
+ *The token for the next set of items to return. (You received this token from a + * previous call.)
*/ - StartTime?: Date; + NextToken?: string; + + /** + *The maximum number of items to return with this call. The default value is
+ * 50
and the maximum value is 100
.
The name of the Auto Scaling group.
+ */ + AutoScalingGroupName?: string; + /** *The name of the scheduled action.
*/ @@ -3845,28 +3807,9 @@ export interface ScheduledUpdateGroupAction { ScheduledActionARN?: string; /** - *The maximum size of the Auto Scaling group.
- */ - MaxSize?: number; - - /** - *The name of the Auto Scaling group.
- */ - AutoScalingGroupName?: string; - - /** - *The recurring schedule for the action, in Unix cron syntax format.
- *When StartTime
and EndTime
are specified with
- * Recurrence
, they form the boundaries of when the recurring action
- * starts and stops.
The desired capacity is the initial capacity of the Auto Scaling group after the scheduled - * action runs and the capacity it attempts to maintain.
+ *This parameter is no longer used.
*/ - DesiredCapacity?: number; + Time?: Date; /** *The date and time in UTC for this action to start. For example, @@ -3883,14 +3826,28 @@ export interface ScheduledUpdateGroupAction { EndTime?: Date; /** - *
This parameter is no longer used.
+ *The recurring schedule for the action, in Unix cron syntax format.
+ *When StartTime
and EndTime
are specified with
+ * Recurrence
, they form the boundaries of when the recurring action
+ * starts and stops.
The minimum size of the Auto Scaling group.
*/ MinSize?: number; + + /** + *The maximum size of the Auto Scaling group.
+ */ + MaxSize?: number; + + /** + *The desired capacity is the initial capacity of the Auto Scaling group after the scheduled + * action runs and the capacity it attempts to maintain.
+ */ + DesiredCapacity?: number; } export namespace ScheduledUpdateGroupAction { @@ -3900,6 +3857,11 @@ export namespace ScheduledUpdateGroupAction { } export interface ScheduledActionsType { + /** + *The scheduled actions.
+ */ + ScheduledUpdateGroupActions?: ScheduledUpdateGroupAction[]; + /** *A string that indicates that the response contains more items than can be returned in * a single response. To receive additional items, specify this string for the @@ -3907,11 +3869,6 @@ export interface ScheduledActionsType { * null when there are no more items to return.
*/ NextToken?: string; - - /** - *The scheduled actions.
- */ - ScheduledUpdateGroupActions?: ScheduledUpdateGroupAction[]; } export namespace ScheduledActionsType { @@ -3923,20 +3880,20 @@ export namespace ScheduledActionsType { /** *Describes a filter that is used to return a more specific list of results when * describing tags.
- *For more information, see Tagging Auto Scaling Groups and - * Instances in the Amazon EC2 Auto Scaling User Guide.
+ *For more information, see Tagging Auto Scaling groups and + * instances in the Amazon EC2 Auto Scaling User Guide.
*/ export interface Filter { - /** - *One or more filter values. Filter values are case-sensitive.
- */ - Values?: string[]; - /** *The name of the filter. The valid values are: auto-scaling-group
,
* key
, value
, and propagate-at-launch
.
One or more filter values. Filter values are case-sensitive.
+ */ + Values?: string[]; } export namespace Filter { @@ -3946,18 +3903,18 @@ export namespace Filter { } export interface DescribeTagsType { - /** - *The token for the next set of items to return. (You received this token from a - * previous call.)
- */ - NextToken?: string; - /** *One or more filters to scope the tags to return. The maximum number of filters per
* filter type (for example, auto-scaling-group
) is 1000.
The token for the next set of items to return. (You received this token from a + * previous call.)
+ */ + NextToken?: string; + /** *The maximum number of items to return with this call. The default value is
* 50
and the maximum value is 100
.
One or more tags.
+ */ + Tags?: TagDescription[]; + /** *A string that indicates that the response contains more items than can be returned in * a single response. To receive additional items, specify this string for the @@ -3979,11 +3941,6 @@ export interface TagsType { * null when there are no more items to return.
*/ NextToken?: string; - - /** - *One or more tags.
- */ - Tags?: TagDescription[]; } export namespace TagsType { @@ -4023,10 +3980,9 @@ export namespace DetachInstancesAnswer { export interface DetachInstancesQuery { /** - *Indicates whether the Auto Scaling group decrements the desired capacity value by the number - * of instances detached.
+ *The IDs of the instances. You can specify up to 20 instances.
*/ - ShouldDecrementDesiredCapacity: boolean | undefined; + InstanceIds?: string[]; /** *The name of the Auto Scaling group.
@@ -4034,9 +3990,10 @@ export interface DetachInstancesQuery { AutoScalingGroupName: string | undefined; /** - *The IDs of the instances. You can specify up to 20 instances.
+ *Indicates whether the Auto Scaling group decrements the desired capacity value by the number + * of instances detached.
*/ - InstanceIds?: string[]; + ShouldDecrementDesiredCapacity: boolean | undefined; } export namespace DetachInstancesQuery { @@ -4081,15 +4038,15 @@ export namespace DetachLoadBalancerTargetGroupsResultType { export interface DetachLoadBalancerTargetGroupsType { /** - *The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target - * groups.
+ *The name of the Auto Scaling group.
*/ - TargetGroupARNs: string[] | undefined; + AutoScalingGroupName: string | undefined; /** - *The name of the Auto Scaling group.
+ *The Amazon Resource Names (ARN) of the target groups. You can specify up to 10 target + * groups.
*/ - AutoScalingGroupName: string | undefined; + TargetGroupARNs: string[] | undefined; } export namespace DetachLoadBalancerTargetGroupsType { @@ -4099,6 +4056,11 @@ export namespace DetachLoadBalancerTargetGroupsType { } export interface DisableMetricsCollectionQuery { + /** + *The name of the Auto Scaling group.
+ */ + AutoScalingGroupName: string | undefined; + /** *Specifies one or more of the following metrics:
*If you omit this parameter, all metrics are disabled.
*/ Metrics?: string[]; - - /** - *The name of the Auto Scaling group.
- */ - AutoScalingGroupName: string | undefined; } export namespace DisableMetricsCollectionQuery { @@ -4185,6 +4142,11 @@ export namespace DisableMetricsCollectionQuery { } export interface EnableMetricsCollectionQuery { + /** + *The name of the Auto Scaling group.
+ */ + AutoScalingGroupName: string | undefined; + /** *Specifies which group-level metrics to start collecting. You can specify one or more * of the following metrics:
@@ -4262,11 +4224,6 @@ export interface EnableMetricsCollectionQuery { */ Metrics?: string[]; - /** - *The name of the Auto Scaling group.
- */ - AutoScalingGroupName: string | undefined; - /** *The granularity to associate with the metrics to collect. The only valid value is
* 1Minute
.
Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing - * the policy.
- *Valid only if the policy type is SimpleScaling
. For more information, see
- * Scaling
- * Cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
The name of the Auto Scaling group.
*/ @@ -4337,6 +4285,15 @@ export interface ExecutePolicyType { */ PolicyName: string | undefined; + /** + *Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing + * the policy.
+ *Valid only if the policy type is SimpleScaling
. For more information, see
+ * Scaling
+ * cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
The metric value to compare to BreachThreshold
. This enables you to
* execute a policy of type StepScaling
and determine which step adjustment to
@@ -4379,14 +4336,14 @@ export namespace ExitStandbyAnswer {
export interface ExitStandbyQuery {
/**
- *
The name of the Auto Scaling group.
+ *The IDs of the instances. You can specify up to 20 instances.
*/ - AutoScalingGroupName: string | undefined; + InstanceIds?: string[]; /** - *The IDs of the instances. You can specify up to 20 instances.
+ *The name of the Auto Scaling group.
*/ - InstanceIds?: string[]; + AutoScalingGroupName: string | undefined; } export namespace ExitStandbyQuery { @@ -4404,6 +4361,16 @@ export namespace PutLifecycleHookAnswer { } export interface PutLifecycleHookType { + /** + *The name of the lifecycle hook.
+ */ + LifecycleHookName: string | undefined; + + /** + *The name of the Auto Scaling group.
+ */ + AutoScalingGroupName: string | undefined; + /** *The instance state to which you want to attach the lifecycle hook. The valid values * are:
@@ -4419,27 +4386,6 @@ export interface PutLifecycleHookType { */ LifecycleTransition?: string; - /** - *The maximum time, in seconds, that can elapse before the lifecycle hook times out. The
- * range is from 30
to 7200
seconds. The default value is
- * 3600
seconds (1 hour).
If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in
- * the DefaultResult
parameter. You can prevent the lifecycle hook from timing
- * out by calling the RecordLifecycleActionHeartbeat API.
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to - * the notification target.
- */ - NotificationMetadata?: string; - - /** - *The name of the Auto Scaling group.
- */ - AutoScalingGroupName: string | undefined; - /** *The ARN of the IAM role that allows the Auto Scaling group to publish to the specified * notification target, for example, an Amazon SNS topic or an Amazon SQS queue.
@@ -4447,11 +4393,6 @@ export interface PutLifecycleHookType { */ RoleARN?: string; - /** - *The name of the lifecycle hook.
- */ - LifecycleHookName: string | undefined; - /** *The ARN of the notification target that Amazon EC2 Auto Scaling uses to notify you when an instance * is in the transition state for the lifecycle hook. This target can be either an SQS @@ -4466,6 +4407,22 @@ export interface PutLifecycleHookType { */ NotificationTargetARN?: string; + /** + *
Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to + * the notification target.
+ */ + NotificationMetadata?: string; + + /** + *The maximum time, in seconds, that can elapse before the lifecycle hook times out. The
+ * range is from 30
to 7200
seconds. The default value is
+ * 3600
seconds (1 hour).
If the lifecycle hook times out, Amazon EC2 Auto Scaling performs the action that you specified in
+ * the DefaultResult
parameter. You can prevent the lifecycle hook from timing
+ * out by calling the RecordLifecycleActionHeartbeat API.
Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses
* or if an unexpected failure occurs. This parameter can be either CONTINUE
@@ -4481,6 +4438,11 @@ export namespace PutLifecycleHookType {
}
export interface PutNotificationConfigurationType {
+ /**
+ *
The name of the Auto Scaling group.
+ */ + AutoScalingGroupName: string | undefined; + /** *The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (Amazon SNS) * topic.
@@ -4492,11 +4454,6 @@ export interface PutNotificationConfigurationType { * types supported by Amazon EC2 Auto Scaling, call the DescribeAutoScalingNotificationTypes API. */ NotificationTypes: string[] | undefined; - - /** - *The name of the Auto Scaling group.
- */ - AutoScalingGroupName: string | undefined; } export namespace PutNotificationConfigurationType { @@ -4528,86 +4485,51 @@ export namespace PolicyARNType { export interface PutScalingPolicyType { /** - *The amount by which to scale, based on the specified adjustment type. A positive value - * adds to the current capacity while a negative number removes from the current capacity. - * For exact capacity, you must specify a positive value.
- *Required if the policy type is SimpleScaling
. (Not used with any other
- * policy type.)
The name of the Auto Scaling group.
*/ - ScalingAdjustment?: number; + AutoScalingGroupName: string | undefined; /** - *A target tracking scaling policy. Includes support for predefined or customized - * metrics.
- *The following predefined metrics are available:
+ *The name of the policy.
+ */ + PolicyName: string | undefined; + + /** + *One of the following policy types:
*
- * ASGAverageCPUUtilization
- *
- * ASGAverageNetworkIn
+ * TargetTrackingScaling
*
- * ASGAverageNetworkOut
+ * StepScaling
*
- * ALBRequestCountPerTarget
- *
SimpleScaling
(default)
* If you specify ALBRequestCountPerTarget
for the metric, you must specify
- * the ResourceLabel
parameter with the
- * PredefinedMetricSpecification
.
For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API - * Reference.
- *Required if the policy type is TargetTrackingScaling
.
Specifies how the scaling adjustment is interpreted (for example, an absolute number
* or a percentage). The valid values are ChangeInCapacity
,
* ExactCapacity
, and PercentChangeInCapacity
.
Required if the policy type is StepScaling
or SimpleScaling
.
- * For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User Guide.
The estimated time, in seconds, until a newly launched instance can contribute to the - * CloudWatch metrics. If not provided, the default is to use the value from the default cooldown - * period for the Auto Scaling group.
- *Valid only if the policy type is TargetTrackingScaling
or
- * StepScaling
.
Indicates whether the scaling policy is enabled or disabled. The default is enabled. - * For more information, see Disabling a - * Scaling Policy for an Auto Scaling Group in the - * Amazon EC2 Auto Scaling User Guide.
- */ - Enabled?: boolean; - /** *Available for backward compatibility. Use MinAdjustmentMagnitude
* instead.
The name of the policy.
- */ - PolicyName: string | undefined; - /** *The minimum value to scale by when the adjustment type is
* PercentChangeInCapacity
. For example, suppose that you create a step
@@ -4617,7 +4539,7 @@ export interface PutScalingPolicyType {
* MinAdjustmentMagnitude
of 2, Amazon EC2 Auto Scaling scales out the group by 2
* instances.
Valid only if the policy type is StepScaling
or
- * SimpleScaling
. For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User
+ * SimpleScaling
. For more information, see Scaling adjustment types in the Amazon EC2 Auto Scaling User
* Guide.
Some Auto Scaling groups use instance weights. In this case, set the @@ -4628,9 +4550,31 @@ export interface PutScalingPolicyType { MinAdjustmentMagnitude?: number; /** - *
The name of the Auto Scaling group.
+ *The amount by which to scale, based on the specified adjustment type. A positive value + * adds to the current capacity while a negative number removes from the current capacity. + * For exact capacity, you must specify a positive value.
+ *Required if the policy type is SimpleScaling
. (Not used with any other
+ * policy type.)
The duration of the policy's cooldown period, in seconds. When a cooldown period is + * specified here, it overrides the default cooldown period defined for the Auto Scaling + * group.
+ *Valid only if the policy type is SimpleScaling
. For more information, see
+ * Scaling
+ * cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
The aggregation type for the CloudWatch metrics. The valid values are Minimum
,
+ * Maximum
, and Average
. If the aggregation type is null, the
+ * value is treated as Average
.
Valid only if the policy type is StepScaling
.
A set of adjustments that enable you to scale based on the size of the alarm @@ -4641,43 +4585,56 @@ export interface PutScalingPolicyType { StepAdjustments?: StepAdjustment[]; /** - *
One of the following policy types:
+ *The estimated time, in seconds, until a newly launched instance can contribute to the + * CloudWatch metrics. If not provided, the default is to use the value from the default cooldown + * period for the Auto Scaling group.
+ *Valid only if the policy type is TargetTrackingScaling
or
+ * StepScaling
.
A target tracking scaling policy. Includes support for predefined or customized + * metrics.
+ *The following predefined metrics are available:
*
- * TargetTrackingScaling
+ * ASGAverageCPUUtilization
*
- * StepScaling
+ * ASGAverageNetworkIn
+ *
+ * ASGAverageNetworkOut
*
- * SimpleScaling
(default)
ALBRequestCountPerTarget
+ *
* If you specify ALBRequestCountPerTarget
for the metric, you must specify
+ * the ResourceLabel
parameter with the
+ * PredefinedMetricSpecification
.
For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API + * Reference.
+ *Required if the policy type is TargetTrackingScaling
.
The duration of the policy's cooldown period, in seconds. When a cooldown period is - * specified here, it overrides the default cooldown period defined for the Auto Scaling - * group.
- *Valid only if the policy type is SimpleScaling
. For more information, see
- * Scaling
- * Cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
The aggregation type for the CloudWatch metrics. The valid values are Minimum
,
- * Maximum
, and Average
. If the aggregation type is null, the
- * value is treated as Average
.
Valid only if the policy type is StepScaling
.
Indicates whether the scaling policy is enabled or disabled. The default is enabled. + * For more information, see Disabling a + * scaling policy for an Auto Scaling group in the + * Amazon EC2 Auto Scaling User Guide.
*/ - MetricAggregationType?: string; + Enabled?: boolean; } export namespace PutScalingPolicyType { @@ -4688,14 +4645,19 @@ export namespace PutScalingPolicyType { export interface PutScheduledUpdateGroupActionType { /** - *This parameter is no longer used.
+ *The name of the Auto Scaling group.
*/ - Time?: Date; + AutoScalingGroupName: string | undefined; /** - *The minimum size of the Auto Scaling group.
+ *The name of this scaling action.
*/ - MinSize?: number; + ScheduledActionName: string | undefined; + + /** + *This parameter is no longer used.
+ */ + Time?: Date; /** *The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT @@ -4708,11 +4670,6 @@ export interface PutScheduledUpdateGroupActionType { */ StartTime?: Date; - /** - *
The name of this scaling action.
- */ - ScheduledActionName: string | undefined; - /** *The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the * action after this time.
@@ -4720,9 +4677,20 @@ export interface PutScheduledUpdateGroupActionType { EndTime?: Date; /** - *The name of the Auto Scaling group.
+ *The recurring schedule for this action, in Unix cron syntax format. This format
+ * consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]
+ * [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1
+ * 1,6,12 *"
). For more information about this format, see Crontab.
When StartTime
and EndTime
are specified with
+ * Recurrence
, they form the boundaries of when the recurring action
+ * starts and stops.
The minimum size of the Auto Scaling group.
+ */ + MinSize?: number; /** *The maximum size of the Auto Scaling group.
@@ -4735,17 +4703,6 @@ export interface PutScheduledUpdateGroupActionType { * if you add more scaling conditions. */ DesiredCapacity?: number; - - /** - *The recurring schedule for this action, in Unix cron syntax format. This format
- * consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month]
- * [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, "30 0 1
- * 1,6,12 *"
). For more information about this format, see Crontab.
When StartTime
and EndTime
are specified with
- * Recurrence
, they form the boundaries of when the recurring action
- * starts and stops.
The name of the Auto Scaling group.
+ */ + AutoScalingGroupName: string | undefined; + /** *A token that uniquely identifies a specific lifecycle action associated with an * instance. Amazon EC2 Auto Scaling sends this token to the notification target that you specified when @@ -4779,11 +4741,6 @@ export interface RecordLifecycleActionHeartbeatType { *
The ID of the instance.
*/ InstanceId?: string; - - /** - *The name of the Auto Scaling group.
- */ - AutoScalingGroupName: string | undefined; } export namespace RecordLifecycleActionHeartbeatType { @@ -4793,6 +4750,11 @@ export namespace RecordLifecycleActionHeartbeatType { } export interface ScalingProcessQuery { + /** + *The name of the Auto Scaling group.
+ */ + AutoScalingGroupName: string | undefined; + /** *One or more of the following processes:
*If you omit this parameter, all processes are specified.
*/ ScalingProcesses?: string[]; - - /** - *The name of the Auto Scaling group.
- */ - AutoScalingGroupName: string | undefined; } export namespace ScalingProcessQuery { @@ -4859,6 +4816,11 @@ export namespace ScalingProcessQuery { } export interface SetDesiredCapacityType { + /** + *The name of the Auto Scaling group.
+ */ + AutoScalingGroupName: string | undefined; + /** *The desired capacity is the initial capacity of the Auto Scaling group after this operation * completes and the capacity it attempts to maintain.
@@ -4871,11 +4833,6 @@ export interface SetDesiredCapacityType { * not honor the cooldown period during manual scaling activities. */ HonorCooldown?: boolean; - - /** - *The name of the Auto Scaling group.
- */ - AutoScalingGroupName: string | undefined; } export namespace SetDesiredCapacityType { @@ -4885,6 +4842,11 @@ export namespace SetDesiredCapacityType { } export interface SetInstanceHealthQuery { + /** + *The ID of the instance.
+ */ + InstanceId: string | undefined; + /** *The health status of the instance. Set to Healthy
to have the instance
* remain in service. Set to Unhealthy
to have the instance be out of service.
@@ -4892,11 +4854,6 @@ export interface SetInstanceHealthQuery {
*/
HealthStatus: string | undefined;
- /**
- *
The ID of the instance.
- */ - InstanceId: string | undefined; - /** *If the Auto Scaling group of the specified instance has a HealthCheckGracePeriod
* specified for the group, by default, this call respects the grace period. Set this to
@@ -4926,20 +4883,20 @@ export namespace SetInstanceProtectionAnswer {
export interface SetInstanceProtectionQuery {
/**
- *
One or more instance IDs.
+ *One or more instance IDs. You can specify up to 50 instances.
*/ InstanceIds: string[] | undefined; /** - *Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling - * in.
+ *The name of the Auto Scaling group.
*/ - ProtectedFromScaleIn: boolean | undefined; + AutoScalingGroupName: string | undefined; /** - *The name of the Auto Scaling group.
+ *Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling + * in.
*/ - AutoScalingGroupName: string | undefined; + ProtectedFromScaleIn: boolean | undefined; } export namespace SetInstanceProtectionQuery { @@ -4981,14 +4938,6 @@ export namespace StartInstanceRefreshAnswer { *Describes information used to start an instance refresh.
*/ export interface RefreshPreferences { - /** - *The number of seconds until a newly launched instance is configured and ready to use. - * During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The - * default is to use the value for the health check grace period defined for the - * group.
- */ - InstanceWarmup?: number; - /** *The amount of capacity in the Auto Scaling group that must remain healthy during an instance * refresh to allow the operation to continue, as a percentage of the desired capacity of @@ -4996,6 +4945,14 @@ export interface RefreshPreferences { *
*/ MinHealthyPercentage?: number; + + /** + *The number of seconds until a newly launched instance is configured and ready to use. + * During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. The + * default is to use the value for the health check grace period defined for the + * group.
+ */ + InstanceWarmup?: number; } export namespace RefreshPreferences { @@ -5009,6 +4966,11 @@ export enum RefreshStrategy { } export interface StartInstanceRefreshType { + /** + *The name of the Auto Scaling group.
+ */ + AutoScalingGroupName: string | undefined; + /** *The strategy to use for the instance refresh. The only valid value is
* Rolling
.
The name of the Auto Scaling group.
- */ - AutoScalingGroupName: string | undefined; } export namespace StartInstanceRefreshType { @@ -5044,15 +5001,15 @@ export namespace StartInstanceRefreshType { export interface TerminateInstanceInAutoScalingGroupType { /** - *Indicates whether terminating the instance also decrements the size of the Auto Scaling - * group.
+ *The ID of the instance.
*/ - ShouldDecrementDesiredCapacity: boolean | undefined; + InstanceId: string | undefined; /** - *The ID of the instance.
+ *Indicates whether terminating the instance also decrements the size of the Auto Scaling + * group.
*/ - InstanceId: string | undefined; + ShouldDecrementDesiredCapacity: boolean | undefined; } export namespace TerminateInstanceInAutoScalingGroupType { @@ -5063,20 +5020,37 @@ export namespace TerminateInstanceInAutoScalingGroupType { export interface UpdateAutoScalingGroupType { /** - *Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling - * when scaling in.
- *For more information about preventing instances from terminating on scale in, see - * Instance Protection in the Amazon EC2 Auto Scaling User Guide.
+ *The name of the Auto Scaling group.
*/ - NewInstancesProtectedFromScaleIn?: boolean; + AutoScalingGroupName: string | undefined; + + /** + *The name of the launch configuration. If you specify
+ * LaunchConfigurationName
in your update request, you can't specify
+ * LaunchTemplate
or MixedInstancesPolicy
.
A comma-separated list of subnet IDs for virtual private cloud (VPC).
- *If you specify VPCZoneIdentifier
with AvailabilityZones
, the
- * subnets that you specify for this parameter must reside in those Availability
- * Zones.
The launch template and version to use to specify the updates. If you specify
+ * LaunchTemplate
in your update request, you can't specify
+ * LaunchConfigurationName
or MixedInstancesPolicy
.
An embedded object that specifies a mixed instances policy. When you make changes to + * an existing policy, all optional parameters are left unchanged if not specified. For + * more information, see Auto Scaling Groups with Multiple + * Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User + * Guide.
+ */ + MixedInstancesPolicy?: MixedInstancesPolicy; + + /** + *The minimum size of the Auto Scaling group.
+ */ + MinSize?: number; /** *The maximum size of the Auto Scaling group.
@@ -5092,61 +5066,25 @@ export interface UpdateAutoScalingGroupType { /** *The desired capacity is the initial capacity of the Auto Scaling group after this operation - * completes and the capacity it attempts to maintain.
- *This number must be greater than or equal to the minimum size of the group and less - * than or equal to the maximum size of the group.
+ * completes and the capacity it attempts to maintain. This number must be greater than or + * equal to the minimum size of the group and less than or equal to the maximum size of the + * group. */ DesiredCapacity?: number; - /** - *The launch template and version to use to specify the updates. If you specify
- * LaunchTemplate
in your update request, you can't specify
- * LaunchConfigurationName
or MixedInstancesPolicy
.
For more information, see LaunchTemplateSpecification in the Amazon EC2 Auto Scaling API - * Reference.
- */ - LaunchTemplate?: LaunchTemplateSpecification; - - /** - *The name of the placement group into which to launch your instances, if any. A - * placement group is a logical grouping of instances within a single Availability Zone. - * You cannot specify multiple Availability Zones and a placement group. For more - * information, see Placement Groups in the - * Amazon EC2 User Guide for Linux Instances.
- */ - PlacementGroup?: string; - /** *The amount of time, in seconds, after a scaling activity completes before another
- * scaling activity can start. The default value is 300
.
This setting applies when using simple scaling policies, but not when using other - * scaling policies or scheduled scaling. For more information, see Scaling Cooldowns - * for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
+ * scaling activity can start. The default value is300
. This setting applies
+ * when using simple scaling policies, but not when using other scaling policies or
+ * scheduled scaling. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling
+ * in the Amazon EC2 Auto Scaling User Guide.
*/
DefaultCooldown?: number;
/**
- * An embedded object that specifies a mixed instances policy.
- *In your call to UpdateAutoScalingGroup
, you can make changes to the
- * policy that is specified. All optional parameters are left unchanged if not
- * specified.
For more information, see MixedInstancesPolicy in the Amazon EC2 Auto Scaling API Reference and - * Auto Scaling Groups with Multiple - * Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User - * Guide.
- */ - MixedInstancesPolicy?: MixedInstancesPolicy; - - /** - *The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status
- * of an EC2 instance that has come into service. The default value is
- * 0
.
For more information, see Health - * Check Grace Period in the Amazon EC2 Auto Scaling User Guide.
- *Required if you are adding an ELB
health check.
One or more Availability Zones for the group.
*/ - HealthCheckGracePeriod?: number; + AvailabilityZones?: string[]; /** *The service to use for the health checks. The valid values are EC2
and
@@ -5157,67 +5095,67 @@ export interface UpdateAutoScalingGroupType {
HealthCheckType?: string;
/**
- *
The maximum amount of time, in seconds, that an instance can be in service. The - * default is null.
- *This parameter is optional, but if you specify a value for it, you must specify a - * value of at least 604,800 seconds (7 days). To clear a previously set value, specify a - * new value of 0.
- *For more information, see Replacing Auto Scaling - * Instances Based on Maximum Instance Lifetime in the - * Amazon EC2 Auto Scaling User Guide.
- *Valid Range: Minimum value of 0.
+ *The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status
+ * of an EC2 instance that has come into service. The default value is 0
. For
+ * more information, see Health
+ * check grace period in the Amazon EC2 Auto Scaling User Guide.
Conditional: Required if you are adding an ELB
health check.
One or more Availability Zones for the group.
+ *The name of an existing placement group into which to launch your instances, if any. A + * placement group is a logical grouping of instances within a single Availability Zone. + * You cannot specify multiple Availability Zones and a placement group. For more + * information, see Placement Groups in the + * Amazon EC2 User Guide for Linux Instances.
*/ - AvailabilityZones?: string[]; + PlacementGroup?: string; /** - *The name of the launch configuration. If you specify
- * LaunchConfigurationName
in your update request, you can't specify
- * LaunchTemplate
or MixedInstancesPolicy
.
A comma-separated list of subnet IDs for a virtual private cloud (VPC). If you specify
+ * VPCZoneIdentifier
with AvailabilityZones
, the subnets that
+ * you specify for this parameter must reside in those Availability Zones.
The minimum size of the Auto Scaling group.
+ *A policy or a list of policies that are used to select the instances to terminate. The + * policies are executed in the order that you list them. For more information, see Controlling which Auto Scaling instances terminate during scale in in the + * Amazon EC2 Auto Scaling User Guide.
*/ - MinSize?: number; + TerminationPolicies?: string[]; /** - *Enables or disables capacity rebalance.
- *You can enable capacity rebalancing for your Auto Scaling groups when using Spot Instances. - * When you turn on capacity rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance - * whenever Amazon EC2 predicts that a Spot Instance is at an elevated risk of interruption. - * After launching a new instance, it then terminates an old instance. For more - * information, see Amazon EC2 Auto Scaling capacity - * rebalancing in the Amazon EC2 Auto Scaling User Guide.
+ *Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling + * when scaling in. For more information about preventing instances from terminating on + * scale in, see Instance scale-in protection in the + * Amazon EC2 Auto Scaling User Guide.
*/ - CapacityRebalance?: boolean; + NewInstancesProtectedFromScaleIn?: boolean; /** - *A standalone termination policy or a list of termination policies used to select the - * instance to terminate. The policies are executed in the order that they are - * listed.
- *For more information, see Controlling Which - * Instances Auto Scaling Terminates During Scale In in the - * Amazon EC2 Auto Scaling User Guide.
+ *The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to + * call other AWS services on your behalf. For more information, see Service-linked + * roles in the Amazon EC2 Auto Scaling User Guide.
*/ - TerminationPolicies?: string[]; + ServiceLinkedRoleARN?: string; /** - *The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to - * call other AWS services on your behalf. For more information, see Service-Linked - * Roles in the Amazon EC2 Auto Scaling User Guide.
+ *The maximum amount of time, in seconds, that an instance can be in service. The + * default is null. If specified, the value must be either 0 or a number equal to or + * greater than 86,400 seconds (1 day). To clear a previously set value, specify a new + * value of 0. For more information, see Replacing Auto Scaling + * instances based on maximum instance lifetime in the + * Amazon EC2 Auto Scaling User Guide.
*/ - ServiceLinkedRoleARN?: string; + MaxInstanceLifetime?: number; /** - *The name of the Auto Scaling group.
+ *Enables or disables Capacity Rebalancing. For more information, see Amazon EC2 Auto Scaling Capacity Rebalancing in the + * Amazon EC2 Auto Scaling User Guide.
*/ - AutoScalingGroupName: string | undefined; + CapacityRebalance?: boolean; } export namespace UpdateAutoScalingGroupType { diff --git a/clients/client-auto-scaling/pagination/DescribeAutoScalingGroupsPaginator.ts b/clients/client-auto-scaling/pagination/DescribeAutoScalingGroupsPaginator.ts index 09544f89876d..4e1aa82b7c1b 100644 --- a/clients/client-auto-scaling/pagination/DescribeAutoScalingGroupsPaginator.ts +++ b/clients/client-auto-scaling/pagination/DescribeAutoScalingGroupsPaginator.ts @@ -14,7 +14,7 @@ const makePagedClientRequest = async ( ...args: any ): Promise