From 2a1ff430db161da75e3bece4ccc5a7c3b551dac9 Mon Sep 17 00:00:00 2001 From: Noah Meyerhans Date: Thu, 16 Jul 2020 14:43:45 -0700 Subject: [PATCH] New upstream version 1.17.22+repack --- PKG-INFO | 2 +- botocore/__init__.py | 2 +- .../2017-11-09/service-2.json | 6 +- .../data/amplify/2017-07-25/service-2.json | 922 +++++----- .../data/appmesh/2019-01-25/paginators-1.json | 12 + .../data/appmesh/2019-01-25/service-2.json | 1627 ++++++++++++++++- .../data/appsync/2017-07-25/service-2.json | 18 +- .../autoscaling/2011-01-01/service-2.json | 70 +- .../data/backup/2018-11-15/service-2.json | 95 +- botocore/data/ce/2017-10-25/service-2.json | 18 +- botocore/data/chime/2018-05-01/service-2.json | 193 +- .../cloudformation/2010-05-15/service-2.json | 65 +- .../data/cloudfront/2019-03-26/service-2.json | 25 +- .../data/cloudhsmv2/2017-04-28/service-2.json | 25 +- .../data/codebuild/2016-10-06/service-2.json | 28 +- .../data/codecommit/2015-04-13/service-2.json | 214 ++- .../2019-09-19/service-2.json | 119 +- .../2019-07-18/service-2.json | 1105 ++++++++++- .../2019-12-01/service-2.json | 320 +++- .../cognito-idp/2016-04-18/service-2.json | 6 +- .../data/comprehend/2017-11-27/service-2.json | 112 +- .../2018-10-30/service-2.json | 3 +- .../data/connect/2017-08-08/service-2.json | 46 +- botocore/data/dms/2016-01-01/service-2.json | 100 +- .../data/docdb/2014-10-31/paginators-1.json | 30 + botocore/data/docdb/2014-10-31/service-2.json | 54 +- .../2014-10-31/service-2.sdk-extras.json | 15 + botocore/data/ebs/2019-11-02/service-2.json | 487 ++++- .../data/ec2/2016-11-15/paginators-1.json | 18 + botocore/data/ec2/2016-11-15/service-2.json | 736 +++++++- botocore/data/ecr/2015-09-21/service-2.json | 15 +- botocore/data/efs/2015-02-01/examples-1.json | 77 +- botocore/data/efs/2015-02-01/service-2.json | 178 +- .../elasticache/2015-02-02/service-2.json | 18 +- botocore/data/emr/2009-03-31/service-2.json | 34 +- botocore/data/endpoints.json | 168 ++ .../data/events/2015-10-07/service-2.json | 106 +- .../data/forecast/2018-06-26/service-2.json | 206 ++- botocore/data/fsx/2018-03-01/service-2.json | 113 +- botocore/data/glue/2017-03-31/service-2.json | 843 ++++++++- .../honeycode/2020-03-01/paginators-1.json | 3 + .../data/honeycode/2020-03-01/service-2.json | 411 +++++ botocore/data/iam/2010-05-08/service-2.json | 18 +- .../imagebuilder/2019-12-02/service-2.json | 6 +- .../iotsitewise/2019-12-02/service-2.json | 4 - .../data/ivs/2020-07-14/paginators-1.json | 22 + botocore/data/ivs/2020-07-14/service-2.json | 1082 +++++++++++ .../lakeformation/2017-03-31/service-2.json | 78 +- .../organizations/2016-11-28/service-2.json | 83 +- .../data/quicksight/2018-04-01/service-2.json | 1436 ++++++++++++++- botocore/data/rds/2014-10-31/service-2.json | 74 +- .../data/sagemaker/2017-07-24/service-2.json | 117 +- .../secretsmanager/2017-10-17/service-2.json | 253 ++- .../securityhub/2018-10-26/service-2.json | 368 +++- botocore/data/sns/2010-03-31/service-2.json | 44 +- .../storagegateway/2013-06-30/service-2.json | 119 +- botocore/data/wafv2/2019-07-29/service-2.json | 115 +- botocore/eventstream.py | 16 +- botocore/handlers.py | 12 +- docs/source/conf.py | 4 +- tests/functional/test_docdb.py | 49 + tests/unit/test_eventstream.py | 85 +- 62 files changed, 11350 insertions(+), 1280 deletions(-) create mode 100644 botocore/data/docdb/2014-10-31/service-2.sdk-extras.json create mode 100644 botocore/data/honeycode/2020-03-01/paginators-1.json create mode 100644 botocore/data/honeycode/2020-03-01/service-2.json create mode 100644 botocore/data/ivs/2020-07-14/paginators-1.json create mode 100644 botocore/data/ivs/2020-07-14/service-2.json create mode 100644 tests/functional/test_docdb.py diff --git a/PKG-INFO b/PKG-INFO index efd651cd..617b6397 100644 --- a/PKG-INFO +++ b/PKG-INFO @@ -1,6 +1,6 @@ Metadata-Version: 1.1 Name: botocore -Version: 1.17.9 +Version: 1.17.22 Summary: Low-level, data-driven core of boto 3. Home-page: https://github.com/boto/botocore Author: Amazon Web Services diff --git a/botocore/__init__.py b/botocore/__init__.py index 8a04a558..965c4423 100644 --- a/botocore/__init__.py +++ b/botocore/__init__.py @@ -16,7 +16,7 @@ import os import re import logging -__version__ = '1.17.9' +__version__ = '1.17.22' class NullHandler(logging.Handler): diff --git a/botocore/data/alexaforbusiness/2017-11-09/service-2.json b/botocore/data/alexaforbusiness/2017-11-09/service-2.json index 5a5eea08..700df59a 100644 --- a/botocore/data/alexaforbusiness/2017-11-09/service-2.json +++ b/botocore/data/alexaforbusiness/2017-11-09/service-2.json @@ -874,6 +874,7 @@ "errors":[ {"shape":"LimitExceededException"}, {"shape":"ConcurrentModificationException"}, + {"shape":"NotFoundException"}, {"shape":"InvalidDeviceException"} ], "documentation":"

Registers an Alexa-enabled device built by an Original Equipment Manufacturer (OEM) using Alexa Voice Service (AVS).

" @@ -4422,7 +4423,6 @@ "ClientId", "UserCode", "ProductId", - "DeviceSerialNumber", "AmazonId" ], "members":{ @@ -4445,6 +4445,10 @@ "AmazonId":{ "shape":"AmazonId", "documentation":"

The device type ID for your AVS device generated by Amazon when the OEM creates a new product on Amazon's Developer Console.

" + }, + "RoomArn":{ + "shape":"Arn", + "documentation":"

The ARN of the room with which to associate your AVS device.

" } } }, diff --git a/botocore/data/amplify/2017-07-25/service-2.json b/botocore/data/amplify/2017-07-25/service-2.json index 076a7dd8..cab8cb0b 100644 --- a/botocore/data/amplify/2017-07-25/service-2.json +++ b/botocore/data/amplify/2017-07-25/service-2.json @@ -28,7 +28,7 @@ {"shape":"LimitExceededException"}, {"shape":"DependentServiceFailureException"} ], - "documentation":"

Creates a new Amplify App.

" + "documentation":"

Creates a new Amplify app.

" }, "CreateBackendEnvironment":{ "name":"CreateBackendEnvironment", @@ -45,7 +45,7 @@ {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"} ], - "documentation":"

Creates a new backend environment for an Amplify App.

" + "documentation":"

Creates a new backend environment for an Amplify app.

" }, "CreateBranch":{ "name":"CreateBranch", @@ -63,7 +63,7 @@ {"shape":"LimitExceededException"}, {"shape":"DependentServiceFailureException"} ], - "documentation":"

Creates a new Branch for an Amplify App.

" + "documentation":"

Creates a new branch for an Amplify app.

" }, "CreateDeployment":{ "name":"CreateDeployment", @@ -79,7 +79,7 @@ {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"} ], - "documentation":"

Create a deployment for manual deploy apps. (Apps are not connected to repository)

" + "documentation":"

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

" }, "CreateDomainAssociation":{ "name":"CreateDomainAssociation", @@ -97,7 +97,7 @@ {"shape":"LimitExceededException"}, {"shape":"DependentServiceFailureException"} ], - "documentation":"

Create a new DomainAssociation on an App

" + "documentation":"

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

" }, "CreateWebhook":{ "name":"CreateWebhook", @@ -115,7 +115,7 @@ {"shape":"LimitExceededException"}, {"shape":"DependentServiceFailureException"} ], - "documentation":"

Create a new webhook on an App.

" + "documentation":"

Creates a new webhook on an Amplify app.

" }, "DeleteApp":{ "name":"DeleteApp", @@ -132,7 +132,7 @@ {"shape":"InternalFailureException"}, {"shape":"DependentServiceFailureException"} ], - "documentation":"

Delete an existing Amplify App by appId.

" + "documentation":"

Deletes an existing Amplify app specified by an app ID.

" }, "DeleteBackendEnvironment":{ "name":"DeleteBackendEnvironment", @@ -149,7 +149,7 @@ {"shape":"InternalFailureException"}, {"shape":"DependentServiceFailureException"} ], - "documentation":"

Delete backend environment for an Amplify App.

" + "documentation":"

Deletes a backend environment for an Amplify app.

" }, "DeleteBranch":{ "name":"DeleteBranch", @@ -166,7 +166,7 @@ {"shape":"InternalFailureException"}, {"shape":"DependentServiceFailureException"} ], - "documentation":"

Deletes a branch for an Amplify App.

" + "documentation":"

Deletes a branch for an Amplify app.

" }, "DeleteDomainAssociation":{ "name":"DeleteDomainAssociation", @@ -183,7 +183,7 @@ {"shape":"InternalFailureException"}, {"shape":"DependentServiceFailureException"} ], - "documentation":"

Deletes a DomainAssociation.

" + "documentation":"

Deletes a domain association for an Amplify app.

" }, "DeleteJob":{ "name":"DeleteJob", @@ -200,7 +200,7 @@ {"shape":"NotFoundException"}, {"shape":"LimitExceededException"} ], - "documentation":"

Delete a job, for an Amplify branch, part of Amplify App.

" + "documentation":"

Deletes a job for a branch of an Amplify app.

" }, "DeleteWebhook":{ "name":"DeleteWebhook", @@ -233,7 +233,7 @@ {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], - "documentation":"

Retrieve website access logs for a specific time range via a pre-signed URL.

" + "documentation":"

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

" }, "GetApp":{ "name":"GetApp", @@ -249,7 +249,7 @@ {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], - "documentation":"

Retrieves an existing Amplify App by appId.

" + "documentation":"

Returns an existing Amplify app by appID.

" }, "GetArtifactUrl":{ "name":"GetArtifactUrl", @@ -266,7 +266,7 @@ {"shape":"NotFoundException"}, {"shape":"LimitExceededException"} ], - "documentation":"

Retrieves artifact info that corresponds to a artifactId.

" + "documentation":"

Returns the artifact info that corresponds to an artifact id.

" }, "GetBackendEnvironment":{ "name":"GetBackendEnvironment", @@ -282,7 +282,7 @@ {"shape":"NotFoundException"}, {"shape":"InternalFailureException"} ], - "documentation":"

Retrieves a backend environment for an Amplify App.

" + "documentation":"

Returns a backend environment for an Amplify app.

" }, "GetBranch":{ "name":"GetBranch", @@ -298,7 +298,7 @@ {"shape":"NotFoundException"}, {"shape":"InternalFailureException"} ], - "documentation":"

Retrieves a branch for an Amplify App.

" + "documentation":"

Returns a branch for an Amplify app.

" }, "GetDomainAssociation":{ "name":"GetDomainAssociation", @@ -314,7 +314,7 @@ {"shape":"NotFoundException"}, {"shape":"InternalFailureException"} ], - "documentation":"

Retrieves domain info that corresponds to an appId and domainName.

" + "documentation":"

Returns the domain information for an Amplify app.

" }, "GetJob":{ "name":"GetJob", @@ -331,7 +331,7 @@ {"shape":"NotFoundException"}, {"shape":"LimitExceededException"} ], - "documentation":"

Get a job for a branch, part of an Amplify App.

" + "documentation":"

Returns a job for a branch of an Amplify app.

" }, "GetWebhook":{ "name":"GetWebhook", @@ -348,7 +348,7 @@ {"shape":"NotFoundException"}, {"shape":"LimitExceededException"} ], - "documentation":"

Retrieves webhook info that corresponds to a webhookId.

" + "documentation":"

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

" }, "ListApps":{ "name":"ListApps", @@ -363,7 +363,7 @@ {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], - "documentation":"

Lists existing Amplify Apps.

" + "documentation":"

Returns a list of the existing Amplify apps.

" }, "ListArtifacts":{ "name":"ListArtifacts", @@ -379,7 +379,7 @@ {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"} ], - "documentation":"

List artifacts with an app, a branch, a job and an artifact type.

" + "documentation":"

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

" }, "ListBackendEnvironments":{ "name":"ListBackendEnvironments", @@ -394,7 +394,7 @@ {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], - "documentation":"

Lists backend environments for an Amplify App.

" + "documentation":"

Lists the backend environments for an Amplify app.

" }, "ListBranches":{ "name":"ListBranches", @@ -409,7 +409,7 @@ {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], - "documentation":"

Lists branches for an Amplify App.

" + "documentation":"

Lists the branches of an Amplify app.

" }, "ListDomainAssociations":{ "name":"ListDomainAssociations", @@ -424,7 +424,7 @@ {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], - "documentation":"

List domains with an app

" + "documentation":"

Returns the domain associations for an Amplify app.

" }, "ListJobs":{ "name":"ListJobs", @@ -440,7 +440,7 @@ {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"} ], - "documentation":"

List Jobs for a branch, part of an Amplify App.

" + "documentation":"

Lists the jobs for a branch of an Amplify app.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -455,7 +455,7 @@ {"shape":"BadRequestException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

List tags for resource.

" + "documentation":"

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

" }, "ListWebhooks":{ "name":"ListWebhooks", @@ -471,7 +471,7 @@ {"shape":"InternalFailureException"}, {"shape":"LimitExceededException"} ], - "documentation":"

List webhooks with an app.

" + "documentation":"

Returns a list of webhooks for an Amplify app.

" }, "StartDeployment":{ "name":"StartDeployment", @@ -488,7 +488,7 @@ {"shape":"NotFoundException"}, {"shape":"LimitExceededException"} ], - "documentation":"

Start a deployment for manual deploy apps. (Apps are not connected to repository)

" + "documentation":"

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

" }, "StartJob":{ "name":"StartJob", @@ -505,7 +505,7 @@ {"shape":"NotFoundException"}, {"shape":"LimitExceededException"} ], - "documentation":"

Starts a new job for a branch, part of an Amplify App.

" + "documentation":"

Starts a new job for a branch of an Amplify app.

" }, "StopJob":{ "name":"StopJob", @@ -522,7 +522,7 @@ {"shape":"NotFoundException"}, {"shape":"LimitExceededException"} ], - "documentation":"

Stop a job that is in progress, for an Amplify branch, part of Amplify App.

" + "documentation":"

Stops a job that is in progress for a branch of an Amplify app.

" }, "TagResource":{ "name":"TagResource", @@ -537,7 +537,7 @@ {"shape":"BadRequestException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Tag resource with tag key and value.

" + "documentation":"

Tags the resource with a tag key and value.

" }, "UntagResource":{ "name":"UntagResource", @@ -552,7 +552,7 @@ {"shape":"BadRequestException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Untag resource with resourceArn.

" + "documentation":"

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

" }, "UpdateApp":{ "name":"UpdateApp", @@ -568,7 +568,7 @@ {"shape":"UnauthorizedException"}, {"shape":"InternalFailureException"} ], - "documentation":"

Updates an existing Amplify App.

" + "documentation":"

Updates an existing Amplify app.

" }, "UpdateBranch":{ "name":"UpdateBranch", @@ -585,7 +585,7 @@ {"shape":"InternalFailureException"}, {"shape":"DependentServiceFailureException"} ], - "documentation":"

Updates a branch for an Amplify App.

" + "documentation":"

Updates a branch for an Amplify app.

" }, "UpdateDomainAssociation":{ "name":"UpdateDomainAssociation", @@ -602,7 +602,7 @@ {"shape":"InternalFailureException"}, {"shape":"DependentServiceFailureException"} ], - "documentation":"

Create a new DomainAssociation on an App

" + "documentation":"

Creates a new domain association for an Amplify app.

" }, "UpdateWebhook":{ "name":"UpdateWebhook", @@ -619,14 +619,15 @@ {"shape":"InternalFailureException"}, {"shape":"DependentServiceFailureException"} ], - "documentation":"

Update a webhook.

" + "documentation":"

Updates a webhook.

" } }, "shapes":{ "AccessToken":{ "type":"string", "max":255, - "min":1 + "min":1, + "sensitive":true }, "ActiveJobId":{ "type":"string", @@ -651,90 +652,94 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for the Amplify App.

" + "documentation":"

The unique ID of the Amplify app.

" }, "appArn":{ "shape":"AppArn", - "documentation":"

ARN for the Amplify App.

" + "documentation":"

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

" }, "name":{ "shape":"Name", - "documentation":"

Name for the Amplify App.

" + "documentation":"

The name for the Amplify app.

" }, "tags":{ "shape":"TagMap", - "documentation":"

Tag for Amplify App.

" + "documentation":"

The tag for the Amplify app.

" }, "description":{ "shape":"Description", - "documentation":"

Description for the Amplify App.

" + "documentation":"

The description for the Amplify app.

" }, "repository":{ "shape":"Repository", - "documentation":"

Repository for the Amplify App.

" + "documentation":"

The repository for the Amplify app.

" }, "platform":{ "shape":"Platform", - "documentation":"

Platform for the Amplify App.

" + "documentation":"

The platform for the Amplify app.

" }, "createTime":{ "shape":"CreateTime", - "documentation":"

Create date / time for the Amplify App.

" + "documentation":"

Creates a date and time for the Amplify app.

" }, "updateTime":{ "shape":"UpdateTime", - "documentation":"

Update date / time for the Amplify App.

" + "documentation":"

Updates the date and time for the Amplify app.

" }, "iamServiceRoleArn":{ "shape":"ServiceRoleArn", - "documentation":"

IAM service role ARN for the Amplify App.

" + "documentation":"

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

" }, "environmentVariables":{ "shape":"EnvironmentVariables", - "documentation":"

Environment Variables for the Amplify App.

" + "documentation":"

The environment variables for the Amplify app.

" }, "defaultDomain":{ "shape":"DefaultDomain", - "documentation":"

Default domain for the Amplify App.

" + "documentation":"

The default domain for the Amplify app.

" }, "enableBranchAutoBuild":{ "shape":"EnableBranchAutoBuild", - "documentation":"

Enables auto-building of branches for the Amplify App.

" + "documentation":"

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

" + }, + "enableBranchAutoDeletion":{ + "shape":"EnableBranchAutoDeletion", + "documentation":"

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

" }, "enableBasicAuth":{ "shape":"EnableBasicAuth", - "documentation":"

Enables Basic Authorization for branches for the Amplify App.

" + "documentation":"

Enables basic authorization for the Amplify app's branches.

" }, "basicAuthCredentials":{ "shape":"BasicAuthCredentials", - "documentation":"

Basic Authorization credentials for branches for the Amplify App.

" + "documentation":"

The basic authorization credentials for branches for the Amplify app.

" }, "customRules":{ "shape":"CustomRules", - "documentation":"

Custom redirect / rewrite rules for the Amplify App.

" + "documentation":"

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

" }, "productionBranch":{ "shape":"ProductionBranch", - "documentation":"

Structure with Production Branch information.

" + "documentation":"

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

" }, "buildSpec":{ "shape":"BuildSpec", - "documentation":"

BuildSpec content for Amplify App.

" + "documentation":"

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

" }, "enableAutoBranchCreation":{ "shape":"EnableAutoBranchCreation", - "documentation":"

Enables automated branch creation for the Amplify App.

" + "documentation":"

Enables automated branch creation for the Amplify app.

" }, "autoBranchCreationPatterns":{ "shape":"AutoBranchCreationPatterns", - "documentation":"

Automated branch creation glob patterns for the Amplify App.

" + "documentation":"

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

" }, "autoBranchCreationConfig":{ "shape":"AutoBranchCreationConfig", - "documentation":"

Automated branch creation config for the Amplify App.

" + "documentation":"

Describes the automated branch creation configuration for the Amplify app.

" } }, - "documentation":"

Amplify App represents different branches of a repository for building, deploying, and hosting.

" + "documentation":"

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

" }, "AppArn":{ "type":"string", @@ -758,14 +763,14 @@ "members":{ "artifactFileName":{ "shape":"ArtifactFileName", - "documentation":"

File name for the artifact.

" + "documentation":"

The file name for the artifact.

" }, "artifactId":{ "shape":"ArtifactId", - "documentation":"

Unique Id for a artifact.

" + "documentation":"

The unique ID for the artifact.

" } }, - "documentation":"

Structure for artifact.

" + "documentation":"

Describes an artifact.

" }, "ArtifactFileName":{ "type":"string", @@ -801,42 +806,42 @@ "members":{ "stage":{ "shape":"Stage", - "documentation":"

Stage for the auto created branch.

" + "documentation":"

Describes the current stage for the autocreated branch.

" }, "framework":{ "shape":"Framework", - "documentation":"

Framework for the auto created branch.

" + "documentation":"

The framework for the autocreated branch.

" }, "enableAutoBuild":{ "shape":"EnableAutoBuild", - "documentation":"

Enables auto building for the auto created branch.

" + "documentation":"

Enables auto building for the autocreated branch.

" }, "environmentVariables":{ "shape":"EnvironmentVariables", - "documentation":"

Environment Variables for the auto created branch.

" + "documentation":"

The environment variables for the autocreated branch.

" }, "basicAuthCredentials":{ "shape":"BasicAuthCredentials", - "documentation":"

Basic Authorization credentials for the auto created branch.

" + "documentation":"

The basic authorization credentials for the autocreated branch.

" }, "enableBasicAuth":{ "shape":"EnableBasicAuth", - "documentation":"

Enables Basic Auth for the auto created branch.

" + "documentation":"

Enables basic authorization for the autocreated branch.

" }, "buildSpec":{ "shape":"BuildSpec", - "documentation":"

BuildSpec for the auto created branch.

" + "documentation":"

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

" }, "enablePullRequestPreview":{ "shape":"EnablePullRequestPreview", - "documentation":"

Enables Pull Request Preview for auto created branch.

" + "documentation":"

Enables pull request preview for the autocreated branch.

" }, "pullRequestEnvironmentName":{ "shape":"PullRequestEnvironmentName", - "documentation":"

The Amplify Environment name for the pull request.

" + "documentation":"

The Amplify environment name for the pull request.

" } }, - "documentation":"

Structure with auto branch creation config.

" + "documentation":"

Describes the automated branch creation configuration.

" }, "AutoBranchCreationPattern":{ "type":"string", @@ -847,6 +852,20 @@ "type":"list", "member":{"shape":"AutoBranchCreationPattern"} }, + "AutoSubDomainCreationPattern":{ + "type":"string", + "max":2048, + "min":1 + }, + "AutoSubDomainCreationPatterns":{ + "type":"list", + "member":{"shape":"AutoSubDomainCreationPattern"} + }, + "AutoSubDomainIAMRole":{ + "type":"string", + "max":1000, + "pattern":"^$|^arn:aws:iam::\\d{12}:role.+" + }, "BackendEnvironment":{ "type":"structure", "required":[ @@ -858,30 +877,30 @@ "members":{ "backendEnvironmentArn":{ "shape":"BackendEnvironmentArn", - "documentation":"

Arn for a backend environment, part of an Amplify App.

" + "documentation":"

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

" }, "environmentName":{ "shape":"EnvironmentName", - "documentation":"

Name for a backend environment, part of an Amplify App.

" + "documentation":"

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

" }, "stackName":{ "shape":"StackName", - "documentation":"

CloudFormation stack name of backend environment.

" + "documentation":"

The AWS CloudFormation stack name of a backend environment.

" }, "deploymentArtifacts":{ "shape":"DeploymentArtifacts", - "documentation":"

Name of deployment artifacts.

" + "documentation":"

The name of deployment artifacts.

" }, "createTime":{ "shape":"CreateTime", - "documentation":"

Creation date and time for a backend environment, part of an Amplify App.

" + "documentation":"

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

" }, "updateTime":{ "shape":"UpdateTime", - "documentation":"

Last updated date and time for a backend environment, part of an Amplify App.

" + "documentation":"

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

" } }, - "documentation":"

Backend environment for an Amplify App.

" + "documentation":"

Describes the backend environment for an Amplify app.

" }, "BackendEnvironmentArn":{ "type":"string", @@ -897,13 +916,14 @@ "members":{ "message":{"shape":"ErrorMessage"} }, - "documentation":"

Exception thrown when a request contains unexpected data.

", + "documentation":"

A request contains unexpected data.

", "error":{"httpStatusCode":400}, "exception":true }, "BasicAuthCredentials":{ "type":"string", - "max":2000 + "max":2000, + "sensitive":true }, "Branch":{ "type":"structure", @@ -929,95 +949,95 @@ "members":{ "branchArn":{ "shape":"BranchArn", - "documentation":"

ARN for a branch, part of an Amplify App.

" + "documentation":"

The Amazon Resource Name (ARN) for a branch that is part of an Amplify app.

" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for a branch, part of an Amplify App.

" + "documentation":"

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

" }, "description":{ "shape":"Description", - "documentation":"

Description for a branch, part of an Amplify App.

" + "documentation":"

The description for the branch that is part of an Amplify app.

" }, "tags":{ "shape":"TagMap", - "documentation":"

Tag for branch for Amplify App.

" + "documentation":"

The tag for the branch of an Amplify app.

" }, "stage":{ "shape":"Stage", - "documentation":"

Stage for a branch, part of an Amplify App.

" + "documentation":"

The current stage for the branch that is part of an Amplify app.

" }, "displayName":{ "shape":"DisplayName", - "documentation":"

Display name for a branch, will use as the default domain prefix.

" + "documentation":"

The display name for the branch. This is used as the default domain prefix.

" }, "enableNotification":{ "shape":"EnableNotification", - "documentation":"

Enables notifications for a branch, part of an Amplify App.

" + "documentation":"

Enables notifications for a branch that is part of an Amplify app.

" }, "createTime":{ "shape":"CreateTime", - "documentation":"

Creation date and time for a branch, part of an Amplify App.

" + "documentation":"

The creation date and time for a branch that is part of an Amplify app.

" }, "updateTime":{ "shape":"UpdateTime", - "documentation":"

Last updated date and time for a branch, part of an Amplify App.

" + "documentation":"

The last updated date and time for a branch that is part of an Amplify app.

" }, "environmentVariables":{ "shape":"EnvironmentVariables", - "documentation":"

Environment Variables specific to a branch, part of an Amplify App.

" + "documentation":"

The environment variables specific to a branch of an Amplify app.

" }, "enableAutoBuild":{ "shape":"EnableAutoBuild", - "documentation":"

Enables auto-building on push for a branch, part of an Amplify App.

" + "documentation":"

Enables auto-building on push for a branch of an Amplify app.

" }, "customDomains":{ "shape":"CustomDomains", - "documentation":"

Custom domains for a branch, part of an Amplify App.

" + "documentation":"

The custom domains for a branch of an Amplify app.

" }, "framework":{ "shape":"Framework", - "documentation":"

Framework for a branch, part of an Amplify App.

" + "documentation":"

The framework for a branch of an Amplify app.

" }, "activeJobId":{ "shape":"ActiveJobId", - "documentation":"

Id of the active job for a branch, part of an Amplify App.

" + "documentation":"

The ID of the active job for a branch of an Amplify app.

" }, "totalNumberOfJobs":{ "shape":"TotalNumberOfJobs", - "documentation":"

Total number of Jobs part of an Amplify App.

" + "documentation":"

The total number of jobs that are part of an Amplify app.

" }, "enableBasicAuth":{ "shape":"EnableBasicAuth", - "documentation":"

Enables Basic Authorization for a branch, part of an Amplify App.

" + "documentation":"

Enables basic authorization for a branch of an Amplify app.

" }, "thumbnailUrl":{ "shape":"ThumbnailUrl", - "documentation":"

Thumbnail URL for the branch.

" + "documentation":"

The thumbnail URL for the branch of an Amplify app.

" }, "basicAuthCredentials":{ "shape":"BasicAuthCredentials", - "documentation":"

Basic Authorization credentials for a branch, part of an Amplify App.

" + "documentation":"

The basic authorization credentials for a branch of an Amplify app.

" }, "buildSpec":{ "shape":"BuildSpec", - "documentation":"

BuildSpec content for branch for Amplify App.

" + "documentation":"

The build specification (build spec) content for the branch of an Amplify app.

" }, "ttl":{ "shape":"TTL", - "documentation":"

The content TTL for the website in seconds.

" + "documentation":"

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

" }, "associatedResources":{ "shape":"AssociatedResources", - "documentation":"

List of custom resources that are linked to this branch.

" + "documentation":"

A list of custom resources that are linked to this branch.

" }, "enablePullRequestPreview":{ "shape":"EnablePullRequestPreview", - "documentation":"

Enables Pull Request Preview for this branch.

" + "documentation":"

Enables pull request preview for the branch.

" }, "pullRequestEnvironmentName":{ "shape":"PullRequestEnvironmentName", - "documentation":"

The Amplify Environment name for the pull request.

" + "documentation":"

The Amplify environment name for the pull request.

" }, "destinationBranch":{ "shape":"BranchName", @@ -1029,10 +1049,10 @@ }, "backendEnvironmentArn":{ "shape":"BackendEnvironmentArn", - "documentation":"

ARN for a Backend Environment, part of an Amplify App.

" + "documentation":"

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

" } }, - "documentation":"

Branch for an Amplify App, which maps to a 3rd party repository branch.

" + "documentation":"

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

" }, "BranchArn":{ "type":"string", @@ -1050,7 +1070,7 @@ }, "BuildSpec":{ "type":"string", - "documentation":"

BuildSpec file for Amplify app build.

", + "documentation":"

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

", "max":25000, "min":1 }, @@ -1080,74 +1100,78 @@ "members":{ "name":{ "shape":"Name", - "documentation":"

Name for the Amplify App

" + "documentation":"

The name for the Amplify app.

" }, "description":{ "shape":"Description", - "documentation":"

Description for an Amplify App

" + "documentation":"

The description for an Amplify app.

" }, "repository":{ "shape":"Repository", - "documentation":"

Repository for an Amplify App

" + "documentation":"

The repository for an Amplify app.

" }, "platform":{ "shape":"Platform", - "documentation":"

Platform / framework for an Amplify App

" + "documentation":"

The platform or framework for an Amplify app.

" }, "iamServiceRoleArn":{ "shape":"ServiceRoleArn", - "documentation":"

AWS IAM service role for an Amplify App

" + "documentation":"

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

" }, "oauthToken":{ "shape":"OauthToken", - "documentation":"

OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. OAuth token is not stored.

" + "documentation":"

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.

" }, "accessToken":{ "shape":"AccessToken", - "documentation":"

Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. Token is not stored.

" + "documentation":"

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 token is not stored.

" }, "environmentVariables":{ "shape":"EnvironmentVariables", - "documentation":"

Environment variables map for an Amplify App.

" + "documentation":"

The environment variables map for an Amplify app.

" }, "enableBranchAutoBuild":{ "shape":"EnableBranchAutoBuild", - "documentation":"

Enable the auto building of branches for an Amplify App.

" + "documentation":"

Enables the auto building of branches for an Amplify app.

" + }, + "enableBranchAutoDeletion":{ + "shape":"EnableBranchAutoDeletion", + "documentation":"

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

" }, "enableBasicAuth":{ "shape":"EnableBasicAuth", - "documentation":"

Enable Basic Authorization for an Amplify App, this will apply to all branches part of this App.

" + "documentation":"

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

" }, "basicAuthCredentials":{ "shape":"BasicAuthCredentials", - "documentation":"

Credentials for Basic Authorization for an Amplify App.

" + "documentation":"

The credentials for basic authorization for an Amplify app.

" }, "customRules":{ "shape":"CustomRules", - "documentation":"

Custom rewrite / redirect rules for an Amplify App.

" + "documentation":"

The custom rewrite and redirect rules for an Amplify app.

" }, "tags":{ "shape":"TagMap", - "documentation":"

Tag for an Amplify App

" + "documentation":"

The tag for an Amplify app.

" }, "buildSpec":{ "shape":"BuildSpec", - "documentation":"

BuildSpec for an Amplify App

" + "documentation":"

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

" }, "enableAutoBranchCreation":{ "shape":"EnableAutoBranchCreation", - "documentation":"

Enables automated branch creation for the Amplify App.

" + "documentation":"

Enables automated branch creation for the Amplify app.

" }, "autoBranchCreationPatterns":{ "shape":"AutoBranchCreationPatterns", - "documentation":"

Automated branch creation glob patterns for the Amplify App.

" + "documentation":"

The automated branch creation glob patterns for the Amplify app.

" }, "autoBranchCreationConfig":{ "shape":"AutoBranchCreationConfig", - "documentation":"

Automated branch creation config for the Amplify App.

" + "documentation":"

The automated branch creation configuration for the Amplify app.

" } }, - "documentation":"

Request structure used to create Apps in Amplify.

" + "documentation":"

The request structure used to create apps in Amplify.

" }, "CreateAppResult":{ "type":"structure", @@ -1165,24 +1189,24 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "environmentName":{ "shape":"EnvironmentName", - "documentation":"

Name for the backend environment.

" + "documentation":"

The name for the backend environment.

" }, "stackName":{ "shape":"StackName", - "documentation":"

CloudFormation stack name of backend environment.

" + "documentation":"

The AWS CloudFormation stack name of a backend environment.

" }, "deploymentArtifacts":{ "shape":"DeploymentArtifacts", - "documentation":"

Name of deployment artifacts.

" + "documentation":"

The name of deployment artifacts.

" } }, - "documentation":"

Request structure for a backend environment create request.

" + "documentation":"

The request structure for the backend environment create request.

" }, "CreateBackendEnvironmentResult":{ "type":"structure", @@ -1190,10 +1214,10 @@ "members":{ "backendEnvironment":{ "shape":"BackendEnvironment", - "documentation":"

Backend environment structure for an amplify App.

" + "documentation":"

Describes the backend environment for an Amplify app.

" } }, - "documentation":"

Result structure for create backend environment.

" + "documentation":"

The result structure for the create backend environment request.

" }, "CreateBranchRequest":{ "type":"structure", @@ -1204,25 +1228,25 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for the branch.

" + "documentation":"

The name for the branch.

" }, "description":{ "shape":"Description", - "documentation":"

Description for the branch.

" + "documentation":"

The description for the branch.

" }, "stage":{ "shape":"Stage", - "documentation":"

Stage for the branch.

" + "documentation":"

Describes the current stage for the branch.

" }, "framework":{ "shape":"Framework", - "documentation":"

Framework for the branch.

" + "documentation":"

The framework for the branch.

" }, "enableNotification":{ "shape":"EnableNotification", @@ -1234,46 +1258,46 @@ }, "environmentVariables":{ "shape":"EnvironmentVariables", - "documentation":"

Environment Variables for the branch.

" + "documentation":"

The environment variables for the branch.

" }, "basicAuthCredentials":{ "shape":"BasicAuthCredentials", - "documentation":"

Basic Authorization credentials for the branch.

" + "documentation":"

The basic authorization credentials for the branch.

" }, "enableBasicAuth":{ "shape":"EnableBasicAuth", - "documentation":"

Enables Basic Auth for the branch.

" + "documentation":"

Enables basic authorization for the branch.

" }, "tags":{ "shape":"TagMap", - "documentation":"

Tag for the branch.

" + "documentation":"

The tag for the branch.

" }, "buildSpec":{ "shape":"BuildSpec", - "documentation":"

BuildSpec for the branch.

" + "documentation":"

The build specification (build spec) for the branch.

" }, "ttl":{ "shape":"TTL", - "documentation":"

The content TTL for the website in seconds.

" + "documentation":"

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

" }, "displayName":{ "shape":"DisplayName", - "documentation":"

Display name for a branch, will use as the default domain prefix.

" + "documentation":"

The display name for a branch. This is used as the default domain prefix.

" }, "enablePullRequestPreview":{ "shape":"EnablePullRequestPreview", - "documentation":"

Enables Pull Request Preview for this branch.

" + "documentation":"

Enables pull request preview for this branch.

" }, "pullRequestEnvironmentName":{ "shape":"PullRequestEnvironmentName", - "documentation":"

The Amplify Environment name for the pull request.

" + "documentation":"

The Amplify environment name for the pull request.

" }, "backendEnvironmentArn":{ "shape":"BackendEnvironmentArn", - "documentation":"

ARN for a Backend Environment, part of an Amplify App.

" + "documentation":"

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

" } }, - "documentation":"

Request structure for a branch create request.

" + "documentation":"

The request structure for the create branch request.

" }, "CreateBranchResult":{ "type":"structure", @@ -1281,10 +1305,10 @@ "members":{ "branch":{ "shape":"Branch", - "documentation":"

Branch structure for an Amplify App.

" + "documentation":"

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

" } }, - "documentation":"

Result structure for create branch request.

" + "documentation":"

The result structure for create branch request.

" }, "CreateDeploymentRequest":{ "type":"structure", @@ -1295,22 +1319,22 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for the branch, for the Job.

", + "documentation":"

The name for the branch, for the job.

", "location":"uri", "locationName":"branchName" }, "fileMap":{ "shape":"FileMap", - "documentation":"

Optional file map that contains file name as the key and file content md5 hash as the value. If this argument is provided, the service will generate different upload url per file. Otherwise, the service will only generate a single upload url for the zipped files.

" + "documentation":"

An optional file map that contains the file name as the key and the file content md5 hash as the value. If this argument is provided, the service will generate a unique upload URL per file. Otherwise, the service will only generate a single upload URL for the zipped files.

" } }, - "documentation":"

Request structure for create a new deployment.

" + "documentation":"

The request structure for the create a new deployment request.

" }, "CreateDeploymentResult":{ "type":"structure", @@ -1321,18 +1345,18 @@ "members":{ "jobId":{ "shape":"JobId", - "documentation":"

The jobId for this deployment, will supply to start deployment api.

" + "documentation":"

The job ID for this deployment. will supply to start deployment api.

" }, "fileUploadUrls":{ "shape":"FileUploadUrls", - "documentation":"

When the fileMap argument is provided in the request, the fileUploadUrls will contain a map of file names to upload url.

" + "documentation":"

When the fileMap argument is provided in the request, fileUploadUrls will contain a map of file names to upload URLs.

" }, "zipUploadUrl":{ "shape":"UploadUrl", - "documentation":"

When the fileMap argument is NOT provided. This zipUploadUrl will be returned.

" + "documentation":"

When the fileMap argument is not provided in the request, this zipUploadUrl is returned.

" } }, - "documentation":"

Result structure for create a new deployment.

" + "documentation":"

The result structure for the create a new deployment request.

" }, "CreateDomainAssociationRequest":{ "type":"structure", @@ -1344,24 +1368,32 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "domainName":{ "shape":"DomainName", - "documentation":"

Domain name for the Domain Association.

" + "documentation":"

The domain name for the domain association.

" }, "enableAutoSubDomain":{ "shape":"EnableAutoSubDomain", - "documentation":"

Enables automated creation of Subdomains for branches. (Currently not supported)

" + "documentation":"

Enables the automated creation of subdomains for branches.

" }, "subDomainSettings":{ "shape":"SubDomainSettings", - "documentation":"

Setting structure for the Subdomain.

" + "documentation":"

The setting for the subdomain.

" + }, + "autoSubDomainCreationPatterns":{ + "shape":"AutoSubDomainCreationPatterns", + "documentation":"

Sets the branch patterns for automatic subdomain creation.

" + }, + "autoSubDomainIAMRole":{ + "shape":"AutoSubDomainIAMRole", + "documentation":"

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

" } }, - "documentation":"

Request structure for create Domain Association request.

" + "documentation":"

The request structure for the create domain association request.

" }, "CreateDomainAssociationResult":{ "type":"structure", @@ -1369,10 +1401,10 @@ "members":{ "domainAssociation":{ "shape":"DomainAssociation", - "documentation":"

Domain Association structure.

" + "documentation":"

Describes the structure of a domain association, which associates a custom domain with an Amplify app.

" } }, - "documentation":"

Result structure for the create Domain Association request.

" + "documentation":"

The result structure for the create domain association request.

" }, "CreateTime":{"type":"timestamp"}, "CreateWebhookRequest":{ @@ -1384,20 +1416,20 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for a branch, part of an Amplify App.

" + "documentation":"

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

" }, "description":{ "shape":"Description", - "documentation":"

Description for a webhook.

" + "documentation":"

The description for a webhook.

" } }, - "documentation":"

Request structure for create webhook request.

" + "documentation":"

The request structure for the create webhook request.

" }, "CreateWebhookResult":{ "type":"structure", @@ -1405,10 +1437,10 @@ "members":{ "webhook":{ "shape":"Webhook", - "documentation":"

Webhook structure.

" + "documentation":"

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

" } }, - "documentation":"

Result structure for the create webhook request.

" + "documentation":"

The result structure for the create webhook request.

" }, "CustomDomain":{ "type":"string", @@ -1440,10 +1472,10 @@ }, "condition":{ "shape":"Condition", - "documentation":"

The condition for a URL rewrite or redirect rule, e.g. country code.

" + "documentation":"

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

" } }, - "documentation":"

Custom rewrite / redirect rule.

" + "documentation":"

Describes a custom rewrite or redirect rule.

" }, "CustomRules":{ "type":"list", @@ -1464,12 +1496,12 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" } }, - "documentation":"

Request structure for an Amplify App delete request.

" + "documentation":"

Describes the request structure for the delete app request.

" }, "DeleteAppResult":{ "type":"structure", @@ -1477,7 +1509,7 @@ "members":{ "app":{"shape":"App"} }, - "documentation":"

Result structure for an Amplify App delete request.

" + "documentation":"

The result structure for the delete app request.

" }, "DeleteBackendEnvironmentRequest":{ "type":"structure", @@ -1488,18 +1520,18 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id of an Amplify App.

", + "documentation":"

The unique ID of an Amplify app.

", "location":"uri", "locationName":"appId" }, "environmentName":{ "shape":"EnvironmentName", - "documentation":"

Name of a backend environment of an Amplify App.

", + "documentation":"

The name of a backend environment of an Amplify app.

", "location":"uri", "locationName":"environmentName" } }, - "documentation":"

Request structure for delete backend environment request.

" + "documentation":"

The request structure for the delete backend environment request.

" }, "DeleteBackendEnvironmentResult":{ "type":"structure", @@ -1507,10 +1539,10 @@ "members":{ "backendEnvironment":{ "shape":"BackendEnvironment", - "documentation":"

Backend environment structure for an Amplify App.

" + "documentation":"

Describes the backend environment for an Amplify app.

" } }, - "documentation":"

Result structure of a delete backend environment result.

" + "documentation":"

The result structure of the delete backend environment result.

" }, "DeleteBranchRequest":{ "type":"structure", @@ -1521,18 +1553,18 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for the branch.

", + "documentation":"

The name for the branch.

", "location":"uri", "locationName":"branchName" } }, - "documentation":"

Request structure for delete branch request.

" + "documentation":"

The request structure for the delete branch request.

" }, "DeleteBranchResult":{ "type":"structure", @@ -1540,10 +1572,10 @@ "members":{ "branch":{ "shape":"Branch", - "documentation":"

Branch structure for an Amplify App.

" + "documentation":"

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

" } }, - "documentation":"

Result structure for delete branch request.

" + "documentation":"

The result structure for the delete branch request.

" }, "DeleteDomainAssociationRequest":{ "type":"structure", @@ -1554,18 +1586,18 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique id for an Amplify app.

", "location":"uri", "locationName":"appId" }, "domainName":{ "shape":"DomainName", - "documentation":"

Name of the domain.

", + "documentation":"

The name of the domain.

", "location":"uri", "locationName":"domainName" } }, - "documentation":"

Request structure for the delete Domain Association request.

" + "documentation":"

The request structure for the delete domain association request.

" }, "DeleteDomainAssociationResult":{ "type":"structure", @@ -1584,24 +1616,24 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for the branch, for the Job.

", + "documentation":"

The name for the branch, for the job.

", "location":"uri", "locationName":"branchName" }, "jobId":{ "shape":"JobId", - "documentation":"

Unique Id for the Job.

", + "documentation":"

The unique ID for the job.

", "location":"uri", "locationName":"jobId" } }, - "documentation":"

Request structure for delete job request.

" + "documentation":"

The request structure for the delete job request.

" }, "DeleteJobResult":{ "type":"structure", @@ -1609,7 +1641,7 @@ "members":{ "jobSummary":{"shape":"JobSummary"} }, - "documentation":"

Result structure for the delete job request.

" + "documentation":"

The result structure for the delete job request.

" }, "DeleteWebhookRequest":{ "type":"structure", @@ -1617,12 +1649,12 @@ "members":{ "webhookId":{ "shape":"WebhookId", - "documentation":"

Unique Id for a webhook.

", + "documentation":"

The unique ID for a webhook.

", "location":"uri", "locationName":"webhookId" } }, - "documentation":"

Request structure for the delete webhook request.

" + "documentation":"

The request structure for the delete webhook request.

" }, "DeleteWebhookResult":{ "type":"structure", @@ -1630,17 +1662,17 @@ "members":{ "webhook":{ "shape":"Webhook", - "documentation":"

Webhook structure.

" + "documentation":"

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

" } }, - "documentation":"

Result structure for the delete webhook request.

" + "documentation":"

The result structure for the delete webhook request.

" }, "DependentServiceFailureException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, - "documentation":"

Exception thrown when an operation fails due to a dependent service throwing an exception.

", + "documentation":"

An operation failed because a dependent service threw an exception.

", "error":{"httpStatusCode":503}, "exception":true }, @@ -1670,34 +1702,42 @@ "members":{ "domainAssociationArn":{ "shape":"DomainAssociationArn", - "documentation":"

ARN for the Domain Association.

" + "documentation":"

The Amazon Resource Name (ARN) for the domain association.

" }, "domainName":{ "shape":"DomainName", - "documentation":"

Name of the domain.

" + "documentation":"

The name of the domain.

" }, "enableAutoSubDomain":{ "shape":"EnableAutoSubDomain", - "documentation":"

Enables automated creation of Subdomains for branches. (Currently not supported)

" + "documentation":"

Enables the automated creation of subdomains for branches.

" + }, + "autoSubDomainCreationPatterns":{ + "shape":"AutoSubDomainCreationPatterns", + "documentation":"

Sets branch patterns for automatic subdomain creation.

" + }, + "autoSubDomainIAMRole":{ + "shape":"AutoSubDomainIAMRole", + "documentation":"

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

" }, "domainStatus":{ "shape":"DomainStatus", - "documentation":"

Status fo the Domain Association.

" + "documentation":"

The current status of the domain association.

" }, "statusReason":{ "shape":"StatusReason", - "documentation":"

Reason for the current status of the Domain Association.

" + "documentation":"

The reason for the current status of the domain association.

" }, "certificateVerificationDNSRecord":{ "shape":"CertificateVerificationDNSRecord", - "documentation":"

DNS Record for certificate verification.

" + "documentation":"

The DNS record for certificate verification.

" }, "subDomains":{ "shape":"SubDomains", - "documentation":"

Subdomains for the Domain Association.

" + "documentation":"

The subdomains for the domain association.

" } }, - "documentation":"

Structure for Domain Association, which associates a custom domain with an Amplify App.

" + "documentation":"

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

" }, "DomainAssociationArn":{ "type":"string", @@ -1734,6 +1774,7 @@ "EnableAutoSubDomain":{"type":"boolean"}, "EnableBasicAuth":{"type":"boolean"}, "EnableBranchAutoBuild":{"type":"boolean"}, + "EnableBranchAutoDeletion":{"type":"boolean"}, "EnableNotification":{"type":"boolean"}, "EnablePullRequestPreview":{"type":"boolean"}, "EndTime":{"type":"timestamp"}, @@ -1786,34 +1827,34 @@ "members":{ "startTime":{ "shape":"StartTime", - "documentation":"

The time at which the logs should start, inclusive.

" + "documentation":"

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

" }, "endTime":{ "shape":"EndTime", - "documentation":"

The time at which the logs should end, inclusive.

" + "documentation":"

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

" }, "domainName":{ "shape":"DomainName", - "documentation":"

Name of the domain.

" + "documentation":"

The name of the domain.

" }, "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" } }, - "documentation":"

Request structure for the generate access logs request.

" + "documentation":"

The request structure for the generate access logs request.

" }, "GenerateAccessLogsResult":{ "type":"structure", "members":{ "logUrl":{ "shape":"LogUrl", - "documentation":"

Pre-signed URL for the requested access logs.

" + "documentation":"

The pre-signed URL for the requested access logs.

" } }, - "documentation":"

Result structure for the generate access logs request.

" + "documentation":"

The result structure for the generate access logs request.

" }, "GetAppRequest":{ "type":"structure", @@ -1821,12 +1862,12 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" } }, - "documentation":"

Request structure for get App request.

" + "documentation":"

The request structure for the get app request.

" }, "GetAppResult":{ "type":"structure", @@ -1841,12 +1882,12 @@ "members":{ "artifactId":{ "shape":"ArtifactId", - "documentation":"

Unique Id for a artifact.

", + "documentation":"

The unique ID for an artifact.

", "location":"uri", "locationName":"artifactId" } }, - "documentation":"

Request structure for the get artifact request.

" + "documentation":"

Returns the request structure for the get artifact request.

" }, "GetArtifactUrlResult":{ "type":"structure", @@ -1857,14 +1898,14 @@ "members":{ "artifactId":{ "shape":"ArtifactId", - "documentation":"

Unique Id for a artifact.

" + "documentation":"

The unique ID for an artifact.

" }, "artifactUrl":{ "shape":"ArtifactUrl", - "documentation":"

Presigned url for the artifact.

" + "documentation":"

The presigned URL for the artifact.

" } }, - "documentation":"

Result structure for the get artifact request.

" + "documentation":"

Returns the result structure for the get artifact request.

" }, "GetBackendEnvironmentRequest":{ "type":"structure", @@ -1875,18 +1916,18 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique id for an Amplify app.

", "location":"uri", "locationName":"appId" }, "environmentName":{ "shape":"EnvironmentName", - "documentation":"

Name for the backend environment.

", + "documentation":"

The name for the backend environment.

", "location":"uri", "locationName":"environmentName" } }, - "documentation":"

Request structure for get backend environment request.

" + "documentation":"

The request structure for the get backend environment request.

" }, "GetBackendEnvironmentResult":{ "type":"structure", @@ -1894,10 +1935,10 @@ "members":{ "backendEnvironment":{ "shape":"BackendEnvironment", - "documentation":"

Backend environment structure for an an Amplify App.

" + "documentation":"

Describes the backend environment for an Amplify app.

" } }, - "documentation":"

Result structure for get backend environment result.

" + "documentation":"

The result structure for the get backend environment result.

" }, "GetBranchRequest":{ "type":"structure", @@ -1908,18 +1949,18 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for the branch.

", + "documentation":"

The name for the branch.

", "location":"uri", "locationName":"branchName" } }, - "documentation":"

Request structure for get branch request.

" + "documentation":"

The request structure for the get branch request.

" }, "GetBranchResult":{ "type":"structure", @@ -1937,18 +1978,18 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique id for an Amplify app.

", "location":"uri", "locationName":"appId" }, "domainName":{ "shape":"DomainName", - "documentation":"

Name of the domain.

", + "documentation":"

The name of the domain.

", "location":"uri", "locationName":"domainName" } }, - "documentation":"

Request structure for the get Domain Association request.

" + "documentation":"

The request structure for the get domain association request.

" }, "GetDomainAssociationResult":{ "type":"structure", @@ -1956,10 +1997,10 @@ "members":{ "domainAssociation":{ "shape":"DomainAssociation", - "documentation":"

Domain Association structure.

" + "documentation":"

Describes the structure of a domain association, which associates a custom domain with an Amplify app.

" } }, - "documentation":"

Result structure for the get Domain Association request.

" + "documentation":"

The result structure for the get domain association request.

" }, "GetJobRequest":{ "type":"structure", @@ -1971,24 +2012,24 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for the branch, for the Job.

", + "documentation":"

The branch name for the job.

", "location":"uri", "locationName":"branchName" }, "jobId":{ "shape":"JobId", - "documentation":"

Unique Id for the Job.

", + "documentation":"

The unique ID for the job.

", "location":"uri", "locationName":"jobId" } }, - "documentation":"

Request structure for get job request.

" + "documentation":"

The request structure for the get job request.

" }, "GetJobResult":{ "type":"structure", @@ -2003,12 +2044,12 @@ "members":{ "webhookId":{ "shape":"WebhookId", - "documentation":"

Unique Id for a webhook.

", + "documentation":"

The unique ID for a webhook.

", "location":"uri", "locationName":"webhookId" } }, - "documentation":"

Request structure for the get webhook request.

" + "documentation":"

The request structure for the get webhook request.

" }, "GetWebhookResult":{ "type":"structure", @@ -2016,17 +2057,17 @@ "members":{ "webhook":{ "shape":"Webhook", - "documentation":"

Webhook structure.

" + "documentation":"

Describes the structure of a webhook.

" } }, - "documentation":"

Result structure for the get webhook request.

" + "documentation":"

The result structure for the get webhook request.

" }, "InternalFailureException":{ "type":"structure", "members":{ "message":{"shape":"ErrorMessage"} }, - "documentation":"

Exception thrown when the service fails to perform an operation due to an internal issue.

", + "documentation":"

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

", "error":{"httpStatusCode":500}, "exception":true, "fault":true @@ -2040,14 +2081,14 @@ "members":{ "summary":{ "shape":"JobSummary", - "documentation":"

Summary for an execution job for an Amplify App.

" + "documentation":"

Describes the summary for an execution job for an Amplify app.

" }, "steps":{ "shape":"Steps", - "documentation":"

Execution steps for an execution job, for an Amplify App.

" + "documentation":"

The execution steps for an execution job, for an Amplify app.

" } }, - "documentation":"

Structure for an execution job for an Amplify App.

" + "documentation":"

Describes an execution job for an Amplify app.

" }, "JobArn":{ "type":"string", @@ -2092,42 +2133,42 @@ "members":{ "jobArn":{ "shape":"JobArn", - "documentation":"

Arn for the Job.

" + "documentation":"

The Amazon Resource Name (ARN) for the job.

" }, "jobId":{ "shape":"JobId", - "documentation":"

Unique Id for the Job.

" + "documentation":"

The unique ID for the job.

" }, "commitId":{ "shape":"CommitId", - "documentation":"

Commit Id from 3rd party repository provider for the Job.

" + "documentation":"

The commit ID from a third-party repository provider for the job.

" }, "commitMessage":{ "shape":"CommitMessage", - "documentation":"

Commit message from 3rd party repository provider for the Job.

" + "documentation":"

The commit message from a third-party repository provider for the job.

" }, "commitTime":{ "shape":"CommitTime", - "documentation":"

Commit date / time for the Job.

" + "documentation":"

The commit date and time for the job.

" }, "startTime":{ "shape":"StartTime", - "documentation":"

Start date / time for the Job.

" + "documentation":"

The start date and time for the job.

" }, "status":{ "shape":"JobStatus", - "documentation":"

Status for the Job.

" + "documentation":"

The current status for the job.

" }, "endTime":{ "shape":"EndTime", - "documentation":"

End date / time for the Job.

" + "documentation":"

The end date and time for the job.

" }, "jobType":{ "shape":"JobType", - "documentation":"

Type for the Job. \\n \"RELEASE\": Manually released from source by using StartJob API. \"RETRY\": Manually retried by using StartJob API. \"WEB_HOOK\": Automatically triggered by WebHooks.

" + "documentation":"

The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks.

" } }, - "documentation":"

Structure for the summary of a Job.

" + "documentation":"

Describes the summary for an execution job for an Amplify app.

" }, "JobType":{ "type":"string", @@ -2145,7 +2186,7 @@ "members":{ "message":{"shape":"ErrorMessage"} }, - "documentation":"

Exception thrown when a resource could not be created because of service limits.

", + "documentation":"

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

", "error":{"httpStatusCode":429}, "exception":true }, @@ -2154,18 +2195,18 @@ "members":{ "nextToken":{ "shape":"NextToken", - "documentation":"

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

", + "documentation":"

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

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"

Maximum number of records to list in a single response.

", + "documentation":"

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

", "location":"querystring", "locationName":"maxResults" } }, - "documentation":"

Request structure for an Amplify App list request.

" + "documentation":"

The request structure for the list apps request.

" }, "ListAppsResult":{ "type":"structure", @@ -2173,14 +2214,14 @@ "members":{ "apps":{ "shape":"Apps", - "documentation":"

List of Amplify Apps.

" + "documentation":"

A list of Amplify apps.

" }, "nextToken":{ "shape":"NextToken", - "documentation":"

Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects.

" + "documentation":"

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

" } }, - "documentation":"

Result structure for an Amplify App list request.

" + "documentation":"

The result structure for an Amplify app list request.

" }, "ListArtifactsRequest":{ "type":"structure", @@ -2192,36 +2233,36 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for a branch, part of an Amplify App.

", + "documentation":"

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

", "location":"uri", "locationName":"branchName" }, "jobId":{ "shape":"JobId", - "documentation":"

Unique Id for an Job.

", + "documentation":"

The unique ID for a job.

", "location":"uri", "locationName":"jobId" }, "nextToken":{ "shape":"NextToken", - "documentation":"

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

", + "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"

Maximum number of records to list in a single response.

", + "documentation":"

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

", "location":"querystring", "locationName":"maxResults" } }, - "documentation":"

Request structure for the list artifacts request.

" + "documentation":"

Describes the request structure for the list artifacts request.

" }, "ListArtifactsResult":{ "type":"structure", @@ -2229,14 +2270,14 @@ "members":{ "artifacts":{ "shape":"Artifacts", - "documentation":"

List of artifacts.

" + "documentation":"

A list of artifacts.

" }, "nextToken":{ "shape":"NextToken", - "documentation":"

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

" + "documentation":"

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

" } }, - "documentation":"

Result structure for the list artifacts request.

" + "documentation":"

The result structure for the list artifacts request.

" }, "ListBackendEnvironmentsRequest":{ "type":"structure", @@ -2244,28 +2285,30 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "environmentName":{ "shape":"EnvironmentName", - "documentation":"

Name of the backend environment

" + "documentation":"

The name of the backend environment

", + "location":"querystring", + "locationName":"environmentName" }, "nextToken":{ "shape":"NextToken", - "documentation":"

Pagination token. Set to null to start listing backen environments from start. If a non-null pagination token is returned in a result, then pass its value in here to list more backend environments.

", + "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"

Maximum number of records to list in a single response.

", + "documentation":"

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

", "location":"querystring", "locationName":"maxResults" } }, - "documentation":"

Request structure for list backend environments request.

" + "documentation":"

The request structure for the list backend environments request.

" }, "ListBackendEnvironmentsResult":{ "type":"structure", @@ -2273,14 +2316,14 @@ "members":{ "backendEnvironments":{ "shape":"BackendEnvironments", - "documentation":"

List of backend environments for an Amplify App.

" + "documentation":"

The list of backend environments for an Amplify app.

" }, "nextToken":{ "shape":"NextToken", - "documentation":"

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

" + "documentation":"

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

" } }, - "documentation":"

Result structure for list backend environments result.

" + "documentation":"

The result structure for the list backend environments result.

" }, "ListBranchesRequest":{ "type":"structure", @@ -2288,24 +2331,24 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "nextToken":{ "shape":"NextToken", - "documentation":"

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

", + "documentation":"

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

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"

Maximum number of records to list in a single response.

", + "documentation":"

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

", "location":"querystring", "locationName":"maxResults" } }, - "documentation":"

Request structure for list branches request.

" + "documentation":"

The request structure for the list branches request.

" }, "ListBranchesResult":{ "type":"structure", @@ -2313,14 +2356,14 @@ "members":{ "branches":{ "shape":"Branches", - "documentation":"

List of branches for an Amplify App.

" + "documentation":"

A list of branches for an Amplify app.

" }, "nextToken":{ "shape":"NextToken", - "documentation":"

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

" + "documentation":"

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

" } }, - "documentation":"

Result structure for list branches request.

" + "documentation":"

The result structure for the list branches request.

" }, "ListDomainAssociationsRequest":{ "type":"structure", @@ -2328,24 +2371,24 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "nextToken":{ "shape":"NextToken", - "documentation":"

Pagination token. Set to null to start listing Apps from start. If non-null pagination token is returned in a result, then pass its value in here to list more projects.

", + "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"

Maximum number of records to list in a single response.

", + "documentation":"

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

", "location":"querystring", "locationName":"maxResults" } }, - "documentation":"

Request structure for the list Domain Associations request.

" + "documentation":"

The request structure for the list domain associations request.

" }, "ListDomainAssociationsResult":{ "type":"structure", @@ -2353,14 +2396,14 @@ "members":{ "domainAssociations":{ "shape":"DomainAssociations", - "documentation":"

List of Domain Associations.

" + "documentation":"

A list of domain associations.

" }, "nextToken":{ "shape":"NextToken", - "documentation":"

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

" + "documentation":"

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

" } }, - "documentation":"

Result structure for the list Domain Association request.

" + "documentation":"

The result structure for the list domain association request.

" }, "ListJobsRequest":{ "type":"structure", @@ -2371,30 +2414,30 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for a branch.

", + "documentation":"

The name for a branch.

", "location":"uri", "locationName":"branchName" }, "nextToken":{ "shape":"NextToken", - "documentation":"

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

", + "documentation":"

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.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"

Maximum number of records to list in a single response.

", + "documentation":"

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

", "location":"querystring", "locationName":"maxResults" } }, - "documentation":"

Request structure for list job request.

" + "documentation":"

The request structure for the list jobs request.

" }, "ListJobsResult":{ "type":"structure", @@ -2402,14 +2445,14 @@ "members":{ "jobSummaries":{ "shape":"JobSummaries", - "documentation":"

Result structure for list job result request.

" + "documentation":"

The result structure for the list job result request.

" }, "nextToken":{ "shape":"NextToken", - "documentation":"

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

" + "documentation":"

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

" } }, - "documentation":"

Maximum number of records to list in a single response.

" + "documentation":"

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

" }, "ListTagsForResourceRequest":{ "type":"structure", @@ -2417,22 +2460,22 @@ "members":{ "resourceArn":{ "shape":"ResourceArn", - "documentation":"

Resource arn used to list tags.

", + "documentation":"

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

", "location":"uri", "locationName":"resourceArn" } }, - "documentation":"

Request structure used to list tags for resource.

" + "documentation":"

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

" }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "tags":{ "shape":"TagMap", - "documentation":"

Tags result for response.

" + "documentation":"

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

" } }, - "documentation":"

Response for list tags.

" + "documentation":"

The response for the list tags for resource request.

" }, "ListWebhooksRequest":{ "type":"structure", @@ -2440,24 +2483,24 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "nextToken":{ "shape":"NextToken", - "documentation":"

Pagination token. Set to null to start listing webhooks from start. If non-null pagination token is returned in a result, then pass its value in here to list more webhooks.

", + "documentation":"

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

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"MaxResults", - "documentation":"

Maximum number of records to list in a single response.

", + "documentation":"

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

", "location":"querystring", "locationName":"maxResults" } }, - "documentation":"

Request structure for the list webhooks request.

" + "documentation":"

The request structure for the list webhooks request.

" }, "ListWebhooksResult":{ "type":"structure", @@ -2465,14 +2508,14 @@ "members":{ "webhooks":{ "shape":"Webhooks", - "documentation":"

List of webhooks.

" + "documentation":"

A list of webhooks.

" }, "nextToken":{ "shape":"NextToken", - "documentation":"

Pagination token. If non-null pagination token is returned in a result, then pass its value in another request to fetch more entries.

" + "documentation":"

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

" } }, - "documentation":"

Result structure for the list webhooks request.

" + "documentation":"

The result structure for the list webhooks request.

" }, "LogUrl":{ "type":"string", @@ -2501,13 +2544,14 @@ "members":{ "message":{"shape":"ErrorMessage"} }, - "documentation":"

Exception thrown when an entity has not been found during an operation.

", + "documentation":"

An entity was not found during an operation.

", "error":{"httpStatusCode":404}, "exception":true }, "OauthToken":{ "type":"string", - "max":100 + "max":100, + "sensitive":true }, "Platform":{ "type":"string", @@ -2518,22 +2562,22 @@ "members":{ "lastDeployTime":{ "shape":"LastDeployTime", - "documentation":"

Last Deploy Time of Production Branch.

" + "documentation":"

The last deploy time of the production branch.

" }, "status":{ "shape":"Status", - "documentation":"

Status of Production Branch.

" + "documentation":"

The status of the production branch.

" }, "thumbnailUrl":{ "shape":"ThumbnailUrl", - "documentation":"

Thumbnail URL for Production Branch.

" + "documentation":"

The thumbnail URL for the production branch.

" }, "branchName":{ "shape":"BranchName", - "documentation":"

Branch Name for Production Branch.

" + "documentation":"

The branch name for the production branch.

" } }, - "documentation":"

Structure with Production Branch information.

" + "documentation":"

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

" }, "PullRequestEnvironmentName":{ "type":"string", @@ -2557,7 +2601,7 @@ "code":{"shape":"Code"}, "message":{"shape":"ErrorMessage"} }, - "documentation":"

Exception thrown when an operation fails due to non-existent resource.

", + "documentation":"

An operation failed due to a non-existent resource.

", "error":{"httpStatusCode":404}, "exception":true }, @@ -2604,26 +2648,26 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for the branch, for the Job.

", + "documentation":"

The name for the branch, for the job.

", "location":"uri", "locationName":"branchName" }, "jobId":{ "shape":"JobId", - "documentation":"

The job id for this deployment, generated by create deployment request.

" + "documentation":"

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

" }, "sourceUrl":{ "shape":"SourceUrl", - "documentation":"

The sourceUrl for this deployment, used when calling start deployment without create deployment. SourceUrl can be any HTTP GET url that is public accessible and downloads a single zip.

" + "documentation":"

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.

" } }, - "documentation":"

Request structure for start a deployment.

" + "documentation":"

The request structure for the start a deployment request.

" }, "StartDeploymentResult":{ "type":"structure", @@ -2631,10 +2675,10 @@ "members":{ "jobSummary":{ "shape":"JobSummary", - "documentation":"

Summary for the Job.

" + "documentation":"

The summary for the job.

" } }, - "documentation":"

Result structure for start a deployment.

" + "documentation":"

The result structure for the start a deployment request.

" }, "StartJobRequest":{ "type":"structure", @@ -2646,42 +2690,42 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for the branch, for the Job.

", + "documentation":"

The branch name for the job.

", "location":"uri", "locationName":"branchName" }, "jobId":{ "shape":"JobId", - "documentation":"

Unique Id for an existing job. Required for \"RETRY\" JobType.

" + "documentation":"

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

" }, "jobType":{ "shape":"JobType", - "documentation":"

Type for the Job. Available JobTypes are: \\n \"RELEASE\": Start a new job with the latest change from the specified branch. Only available for apps that have connected to a repository. \"RETRY\": Retry an existing job. JobId is required for this type of job.

" + "documentation":"

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.

" }, "jobReason":{ "shape":"JobReason", - "documentation":"

Descriptive reason for starting this job.

" + "documentation":"

A descriptive reason for starting this job.

" }, "commitId":{ "shape":"CommitId", - "documentation":"

Commit Id from 3rd party repository provider for the Job.

" + "documentation":"

The commit ID from a third-party repository provider for the job.

" }, "commitMessage":{ "shape":"CommitMessage", - "documentation":"

Commit message from 3rd party repository provider for the Job.

" + "documentation":"

The commit message from a third-party repository provider for the job.

" }, "commitTime":{ "shape":"CommitTime", - "documentation":"

Commit date / time for the Job.

" + "documentation":"

The commit date and time for the job.

" } }, - "documentation":"

Request structure for Start job request.

" + "documentation":"

The request structure for the start job request.

" }, "StartJobResult":{ "type":"structure", @@ -2689,10 +2733,10 @@ "members":{ "jobSummary":{ "shape":"JobSummary", - "documentation":"

Summary for the Job.

" + "documentation":"

The summary for the job.

" } }, - "documentation":"

Result structure for run job request.

" + "documentation":"

The result structure for the run job request.

" }, "StartTime":{"type":"timestamp"}, "Status":{ @@ -2715,50 +2759,50 @@ "members":{ "stepName":{ "shape":"StepName", - "documentation":"

Name of the execution step.

" + "documentation":"

The name of the execution step.

" }, "startTime":{ "shape":"StartTime", - "documentation":"

Start date/ time of the execution step.

" + "documentation":"

The start date and time of the execution step.

" }, "status":{ "shape":"JobStatus", - "documentation":"

Status of the execution step.

" + "documentation":"

The status of the execution step.

" }, "endTime":{ "shape":"EndTime", - "documentation":"

End date/ time of the execution step.

" + "documentation":"

The end date and time of the execution step.

" }, "logUrl":{ "shape":"LogUrl", - "documentation":"

URL to the logs for the execution step.

" + "documentation":"

The URL to the logs for the execution step.

" }, "artifactsUrl":{ "shape":"ArtifactsUrl", - "documentation":"

URL to the artifact for the execution step.

" + "documentation":"

The URL to the artifact for the execution step.

" }, "testArtifactsUrl":{ "shape":"TestArtifactsUrl", - "documentation":"

URL to the test artifact for the execution step.

" + "documentation":"

The URL to the test artifact for the execution step.

" }, "testConfigUrl":{ "shape":"TestConfigUrl", - "documentation":"

URL to the test config for the execution step.

" + "documentation":"

The URL to the test configuration for the execution step.

" }, "screenshots":{ "shape":"Screenshots", - "documentation":"

List of screenshot URLs for the execution step, if relevant.

" + "documentation":"

The list of screenshot URLs for the execution step, if relevant.

" }, "statusReason":{ "shape":"StatusReason", - "documentation":"

The reason for current step status.

" + "documentation":"

The reason for the current step status.

" }, "context":{ "shape":"Context", - "documentation":"

The context for current step, will include build image if step is build.

" + "documentation":"

The context for the current step. Includes a build image if the step is build.

" } }, - "documentation":"

Structure for an execution step for an execution job, for an Amplify App.

" + "documentation":"

Describes an execution step, for an execution job, for an Amplify app.

" }, "StepName":{ "type":"string", @@ -2778,24 +2822,24 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for the branch, for the Job.

", + "documentation":"

The name for the branch, for the job.

", "location":"uri", "locationName":"branchName" }, "jobId":{ "shape":"JobId", - "documentation":"

Unique Id for the Job.

", + "documentation":"

The unique id for the job.

", "location":"uri", "locationName":"jobId" } }, - "documentation":"

Request structure for stop job request.

" + "documentation":"

The request structure for the stop job request.

" }, "StopJobResult":{ "type":"structure", @@ -2803,10 +2847,10 @@ "members":{ "jobSummary":{ "shape":"JobSummary", - "documentation":"

Summary for the Job.

" + "documentation":"

The summary for the job.

" } }, - "documentation":"

Result structure for the stop job request.

" + "documentation":"

The result structure for the stop job request.

" }, "SubDomain":{ "type":"structure", @@ -2818,18 +2862,18 @@ "members":{ "subDomainSetting":{ "shape":"SubDomainSetting", - "documentation":"

Setting structure for the Subdomain.

" + "documentation":"

Describes the settings for the subdomain.

" }, "verified":{ "shape":"Verified", - "documentation":"

Verified status of the Subdomain

" + "documentation":"

The verified status of the subdomain

" }, "dnsRecord":{ "shape":"DNSRecord", - "documentation":"

DNS record for the Subdomain.

" + "documentation":"

The DNS record for the subdomain.

" } }, - "documentation":"

Subdomain for the Domain Association.

" + "documentation":"

The subdomain for the domain association.

" }, "SubDomainSetting":{ "type":"structure", @@ -2840,14 +2884,14 @@ "members":{ "prefix":{ "shape":"DomainPrefix", - "documentation":"

Prefix setting for the Subdomain.

" + "documentation":"

The prefix setting for the subdomain.

" }, "branchName":{ "shape":"BranchName", - "documentation":"

Branch name setting for the Subdomain.

" + "documentation":"

The branch name setting for the subdomain.

" } }, - "documentation":"

Setting for the Subdomain.

" + "documentation":"

Describes the settings for the subdomain.

" }, "SubDomainSettings":{ "type":"list", @@ -2861,7 +2905,7 @@ }, "TTL":{ "type":"string", - "documentation":"

The content TTL for the website in seconds.

" + "documentation":"

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

" }, "TagKey":{ "type":"string", @@ -2891,22 +2935,22 @@ "members":{ "resourceArn":{ "shape":"ResourceArn", - "documentation":"

Resource arn used to tag resource.

", + "documentation":"

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

", "location":"uri", "locationName":"resourceArn" }, "tags":{ "shape":"TagMap", - "documentation":"

Tags used to tag resource.

" + "documentation":"

The tags used to tag the resource.

" } }, - "documentation":"

Request structure used to tag resource.

" + "documentation":"

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

" }, "TagResourceResponse":{ "type":"structure", "members":{ }, - "documentation":"

Response for tag resource.

" + "documentation":"

The response for the tag resource request.

" }, "TagValue":{ "type":"string", @@ -2943,7 +2987,7 @@ "members":{ "message":{"shape":"ErrorMessage"} }, - "documentation":"

Exception thrown when an operation fails due to a lack of access.

", + "documentation":"

An operation failed due to a lack of access.

", "error":{"httpStatusCode":401}, "exception":true }, @@ -2956,24 +3000,24 @@ "members":{ "resourceArn":{ "shape":"ResourceArn", - "documentation":"

Resource arn used to untag resource.

", + "documentation":"

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

", "location":"uri", "locationName":"resourceArn" }, "tagKeys":{ "shape":"TagKeyList", - "documentation":"

Tag keys used to untag resource.

", + "documentation":"

The tag keys to use to untag a resource.

", "location":"querystring", "locationName":"tagKeys" } }, - "documentation":"

Request structure used to untag resource.

" + "documentation":"

The request structure for the untag resource request.

" }, "UntagResourceResponse":{ "type":"structure", "members":{ }, - "documentation":"

Response for untag resource.

" + "documentation":"

The response for the untag resource request.

" }, "UpdateAppRequest":{ "type":"structure", @@ -2981,76 +3025,80 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "name":{ "shape":"Name", - "documentation":"

Name for an Amplify App.

" + "documentation":"

The name for an Amplify app.

" }, "description":{ "shape":"Description", - "documentation":"

Description for an Amplify App.

" + "documentation":"

The description for an Amplify app.

" }, "platform":{ "shape":"Platform", - "documentation":"

Platform for an Amplify App.

" + "documentation":"

The platform for an Amplify app.

" }, "iamServiceRoleArn":{ "shape":"ServiceRoleArn", - "documentation":"

IAM service role for an Amplify App.

" + "documentation":"

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

" }, "environmentVariables":{ "shape":"EnvironmentVariables", - "documentation":"

Environment Variables for an Amplify App.

" + "documentation":"

The environment variables for an Amplify app.

" }, "enableBranchAutoBuild":{ "shape":"EnableAutoBuild", - "documentation":"

Enables branch auto-building for an Amplify App.

" + "documentation":"

Enables branch auto-building for an Amplify app.

" + }, + "enableBranchAutoDeletion":{ + "shape":"EnableBranchAutoDeletion", + "documentation":"

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

" }, "enableBasicAuth":{ "shape":"EnableBasicAuth", - "documentation":"

Enables Basic Authorization for an Amplify App.

" + "documentation":"

Enables basic authorization for an Amplify app.

" }, "basicAuthCredentials":{ "shape":"BasicAuthCredentials", - "documentation":"

Basic Authorization credentials for an Amplify App.

" + "documentation":"

The basic authorization credentials for an Amplify app.

" }, "customRules":{ "shape":"CustomRules", - "documentation":"

Custom redirect / rewrite rules for an Amplify App.

" + "documentation":"

The custom redirect and rewrite rules for an Amplify app.

" }, "buildSpec":{ "shape":"BuildSpec", - "documentation":"

BuildSpec for an Amplify App.

" + "documentation":"

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

" }, "enableAutoBranchCreation":{ "shape":"EnableAutoBranchCreation", - "documentation":"

Enables automated branch creation for the Amplify App.

" + "documentation":"

Enables automated branch creation for the Amplify app.

" }, "autoBranchCreationPatterns":{ "shape":"AutoBranchCreationPatterns", - "documentation":"

Automated branch creation glob patterns for the Amplify App.

" + "documentation":"

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

" }, "autoBranchCreationConfig":{ "shape":"AutoBranchCreationConfig", - "documentation":"

Automated branch creation branchConfig for the Amplify App.

" + "documentation":"

The automated branch creation configuration for the Amplify app.

" }, "repository":{ "shape":"Repository", - "documentation":"

Repository for an Amplify App

" + "documentation":"

The name of the repository for an Amplify app

" }, "oauthToken":{ "shape":"OauthToken", - "documentation":"

OAuth token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. OAuth token is not stored.

" + "documentation":"

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.

" }, "accessToken":{ "shape":"AccessToken", - "documentation":"

Personal Access token for 3rd party source control system for an Amplify App, used to create webhook and read-only deploy key. Token is not stored.

" + "documentation":"

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.

" } }, - "documentation":"

Request structure for update App request.

" + "documentation":"

The request structure for the update app request.

" }, "UpdateAppResult":{ "type":"structure", @@ -3058,10 +3106,10 @@ "members":{ "app":{ "shape":"App", - "documentation":"

App structure for the updated App.

" + "documentation":"

Represents the updated Amplify app.

" } }, - "documentation":"

Result structure for an Amplify App update request.

" + "documentation":"

The result structure for an Amplify app update request.

" }, "UpdateBranchRequest":{ "type":"structure", @@ -3072,27 +3120,27 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for the branch.

", + "documentation":"

The name for the branch.

", "location":"uri", "locationName":"branchName" }, "description":{ "shape":"Description", - "documentation":"

Description for the branch.

" + "documentation":"

The description for the branch.

" }, "framework":{ "shape":"Framework", - "documentation":"

Framework for the branch.

" + "documentation":"

The framework for the branch.

" }, "stage":{ "shape":"Stage", - "documentation":"

Stage for the branch.

" + "documentation":"

Describes the current stage for the branch.

" }, "enableNotification":{ "shape":"EnableNotification", @@ -3104,42 +3152,42 @@ }, "environmentVariables":{ "shape":"EnvironmentVariables", - "documentation":"

Environment Variables for the branch.

" + "documentation":"

The environment variables for the branch.

" }, "basicAuthCredentials":{ "shape":"BasicAuthCredentials", - "documentation":"

Basic Authorization credentials for the branch.

" + "documentation":"

The basic authorization credentials for the branch.

" }, "enableBasicAuth":{ "shape":"EnableBasicAuth", - "documentation":"

Enables Basic Auth for the branch.

" + "documentation":"

Enables basic authorization for the branch.

" }, "buildSpec":{ "shape":"BuildSpec", - "documentation":"

BuildSpec for the branch.

" + "documentation":"

The build specification (build spec) for the branch.

" }, "ttl":{ "shape":"TTL", - "documentation":"

The content TTL for the website in seconds.

" + "documentation":"

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

" }, "displayName":{ "shape":"DisplayName", - "documentation":"

Display name for a branch, will use as the default domain prefix.

" + "documentation":"

The display name for a branch. This is used as the default domain prefix.

" }, "enablePullRequestPreview":{ "shape":"EnablePullRequestPreview", - "documentation":"

Enables Pull Request Preview for this branch.

" + "documentation":"

Enables pull request preview for this branch.

" }, "pullRequestEnvironmentName":{ "shape":"PullRequestEnvironmentName", - "documentation":"

The Amplify Environment name for the pull request.

" + "documentation":"

The Amplify environment name for the pull request.

" }, "backendEnvironmentArn":{ "shape":"BackendEnvironmentArn", - "documentation":"

ARN for a Backend Environment, part of an Amplify App.

" + "documentation":"

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

" } }, - "documentation":"

Request structure for update branch request.

" + "documentation":"

The request structure for the update branch request.

" }, "UpdateBranchResult":{ "type":"structure", @@ -3147,10 +3195,10 @@ "members":{ "branch":{ "shape":"Branch", - "documentation":"

Branch structure for an Amplify App.

" + "documentation":"

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

" } }, - "documentation":"

Result structure for update branch request.

" + "documentation":"

The result structure for the update branch request.

" }, "UpdateDomainAssociationRequest":{ "type":"structure", @@ -3162,26 +3210,34 @@ "members":{ "appId":{ "shape":"AppId", - "documentation":"

Unique Id for an Amplify App.

", + "documentation":"

The unique ID for an Amplify app.

", "location":"uri", "locationName":"appId" }, "domainName":{ "shape":"DomainName", - "documentation":"

Name of the domain.

", + "documentation":"

The name of the domain.

", "location":"uri", "locationName":"domainName" }, "enableAutoSubDomain":{ "shape":"EnableAutoSubDomain", - "documentation":"

Enables automated creation of Subdomains for branches. (Currently not supported)

" + "documentation":"

Enables the automated creation of subdomains for branches.

" }, "subDomainSettings":{ "shape":"SubDomainSettings", - "documentation":"

Setting structure for the Subdomain.

" + "documentation":"

Describes the settings for the subdomain.

" + }, + "autoSubDomainCreationPatterns":{ + "shape":"AutoSubDomainCreationPatterns", + "documentation":"

Sets the branch patterns for automatic subdomain creation.

" + }, + "autoSubDomainIAMRole":{ + "shape":"AutoSubDomainIAMRole", + "documentation":"

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

" } }, - "documentation":"

Request structure for update Domain Association request.

" + "documentation":"

The request structure for the update domain association request.

" }, "UpdateDomainAssociationResult":{ "type":"structure", @@ -3189,10 +3245,10 @@ "members":{ "domainAssociation":{ "shape":"DomainAssociation", - "documentation":"

Domain Association structure.

" + "documentation":"

Describes a domain association, which associates a custom domain with an Amplify app.

" } }, - "documentation":"

Result structure for the update Domain Association request.

" + "documentation":"

The result structure for the update domain association request.

" }, "UpdateTime":{"type":"timestamp"}, "UpdateWebhookRequest":{ @@ -3201,20 +3257,20 @@ "members":{ "webhookId":{ "shape":"WebhookId", - "documentation":"

Unique Id for a webhook.

", + "documentation":"

The unique ID for a webhook.

", "location":"uri", "locationName":"webhookId" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for a branch, part of an Amplify App.

" + "documentation":"

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

" }, "description":{ "shape":"Description", - "documentation":"

Description for a webhook.

" + "documentation":"

The description for a webhook.

" } }, - "documentation":"

Request structure for update webhook request.

" + "documentation":"

The request structure for the update webhook request.

" }, "UpdateWebhookResult":{ "type":"structure", @@ -3222,10 +3278,10 @@ "members":{ "webhook":{ "shape":"Webhook", - "documentation":"

Webhook structure.

" + "documentation":"

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

" } }, - "documentation":"

Result structure for the update webhook request.

" + "documentation":"

The result structure for the update webhook request.

" }, "UploadUrl":{ "type":"string", @@ -3246,34 +3302,34 @@ "members":{ "webhookArn":{ "shape":"WebhookArn", - "documentation":"

ARN for the webhook.

" + "documentation":"

The Amazon Resource Name (ARN) for the webhook.

" }, "webhookId":{ "shape":"WebhookId", - "documentation":"

Id of the webhook.

" + "documentation":"

The ID of the webhook.

" }, "webhookUrl":{ "shape":"WebhookUrl", - "documentation":"

Url of the webhook.

" + "documentation":"

The URL of the webhook.

" }, "branchName":{ "shape":"BranchName", - "documentation":"

Name for a branch, part of an Amplify App.

" + "documentation":"

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

" }, "description":{ "shape":"Description", - "documentation":"

Description for a webhook.

" + "documentation":"

The description for a webhook.

" }, "createTime":{ "shape":"CreateTime", - "documentation":"

Create date / time for a webhook.

" + "documentation":"

The create date and time for a webhook.

" }, "updateTime":{ "shape":"UpdateTime", - "documentation":"

Update date / time for a webhook.

" + "documentation":"

Updates the date and time for a webhook.

" } }, - "documentation":"

Structure for webhook, which associates a webhook with an Amplify App.

" + "documentation":"

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

" }, "WebhookArn":{ "type":"string", @@ -3292,5 +3348,5 @@ "member":{"shape":"Webhook"} } }, - "documentation":"

Amplify is a fully managed continuous deployment and hosting service for modern web apps.

" + "documentation":"

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

" } diff --git a/botocore/data/appmesh/2019-01-25/paginators-1.json b/botocore/data/appmesh/2019-01-25/paginators-1.json index 88d8fcc7..5a79b5b5 100644 --- a/botocore/data/appmesh/2019-01-25/paginators-1.json +++ b/botocore/data/appmesh/2019-01-25/paginators-1.json @@ -35,6 +35,18 @@ "limit_key": "limit", "output_token": "nextToken", "result_key": "tags" + }, + "ListGatewayRoutes": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "gatewayRoutes" + }, + "ListVirtualGateways": { + "input_token": "nextToken", + "limit_key": "limit", + "output_token": "nextToken", + "result_key": "virtualGateways" } } } diff --git a/botocore/data/appmesh/2019-01-25/service-2.json b/botocore/data/appmesh/2019-01-25/service-2.json index a17b0c56..67766281 100644 --- a/botocore/data/appmesh/2019-01-25/service-2.json +++ b/botocore/data/appmesh/2019-01-25/service-2.json @@ -13,6 +13,48 @@ }, "documentation": "

AWS App Mesh is a service mesh based on the Envoy proxy that makes it easy to monitor and\n control microservices. App Mesh standardizes how your microservices communicate, giving you\n end-to-end visibility and helping to ensure high availability for your applications.

\n

App Mesh gives you consistent visibility and network traffic controls for every\n microservice in an application. You can use App Mesh with AWS Fargate, Amazon ECS, Amazon EKS,\n Kubernetes on AWS, and Amazon EC2.

\n \n

App Mesh supports microservice applications that use service discovery naming for their\n components. For more information about service discovery on Amazon ECS, see Service Discovery in the Amazon Elastic Container Service Developer Guide. Kubernetes\n kube-dns and coredns are supported. For more information,\n see DNS\n for Services and Pods in the Kubernetes documentation.

\n ", "operations": { + "CreateGatewayRoute": { + "name": "CreateGatewayRoute", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes", + "responseCode": 200 + }, + "input": { + "shape": "CreateGatewayRouteInput" + }, + "output": { + "shape": "CreateGatewayRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Creates a gateway route.

\n

A gateway route is attached to a virtual gateway and routes traffic to an existing\n virtual service. If a route matches a request, it can distribute traffic to a target virtual service.

\n

For more information about gateway routes, see Gateway routes.

", + "idempotent": true + }, "CreateMesh": { "name": "CreateMesh", "http": { @@ -97,6 +139,48 @@ "documentation": "

Creates a route that is associated with a virtual router.

\n

You can route several different protocols and define a retry policy for a route.\n Traffic can be routed to one or more virtual nodes.

\n

For more information about routes, see Routes.

", "idempotent": true }, + "CreateVirtualGateway": { + "name": "CreateVirtualGateway", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualGateways", + "responseCode": 200 + }, + "input": { + "shape": "CreateVirtualGatewayInput" + }, + "output": { + "shape": "CreateVirtualGatewayOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Creates a virtual gateway.

\n

A virtual gateway allows resources outside your mesh to communicate to resources that\n are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS\n task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which\n represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself.

\n

For more information about virtual gateways, see Virtual gateways.

", + "idempotent": true + }, "CreateVirtualNode": { "name": "CreateVirtualNode", "http": { @@ -223,6 +307,45 @@ "documentation": "

Creates a virtual service within a service mesh.

\n

A virtual service is an abstraction of a real service that is provided by a virtual node\n directly or indirectly by means of a virtual router. Dependent services call your virtual\n service by its virtualServiceName, and those requests are routed to the\n virtual node or virtual router that is specified as the provider for the virtual\n service.

\n

For more information about virtual services, see Virtual services.

", "idempotent": true }, + "DeleteGatewayRoute": { + "name": "DeleteGatewayRoute", + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes/{gatewayRouteName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteGatewayRouteInput" + }, + "output": { + "shape": "DeleteGatewayRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Deletes an existing gateway route.

", + "idempotent": true + }, "DeleteMesh": { "name": "DeleteMesh", "http": { @@ -301,6 +424,45 @@ "documentation": "

Deletes an existing route.

", "idempotent": true }, + "DeleteVirtualGateway": { + "name": "DeleteVirtualGateway", + "http": { + "method": "DELETE", + "requestUri": "/v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}", + "responseCode": 200 + }, + "input": { + "shape": "DeleteVirtualGatewayInput" + }, + "output": { + "shape": "DeleteVirtualGatewayOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Deletes an existing virtual gateway. You cannot delete a virtual gateway if any gateway\n routes are associated to it.

", + "idempotent": true + }, "DeleteVirtualNode": { "name": "DeleteVirtualNode", "http": { @@ -418,6 +580,41 @@ "documentation": "

Deletes an existing virtual service.

", "idempotent": true }, + "DescribeGatewayRoute": { + "name": "DescribeGatewayRoute", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes/{gatewayRouteName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeGatewayRouteInput" + }, + "output": { + "shape": "DescribeGatewayRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Describes an existing gateway route.

" + }, "DescribeMesh": { "name": "DescribeMesh", "http": { @@ -488,6 +685,41 @@ ], "documentation": "

Describes an existing route.

" }, + "DescribeVirtualGateway": { + "name": "DescribeVirtualGateway", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeVirtualGatewayInput" + }, + "output": { + "shape": "DescribeVirtualGatewayOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Describes an existing virtual gateway.

" + }, "DescribeVirtualNode": { "name": "DescribeVirtualNode", "http": { @@ -593,6 +825,41 @@ ], "documentation": "

Describes an existing virtual service.

" }, + "ListGatewayRoutes": { + "name": "ListGatewayRoutes", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes", + "responseCode": 200 + }, + "input": { + "shape": "ListGatewayRoutesInput" + }, + "output": { + "shape": "ListGatewayRoutesOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Returns a list of existing gateway routes that are associated to a virtual\n gateway.

" + }, "ListMeshes": { "name": "ListMeshes", "http": { @@ -698,6 +965,41 @@ ], "documentation": "

List the tags for an App Mesh resource.

" }, + "ListVirtualGateways": { + "name": "ListVirtualGateways", + "http": { + "method": "GET", + "requestUri": "/v20190125/meshes/{meshName}/virtualGateways", + "responseCode": 200 + }, + "input": { + "shape": "ListVirtualGatewaysInput" + }, + "output": { + "shape": "ListVirtualGatewaysOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Returns a list of existing virtual gateways in a service mesh.

" + }, "ListVirtualNodes": { "name": "ListVirtualNodes", "http": { @@ -878,6 +1180,48 @@ "documentation": "

Deletes specified tags from a resource.

", "idempotent": true }, + "UpdateGatewayRoute": { + "name": "UpdateGatewayRoute", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualGateway/{virtualGatewayName}/gatewayRoutes/{gatewayRouteName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateGatewayRouteInput" + }, + "output": { + "shape": "UpdateGatewayRouteOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Updates an existing gateway route that is associated to a specified virtual gateway in a\n service mesh.

", + "idempotent": true + }, "UpdateMesh": { "name": "UpdateMesh", "http": { @@ -959,6 +1303,48 @@ "documentation": "

Updates an existing route for a specified service mesh and virtual router.

", "idempotent": true }, + "UpdateVirtualGateway": { + "name": "UpdateVirtualGateway", + "http": { + "method": "PUT", + "requestUri": "/v20190125/meshes/{meshName}/virtualGateways/{virtualGatewayName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateVirtualGatewayInput" + }, + "output": { + "shape": "UpdateVirtualGatewayOutput" + }, + "errors": [ + { + "shape": "BadRequestException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ForbiddenException" + }, + { + "shape": "InternalServerErrorException" + }, + { + "shape": "LimitExceededException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "TooManyRequestsException" + } + ], + "documentation": "

Updates an existing virtual gateway in a specified service mesh.

", + "idempotent": true + }, "UpdateVirtualNode": { "name": "UpdateVirtualNode", "http": { @@ -1204,6 +1590,82 @@ }, "documentation": "" }, + "CreateVirtualGatewayInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualGatewayName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to create the virtual gateway in.

", + "location": "uri", + "locationName": "meshName" + }, + "meshOwner": { + "shape": "AccountId", + "documentation": "

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

", + "location": "querystring", + "locationName": "meshOwner" + }, + "spec": { + "shape": "VirtualGatewaySpec", + "documentation": "

The virtual gateway specification to apply.

" + }, + "tags": { + "shape": "TagList", + "documentation": "

Optional metadata that you can apply to the virtual gateway to assist with\n categorization and organization. Each tag consists of a key and an optional value, both of\n which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + }, + "virtualGatewayName": { + "shape": "ResourceName", + "documentation": "

The name to use for the virtual gateway.

" + } + } + }, + "UpdateVirtualGatewayInput": { + "type": "structure", + "required": [ + "meshName", + "spec", + "virtualGatewayName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the virtual gateway resides in.

", + "location": "uri", + "locationName": "meshName" + }, + "meshOwner": { + "shape": "AccountId", + "documentation": "

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

", + "location": "querystring", + "locationName": "meshOwner" + }, + "spec": { + "shape": "VirtualGatewaySpec", + "documentation": "

The new virtual gateway specification to apply. This overwrites the existing\n data.

" + }, + "virtualGatewayName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual gateway to update.

", + "location": "uri", + "locationName": "virtualGatewayName" + } + } + }, "ResourceMetadata": { "type": "structure", "required": [ @@ -1242,7 +1704,7 @@ }, "version": { "shape": "Long", - "documentation": "

The version of the resource. Resources are created at version 1, and this version is\n incremented each time that they're updated.

" + "documentation": "

The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

" } }, "documentation": "

An object that represents metadata for a resource.

" @@ -1325,6 +1787,19 @@ "senderFault": true } }, + "HttpGatewayRouteMatch": { + "type": "structure", + "required": [ + "prefix" + ], + "members": { + "prefix": { + "shape": "String", + "documentation": "

Specifies the path to match requests with. This parameter must always start with\n /, which by itself matches all requests to the virtual service name. You\n can also match for path-based routing of requests. For example, if your virtual service\n name is my-service.local and you want the route to match requests to\n my-service.local/metrics, your prefix should be\n /metrics.

" + } + }, + "documentation": "

An object that represents the criteria for determining a request match.

" + }, "GrpcRouteMetadataList": { "type": "list", "member": { @@ -1382,6 +1857,12 @@ }, "documentation": "

An object that represents the health check policy for a virtual node's listener.

" }, + "VirtualGatewayHealthCheckTimeoutMillis": { + "type": "long", + "box": true, + "min": 2000, + "max": 60000 + }, "EgressFilter": { "type": "structure", "required": [ @@ -1411,15 +1892,54 @@ }, "documentation": "

An object that represents a client policy.

" }, + "VirtualGatewayHealthCheckIntervalMillis": { + "type": "long", + "box": true, + "min": 5000, + "max": 300000 + }, "Boolean": { "type": "boolean", "box": true }, + "VirtualGatewaySpec": { + "type": "structure", + "required": [ + "listeners" + ], + "members": { + "backendDefaults": { + "shape": "VirtualGatewayBackendDefaults", + "documentation": "

A reference to an object that represents the defaults for backends.

" + }, + "listeners": { + "shape": "VirtualGatewayListeners", + "documentation": "

The listeners that the mesh endpoint is expected to receive inbound traffic from. You\n can specify one listener.

" + }, + "logging": { + "shape": "VirtualGatewayLogging" + } + }, + "documentation": "

An object that represents the specification of a service mesh resource.

" + }, "HttpRetryPolicyEvent": { "type": "string", "min": 1, "max": 25 }, + "VirtualGatewayFileAccessLog": { + "type": "structure", + "required": [ + "path" + ], + "members": { + "path": { + "shape": "FilePath", + "documentation": "

The file path to write access logs to. You can use /dev/stdout to send\n access logs to standard out and configure your Envoy container to use a log driver, such as\n awslogs, to export the access logs to a log storage service such as Amazon\n CloudWatch Logs. You can also specify a path in the Envoy container's file system to write\n the files to disk.

" + } + }, + "documentation": "

An object that represents an access log file.

" + }, "DescribeVirtualServiceOutput": { "type": "structure", "required": [ @@ -1434,6 +1954,52 @@ "documentation": "", "payload": "virtualService" }, + "CreateGatewayRouteInput": { + "type": "structure", + "required": [ + "gatewayRouteName", + "meshName", + "spec", + "virtualGatewayName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "gatewayRouteName": { + "shape": "ResourceName", + "documentation": "

The name to use for the gateway route.

" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to create the gateway route in.

", + "location": "uri", + "locationName": "meshName" + }, + "meshOwner": { + "shape": "AccountId", + "documentation": "

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then\n the account that you specify must share the mesh with your account before you can create \n the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

", + "location": "querystring", + "locationName": "meshOwner" + }, + "spec": { + "shape": "GatewayRouteSpec", + "documentation": "

The gateway route specification to apply.

" + }, + "tags": { + "shape": "TagList", + "documentation": "

Optional metadata that you can apply to the gateway route to assist with categorization\n and organization. Each tag consists of a key and an optional value, both of which you\n define. Tag keys can have a maximum character length of 128 characters, and tag values can have\n a maximum length of 256 characters.

" + }, + "virtualGatewayName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual gateway to associate the gateway route with. If the virtual\n gateway is in a shared mesh, then you must be the owner of the virtual gateway\n resource.

", + "location": "uri", + "locationName": "virtualGatewayName" + } + } + }, "CertificateAuthorityArns": { "type": "list", "member": { @@ -1462,6 +2028,38 @@ "max": 1024, "pattern": "((?=^.{1,127}$)^([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9])(.([a-zA-Z0-9_][a-zA-Z0-9-_]{0,61}[a-zA-Z0-9_]|[a-zA-Z0-9]))*$)|(^.$)" }, + "VirtualGatewayData": { + "type": "structure", + "required": [ + "meshName", + "metadata", + "spec", + "status", + "virtualGatewayName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the virtual gateway resides in.

" + }, + "metadata": { + "shape": "ResourceMetadata" + }, + "spec": { + "shape": "VirtualGatewaySpec", + "documentation": "

The specifications of the virtual gateway.

" + }, + "status": { + "shape": "VirtualGatewayStatus", + "documentation": "

The current status of the virtual gateway.

" + }, + "virtualGatewayName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual gateway.

" + } + }, + "documentation": "

An object that represents a virtual gateway returned by a describe operation.

" + }, "CreateRouteOutput": { "type": "structure", "required": [ @@ -1476,6 +2074,27 @@ "documentation": "", "payload": "route" }, + "VirtualGatewayListener": { + "type": "structure", + "required": [ + "portMapping" + ], + "members": { + "healthCheck": { + "shape": "VirtualGatewayHealthCheckPolicy", + "documentation": "

The health check information for the listener.

" + }, + "portMapping": { + "shape": "VirtualGatewayPortMapping", + "documentation": "

The port mapping information for the listener.

" + }, + "tls": { + "shape": "VirtualGatewayListenerTls", + "documentation": "

A reference to an object that represents the Transport Layer Security (TLS) properties for the listener.

" + } + }, + "documentation": "

An object that represents a listener for a virtual gateway.

" + }, "DnsServiceDiscovery": { "type": "structure", "required": [ @@ -1489,6 +2108,37 @@ }, "documentation": "

An object that represents the DNS service discovery information for your virtual\n node.

" }, + "VirtualGatewayPortMapping": { + "type": "structure", + "required": [ + "port", + "protocol" + ], + "members": { + "port": { + "shape": "PortNumber", + "documentation": "

The port used for the port mapping. Specify one protocol.

" + }, + "protocol": { + "shape": "VirtualGatewayPortProtocol", + "documentation": "

The protocol used for the port mapping.

" + } + }, + "documentation": "

An object that represents a port mapping.

" + }, + "DeleteVirtualGatewayOutput": { + "type": "structure", + "required": [ + "virtualGateway" + ], + "members": { + "virtualGateway": { + "shape": "VirtualGatewayData", + "documentation": "

The virtual gateway that was deleted.

" + } + }, + "payload": "virtualGateway" + }, "DeleteRouteInput": { "type": "structure", "required": [ @@ -1562,12 +2212,36 @@ "members": { }, "documentation": "" }, + "ListGatewayRoutesLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, "TcpRetryPolicyEvent": { "type": "string", "enum": [ "connection-error" ] }, + "VirtualGatewayListenerTls": { + "type": "structure", + "required": [ + "certificate", + "mode" + ], + "members": { + "certificate": { + "shape": "VirtualGatewayListenerTlsCertificate", + "documentation": "

An object that represents a Transport Layer Security (TLS) certificate.

" + }, + "mode": { + "shape": "VirtualGatewayListenerTlsMode", + "documentation": "

Specify one of the following modes.

\n " + } + }, + "documentation": "

An object that represents the Transport Layer Security (TLS) properties for a listener.

" + }, "Backend": { "type": "structure", "members": { @@ -1596,6 +2270,63 @@ }, "documentation": "" }, + "VirtualGatewayListenerTlsFileCertificate": { + "type": "structure", + "required": [ + "certificateChain", + "privateKey" + ], + "members": { + "certificateChain": { + "shape": "FilePath", + "documentation": "

The certificate chain for the certificate.

" + }, + "privateKey": { + "shape": "FilePath", + "documentation": "

The private key for a certificate stored on the file system of the mesh endpoint that\n the proxy is running on.

" + } + }, + "documentation": "

An object that represents a local file certificate.\n The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

" + }, + "ListGatewayRoutesInput": { + "type": "structure", + "required": [ + "meshName", + "virtualGatewayName" + ], + "members": { + "limit": { + "shape": "ListGatewayRoutesLimit", + "documentation": "

The maximum number of results returned by ListGatewayRoutes in paginated\n output. When you use this parameter, ListGatewayRoutes returns only\n limit results in a single page along with a nextToken response\n element. You can see the remaining results of the initial request by sending another\n ListGatewayRoutes request with the returned nextToken value.\n This value can be between 1 and 100. If you don't use this\n parameter, ListGatewayRoutes returns up to 100 results and a\n nextToken value if applicable.

", + "location": "querystring", + "locationName": "limit" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to list gateway routes in.

", + "location": "uri", + "locationName": "meshName" + }, + "meshOwner": { + "shape": "AccountId", + "documentation": "

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

", + "location": "querystring", + "locationName": "meshOwner" + }, + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value returned from a previous paginated\n ListGatewayRoutes request where limit was used and the results\n exceeded the value of that parameter. Pagination continues from the end of the previous\n results that returned the nextToken value.

", + "location": "querystring", + "locationName": "nextToken" + }, + "virtualGatewayName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual gateway to list gateway routes in.

", + "location": "uri", + "locationName": "virtualGatewayName" + } + } + }, "VirtualRouterData": { "type": "structure", "required": [ @@ -1653,6 +2384,47 @@ }, "documentation": "" }, + "VirtualGatewayHealthCheckPolicy": { + "type": "structure", + "required": [ + "healthyThreshold", + "intervalMillis", + "protocol", + "timeoutMillis", + "unhealthyThreshold" + ], + "members": { + "healthyThreshold": { + "shape": "VirtualGatewayHealthCheckThreshold", + "documentation": "

The number of consecutive successful health checks that must occur before declaring the\n listener healthy.

" + }, + "intervalMillis": { + "shape": "VirtualGatewayHealthCheckIntervalMillis", + "documentation": "

The time period in milliseconds between each health check execution.

" + }, + "path": { + "shape": "String", + "documentation": "

The destination path for the health check request. This value is only used if the\n specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

" + }, + "port": { + "shape": "PortNumber", + "documentation": "

The destination port for the health check request. This port must match the port defined\n in the PortMapping for the listener.

" + }, + "protocol": { + "shape": "VirtualGatewayPortProtocol", + "documentation": "

The protocol for the health check request. If you specify grpc, then your\n service must conform to the GRPC Health\n Checking Protocol.

" + }, + "timeoutMillis": { + "shape": "VirtualGatewayHealthCheckTimeoutMillis", + "documentation": "

The amount of time to wait when receiving a response from the health check, in\n milliseconds.

" + }, + "unhealthyThreshold": { + "shape": "VirtualGatewayHealthCheckThreshold", + "documentation": "

The number of consecutive failed health checks that must occur before declaring a\n virtual gateway unhealthy.

" + } + }, + "documentation": "

An object that represents the health check policy for a virtual gateway's\n listener.

" + }, "CreateVirtualRouterInput": { "type": "structure", "required": [ @@ -1759,6 +2531,20 @@ "min": 1, "max": 25 }, + "VirtualGatewayListenerTlsCertificate": { + "type": "structure", + "members": { + "acm": { + "shape": "VirtualGatewayListenerTlsAcmCertificate", + "documentation": "

A reference to an object that represents an AWS Certicate Manager (ACM) certificate.

" + }, + "file": { + "shape": "VirtualGatewayListenerTlsFileCertificate", + "documentation": "

A reference to an object that represents a local file certificate.

" + } + }, + "documentation": "

An object that represents a listener's Transport Layer Security (TLS) certificate.

" + }, "ListenerTlsCertificate": { "type": "structure", "members": { @@ -1795,6 +2581,19 @@ }, "documentation": "

An object that represents the specification of a virtual router.

" }, + "GatewayRouteVirtualService": { + "type": "structure", + "required": [ + "virtualServiceName" + ], + "members": { + "virtualServiceName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual service that traffic is routed to.

" + } + }, + "documentation": "

An object that represents the virtual service that traffic is routed to.

" + }, "VirtualNodeSpec": { "type": "structure", "members": { @@ -1846,6 +2645,24 @@ "min": 1, "max": 1 }, + "GatewayRouteSpec": { + "type": "structure", + "members": { + "grpcRoute": { + "shape": "GrpcGatewayRoute", + "documentation": "

An object that represents the specification of a gRPC gateway route.

" + }, + "http2Route": { + "shape": "HttpGatewayRoute", + "documentation": "

An object that represents the specification of an HTTP/2 gateway route.

" + }, + "httpRoute": { + "shape": "HttpGatewayRoute", + "documentation": "

An object that represents the specification of an HTTP gateway route.

" + } + }, + "documentation": "

An object that represents a gateway route specification. Specify one gateway route\n type.

" + }, "PortSet": { "type": "list", "member": { @@ -1881,6 +2698,16 @@ "senderFault": true } }, + "VirtualGatewayBackendDefaults": { + "type": "structure", + "members": { + "clientPolicy": { + "shape": "VirtualGatewayClientPolicy", + "documentation": "

A reference to an object that represents a client policy.

" + } + }, + "documentation": "

An object that represents the default properties for a backend.

" + }, "ListenerTimeout": { "type": "structure", "members": { @@ -1888,15 +2715,19 @@ "shape": "GrpcTimeout" }, "http": { - "shape": "HttpTimeout" + "shape": "HttpTimeout", + "documentation": "

An object that represents types of timeouts.

" }, "http2": { - "shape": "HttpTimeout" + "shape": "HttpTimeout", + "documentation": "

An object that represents types of timeouts.

" }, "tcp": { - "shape": "TcpTimeout" + "shape": "TcpTimeout", + "documentation": "

An object that represents types of timeouts.

" } - } + }, + "documentation": "

An object that represents timeouts for different protocols.

" }, "MeshList": { "type": "list", @@ -1909,6 +2740,40 @@ "box": true, "min": 0 }, + "DescribeGatewayRouteInput": { + "type": "structure", + "required": [ + "gatewayRouteName", + "meshName", + "virtualGatewayName" + ], + "members": { + "gatewayRouteName": { + "shape": "ResourceName", + "documentation": "

The name of the gateway route to describe.

", + "location": "uri", + "locationName": "gatewayRouteName" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the gateway route resides in.

", + "location": "uri", + "locationName": "meshName" + }, + "meshOwner": { + "shape": "AccountId", + "documentation": "

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

", + "location": "querystring", + "locationName": "meshOwner" + }, + "virtualGatewayName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual gateway that the gateway route is associated with.

", + "location": "uri", + "locationName": "virtualGatewayName" + } + } + }, "TlsValidationContextTrust": { "type": "structure", "members": { @@ -1941,6 +2806,11 @@ }, "documentation": "

An object that represents a port mapping.

" }, + "VirtualGatewayHealthCheckThreshold": { + "type": "integer", + "min": 2, + "max": 10 + }, "ListVirtualServicesOutput": { "type": "structure", "required": [ @@ -1982,6 +2852,61 @@ }, "documentation": "

An object that represents a target and its relative weight. Traffic is distributed\n across targets according to their relative weight. For example, a weighted target with a\n relative weight of 50 receives five times as much traffic as one with a relative weight of\n 10. The total weight for all targets combined must be less than or equal to 100.

" }, + "GrpcGatewayRoute": { + "type": "structure", + "required": [ + "action", + "match" + ], + "members": { + "action": { + "shape": "GrpcGatewayRouteAction", + "documentation": "

An object that represents the action to take if a match is determined.

" + }, + "match": { + "shape": "GrpcGatewayRouteMatch", + "documentation": "

An object that represents the criteria for determining a request match.

" + } + }, + "documentation": "

An object that represents a gRPC gateway route.

" + }, + "GatewayRouteData": { + "type": "structure", + "required": [ + "gatewayRouteName", + "meshName", + "metadata", + "spec", + "status", + "virtualGatewayName" + ], + "members": { + "gatewayRouteName": { + "shape": "ResourceName", + "documentation": "

The name of the gateway route.

" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the resource resides in.

" + }, + "metadata": { + "shape": "ResourceMetadata" + }, + "spec": { + "shape": "GatewayRouteSpec", + "documentation": "

The specifications of the gateway route.

" + }, + "status": { + "shape": "GatewayRouteStatus", + "documentation": "

The status of the gateway route.

" + }, + "virtualGatewayName": { + "shape": "ResourceName", + "documentation": "

The virtual gateway that the gateway route is associated with.

" + } + }, + "documentation": "

An object that represents a gateway route returned by a describe operation.

" + }, "RouteRef": { "type": "structure", "required": [ @@ -2215,6 +3140,28 @@ "documentation": "", "payload": "mesh" }, + "VirtualGatewayClientPolicyTls": { + "type": "structure", + "required": [ + "validation" + ], + "members": { + "enforce": { + "shape": "Boolean", + "box": true, + "documentation": "

Whether the policy is enforced. The default is True, if a value isn't\n specified.

" + }, + "ports": { + "shape": "PortSet", + "documentation": "

One or more ports that the policy is enforced for.

" + }, + "validation": { + "shape": "VirtualGatewayTlsValidationContext", + "documentation": "

A reference to an object that represents a TLS validation context.

" + } + }, + "documentation": "

An object that represents a Transport Layer Security (TLS) client policy.

" + }, "EgressFilterType": { "type": "string", "enum": [ @@ -2230,6 +3177,40 @@ "Hostname": { "type": "string" }, + "VirtualGatewayStatus": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": { + "shape": "VirtualGatewayStatusCode", + "documentation": "

The current status.

" + } + }, + "documentation": "

An object that represents the status of the mesh resource.

" + }, + "GatewayRouteStatus": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": { + "shape": "GatewayRouteStatusCode", + "documentation": "

The current status for the gateway route.

" + } + }, + "documentation": "

An object that represents the current status of a gateway route.

" + }, + "VirtualGatewayListeners": { + "type": "list", + "member": { + "shape": "VirtualGatewayListener" + }, + "min": 0, + "max": 1 + }, "TagResourceInput": { "type": "structure", "required": [ @@ -2250,6 +3231,48 @@ }, "documentation": "" }, + "CreateVirtualGatewayOutput": { + "type": "structure", + "required": [ + "virtualGateway" + ], + "members": { + "virtualGateway": { + "shape": "VirtualGatewayData", + "documentation": "

The full description of your virtual gateway following the create call.

" + } + }, + "payload": "virtualGateway" + }, + "ListVirtualGatewaysOutput": { + "type": "structure", + "required": [ + "virtualGateways" + ], + "members": { + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value to include in a future ListVirtualGateways\n request. When the results of a ListVirtualGateways request exceed\n limit, you can use this value to retrieve the next page of results. This\n value is null when there are no more results to return.

" + }, + "virtualGateways": { + "shape": "VirtualGatewayList", + "documentation": "

The list of existing virtual gateways for the specified service mesh.

" + } + } + }, + "VirtualGatewayTlsValidationContext": { + "type": "structure", + "required": [ + "trust" + ], + "members": { + "trust": { + "shape": "VirtualGatewayTlsValidationContextTrust", + "documentation": "

A reference to an object that represents a TLS validation context trust.

" + } + }, + "documentation": "

An object that represents a Transport Layer Security (TLS) validation context.

" + }, "VirtualServiceProvider": { "type": "structure", "members": { @@ -2412,6 +3435,88 @@ }, "documentation": "

An object that represents a route specification. Specify one route type.

" }, + "GatewayRouteRef": { + "type": "structure", + "required": [ + "arn", + "createdAt", + "gatewayRouteName", + "lastUpdatedAt", + "meshName", + "meshOwner", + "resourceOwner", + "version", + "virtualGatewayName" + ], + "members": { + "arn": { + "shape": "Arn", + "documentation": "

The full Amazon Resource Name (ARN) for the gateway route.

" + }, + "createdAt": { + "shape": "Timestamp", + "documentation": "

The Unix epoch timestamp in seconds for when the resource was created.

" + }, + "gatewayRouteName": { + "shape": "ResourceName", + "documentation": "

The name of the gateway route.

" + }, + "lastUpdatedAt": { + "shape": "Timestamp", + "documentation": "

The Unix epoch timestamp in seconds for when the resource was last updated.

" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the resource resides in.

" + }, + "meshOwner": { + "shape": "AccountId", + "documentation": "

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

" + }, + "resourceOwner": { + "shape": "AccountId", + "documentation": "

The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.

" + }, + "version": { + "shape": "Long", + "documentation": "

The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

" + }, + "virtualGatewayName": { + "shape": "ResourceName", + "documentation": "

The virtual gateway that the gateway route is associated with.

" + } + }, + "documentation": "

An object that represents a gateway route returned by a list operation.

" + }, + "VirtualGatewayListenerTlsAcmCertificate": { + "type": "structure", + "required": [ + "certificateArn" + ], + "members": { + "certificateArn": { + "shape": "Arn", + "documentation": "

The Amazon Resource Name (ARN) for the certificate. The certificate must meet specific requirements and you must have proxy authorization enabled. For more information, see Transport Layer Security (TLS).

" + } + }, + "documentation": "

An object that represents an AWS Certicate Manager (ACM) certificate.

" + }, + "ListGatewayRoutesOutput": { + "type": "structure", + "required": [ + "gatewayRoutes" + ], + "members": { + "gatewayRoutes": { + "shape": "GatewayRouteList", + "documentation": "

The list of existing gateway routes for the specified service mesh and virtual\n gateway.

" + }, + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value to include in a future ListGatewayRoutes\n request. When the results of a ListGatewayRoutes request exceed\n limit, you can use this value to retrieve the next page of results. This\n value is null when there are no more results to return.

" + } + } + }, "CreateVirtualServiceOutput": { "type": "structure", "required": [ @@ -2461,7 +3566,8 @@ "perRequest": { "shape": "Duration" } - } + }, + "documentation": "

An object that represents types of timeouts.

" }, "DeleteVirtualServiceInput": { "type": "structure", @@ -2504,6 +3610,14 @@ }, "documentation": "

An object that represents a Transport Layer Security (TLS) validation context.

" }, + "GatewayRouteStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, "DeleteVirtualRouterOutput": { "type": "structure", "required": [ @@ -2518,12 +3632,52 @@ "documentation": "", "payload": "virtualRouter" }, + "DescribeVirtualGatewayInput": { + "type": "structure", + "required": [ + "meshName", + "virtualGatewayName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the gateway route resides in.

", + "location": "uri", + "locationName": "meshName" + }, + "meshOwner": { + "shape": "AccountId", + "documentation": "

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

", + "location": "querystring", + "locationName": "meshOwner" + }, + "virtualGatewayName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual gateway to describe.

", + "location": "uri", + "locationName": "virtualGatewayName" + } + } + }, "TagsLimit": { "type": "integer", "box": true, "min": 1, "max": 50 }, + "GrpcGatewayRouteAction": { + "type": "structure", + "required": [ + "target" + ], + "members": { + "target": { + "shape": "GatewayRouteTarget", + "documentation": "

An object that represents the target that traffic is routed to when a request matches the gateway route.

" + } + }, + "documentation": "

An object that represents the action to take if a match is determined.

" + }, "DeleteVirtualNodeOutput": { "type": "structure", "required": [ @@ -2698,6 +3852,29 @@ }, "documentation": "" }, + "HttpGatewayRouteAction": { + "type": "structure", + "required": [ + "target" + ], + "members": { + "target": { + "shape": "GatewayRouteTarget", + "documentation": "

An object that represents the target that traffic is routed to when a request matches the gateway route.

" + } + }, + "documentation": "

An object that represents the action to take if a match is determined.

" + }, + "GrpcGatewayRouteMatch": { + "type": "structure", + "members": { + "serviceName": { + "shape": "ServiceName", + "documentation": "

The fully qualified domain name for the service to match from the request.

" + } + }, + "documentation": "

An object that represents the criteria for determining a request match.

" + }, "ListTagsForResourceInput": { "type": "structure", "required": [ @@ -2733,6 +3910,14 @@ "min": 1, "max": 5 }, + "VirtualGatewayStatusCode": { + "type": "string", + "enum": [ + "ACTIVE", + "DELETED", + "INACTIVE" + ] + }, "ServiceUnavailableException": { "type": "structure", "members": { @@ -2790,6 +3975,19 @@ }, "documentation": "" }, + "UpdateGatewayRouteOutput": { + "type": "structure", + "required": [ + "gatewayRoute" + ], + "members": { + "gatewayRoute": { + "shape": "GatewayRouteData", + "documentation": "

A full description of the gateway route that was updated.

" + } + }, + "payload": "gatewayRoute" + }, "DescribeRouteInput": { "type": "structure", "required": [ @@ -2862,6 +4060,25 @@ "tcp" ] }, + "DeleteGatewayRouteOutput": { + "type": "structure", + "required": [ + "gatewayRoute" + ], + "members": { + "gatewayRoute": { + "shape": "GatewayRouteData", + "documentation": "

The gateway route that was deleted.

" + } + }, + "payload": "gatewayRoute" + }, + "VirtualGatewayList": { + "type": "list", + "member": { + "shape": "VirtualGatewayRef" + } + }, "VirtualNodeStatusCode": { "type": "string", "enum": [ @@ -3050,12 +4267,15 @@ "type": "structure", "members": { "idle": { - "shape": "Duration" + "shape": "Duration", + "documentation": "

An object that represents an idle timeout. An idle timeout bounds the amount of time that a connection may be idle. The default value is none.

" }, "perRequest": { - "shape": "Duration" + "shape": "Duration", + "documentation": "

An object that represents a per request timeout. The default value is 15 seconds. If you set a higher timeout, then make sure that the higher value is set for each App Mesh resource in a conversation. For example, if a virtual node backend uses a virtual router provider to route to another virtual node, then the timeout should be greater than 15 seconds for the source and destination virtual node and the route.

" } - } + }, + "documentation": "

An object that represents types of timeouts.

" }, "VirtualNodeStatus": { "type": "structure", @@ -3272,6 +4492,19 @@ }, "documentation": "

An object that represents the action to take if a match is determined.

" }, + "VirtualGatewayTlsValidationContextFileTrust": { + "type": "structure", + "required": [ + "certificateChain" + ], + "members": { + "certificateChain": { + "shape": "FilePath", + "documentation": "

The certificate trust chain for a certificate stored on the file system of the virtual\n node that the proxy is running on.

" + } + }, + "documentation": "

An object that represents a Transport Layer Security (TLS) validation context trust for a local file.

" + }, "LimitExceededException": { "type": "structure", "members": { @@ -3378,6 +4611,14 @@ }, "documentation": "

An object that represents the AWS Cloud Map attribute information for your virtual\n node.

" }, + "VirtualGatewayListenerTlsMode": { + "type": "string", + "enum": [ + "DISABLED", + "PERMISSIVE", + "STRICT" + ] + }, "VirtualServiceSpec": { "type": "structure", "members": { @@ -3388,6 +4629,29 @@ }, "documentation": "

An object that represents the specification of a virtual service.

" }, + "VirtualGatewayTlsValidationContextAcmTrust": { + "type": "structure", + "required": [ + "certificateAuthorityArns" + ], + "members": { + "certificateAuthorityArns": { + "shape": "VirtualGatewayCertificateAuthorityArns", + "documentation": "

One or more ACM Amazon Resource Name (ARN)s.

" + } + }, + "documentation": "

An object that represents a TLS validation context trust for an AWS Certicate Manager (ACM)\n certificate.

" + }, + "VirtualGatewayAccessLog": { + "type": "structure", + "members": { + "file": { + "shape": "VirtualGatewayFileAccessLog", + "documentation": "

The file object to send virtual gateway access logs to.

" + } + }, + "documentation": "

The access log configuration for a virtual gateway.

" + }, "MatchRange": { "type": "structure", "required": [ @@ -3438,7 +4702,8 @@ "documentation": "

The action to take if a match is determined.

" }, "timeout": { - "shape": "TcpTimeout" + "shape": "TcpTimeout", + "documentation": "

An object that represents types of timeouts.

" } }, "documentation": "

An object that represents a TCP route type.

" @@ -3449,6 +4714,19 @@ "shape": "VirtualNodeRef" } }, + "UpdateVirtualGatewayOutput": { + "type": "structure", + "required": [ + "virtualGateway" + ], + "members": { + "virtualGateway": { + "shape": "VirtualGatewayData", + "documentation": "

A full description of the virtual gateway that was updated.

" + } + }, + "payload": "virtualGateway" + }, "ListVirtualRoutersInput": { "type": "structure", "required": [ @@ -3571,6 +4849,16 @@ }, "documentation": "" }, + "VirtualGatewayClientPolicy": { + "type": "structure", + "members": { + "tls": { + "shape": "VirtualGatewayClientPolicyTls", + "documentation": "

A reference to an object that represents a Transport Layer Security (TLS) client policy.

" + } + }, + "documentation": "

An object that represents a client policy.

" + }, "ListVirtualNodesLimit": { "type": "integer", "box": true, @@ -3606,6 +4894,16 @@ "Timestamp": { "type": "timestamp" }, + "VirtualGatewayLogging": { + "type": "structure", + "members": { + "accessLog": { + "shape": "VirtualGatewayAccessLog", + "documentation": "

The access log configuration.

" + } + }, + "documentation": "

An object that represents logging information.

" + }, "HeaderMatch": { "type": "string", "min": 1, @@ -3616,6 +4914,19 @@ "min": 12, "max": 12 }, + "GatewayRouteTarget": { + "type": "structure", + "required": [ + "virtualService" + ], + "members": { + "virtualService": { + "shape": "GatewayRouteVirtualService", + "documentation": "

An object that represents a virtual service gateway route target.

" + } + }, + "documentation": "

An object that represents a gateway route target.

" + }, "Duration": { "type": "structure", "members": { @@ -3729,6 +5040,12 @@ }, "documentation": "

An object that represents a service mesh returned by a list operation.

" }, + "ListVirtualGatewaysLimit": { + "type": "integer", + "box": true, + "min": 1, + "max": 100 + }, "MeshStatusCode": { "type": "string", "enum": [ @@ -3765,6 +5082,25 @@ }, "documentation": "

An object that represents a service mesh returned by a describe operation.

" }, + "CreateGatewayRouteOutput": { + "type": "structure", + "required": [ + "gatewayRoute" + ], + "members": { + "gatewayRoute": { + "shape": "GatewayRouteData", + "documentation": "

The full description of your gateway route following the create call.

" + } + }, + "payload": "gatewayRoute" + }, + "GatewayRouteList": { + "type": "list", + "member": { + "shape": "GatewayRouteRef" + } + }, "VirtualRouterStatus": { "type": "structure", "required": [ @@ -3791,6 +5127,33 @@ }, "documentation": "

An object that represents the action to take if a match is determined.

" }, + "DeleteVirtualGatewayInput": { + "type": "structure", + "required": [ + "meshName", + "virtualGatewayName" + ], + "members": { + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to delete the virtual gateway from.

", + "location": "uri", + "locationName": "meshName" + }, + "meshOwner": { + "shape": "AccountId", + "documentation": "

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

", + "location": "querystring", + "locationName": "meshOwner" + }, + "virtualGatewayName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual gateway to delete.

", + "location": "uri", + "locationName": "virtualGatewayName" + } + } + }, "DescribeVirtualNodeInput": { "type": "structure", "required": [ @@ -3847,7 +5210,8 @@ "documentation": "

The port mapping information for the listener.

" }, "timeout": { - "shape": "ListenerTimeout" + "shape": "ListenerTimeout", + "documentation": "

An object that represents timeouts for different protocols.

" }, "tls": { "shape": "ListenerTls", @@ -3876,7 +5240,8 @@ "documentation": "

An object that represents a retry policy.

" }, "timeout": { - "shape": "GrpcTimeout" + "shape": "GrpcTimeout", + "documentation": "

An object that represents types of timeouts.

" } }, "documentation": "

An object that represents a gRPC route type.

" @@ -3909,6 +5274,20 @@ }, "documentation": "

An object that represents a Transport Layer Security (TLS) client policy.

" }, + "VirtualGatewayTlsValidationContextTrust": { + "type": "structure", + "members": { + "acm": { + "shape": "VirtualGatewayTlsValidationContextAcmTrust", + "documentation": "

A reference to an object that represents a TLS validation context trust for an AWS Certicate Manager (ACM)\n certificate.

" + }, + "file": { + "shape": "VirtualGatewayTlsValidationContextFileTrust", + "documentation": "

An object that represents a TLS validation context trust for a local file.

" + } + }, + "documentation": "

An object that represents a Transport Layer Security (TLS) validation context trust.

" + }, "DeleteVirtualServiceOutput": { "type": "structure", "required": [ @@ -3923,6 +5302,14 @@ "documentation": "", "payload": "virtualService" }, + "VirtualGatewayPortProtocol": { + "type": "string", + "enum": [ + "grpc", + "http", + "http2" + ] + }, "VirtualNodeServiceProvider": { "type": "structure", "required": [ @@ -3936,6 +5323,24 @@ }, "documentation": "

An object that represents a virtual node service provider.

" }, + "HttpGatewayRoute": { + "type": "structure", + "required": [ + "action", + "match" + ], + "members": { + "action": { + "shape": "HttpGatewayRouteAction", + "documentation": "

An object that represents the action to take if a match is determined.

" + }, + "match": { + "shape": "HttpGatewayRouteMatch", + "documentation": "

An object that represents the criteria for determining a request match.

" + } + }, + "documentation": "

An object that represents an HTTP gateway route.

" + }, "BackendDefaults": { "type": "structure", "members": { @@ -4044,6 +5449,82 @@ "senderFault": true } }, + "UpdateGatewayRouteInput": { + "type": "structure", + "required": [ + "gatewayRouteName", + "meshName", + "spec", + "virtualGatewayName" + ], + "members": { + "clientToken": { + "shape": "String", + "documentation": "

Unique, case-sensitive identifier that you provide to ensure the idempotency of the\nrequest. Up to 36 letters, numbers, hyphens, and underscores are allowed.

", + "idempotencyToken": true + }, + "gatewayRouteName": { + "shape": "ResourceName", + "documentation": "

The name of the gateway route to update.

", + "location": "uri", + "locationName": "gatewayRouteName" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the gateway route resides in.

", + "location": "uri", + "locationName": "meshName" + }, + "meshOwner": { + "shape": "AccountId", + "documentation": "

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

", + "location": "querystring", + "locationName": "meshOwner" + }, + "spec": { + "shape": "GatewayRouteSpec", + "documentation": "

The new gateway route specification to apply. This overwrites the existing data.

" + }, + "virtualGatewayName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual gateway that the gateway route is associated with.

", + "location": "uri", + "locationName": "virtualGatewayName" + } + } + }, + "ListVirtualGatewaysInput": { + "type": "structure", + "required": [ + "meshName" + ], + "members": { + "limit": { + "shape": "ListVirtualGatewaysLimit", + "documentation": "

The maximum number of results returned by ListVirtualGateways in paginated\n output. When you use this parameter, ListVirtualGateways returns only\n limit results in a single page along with a nextToken response\n element. You can see the remaining results of the initial request by sending another\n ListVirtualGateways request with the returned nextToken value.\n This value can be between 1 and 100. If you don't use this\n parameter, ListVirtualGateways returns up to 100 results and\n a nextToken value if applicable.

", + "location": "querystring", + "locationName": "limit" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to list virtual gateways in.

", + "location": "uri", + "locationName": "meshName" + }, + "meshOwner": { + "shape": "AccountId", + "documentation": "

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

", + "location": "querystring", + "locationName": "meshOwner" + }, + "nextToken": { + "shape": "String", + "documentation": "

The nextToken value returned from a previous paginated\n ListVirtualGateways request where limit was used and the\n results exceeded the value of that parameter. Pagination continues from the end of the\n previous results that returned the nextToken value.

", + "location": "querystring", + "locationName": "nextToken" + } + } + }, "PortNumber": { "type": "integer", "min": 1, @@ -4133,6 +5614,14 @@ }, "documentation": "" }, + "VirtualGatewayCertificateAuthorityArns": { + "type": "list", + "member": { + "shape": "Arn" + }, + "min": 1, + "max": 3 + }, "WeightedTargets": { "type": "list", "member": { @@ -4158,7 +5647,8 @@ "idle": { "shape": "Duration" } - } + }, + "documentation": "

An object that represents types of timeouts.

" }, "HttpScheme": { "type": "string", @@ -4167,6 +5657,40 @@ "https" ] }, + "DeleteGatewayRouteInput": { + "type": "structure", + "required": [ + "gatewayRouteName", + "meshName", + "virtualGatewayName" + ], + "members": { + "gatewayRouteName": { + "shape": "ResourceName", + "documentation": "

The name of the gateway route to delete.

", + "location": "uri", + "locationName": "gatewayRouteName" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh to delete the gateway route from.

", + "location": "uri", + "locationName": "meshName" + }, + "meshOwner": { + "shape": "AccountId", + "documentation": "

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

", + "location": "querystring", + "locationName": "meshOwner" + }, + "virtualGatewayName": { + "shape": "ResourceName", + "documentation": "

The name of the virtual gateway to delete the route from.

", + "location": "uri", + "locationName": "virtualGatewayName" + } + } + }, "UpdateRouteInput": { "type": "structure", "required": [ @@ -4232,7 +5756,8 @@ "documentation": "

An object that represents a retry policy.

" }, "timeout": { - "shape": "HttpTimeout" + "shape": "HttpTimeout", + "documentation": "

An object that represents types of timeouts.

" } }, "documentation": "

An object that represents an HTTP or HTTP/2 route type.

" @@ -4258,6 +5783,54 @@ }, "documentation": "" }, + "VirtualGatewayRef": { + "type": "structure", + "required": [ + "arn", + "createdAt", + "lastUpdatedAt", + "meshName", + "meshOwner", + "resourceOwner", + "version", + "virtualGatewayName" + ], + "members": { + "arn": { + "shape": "Arn", + "documentation": "

The full Amazon Resource Name (ARN) for the resource.

" + }, + "createdAt": { + "shape": "Timestamp", + "documentation": "

The Unix epoch timestamp in seconds for when the resource was created.

" + }, + "lastUpdatedAt": { + "shape": "Timestamp", + "documentation": "

The Unix epoch timestamp in seconds for when the resource was last updated.

" + }, + "meshName": { + "shape": "ResourceName", + "documentation": "

The name of the service mesh that the resource resides in.

" + }, + "meshOwner": { + "shape": "AccountId", + "documentation": "

The AWS IAM account ID of the service mesh owner. If the account ID is not your own, then it's\n the ID of the account that shared the mesh with your account. For more information about mesh sharing, see Working with shared meshes.

" + }, + "resourceOwner": { + "shape": "AccountId", + "documentation": "

The AWS IAM account ID of the resource owner. If the account ID is not your own, then it's\n the ID of the mesh owner or of another account that the mesh is shared with. For more information about mesh sharing, see Working with shared meshes.

" + }, + "version": { + "shape": "Long", + "documentation": "

The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated.

" + }, + "virtualGatewayName": { + "shape": "ResourceName", + "documentation": "

The name of the resource.

" + } + }, + "documentation": "

An object that represents a virtual gateway returned by a list operation.

" + }, "MeshSpec": { "type": "structure", "members": { @@ -4268,6 +5841,32 @@ }, "documentation": "

An object that represents the specification of a service mesh.

" }, + "DescribeVirtualGatewayOutput": { + "type": "structure", + "required": [ + "virtualGateway" + ], + "members": { + "virtualGateway": { + "shape": "VirtualGatewayData", + "documentation": "

The full description of your virtual gateway.

" + } + }, + "payload": "virtualGateway" + }, + "DescribeGatewayRouteOutput": { + "type": "structure", + "required": [ + "gatewayRoute" + ], + "members": { + "gatewayRoute": { + "shape": "GatewayRouteData", + "documentation": "

The full description of your gateway route.

" + } + }, + "payload": "gatewayRoute" + }, "ListTagsForResourceOutput": { "type": "structure", "required": [ diff --git a/botocore/data/appsync/2017-07-25/service-2.json b/botocore/data/appsync/2017-07-25/service-2.json index b2dfb371..fdeb80c9 100644 --- a/botocore/data/appsync/2017-07-25/service-2.json +++ b/botocore/data/appsync/2017-07-25/service-2.json @@ -754,7 +754,7 @@ }, "type":{ "shape":"ApiCacheType", - "documentation":"

The cache instance type.

  • T2_SMALL: A t2.small instance type.

  • T2_MEDIUM: A t2.medium instance type.

  • R4_LARGE: A r4.large instance type.

  • R4_XLARGE: A r4.xlarge instance type.

  • R4_2XLARGE: A r4.2xlarge instance type.

  • R4_4XLARGE: A r4.4xlarge instance type.

  • R4_8XLARGE: A r4.8xlarge instance type.

" + "documentation":"

The cache instance type. Valid values are

  • SMALL

  • MEDIUM

  • LARGE

  • XLARGE

  • LARGE_2X

  • LARGE_4X

  • LARGE_8X (not available in all regions)

  • LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are avaible, but their use is discouraged:

  • T2_SMALL: A t2.small instance type.

  • T2_MEDIUM: A t2.medium instance type.

  • R4_LARGE: A r4.large instance type.

  • R4_XLARGE: A r4.xlarge instance type.

  • R4_2XLARGE: A r4.2xlarge instance type.

  • R4_4XLARGE: A r4.4xlarge instance type.

  • R4_8XLARGE: A r4.8xlarge instance type.

" }, "status":{ "shape":"ApiCacheStatus", @@ -782,7 +782,15 @@ "R4_XLARGE", "R4_2XLARGE", "R4_4XLARGE", - "R4_8XLARGE" + "R4_8XLARGE", + "SMALL", + "MEDIUM", + "LARGE", + "XLARGE", + "LARGE_2X", + "LARGE_4X", + "LARGE_8X", + "LARGE_12X" ] }, "ApiCachingBehavior":{ @@ -993,7 +1001,7 @@ }, "type":{ "shape":"ApiCacheType", - "documentation":"

The cache instance type.

  • T2_SMALL: A t2.small instance type.

  • T2_MEDIUM: A t2.medium instance type.

  • R4_LARGE: A r4.large instance type.

  • R4_XLARGE: A r4.xlarge instance type.

  • R4_2XLARGE: A r4.2xlarge instance type.

  • R4_4XLARGE: A r4.4xlarge instance type.

  • R4_8XLARGE: A r4.8xlarge instance type.

" + "documentation":"

The cache instance type. Valid values are

  • SMALL

  • MEDIUM

  • LARGE

  • XLARGE

  • LARGE_2X

  • LARGE_4X

  • LARGE_8X (not available in all regions)

  • LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are avaible, but their use is discouraged:

  • T2_SMALL: A t2.small instance type.

  • T2_MEDIUM: A t2.medium instance type.

  • R4_LARGE: A r4.large instance type.

  • R4_XLARGE: A r4.xlarge instance type.

  • R4_2XLARGE: A r4.2xlarge instance type.

  • R4_4XLARGE: A r4.4xlarge instance type.

  • R4_8XLARGE: A r4.8xlarge instance type.

" } }, "documentation":"

Represents the input of a CreateApiCache operation.

" @@ -2436,7 +2444,7 @@ }, "dbClusterIdentifier":{ "shape":"String", - "documentation":"

Amazon RDS cluster identifier.

" + "documentation":"

Amazon RDS cluster ARN.

" }, "databaseName":{ "shape":"String", @@ -2745,7 +2753,7 @@ }, "type":{ "shape":"ApiCacheType", - "documentation":"

The cache instance type.

  • T2_SMALL: A t2.small instance type.

  • T2_MEDIUM: A t2.medium instance type.

  • R4_LARGE: A r4.large instance type.

  • R4_XLARGE: A r4.xlarge instance type.

  • R4_2XLARGE: A r4.2xlarge instance type.

  • R4_4XLARGE: A r4.4xlarge instance type.

  • R4_8XLARGE: A r4.8xlarge instance type.

" + "documentation":"

The cache instance type. Valid values are

  • SMALL

  • MEDIUM

  • LARGE

  • XLARGE

  • LARGE_2X

  • LARGE_4X

  • LARGE_8X (not available in all regions)

  • LARGE_12X

Historically, instance types were identified by an EC2-style value. As of July 2020, this is deprecated, and the generic identifiers above should be used.

The following legacy instance types are avaible, but their use is discouraged:

  • T2_SMALL: A t2.small instance type.

  • T2_MEDIUM: A t2.medium instance type.

  • R4_LARGE: A r4.large instance type.

  • R4_XLARGE: A r4.xlarge instance type.

  • R4_2XLARGE: A r4.2xlarge instance type.

  • R4_4XLARGE: A r4.4xlarge instance type.

  • R4_8XLARGE: A r4.8xlarge instance type.

" } }, "documentation":"

Represents the input of a UpdateApiCache operation.

" diff --git a/botocore/data/autoscaling/2011-01-01/service-2.json b/botocore/data/autoscaling/2011-01-01/service-2.json index 63e8b509..84d964fd 100644 --- a/botocore/data/autoscaling/2011-01-01/service-2.json +++ b/botocore/data/autoscaling/2011-01-01/service-2.json @@ -139,7 +139,7 @@ {"shape":"ResourceContentionFault"}, {"shape":"ServiceLinkedRoleFailure"} ], - "documentation":"

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 Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling Groups in the Amazon EC2 Auto Scaling User Guide.

" + "documentation":"

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 Amazon EC2 Auto Scaling User Guide. For more information, see Auto Scaling Groups in the Amazon EC2 Auto Scaling User Guide.

" }, "CreateLaunchConfiguration":{ "name":"CreateLaunchConfiguration", @@ -357,7 +357,7 @@ {"shape":"InvalidNextToken"}, {"shape":"ResourceContentionFault"} ], - "documentation":"

Describes one or more instance refreshes.

You can determine the status of a request by looking at the Status parameter. The following are the possible statuses:

  • Pending - The request was created, but the operation has not started.

  • InProgress - The operation is in progress.

  • Successful - The operation completed successfully.

  • Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

  • Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

  • Cancelled - The operation is cancelled.

" + "documentation":"

Describes one or more instance refreshes.

You can determine the status of a request by looking at the Status parameter. The following are the possible statuses:

  • Pending - The request was created, but the operation has not started.

  • InProgress - The operation is in progress.

  • Successful - The operation completed successfully.

  • Failed - The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.

  • Cancelling - An ongoing operation is being cancelled. Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.

  • Cancelled - The operation is cancelled.

For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.

" }, "DescribeLaunchConfigurations":{ "name":"DescribeLaunchConfigurations", @@ -669,7 +669,7 @@ {"shape":"ScalingActivityInProgressFault"}, {"shape":"ResourceContentionFault"} ], - "documentation":"

Executes the specified policy.

" + "documentation":"

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

" }, "ExitStandby":{ "name":"ExitStandby", @@ -837,7 +837,7 @@ {"shape":"ResourceContentionFault"}, {"shape":"InstanceRefreshInProgressFault"} ], - "documentation":"

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

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

For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.

" + "documentation":"

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

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

For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.

" }, "SuspendProcesses":{ "name":"SuspendProcesses", @@ -1142,7 +1142,7 @@ }, "DefaultCooldown":{ "shape":"Cooldown", - "documentation":"

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start.

" + "documentation":"

The duration of the default cooldown period, in seconds.

" }, "AvailabilityZones":{ "shape":"AvailabilityZones", @@ -1534,7 +1534,7 @@ }, "DefaultCooldown":{ "shape":"Cooldown", - "documentation":"

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

" + "documentation":"

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.

" }, "AvailabilityZones":{ "shape":"AvailabilityZones", @@ -1554,7 +1554,7 @@ }, "HealthCheckGracePeriod":{ "shape":"HealthCheckGracePeriod", - "documentation":"

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: This parameter is required if you are adding an ELB health check.

" + "documentation":"

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.

" }, "PlacementGroup":{ "shape":"XmlStringMaxLen255", @@ -1864,7 +1864,7 @@ "members":{ "InstanceRefreshes":{ "shape":"InstanceRefreshes", - "documentation":"

The instance refreshes for the specified group.

For more information, see Replacing Auto Scaling Instances Based on an Instance Refresh.

" + "documentation":"

The instance refreshes for the specified group.

" }, "NextToken":{ "shape":"XmlString", @@ -2227,11 +2227,11 @@ "members":{ "SnapshotId":{ "shape":"XmlStringMaxLen255", - "documentation":"

The snapshot ID of the volume to use.

Conditional: This parameter is optional if you specify a volume size. If you specify both SnapshotId and VolumeSize, VolumeSize must be equal or greater than the size of the snapshot.

" + "documentation":"

The snapshot ID of the volume to use.

You must specify either a VolumeSize or a SnapshotId.

" }, "VolumeSize":{ "shape":"BlockDeviceEbsVolumeSize", - "documentation":"

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.

At least one of VolumeSize or SnapshotId is required.

" + "documentation":"

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.

" }, "VolumeType":{ "shape":"BlockDeviceEbsVolumeType", @@ -2243,7 +2243,7 @@ }, "Iops":{ "shape":"BlockDeviceEbsIops", - "documentation":"

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.

Conditional: This parameter is required when the volume type is io1. (Not used with standard, gp2, st1, or sc1 volumes.)

" + "documentation":"

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

" }, "Encrypted":{ "shape":"BlockDeviceEbsEncrypted", @@ -2337,15 +2337,15 @@ }, "HonorCooldown":{ "shape":"HonorCooldown", - "documentation":"

Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.

This parameter is not supported if the policy type is StepScaling or TargetTrackingScaling.

For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

" + "documentation":"

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.

" }, "MetricValue":{ "shape":"MetricScale", - "documentation":"

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.

" + "documentation":"

The metric value to compare to BreachThreshold. This enables you to execute a policy of type StepScaling and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.

If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.

Required if the policy type is StepScaling and not supported otherwise.

" }, "BreachThreshold":{ "shape":"MetricScale", - "documentation":"

The breach threshold for the alarm.

Conditional: This parameter is required if the policy type is StepScaling and not supported otherwise.

" + "documentation":"

The breach threshold for the alarm.

Required if the policy type is StepScaling and not supported otherwise.

" } } }, @@ -3072,14 +3072,14 @@ "members":{ "LaunchTemplate":{ "shape":"LaunchTemplate", - "documentation":"

The launch template and instance types (overrides).

This parameter must be specified when creating a mixed instances policy.

" + "documentation":"

The launch template and instance types (overrides).

Required when creating a mixed instances policy.

" }, "InstancesDistribution":{ "shape":"InstancesDistribution", "documentation":"

The instances distribution to use.

If you leave this parameter unspecified, the value for each parameter in InstancesDistribution uses a default value.

" } }, - "documentation":"

Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User 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 template. For more information, see CreateAutoScalingGroup and UpdateAutoScalingGroup.

" + "documentation":"

Describes a mixed instances policy for an Auto Scaling group. With mixed instances, your Auto Scaling group can provision a combination of On-Demand Instances and Spot Instances across multiple instance types. For more information, see Auto Scaling Groups with Multiple Instance Types and Purchase Options in the Amazon EC2 Auto Scaling User 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.

" }, "MonitoringEnabled":{"type":"boolean"}, "NoDevice":{"type":"boolean"}, @@ -3223,11 +3223,11 @@ }, "LifecycleTransition":{ "shape":"LifecycleTransition", - "documentation":"

The instance state to which you want to attach the lifecycle hook. The valid values are:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

" + "documentation":"

The instance state to which you want to attach the lifecycle hook. The valid values are:

  • autoscaling:EC2_INSTANCE_LAUNCHING

  • autoscaling:EC2_INSTANCE_TERMINATING

Required for new lifecycle hooks, but optional when updating existing hooks.

" }, "RoleARN":{ "shape":"ResourceName", - "documentation":"

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.

Conditional: This parameter is required for new lifecycle hooks, but optional when updating existing hooks.

" + "documentation":"

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.

Required for new lifecycle hooks, but optional when updating existing hooks.

" }, "NotificationTargetARN":{ "shape":"NotificationTargetResourceName", @@ -3286,11 +3286,11 @@ }, "PolicyType":{ "shape":"XmlStringMaxLen64", - "documentation":"

The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling. If the policy type is null, the value is treated as SimpleScaling.

" + "documentation":"

One of the following policy types:

  • TargetTrackingScaling

  • StepScaling

  • SimpleScaling (default)

" }, "AdjustmentType":{ "shape":"XmlStringMaxLen255", - "documentation":"

Specifies whether the ScalingAdjustment parameter is an absolute number or a percentage of the current capacity. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

Valid only if the policy type is StepScaling or SimpleScaling. For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User Guide.

" + "documentation":"

Specifies how the scaling adjustment is interpreted (either 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.

" }, "MinAdjustmentStep":{ "shape":"MinAdjustmentStep", @@ -3298,15 +3298,15 @@ }, "MinAdjustmentMagnitude":{ "shape":"MinAdjustmentMagnitude", - "documentation":"

The minimum value to scale by when scaling by percentages. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a MinAdjustmentMagnitude of 2, Amazon EC2 Auto Scaling scales out the group by 2 instances.

Valid only if the policy type is StepScaling or SimpleScaling and the adjustment type is PercentChangeInCapacity. For more information, see Scaling Adjustment Types in the Amazon EC2 Auto Scaling User Guide.

" + "documentation":"

The minimum value to scale by when the adjustment type is PercentChangeInCapacity. For example, suppose that you create a step scaling policy to scale out an Auto Scaling group by 25 percent and you specify a MinAdjustmentMagnitude of 2. If the group has 4 instances and the scaling policy is performed, 25 percent of 4 is 1. However, because you specified a 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 Guide.

Some Auto Scaling groups use instance weights. In this case, set the MinAdjustmentMagnitude to a value that is at least as large as your largest instance weight.

" }, "ScalingAdjustment":{ "shape":"PolicyIncrement", - "documentation":"

The amount by which a simple scaling policy scales the Auto Scaling group in response to an alarm breach. The adjustment is based on the value that you specified in the AdjustmentType parameter (either an absolute number or a percentage). A positive value adds to the current capacity and a negative value subtracts from the current capacity. For exact capacity, you must specify a positive value.

Conditional: If you specify SimpleScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

" + "documentation":"

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

" }, "Cooldown":{ "shape":"Cooldown", - "documentation":"

The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start. If this parameter is not specified, the default cooldown period for the group applies.

Valid only if the policy type is SimpleScaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

" + "documentation":"

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.

" }, "MetricAggregationType":{ "shape":"XmlStringMaxLen32", @@ -3314,15 +3314,15 @@ }, "StepAdjustments":{ "shape":"StepAdjustments", - "documentation":"

A set of adjustments that enable you to scale based on the size of the alarm breach.

Conditional: If you specify StepScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

" + "documentation":"

A set of adjustments that enable you to scale based on the size of the alarm breach.

Required if the policy type is StepScaling. (Not used with any other policy type.)

" }, "EstimatedInstanceWarmup":{ "shape":"EstimatedInstanceWarmup", - "documentation":"

The estimated time, in seconds, until a newly launched instance can contribute to the CloudWatch metrics. The default is to use the value specified for the default cooldown period for the group.

Valid only if the policy type is StepScaling or TargetTrackingScaling.

" + "documentation":"

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.

" }, "TargetTrackingConfiguration":{ "shape":"TargetTrackingConfiguration", - "documentation":"

A target tracking scaling policy. Includes support for predefined or customized metrics.

For more information, see TargetTrackingConfiguration in the Amazon EC2 Auto Scaling API Reference.

Conditional: If you specify TargetTrackingScaling for the policy type, you must specify this parameter. (Not used with any other policy type.)

" + "documentation":"

A target tracking scaling policy. Includes support for predefined or customized metrics.

The following predefined metrics are available:

  • ASGAverageCPUUtilization

  • ASGAverageNetworkIn

  • ASGAverageNetworkOut

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

" }, "Enabled":{ "shape":"ScalingPolicyEnabled", @@ -3418,7 +3418,7 @@ }, "InstanceWarmup":{ "shape":"RefreshInstanceWarmup", - "documentation":"

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 specified for the health check grace period for the group.

Note: While warming up, a newly launched instance is not counted toward the aggregated metrics of the Auto Scaling group.

" + "documentation":"

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.

" } }, "documentation":"

Describes information used to start an instance refresh.

" @@ -3519,11 +3519,11 @@ }, "PolicyType":{ "shape":"XmlStringMaxLen64", - "documentation":"

The policy type. The valid values are SimpleScaling, StepScaling, and TargetTrackingScaling.

" + "documentation":"

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.

" }, "AdjustmentType":{ "shape":"XmlStringMaxLen255", - "documentation":"

The adjustment type, which specifies how ScalingAdjustment is interpreted. The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

" + "documentation":"

Specifies how the scaling adjustment is interpreted (either an absolute number or a percentage). The valid values are ChangeInCapacity, ExactCapacity, and PercentChangeInCapacity.

" }, "MinAdjustmentStep":{ "shape":"MinAdjustmentStep", @@ -3531,7 +3531,7 @@ }, "MinAdjustmentMagnitude":{ "shape":"MinAdjustmentMagnitude", - "documentation":"

The minimum number of instances to scale. If the value of AdjustmentType is PercentChangeInCapacity, the scaling policy changes the DesiredCapacity of the Auto Scaling group by at least this many instances. Otherwise, the error is ValidationError.

" + "documentation":"

The minimum value to scale by when the adjustment type is PercentChangeInCapacity.

" }, "ScalingAdjustment":{ "shape":"PolicyIncrement", @@ -3539,7 +3539,7 @@ }, "Cooldown":{ "shape":"Cooldown", - "documentation":"

The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.

" + "documentation":"

The duration of the policy's cooldown period, in seconds.

" }, "StepAdjustments":{ "shape":"StepAdjustments", @@ -3802,11 +3802,11 @@ }, "Strategy":{ "shape":"RefreshStrategy", - "documentation":"

The strategy to use for the instance refresh. The only valid value is Rolling.

A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale-in. If the rolling update process fails, any instances that were already replaced are not rolled back to their previous configuration.

" + "documentation":"

The strategy to use for the instance refresh. The only valid value is Rolling.

A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated. A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. If the rolling update process fails, any instances that were already replaced are not rolled back to their previous configuration.

" }, "Preferences":{ "shape":"RefreshPreferences", - "documentation":"

Set of preferences associated with the instance refresh request.

" + "documentation":"

Set of preferences associated with the instance refresh request.

If not provided, the default values are used. For MinHealthyPercentage, the default value is 90. For InstanceWarmup, the default is to 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 Reference.

" } } }, @@ -4020,7 +4020,7 @@ }, "DefaultCooldown":{ "shape":"Cooldown", - "documentation":"

The amount of time, in seconds, after a scaling activity completes before another scaling activity can start. The default value is 300. This cooldown period is not used when a scaling-specific cooldown is specified.

Cooldown periods are not supported for target tracking scaling policies, step scaling policies, or scheduled scaling. For more information, see Scaling Cooldowns in the Amazon EC2 Auto Scaling User Guide.

" + "documentation":"

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.

" }, "AvailabilityZones":{ "shape":"AvailabilityZones", @@ -4032,7 +4032,7 @@ }, "HealthCheckGracePeriod":{ "shape":"HealthCheckGracePeriod", - "documentation":"

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: This parameter is required if you are adding an ELB health check.

" + "documentation":"

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.

" }, "PlacementGroup":{ "shape":"XmlStringMaxLen255", diff --git a/botocore/data/backup/2018-11-15/service-2.json b/botocore/data/backup/2018-11-15/service-2.json index 352ce3be..73b18ebb 100644 --- a/botocore/data/backup/2018-11-15/service-2.json +++ b/botocore/data/backup/2018-11-15/service-2.json @@ -259,7 +259,7 @@ "errors":[ {"shape":"ServiceUnavailableException"} ], - "documentation":"

Returns the current service opt-in settings for the region. If the service has a value set to true, AWS Backup will attempt to protect that service's resources in this region, when included in an on-demand backup or scheduled backup plan. If the value is set to false for a service, AWS Backup will not attempt to protect that service's resources in this region.

" + "documentation":"

Returns the current service opt-in settings for the Region. If the service has a value set to true, AWS Backup attempts to protect that service's resources in this Region, when included in an on-demand backup or scheduled backup plan. If the value is set to false for a service, AWS Backup does not attempt to protect that service's resources in this Region.

" }, "DescribeRestoreJob":{ "name":"DescribeRestoreJob", @@ -435,7 +435,6 @@ "output":{"shape":"ListBackupJobsOutput"}, "errors":[ {"shape":"InvalidParameterValueException"}, - {"shape":"InvalidRequestException"}, {"shape":"ServiceUnavailableException"} ], "documentation":"

Returns metadata about your backup jobs.

", @@ -802,11 +801,15 @@ {"shape":"MissingParameterValueException"}, {"shape":"InvalidParameterValueException"} ], - "documentation":"

Updates the current service opt-in settings for the region. If the service has a value set to true, AWS Backup will attempt to protect that service's resources in this region, when included in an on-demand backup or scheduled backup plan. If the value is set to false for a service, AWS Backup will not attempt to protect that service's resources in this region.

" + "documentation":"

Updates the current service opt-in settings for the Region. If the service has a value set to true, AWS Backup attempts to protect that service's resources in this Region, when included in an on-demand backup or scheduled backup plan. If the value is set to false for a service, AWS Backup does not attempt to protect that service's resources in this Region.

" } }, "shapes":{ "ARN":{"type":"string"}, + "AccountId":{ + "type":"string", + "pattern":"^[0-9]{12}$" + }, "AlreadyExistsException":{ "type":"structure", "members":{ @@ -835,6 +838,10 @@ "BackupJob":{ "type":"structure", "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The account ID that owns the backup job.

" + }, "BackupJobId":{ "shape":"string", "documentation":"

Uniquely identifies a request to AWS Backup to back up a resource.

" @@ -950,7 +957,7 @@ "members":{ "BackupPlanName":{ "shape":"BackupPlanName", - "documentation":"

The display name of a backup plan.

" + "documentation":"

The optional display name of a backup plan.

" }, "Rules":{ "shape":"BackupRulesInput", @@ -1313,6 +1320,10 @@ "CopyJob":{ "type":"structure", "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The account ID that owns the copy job.

" + }, "CopyJobId":{ "shape":"string", "documentation":"

Uniquely identifies a copy job.

" @@ -1339,11 +1350,11 @@ }, "CreationDate":{ "shape":"timestamp", - "documentation":"

The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + "documentation":"

The date and time a copy job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "CompletionDate":{ "shape":"timestamp", - "documentation":"

The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + "documentation":"

The date and time a copy job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "State":{ "shape":"CopyJobState", @@ -1528,7 +1539,7 @@ }, "DeletionDate":{ "shape":"timestamp", - "documentation":"

The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + "documentation":"

The date and time a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "VersionId":{ "shape":"string", @@ -1647,6 +1658,10 @@ "DescribeBackupJobOutput":{ "type":"structure", "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

Returns the account ID that owns the backup job.

" + }, "BackupJobId":{ "shape":"string", "documentation":"

Uniquely identifies a request to AWS Backup to back up a resource.

" @@ -1673,7 +1688,7 @@ }, "CompletionDate":{ "shape":"timestamp", - "documentation":"

The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + "documentation":"

The date and time that a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "State":{ "shape":"BackupJobState", @@ -1931,6 +1946,10 @@ "DescribeRestoreJobOutput":{ "type":"structure", "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

Returns the account ID that owns the restore job.

" + }, "RestoreJobId":{ "shape":"string", "documentation":"

Uniquely identifies the job that restores a recovery point.

" @@ -1953,7 +1972,7 @@ }, "StatusMessage":{ "shape":"string", - "documentation":"

A detailed message explaining the status of a job to restore a recovery point.

" + "documentation":"

A message showing the status of a job to restore a recovery point.

" }, "PercentDone":{ "shape":"string", @@ -1974,6 +1993,10 @@ "CreatedResourceArn":{ "shape":"ARN", "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery point is being restored. The format of the ARN depends on the resource type of the backed-up resource.

" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

Returns metadata associated with a restore job listed by resource type.

" } } }, @@ -2085,7 +2108,7 @@ }, "DeletionDate":{ "shape":"timestamp", - "documentation":"

The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" + "documentation":"

The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

" }, "LastExecutionDate":{ "shape":"timestamp", @@ -2244,7 +2267,7 @@ "members":{ "ResourceTypes":{ "shape":"ResourceTypes", - "documentation":"

Contains a string with the supported AWS resource types:

  • EBS for Amazon Elastic Block Store

  • Storage Gateway for AWS Storage Gateway

  • RDS for Amazon Relational Database Service

  • DDB for Amazon DynamoDB

  • EFS for Amazon Elastic File System

" + "documentation":"

Contains a string with the supported AWS resource types:

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

" } } }, @@ -2363,9 +2386,15 @@ }, "ByResourceType":{ "shape":"ResourceType", - "documentation":"

Returns only backup jobs for the specified resources:

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

", + "documentation":"

Returns only backup jobs for the specified resources:

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

", "location":"querystring", "locationName":"resourceType" + }, + "ByAccountId":{ + "shape":"AccountId", + "documentation":"

The account ID to list the jobs from. Returns only backup jobs associated with the specified account ID.

", + "location":"querystring", + "locationName":"accountId" } } }, @@ -2593,7 +2622,7 @@ }, "ByResourceType":{ "shape":"ResourceType", - "documentation":"

Returns only backup jobs for the specified resources:

  • EBS for Amazon Elastic Block Store

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

", + "documentation":"

Returns only backup jobs for the specified resources:

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

", "location":"querystring", "locationName":"resourceType" }, @@ -2602,6 +2631,12 @@ "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

", "location":"querystring", "locationName":"destinationVaultArn" + }, + "ByAccountId":{ + "shape":"AccountId", + "documentation":"

The account ID to list the jobs from. Returns only copy jobs associated with the specified account ID.

", + "location":"querystring", + "locationName":"accountId" } } }, @@ -2770,6 +2805,30 @@ "documentation":"

The maximum number of items to be returned.

", "location":"querystring", "locationName":"maxResults" + }, + "ByAccountId":{ + "shape":"AccountId", + "documentation":"

The account ID to list the jobs from. Returns only restore jobs associated with the specified account ID.

", + "location":"querystring", + "locationName":"accountId" + }, + "ByCreatedBefore":{ + "shape":"timestamp", + "documentation":"

Returns only restore jobs that were created before the specified date.

", + "location":"querystring", + "locationName":"createdBefore" + }, + "ByCreatedAfter":{ + "shape":"timestamp", + "documentation":"

Returns only restore jobs that were created after the specified date.

", + "location":"querystring", + "locationName":"createdAfter" + }, + "ByStatus":{ + "shape":"RestoreJobStatus", + "documentation":"

Returns only restore jobs associated with the specified job status.

", + "location":"querystring", + "locationName":"status" } } }, @@ -3107,6 +3166,10 @@ "RestoreJobsListMember":{ "type":"structure", "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The account ID that owns the restore job.

" + }, "RestoreJobId":{ "shape":"string", "documentation":"

Uniquely identifies the job that restores a recovery point.

" @@ -3150,6 +3213,10 @@ "CreatedResourceArn":{ "shape":"ARN", "documentation":"

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

" + }, + "ResourceType":{ + "shape":"ResourceType", + "documentation":"

The resource type of the listed restore jobs; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.

" } }, "documentation":"

Contains metadata about a restore job.

" @@ -3302,7 +3369,7 @@ }, "ResourceType":{ "shape":"ResourceType", - "documentation":"

Starts a job to restore a recovery point for one of the following resources:

  • EBS for Amazon Elastic Block Store

  • Storage Gateway for AWS Storage Gateway

  • RDS for Amazon Relational Database Service

  • DDB for Amazon DynamoDB

  • EFS for Amazon Elastic File System

" + "documentation":"

Starts a job to restore a recovery point for one of the following resources:

  • DynamoDB for Amazon DynamoDB

  • EBS for Amazon Elastic Block Store

  • EC2 for Amazon Elastic Compute Cloud

  • EFS for Amazon Elastic File System

  • RDS for Amazon Relational Database Service

  • Storage Gateway for AWS Storage Gateway

" } } }, diff --git a/botocore/data/ce/2017-10-25/service-2.json b/botocore/data/ce/2017-10-25/service-2.json index 6eae8234..e8e35ffa 100644 --- a/botocore/data/ce/2017-10-25/service-2.json +++ b/botocore/data/ce/2017-10-25/service-2.json @@ -178,7 +178,7 @@ {"shape":"LimitExceededException"}, {"shape":"InvalidNextTokenException"} ], - "documentation":"

Creates recommendations that helps you save cost by identifying idle and underutilized Amazon EC2 instances.

Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For details on calculation and function, see Optimizing Your Cost with Rightsizing Recommendations.

" + "documentation":"

Creates recommendations that help you save cost by identifying idle and underutilized Amazon EC2 instances.

Recommendations are generated to either downsize or terminate instances, along with providing savings detail and metrics. For details on calculation and function, see Optimizing Your Cost with Rightsizing Recommendations in the AWS Billing and Cost Management User Guide.

" }, "GetSavingsPlansCoverage":{ "name":"GetSavingsPlansCoverage", @@ -584,6 +584,10 @@ "shape":"GenericString", "documentation":"

Resource ID of the current instance.

" }, + "InstanceName":{ + "shape":"GenericString", + "documentation":"

The name you've given an instance. This field will show as blank if you haven't given the instance a name.

" + }, "Tags":{ "shape":"TagValuesList", "documentation":"

Cost allocation resource tags applied to the instance.

" @@ -1347,7 +1351,7 @@ "Filter":{"shape":"Expression"}, "Configuration":{ "shape":"RightsizingRecommendationConfiguration", - "documentation":"

Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or niether.

" + "documentation":"

Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.

" }, "Service":{ "shape":"GenericString", @@ -1384,7 +1388,7 @@ }, "Configuration":{ "shape":"RightsizingRecommendationConfiguration", - "documentation":"

Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or niether.

" + "documentation":"

Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.

" } } }, @@ -1452,7 +1456,7 @@ }, "TermInYears":{ "shape":"TermInYears", - "documentation":"

The savings plan recommendation term used to generated these recommendations.

" + "documentation":"

The savings plan recommendation term used to generate these recommendations.

" }, "PaymentOption":{ "shape":"PaymentOption", @@ -2367,7 +2371,7 @@ "documentation":"

The option to consider RI or Savings Plans discount benefits in your savings calculation. The default value is TRUE.

" } }, - "documentation":"

Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or niether.

" + "documentation":"

Enables you to customize recommendations across two attributes. You can choose to view recommendations for instances within the same instance families or across different instance families. You can also choose to view your estimated savings associated with recommendations with consideration of existing Savings Plans or RI benefits, or neither.

" }, "RightsizingRecommendationList":{ "type":"list", @@ -2382,7 +2386,7 @@ }, "GenerationTimestamp":{ "shape":"GenericString", - "documentation":"

The time stamp for when Amazon Web Services made this recommendation.

" + "documentation":"

The timestamp for when Amazon Web Services made this recommendation.

" }, "LookbackPeriodInDays":{ "shape":"LookbackPeriodInDays", @@ -2408,7 +2412,7 @@ }, "SavingsPercentage":{ "shape":"GenericString", - "documentation":"

Savings percentage based on the recommended modifications, relative to the total On Demand costs associated with these instances.

" + "documentation":"

Savings percentage based on the recommended modifications, relative to the total On-Demand costs associated with these instances.

" } }, "documentation":"

Summary of rightsizing recommendations

" diff --git a/botocore/data/chime/2018-05-01/service-2.json b/botocore/data/chime/2018-05-01/service-2.json index cd845f55..92802767 100644 --- a/botocore/data/chime/2018-05-01/service-2.json +++ b/botocore/data/chime/2018-05-01/service-2.json @@ -656,6 +656,25 @@ ], "documentation":"

Deletes the specified Amazon Chime Voice Connector. Any phone numbers associated with the Amazon Chime Voice Connector must be disassociated from it before it can be deleted.

" }, + "DeleteVoiceConnectorEmergencyCallingConfiguration":{ + "name":"DeleteVoiceConnectorEmergencyCallingConfiguration", + "http":{ + "method":"DELETE", + "requestUri":"/voice-connectors/{voiceConnectorId}/emergency-calling-configuration", + "responseCode":204 + }, + "input":{"shape":"DeleteVoiceConnectorEmergencyCallingConfigurationRequest"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Deletes the emergency calling configuration details from the specified Amazon Chime Voice Connector.

" + }, "DeleteVoiceConnectorGroup":{ "name":"DeleteVoiceConnectorGroup", "http":{ @@ -693,7 +712,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], - "documentation":"

Deletes the origination settings for the specified Amazon Chime Voice Connector.

" + "documentation":"

Deletes the origination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the origination settings.

" }, "DeleteVoiceConnectorProxy":{ "name":"DeleteVoiceConnectorProxy", @@ -750,7 +769,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], - "documentation":"

Deletes the termination settings for the specified Amazon Chime Voice Connector.

" + "documentation":"

Deletes the termination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to deleting the termination settings.

" }, "DeleteVoiceConnectorTerminationCredentials":{ "name":"DeleteVoiceConnectorTerminationCredentials", @@ -1163,6 +1182,26 @@ ], "documentation":"

Retrieves details for the specified Amazon Chime Voice Connector, such as timestamps, name, outbound host, and encryption requirements.

" }, + "GetVoiceConnectorEmergencyCallingConfiguration":{ + "name":"GetVoiceConnectorEmergencyCallingConfiguration", + "http":{ + "method":"GET", + "requestUri":"/voice-connectors/{voiceConnectorId}/emergency-calling-configuration", + "responseCode":200 + }, + "input":{"shape":"GetVoiceConnectorEmergencyCallingConfigurationRequest"}, + "output":{"shape":"GetVoiceConnectorEmergencyCallingConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

Gets the emergency calling configuration details for the specified Amazon Chime Voice Connector.

" + }, "GetVoiceConnectorGroup":{ "name":"GetVoiceConnectorGroup", "http":{ @@ -1695,6 +1734,26 @@ ], "documentation":"

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

To turn off existing retention settings, remove the number of days from the corresponding RetentionDays field in the RetentionSettings object. For more information about retention settings, see Managing Chat Retention Policies in the Amazon Chime Administration Guide.

" }, + "PutVoiceConnectorEmergencyCallingConfiguration":{ + "name":"PutVoiceConnectorEmergencyCallingConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/voice-connectors/{voiceConnectorId}/emergency-calling-configuration", + "responseCode":200 + }, + "input":{"shape":"PutVoiceConnectorEmergencyCallingConfigurationRequest"}, + "output":{"shape":"PutVoiceConnectorEmergencyCallingConfigurationResponse"}, + "errors":[ + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"ThrottledClientException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"} + ], + "documentation":"

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

" + }, "PutVoiceConnectorLoggingConfiguration":{ "name":"PutVoiceConnectorLoggingConfiguration", "http":{ @@ -1733,7 +1792,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], - "documentation":"

Adds origination settings for the specified Amazon Chime Voice Connector.

" + "documentation":"

Adds origination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off origination settings.

" }, "PutVoiceConnectorProxy":{ "name":"PutVoiceConnectorProxy", @@ -1794,7 +1853,7 @@ {"shape":"ServiceUnavailableException"}, {"shape":"ServiceFailureException"} ], - "documentation":"

Adds termination settings for the specified Amazon Chime Voice Connector.

" + "documentation":"

Adds termination settings for the specified Amazon Chime Voice Connector.

If emergency calling is configured for the Amazon Chime Voice Connector, it must be deleted prior to turning off termination settings.

" }, "PutVoiceConnectorTerminationCredentials":{ "name":"PutVoiceConnectorTerminationCredentials", @@ -2408,6 +2467,10 @@ }, "documentation":"

The Alexa for Business metadata associated with an Amazon Chime user, used to integrate Alexa for Business with a device.

" }, + "Alpha2CountryCode":{ + "type":"string", + "pattern":"[A-Z]{2}" + }, "AreaCode":{ "type":"string", "pattern":"^$|^[0-9]{3,3}$" @@ -2452,7 +2515,10 @@ }, "AssociatePhoneNumbersWithVoiceConnectorGroupRequest":{ "type":"structure", - "required":["VoiceConnectorGroupId"], + "required":[ + "VoiceConnectorGroupId", + "E164PhoneNumbers" + ], "members":{ "VoiceConnectorGroupId":{ "shape":"NonEmptyString", @@ -2481,7 +2547,10 @@ }, "AssociatePhoneNumbersWithVoiceConnectorRequest":{ "type":"structure", - "required":["VoiceConnectorId"], + "required":[ + "VoiceConnectorId", + "E164PhoneNumbers" + ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", @@ -3366,6 +3435,32 @@ "type":"list", "member":{"shape":"Credential"} }, + "DNISEmergencyCallingConfiguration":{ + "type":"structure", + "required":[ + "EmergencyPhoneNumber", + "CallingCountry" + ], + "members":{ + "EmergencyPhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"

The DNIS phone number to route emergency calls to, in E.164 format.

" + }, + "TestPhoneNumber":{ + "shape":"E164PhoneNumber", + "documentation":"

The DNIS phone number to route test emergency calls to, in E.164 format.

" + }, + "CallingCountry":{ + "shape":"Alpha2CountryCode", + "documentation":"

The country from which emergency calls are allowed, in ISO 3166-1 alpha-2 format.

" + } + }, + "documentation":"

The Dialed Number Identification Service (DNIS) emergency calling configuration details associated with an Amazon Chime Voice Connector's emergency calling configuration.

" + }, + "DNISEmergencyCallingConfigurationList":{ + "type":"list", + "member":{"shape":"DNISEmergencyCallingConfiguration"} + }, "DataRetentionInHours":{ "type":"integer", "min":0 @@ -3523,6 +3618,18 @@ } } }, + "DeleteVoiceConnectorEmergencyCallingConfigurationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, "DeleteVoiceConnectorGroupRequest":{ "type":"structure", "required":["VoiceConnectorGroupId"], @@ -3585,7 +3692,10 @@ }, "DeleteVoiceConnectorTerminationCredentialsRequest":{ "type":"structure", - "required":["VoiceConnectorId"], + "required":[ + "Usernames", + "VoiceConnectorId" + ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", @@ -3639,7 +3749,10 @@ }, "DisassociatePhoneNumbersFromVoiceConnectorGroupRequest":{ "type":"structure", - "required":["VoiceConnectorGroupId"], + "required":[ + "VoiceConnectorGroupId", + "E164PhoneNumbers" + ], "members":{ "VoiceConnectorGroupId":{ "shape":"NonEmptyString", @@ -3664,7 +3777,10 @@ }, "DisassociatePhoneNumbersFromVoiceConnectorRequest":{ "type":"structure", - "required":["VoiceConnectorId"], + "required":[ + "VoiceConnectorId", + "E164PhoneNumbers" + ], "members":{ "VoiceConnectorId":{ "shape":"NonEmptyString", @@ -3733,6 +3849,16 @@ "Failed" ] }, + "EmergencyCallingConfiguration":{ + "type":"structure", + "members":{ + "DNIS":{ + "shape":"DNISEmergencyCallingConfigurationList", + "documentation":"

The Dialed Number Identification Service (DNIS) emergency calling configuration details.

" + } + }, + "documentation":"

The emergency calling configuration details associated with an Amazon Chime Voice Connector.

" + }, "ErrorCode":{ "type":"string", "enum":[ @@ -4183,6 +4309,27 @@ } } }, + "GetVoiceConnectorEmergencyCallingConfigurationRequest":{ + "type":"structure", + "required":["VoiceConnectorId"], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + } + } + }, + "GetVoiceConnectorEmergencyCallingConfigurationResponse":{ + "type":"structure", + "members":{ + "EmergencyCallingConfiguration":{ + "shape":"EmergencyCallingConfiguration", + "documentation":"

The emergency calling configuration details.

" + } + } + }, "GetVoiceConnectorGroupRequest":{ "type":"structure", "required":["VoiceConnectorGroupId"], @@ -5756,6 +5903,34 @@ } } }, + "PutVoiceConnectorEmergencyCallingConfigurationRequest":{ + "type":"structure", + "required":[ + "VoiceConnectorId", + "EmergencyCallingConfiguration" + ], + "members":{ + "VoiceConnectorId":{ + "shape":"NonEmptyString", + "documentation":"

The Amazon Chime Voice Connector ID.

", + "location":"uri", + "locationName":"voiceConnectorId" + }, + "EmergencyCallingConfiguration":{ + "shape":"EmergencyCallingConfiguration", + "documentation":"

The emergency calling configuration details.

" + } + } + }, + "PutVoiceConnectorEmergencyCallingConfigurationResponse":{ + "type":"structure", + "members":{ + "EmergencyCallingConfiguration":{ + "shape":"EmergencyCallingConfiguration", + "documentation":"

The emergency calling configuration details.

" + } + } + }, "PutVoiceConnectorLoggingConfigurationRequest":{ "type":"structure", "required":[ diff --git a/botocore/data/cloudformation/2010-05-15/service-2.json b/botocore/data/cloudformation/2010-05-15/service-2.json index d9db94ba..48e7d3e6 100644 --- a/botocore/data/cloudformation/2010-05-15/service-2.json +++ b/botocore/data/cloudformation/2010-05-15/service-2.json @@ -564,7 +564,7 @@ "errors":[ {"shape":"StackSetNotFoundException"} ], - "documentation":"

Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or Region.

" + "documentation":"

Returns summary information about stack instances that are associated with the specified stack set. You can filter for stack instances that are associated with a specific AWS account name or Region, or that have a specific status.

" }, "ListStackResources":{ "name":"ListStackResources", @@ -2655,6 +2655,10 @@ "shape":"MaxResults", "documentation":"

The maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

" }, + "Filters":{ + "shape":"StackInstanceFilters", + "documentation":"

The status that stack instances are filtered by.

" + }, "StackInstanceAccount":{ "shape":"Account", "documentation":"

The name of the AWS account that you want to list stack instances for.

" @@ -3608,7 +3612,7 @@ "members":{ "ResourceType":{ "shape":"ResourceType", - "documentation":"

The type of resource to import into your stack, such as AWS::S3::Bucket.

" + "documentation":"

The type of resource to import into your stack, such as AWS::S3::Bucket. For a list of supported resource types, see Resources that support import operations in the AWS CloudFormation User Guide.

" }, "LogicalResourceId":{ "shape":"LogicalResourceId", @@ -4020,6 +4024,10 @@ "shape":"StackInstanceStatus", "documentation":"

The status of the stack instance, in terms of its synchronization with its associated stack set.

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

  • OUTDATED: The stack isn't currently up to date with the stack set because:

    • The associated stack failed during a CreateStackSet or UpdateStackSet operation.

    • The stack was part of a CreateStackSet or UpdateStackSet operation that failed or was stopped before the stack was created or updated.

  • CURRENT: The stack is currently up to date with the stack set.

" }, + "StackInstanceStatus":{ + "shape":"StackInstanceComprehensiveStatus", + "documentation":"

The detailed status of the stack instance.

" + }, "StatusReason":{ "shape":"Reason", "documentation":"

The explanation for the specific status code that is assigned to this stack instance.

" @@ -4039,6 +4047,55 @@ }, "documentation":"

An AWS CloudFormation stack, in a specific account and Region, that's part of a stack set operation. A stack instance is a reference to an attempted or actual stack in a given account within a given Region. A stack instance can exist without a stack—for example, if the stack couldn't be created for some reason. A stack instance is associated with only one stack set. Each stack instance contains the ID of its associated stack set, as well as the ID of the actual stack and the stack status.

" }, + "StackInstanceComprehensiveStatus":{ + "type":"structure", + "members":{ + "DetailedStatus":{ + "shape":"StackInstanceDetailedStatus", + "documentation":"

  • CANCELLED: The operation in the specified account and Region has been cancelled. This is either because a user has stopped the stack set operation, or because the failure tolerance of the stack set operation has been exceeded.

  • FAILED: The operation in the specified account and Region failed. If the stack set operation fails in enough accounts within a Region, the failure tolerance for the stack set operation as a whole might be exceeded.

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

  • PENDING: The operation in the specified account and Region has yet to start.

  • RUNNING: The operation in the specified account and Region is currently in progress.

  • SUCCEEDED: The operation in the specified account and Region completed successfully.

" + } + }, + "documentation":"

The detailed status of the stack instance.

" + }, + "StackInstanceDetailedStatus":{ + "type":"string", + "enum":[ + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED", + "CANCELLED", + "INOPERABLE" + ] + }, + "StackInstanceFilter":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"StackInstanceFilterName", + "documentation":"

The type of filter to apply.

" + }, + "Values":{ + "shape":"StackInstanceFilterValues", + "documentation":"

The status to filter by.

" + } + }, + "documentation":"

The status that stack instances are filtered by.

" + }, + "StackInstanceFilterName":{ + "type":"string", + "enum":["DETAILED_STATUS"] + }, + "StackInstanceFilterValues":{ + "type":"string", + "max":10, + "min":6 + }, + "StackInstanceFilters":{ + "type":"list", + "member":{"shape":"StackInstanceFilter"}, + "max":1 + }, "StackInstanceNotFoundException":{ "type":"structure", "members":{ @@ -4090,6 +4147,10 @@ "shape":"Reason", "documentation":"

The explanation for the specific status code assigned to this stack instance.

" }, + "StackInstanceStatus":{ + "shape":"StackInstanceComprehensiveStatus", + "documentation":"

The detailed status of the stack instance.

" + }, "OrganizationalUnitId":{ "shape":"OrganizationalUnitId", "documentation":"

[Service-managed permissions] The organization root ID or organizational unit (OU) IDs that you specified for DeploymentTargets.

" diff --git a/botocore/data/cloudfront/2019-03-26/service-2.json b/botocore/data/cloudfront/2019-03-26/service-2.json index cff4cfc5..8da11801 100644 --- a/botocore/data/cloudfront/2019-03-26/service-2.json +++ b/botocore/data/cloudfront/2019-03-26/service-2.json @@ -1368,7 +1368,7 @@ }, "Location":{ "shape":"string", - "documentation":"

The fully qualified URI of the new origin access identity just created. For example: https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A.

", + "documentation":"

The fully qualified URI of the new origin access identity just created.

", "location":"header", "locationName":"Location" }, @@ -1405,7 +1405,7 @@ }, "Location":{ "shape":"string", - "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "documentation":"

The fully qualified URI of the new distribution resource just created.

", "location":"header", "locationName":"Location" }, @@ -1442,7 +1442,7 @@ }, "Location":{ "shape":"string", - "documentation":"

The fully qualified URI of the new distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5.

", + "documentation":"

The fully qualified URI of the new distribution resource just created.

", "location":"header", "locationName":"Location" }, @@ -1478,7 +1478,7 @@ }, "Location":{ "shape":"string", - "documentation":"

The fully qualified URI of the new configuration resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-config/EDFDVBD632BHDS5.

", + "documentation":"

The fully qualified URI of the new configuration resource just created.

", "location":"header", "locationName":"Location" }, @@ -1513,7 +1513,7 @@ }, "Location":{ "shape":"string", - "documentation":"

The fully qualified URI of the new profile resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/field-level-encryption-profile/EDFDVBD632BHDS5.

", + "documentation":"

The fully qualified URI of the new profile resource just created.

", "location":"header", "locationName":"Location" }, @@ -1588,7 +1588,7 @@ }, "Location":{ "shape":"string", - "documentation":"

The fully qualified URI of the new public key resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/cloudfront-public-key/EDFDVBD632BHDS5.

", + "documentation":"

The fully qualified URI of the new public key resource just created.

", "location":"header", "locationName":"Location" }, @@ -1624,7 +1624,7 @@ }, "Location":{ "shape":"string", - "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created.

", "location":"header", "locationName":"Location" }, @@ -1661,7 +1661,7 @@ }, "Location":{ "shape":"string", - "documentation":"

The fully qualified URI of the new streaming distribution resource just created. For example: https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8.

", + "documentation":"

The fully qualified URI of the new streaming distribution resource just created.

", "location":"header", "locationName":"Location" }, @@ -3827,7 +3827,8 @@ "TLSv1", "TLSv1_2016", "TLSv1.1_2016", - "TLSv1.2_2018" + "TLSv1.2_2018", + "TLSv1.2_2019" ] }, "MissingBody":{ @@ -5411,11 +5412,11 @@ }, "SSLSupportMethod":{ "shape":"SSLSupportMethod", - "documentation":"

If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.

  • sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is recommended. Most browsers and clients released after 2010 support SNI.

  • vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.

If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don’t set a value for this field.

" + "documentation":"

If the distribution uses Aliases (alternate domain names or CNAMEs), specify which viewers the distribution accepts HTTPS connections from.

  • sni-only – The distribution accepts HTTPS connections from only viewers that support server name indication (SNI). This is recommended. Most browsers and clients support SNI.

  • vip – The distribution accepts HTTPS connections from all viewers including those that don’t support SNI. This is not recommended, and results in additional monthly charges from CloudFront.

If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net, don’t set a value for this field.

" }, "MinimumProtocolVersion":{ "shape":"MinimumProtocolVersion", - "documentation":"

If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:

  • The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.

  • The ciphers that CloudFront can use to encrypt the content that it returns to viewers.

For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

On the CloudFront console, this setting is called Security Policy.

We recommend that you specify TLSv1.2_2018 unless your viewers are using browsers or devices that don’t support TLSv1.2.

When you’re using SNI only (you set SSLSupportMethod to sni-only), you must specify TLSv1 or higher.

If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.

" + "documentation":"

If the distribution uses Aliases (alternate domain names or CNAMEs), specify the security policy that you want CloudFront to use for HTTPS connections with viewers. The security policy determines two settings:

  • The minimum SSL/TLS protocol that CloudFront can use to communicate with viewers.

  • The ciphers that CloudFront can use to encrypt the content that it returns to viewers.

For more information, see Security Policy and Supported Protocols and Ciphers Between Viewers and CloudFront in the Amazon CloudFront Developer Guide.

On the CloudFront console, this setting is called Security Policy.

When you’re using SNI only (you set SSLSupportMethod to sni-only), you must specify TLSv1 or higher.

If the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net (you set CloudFrontDefaultCertificate to true), CloudFront automatically sets the security policy to TLSv1 regardless of the value that you set here.

" }, "Certificate":{ "shape":"string", @@ -5428,7 +5429,7 @@ "deprecated":true } }, - "documentation":"

A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.

If the distribution doesn’t use Aliases (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net—set CloudFrontDefaultCertificate to true and leave all other fields empty.

If the distribution uses Aliases (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:

  • Which viewers the distribution accepts HTTPS connections from: only viewers that support server name indication (SNI) (recommended), or all viewers including those that don’t support SNI.

    • To accept HTTPS connections from only viewers that support SNI, set SSLSupportMethod to sni-only. This is recommended. Most browsers and clients released after 2010 support SNI.

    • To accept HTTPS connections from all viewers, including those that don’t support SNI, set SSLSupportMethod to vip. This is not recommended, and results in additional monthly charges from CloudFront.

  • The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for MinimumProtocolVersion. For more information, see Security Policy in the Amazon CloudFront Developer Guide.

  • The location of the SSL/TLS certificate, AWS Certificate Manager (ACM) (recommended) or AWS Identity and Access Management (AWS IAM). You specify the location by setting a value in one of the following fields (not both):

    • ACMCertificateArn

    • IAMCertificateId

All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ViewerProtocolPolicy in the CacheBehavior or DefaultCacheBehavior. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use CustomOriginConfig.

For more information, see Using HTTPS with CloudFront and Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" + "documentation":"

A complex type that determines the distribution’s SSL/TLS configuration for communicating with viewers.

If the distribution doesn’t use Aliases (also known as alternate domain names or CNAMEs)—that is, if the distribution uses the CloudFront domain name such as d111111abcdef8.cloudfront.net—set CloudFrontDefaultCertificate to true and leave all other fields empty.

If the distribution uses Aliases (alternate domain names or CNAMEs), use the fields in this type to specify the following settings:

  • Which viewers the distribution accepts HTTPS connections from: only viewers that support server name indication (SNI) (recommended), or all viewers including those that don’t support SNI.

    • To accept HTTPS connections from only viewers that support SNI, set SSLSupportMethod to sni-only. This is recommended. Most browsers and clients support SNI.

    • To accept HTTPS connections from all viewers, including those that don’t support SNI, set SSLSupportMethod to vip. This is not recommended, and results in additional monthly charges from CloudFront.

  • The minimum SSL/TLS protocol version that the distribution can use to communicate with viewers. To specify a minimum version, choose a value for MinimumProtocolVersion. For more information, see Security Policy in the Amazon CloudFront Developer Guide.

  • The location of the SSL/TLS certificate, AWS Certificate Manager (ACM) (recommended) or AWS Identity and Access Management (AWS IAM). You specify the location by setting a value in one of the following fields (not both):

    • ACMCertificateArn

    • IAMCertificateId

All distributions support HTTPS connections from viewers. To require viewers to use HTTPS only, or to redirect them from HTTP to HTTPS, use ViewerProtocolPolicy in the CacheBehavior or DefaultCacheBehavior. To specify how CloudFront should use SSL/TLS to communicate with your custom origin, use CustomOriginConfig.

For more information, see Using HTTPS with CloudFront and Using Alternate Domain Names and HTTPS in the Amazon CloudFront Developer Guide.

" }, "ViewerProtocolPolicy":{ "type":"string", diff --git a/botocore/data/cloudhsmv2/2017-04-28/service-2.json b/botocore/data/cloudhsmv2/2017-04-28/service-2.json index 51c2a78b..00344f7c 100644 --- a/botocore/data/cloudhsmv2/2017-04-28/service-2.json +++ b/botocore/data/cloudhsmv2/2017-04-28/service-2.json @@ -270,7 +270,7 @@ }, "SourceRegion":{ "shape":"Region", - "documentation":"

The AWS region that contains the source backup from which the new backup was copied.

" + "documentation":"

The AWS Region that contains the source backup from which the new backup was copied.

" }, "SourceBackup":{ "shape":"BackupId", @@ -278,13 +278,16 @@ }, "SourceCluster":{ "shape":"ClusterId", - "documentation":"

The identifier (ID) of the cluster containing the source backup from which the new backup was copied. .

" + "documentation":"

The identifier (ID) of the cluster containing the source backup from which the new backup was copied.

" }, "DeleteTimestamp":{ "shape":"Timestamp", "documentation":"

The date and time when the backup will be permanently deleted.

" }, - "TagList":{"shape":"TagList"} + "TagList":{ + "shape":"TagList", + "documentation":"

The list of tags for the backup.

" + } }, "documentation":"

Contains information about a backup of an AWS CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion paramters. A backup that is pending deletion will include the DeleteTimestamp parameter.

" }, @@ -387,6 +390,7 @@ "members":{ "Message":{"shape":"errorMessage"} }, + "documentation":"

The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.

", "exception":true }, "Cluster":{ @@ -444,7 +448,10 @@ "shape":"Certificates", "documentation":"

Contains one or more certificates or a certificate signing request (CSR).

" }, - "TagList":{"shape":"TagList"} + "TagList":{ + "shape":"TagList", + "documentation":"

The list of tags for the cluster.

" + } }, "documentation":"

Contains information about an AWS CloudHSM cluster.

" }, @@ -485,7 +492,10 @@ "shape":"BackupId", "documentation":"

The ID of the backup that will be copied to the destination region.

" }, - "TagList":{"shape":"TagList"} + "TagList":{ + "shape":"TagList", + "documentation":"

Tags to apply to the destination backup during creation. If you specify tags, only these tags will be applied to the destination backup. If you do not specify tags, the service copies tags from the source backup to the destination backup.

" + } } }, "CopyBackupToRegionResponse":{ @@ -516,7 +526,10 @@ "shape":"BackupId", "documentation":"

The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.

" }, - "TagList":{"shape":"TagList"} + "TagList":{ + "shape":"TagList", + "documentation":"

Tags to apply to the CloudHSM cluster during creation.

" + } } }, "CreateClusterResponse":{ diff --git a/botocore/data/codebuild/2016-10-06/service-2.json b/botocore/data/codebuild/2016-10-06/service-2.json index 77029720..b718e120 100644 --- a/botocore/data/codebuild/2016-10-06/service-2.json +++ b/botocore/data/codebuild/2016-10-06/service-2.json @@ -864,6 +864,20 @@ "type":"list", "member":{"shape":"String"} }, + "BuildStatusConfig":{ + "type":"structure", + "members":{ + "context":{ + "shape":"String", + "documentation":"

Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.

Bitbucket

This parameter is used for the name parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.

GitHub/GitHub Enterprise Server

This parameter is used for the context parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

" + }, + "targetUrl":{ + "shape":"String", + "documentation":"

Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.

Bitbucket

This parameter is used for the url parameter in the Bitbucket commit status. For more information, see build in the Bitbucket API documentation.

GitHub/GitHub Enterprise Server

This parameter is used for the target_url parameter in the GitHub commit status. For more information, see Create a commit status in the GitHub developer guide.

" + } + }, + "documentation":"

Contains information that defines how the AWS CodeBuild build project reports the build status to the source provider.

" + }, "Builds":{ "type":"list", "member":{"shape":"Build"} @@ -2172,7 +2186,7 @@ "members":{ "type":{ "shape":"SourceType", - "documentation":"

The type of repository that contains the source code to be built. Valid values include:

  • BITBUCKET: The source code is in a Bitbucket repository.

  • CODECOMMIT: The source code is in an AWS CodeCommit repository.

  • CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.

  • GITHUB: The source code is in a GitHub repository.

  • GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise repository.

  • NO_SOURCE: The project does not have input source code.

  • S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.

" + "documentation":"

The type of repository that contains the source code to be built. Valid values include:

  • BITBUCKET: The source code is in a Bitbucket repository.

  • CODECOMMIT: The source code is in an AWS CodeCommit repository.

  • CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.

  • GITHUB: The source code is in a GitHub or GitHub Enterprise Cloud repository.

  • GITHUB_ENTERPRISE: The source code is in a GitHub Enterprise Server repository.

  • NO_SOURCE: The project does not have input source code.

  • S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.

" }, "location":{ "shape":"String", @@ -2198,6 +2212,10 @@ "shape":"WrapperBoolean", "documentation":"

Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown.

The status of a build triggered by a webhook is always reported to your source provider.

" }, + "buildStatusConfig":{ + "shape":"BuildStatusConfig", + "documentation":"

Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

" + }, "insecureSsl":{ "shape":"WrapperBoolean", "documentation":"

Enable this flag to ignore SSL warnings while connecting to the project source code.

" @@ -2667,6 +2685,10 @@ "shape":"WrapperBoolean", "documentation":"

Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

The status of a build triggered by a webhook is always reported to your source provider.

" }, + "buildStatusConfigOverride":{ + "shape":"BuildStatusConfig", + "documentation":"

Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

" + }, "environmentTypeOverride":{ "shape":"EnvironmentType", "documentation":"

A container type for this build that overrides the one specified in the build project.

" @@ -2709,7 +2731,7 @@ }, "idempotencyToken":{ "shape":"String", - "documentation":"

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

" + "documentation":"

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

" }, "logsConfigOverride":{ "shape":"LogsConfig", @@ -3083,7 +3105,7 @@ "members":{ "type":{ "shape":"WebhookFilterType", - "documentation":"

The type of webhook filter. There are five webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, and FILE_PATH.

EVENT

A webhook event triggers a build when the provided pattern matches one of five event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED, and PULL_REQUEST_MERGED. The EVENT patterns are specified as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull request created, and pull request updated events.

The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only.

ACTOR_ACCOUNT_ID

A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern.

HEAD_REF

A webhook event triggers a build when the head reference matches the regular expression pattern. For example, refs/heads/branch-name and refs/tags/tag-name.

Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.

BASE_REF

A webhook event triggers a build when the base reference matches the regular expression pattern. For example, refs/heads/branch-name.

Works with pull request events only.

FILE_PATH

A webhook triggers a build when the path of a changed file matches the regular expression pattern.

Works with GitHub and GitHub Enterprise push events only.

" + "documentation":"

The type of webhook filter. There are six webhook filter types: EVENT, ACTOR_ACCOUNT_ID, HEAD_REF, BASE_REF, FILE_PATH, and COMMIT_MESSAGE.

EVENT

A webhook event triggers a build when the provided pattern matches one of five event types: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED, and PULL_REQUEST_MERGED. The EVENT patterns are specified as a comma-separated string. For example, PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED filters all push, pull request created, and pull request updated events.

The PULL_REQUEST_REOPENED works with GitHub and GitHub Enterprise only.

ACTOR_ACCOUNT_ID

A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression pattern.

HEAD_REF

A webhook event triggers a build when the head reference matches the regular expression pattern. For example, refs/heads/branch-name and refs/tags/tag-name.

Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.

BASE_REF

A webhook event triggers a build when the base reference matches the regular expression pattern. For example, refs/heads/branch-name.

Works with pull request events only.

FILE_PATH

A webhook triggers a build when the path of a changed file matches the regular expression pattern.

Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.

COMMIT_MESSAGE

A webhook triggers a build when the head commit message matches the regular expression pattern.

Works with GitHub and Bitbucket events push and pull requests events. Also works with GitHub Enterprise push events, but does not work with GitHub Enterprise pull request events.

" }, "pattern":{ "shape":"String", diff --git a/botocore/data/codecommit/2015-04-13/service-2.json b/botocore/data/codecommit/2015-04-13/service-2.json index 255175f3..95dd5110 100644 --- a/botocore/data/codecommit/2015-04-13/service-2.json +++ b/botocore/data/codecommit/2015-04-13/service-2.json @@ -695,11 +695,35 @@ "output":{"shape":"GetCommentOutput"}, "errors":[ {"shape":"CommentDoesNotExistException"}, + {"shape":"CommentDeletedException"}, {"shape":"CommentIdRequiredException"}, {"shape":"InvalidCommentIdException"}, + {"shape":"EncryptionIntegrityChecksFailedException"}, + {"shape":"EncryptionKeyAccessDeniedException"}, + {"shape":"EncryptionKeyDisabledException"}, + {"shape":"EncryptionKeyNotFoundException"}, + {"shape":"EncryptionKeyUnavailableException"} + ], + "documentation":"

Returns the content of a comment made on a change, file, or commit in a repository.

Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of reactions from active identities, use GetCommentReactions.

" + }, + "GetCommentReactions":{ + "name":"GetCommentReactions", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetCommentReactionsInput"}, + "output":{"shape":"GetCommentReactionsOutput"}, + "errors":[ + {"shape":"CommentDoesNotExistException"}, + {"shape":"CommentIdRequiredException"}, + {"shape":"InvalidCommentIdException"}, + {"shape":"InvalidReactionUserArnException"}, + {"shape":"InvalidMaxResultsException"}, + {"shape":"InvalidContinuationTokenException"}, {"shape":"CommentDeletedException"} ], - "documentation":"

Returns the content of a comment made on a change, file, or commit in a repository.

" + "documentation":"

Returns information about reactions to a specified comment ID. Reactions from users who have been deleted will not be included in the count.

" }, "GetCommentsForComparedCommit":{ "name":"GetCommentsForComparedCommit", @@ -724,7 +748,7 @@ {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"} ], - "documentation":"

Returns information about comments made on the comparison between two commits.

" + "documentation":"

Returns information about comments made on the comparison between two commits.

Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of reactions from active identities, use GetCommentReactions.

" }, "GetCommentsForPullRequest":{ "name":"GetCommentsForPullRequest", @@ -753,7 +777,7 @@ {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"} ], - "documentation":"

Returns comments made on a pull request.

" + "documentation":"

Returns comments made on a pull request.

Reaction counts might include numbers from user identities who were deleted after the reaction was made. For a count of reactions from active identities, use GetCommentReactions.

" }, "GetCommit":{ "name":"GetCommit", @@ -1496,15 +1520,16 @@ {"shape":"InvalidFilePositionException"}, {"shape":"CommitIdRequiredException"}, {"shape":"InvalidCommitIdException"}, + {"shape":"BeforeCommitIdAndAfterCommitIdAreSameException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, {"shape":"EncryptionKeyNotFoundException"}, {"shape":"EncryptionKeyUnavailableException"}, - {"shape":"BeforeCommitIdAndAfterCommitIdAreSameException"}, {"shape":"CommitDoesNotExistException"}, {"shape":"InvalidPathException"}, - {"shape":"PathDoesNotExistException"} + {"shape":"PathDoesNotExistException"}, + {"shape":"PathRequiredException"} ], "documentation":"

Posts a comment on the comparison between two commits.

", "idempotent":true @@ -1536,6 +1561,7 @@ {"shape":"InvalidFilePositionException"}, {"shape":"CommitIdRequiredException"}, {"shape":"InvalidCommitIdException"}, + {"shape":"BeforeCommitIdAndAfterCommitIdAreSameException"}, {"shape":"EncryptionIntegrityChecksFailedException"}, {"shape":"EncryptionKeyAccessDeniedException"}, {"shape":"EncryptionKeyDisabledException"}, @@ -1544,8 +1570,7 @@ {"shape":"CommitDoesNotExistException"}, {"shape":"InvalidPathException"}, {"shape":"PathDoesNotExistException"}, - {"shape":"PathRequiredException"}, - {"shape":"BeforeCommitIdAndAfterCommitIdAreSameException"} + {"shape":"PathRequiredException"} ], "documentation":"

Posts a comment on a pull request.

", "idempotent":true @@ -1571,6 +1596,24 @@ "documentation":"

Posts a comment in reply to an existing comment on a comparison between commits or a pull request.

", "idempotent":true }, + "PutCommentReaction":{ + "name":"PutCommentReaction", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"PutCommentReactionInput"}, + "errors":[ + {"shape":"CommentDoesNotExistException"}, + {"shape":"CommentIdRequiredException"}, + {"shape":"InvalidCommentIdException"}, + {"shape":"InvalidReactionValueException"}, + {"shape":"ReactionValueRequiredException"}, + {"shape":"ReactionLimitExceededException"}, + {"shape":"CommentDeletedException"} + ], + "documentation":"

Adds or updates a reaction to a specified comment for the user whose identity is used to make the request. You can only add or update a reaction for yourself. You cannot add, modify, or delete a reaction for another user.

" + }, "PutFile":{ "name":"PutFile", "http":{ @@ -2625,7 +2668,7 @@ "type":"structure", "members":{ }, - "documentation":"

The specified branch name already exists.

", + "documentation":"

Cannot create the branch with the specified name because the commit conflicts with an existing branch with the same name. Branch names must be unique.

", "exception":true }, "BranchNameIsTagNameException":{ @@ -2646,6 +2689,10 @@ "documentation":"

A branch name is required, but was not specified.

", "exception":true }, + "CallerReactions":{ + "type":"list", + "member":{"shape":"ReactionValue"} + }, "CannotDeleteApprovalRuleFromTemplateException":{ "type":"structure", "members":{ @@ -2713,6 +2760,14 @@ "clientRequestToken":{ "shape":"ClientRequestToken", "documentation":"

A unique, client-generated idempotency token that, when provided in a request, ensures the request cannot be repeated with a changed parameter. If a request is received with the same parameters and a token is included, the request returns information about the initial request that used that token.

" + }, + "callerReactions":{ + "shape":"CallerReactions", + "documentation":"

The emoji reactions to a comment, if any, submitted by the user whose credentials are associated with the call to the API.

" + }, + "reactionCounts":{ + "shape":"ReactionCountsMap", + "documentation":"

A string to integer map that represents the number of individual users who have responded to a comment with the specified reactions.

" } }, "documentation":"

Returns information about a specific comment.

" @@ -3047,6 +3102,7 @@ "member":{"shape":"Conflict"} }, "Content":{"type":"string"}, + "Count":{"type":"integer"}, "CreateApprovalRuleTemplateInput":{ "type":"structure", "required":[ @@ -3060,7 +3116,7 @@ }, "approvalRuleTemplateContent":{ "shape":"ApprovalRuleTemplateContent", - "documentation":"

The content of the approval rule that is created on pull requests in associated repositories. If you specify one or more destination references (branches), approval rules are created in an associated repository only if their destination references (branches) match those specified in the template.

When you create the content of the approval rule template, you can specify approvers in an approval pool in one of two ways:

  • CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and Mary_Major, all of the following are counted as approvals coming from that user:

    • An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)

    • A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

    This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

  • Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.

" + "documentation":"

The content of the approval rule that is created on pull requests in associated repositories. If you specify one or more destination references (branches), approval rules are created in an associated repository only if their destination references (branches) match those specified in the template.

When you create the content of the approval rule template, you can specify approvers in an approval pool in one of two ways:

  • CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and Mary_Major, all of the following are counted as approvals coming from that user:

    • An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)

    • A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

    This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

  • Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.

" }, "approvalRuleTemplateDescription":{ "shape":"ApprovalRuleTemplateDescription", @@ -3193,7 +3249,7 @@ }, "approvalRuleContent":{ "shape":"ApprovalRuleContent", - "documentation":"

The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information about approval pools, see the AWS CodeCommit User Guide.

When you create the content of the approval rule, you can specify approvers in an approval pool in one of two ways:

  • CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and Mary_Major, all of the following would be counted as approvals coming from that user:

    • An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)

    • A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

    This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

  • Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.

" + "documentation":"

The content of the approval rule, including the number of approvals needed and the structure of an approval pool defined for approvals, if any. For more information about approval pools, see the AWS CodeCommit User Guide.

When you create the content of the approval rule, you can specify approvers in an approval pool in one of two ways:

  • CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and Mary_Major, all of the following would be counted as approvals coming from that user:

    • An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)

    • A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

    This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

  • Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.

" } } }, @@ -4104,6 +4160,42 @@ } } }, + "GetCommentReactionsInput":{ + "type":"structure", + "required":["commentId"], + "members":{ + "commentId":{ + "shape":"CommentId", + "documentation":"

The ID of the comment for which you want to get reactions information.

" + }, + "reactionUserArn":{ + "shape":"Arn", + "documentation":"

Optional. The Amazon Resource Name (ARN) of the user or identity for which you want to get reaction information.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that, when provided in a request, returns the next batch of the results.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

A non-zero, non-negative integer used to limit the number of returned results. The default is the same as the allowed maximum, 1,000.

" + } + } + }, + "GetCommentReactionsOutput":{ + "type":"structure", + "required":["reactionsForComment"], + "members":{ + "reactionsForComment":{ + "shape":"ReactionsForCommentList", + "documentation":"

An array of reactions to the specified comment.

" + }, + "nextToken":{ + "shape":"NextToken", + "documentation":"

An enumeration token that can be used in a request to return the next batch of the results.

" + } + } + }, "GetCommentsForComparedCommitInput":{ "type":"structure", "required":[ @@ -4959,6 +5051,20 @@ "documentation":"

The pull request status update is not valid. The only valid update is from OPEN to CLOSED.

", "exception":true }, + "InvalidReactionUserArnException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The Amazon Resource Name (ARN) of the user or identity is not valid.

", + "exception":true + }, + "InvalidReactionValueException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The value of the reaction is not valid. For more information, see the AWS CodeCommit User Guide.

", + "exception":true + }, "InvalidReferenceNameException":{ "type":"structure", "members":{ @@ -6525,6 +6631,23 @@ "type":"list", "member":{"shape":"PullRequestTarget"} }, + "PutCommentReactionInput":{ + "type":"structure", + "required":[ + "commentId", + "reactionValue" + ], + "members":{ + "commentId":{ + "shape":"CommentId", + "documentation":"

The ID of the comment to which you want to add or update a reaction.

" + }, + "reactionValue":{ + "shape":"ReactionValue", + "documentation":"

The emoji reaction you want to add or update. To remove a reaction, provide a value of blank or null. You can also provide the value of none. For information about emoji reaction values supported in AWS CodeCommit, see the AWS CodeCommit User Guide.

" + } + } + }, "PutFileEntries":{ "type":"list", "member":{"shape":"PutFileEntry"} @@ -6656,6 +6779,73 @@ }, "documentation":"

Represents the output of a put repository triggers operation.

" }, + "ReactionCountsMap":{ + "type":"map", + "key":{"shape":"ReactionValue"}, + "value":{"shape":"Count"} + }, + "ReactionEmoji":{"type":"string"}, + "ReactionForComment":{ + "type":"structure", + "members":{ + "reaction":{ + "shape":"ReactionValueFormats", + "documentation":"

The reaction for a specified comment.

" + }, + "reactionUsers":{ + "shape":"ReactionUsersList", + "documentation":"

The Amazon Resource Names (ARNs) of users who have provided reactions to the comment.

" + }, + "reactionsFromDeletedUsersCount":{ + "shape":"Count", + "documentation":"

A numerical count of users who reacted with the specified emoji whose identities have been subsequently deleted from IAM. While these IAM users or roles no longer exist, the reactions might still appear in total reaction counts.

" + } + }, + "documentation":"

Information about the reaction values provided by users on a comment.

" + }, + "ReactionLimitExceededException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The number of reactions has been exceeded. Reactions are limited to one reaction per user for each individual comment ID.

", + "exception":true + }, + "ReactionShortCode":{"type":"string"}, + "ReactionUnicode":{"type":"string"}, + "ReactionUsersList":{ + "type":"list", + "member":{"shape":"Arn"} + }, + "ReactionValue":{"type":"string"}, + "ReactionValueFormats":{ + "type":"structure", + "members":{ + "emoji":{ + "shape":"ReactionEmoji", + "documentation":"

The Emoji Version 1.0 graphic of the reaction. These graphics are interpreted slightly differently on different operating systems.

" + }, + "shortCode":{ + "shape":"ReactionShortCode", + "documentation":"

The emoji short code for the reaction. Short codes are interpreted slightly differently on different operating systems.

" + }, + "unicode":{ + "shape":"ReactionUnicode", + "documentation":"

The Unicode codepoint for the reaction.

" + } + }, + "documentation":"

Information about the values for reactions to a comment. AWS CodeCommit supports a limited set of reactions.

" + }, + "ReactionValueRequiredException":{ + "type":"structure", + "members":{ + }, + "documentation":"

A reaction value is required.

", + "exception":true + }, + "ReactionsForCommentList":{ + "type":"list", + "member":{"shape":"ReactionForComment"} + }, "ReferenceDoesNotExistException":{ "type":"structure", "members":{ @@ -7453,7 +7643,7 @@ }, "newRuleContent":{ "shape":"ApprovalRuleContent", - "documentation":"

The updated content for the approval rule.

When you update the content of the approval rule, you can specify approvers in an approval pool in one of two ways:

  • CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and Mary_Major, all of the following are counted as approvals coming from that user:

    • An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)

    • A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

    This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

  • Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.

" + "documentation":"

The updated content for the approval rule.

When you update the content of the approval rule, you can specify approvers in an approval pool in one of two ways:

  • CodeCommitApprovers: This option only requires an AWS account and a resource. It can be used for both IAM users and federated access users whose name matches the provided resource name. This is a very powerful option that offers a great deal of flexibility. For example, if you specify the AWS account 123456789012 and Mary_Major, all of the following are counted as approvals coming from that user:

    • An IAM user in the account (arn:aws:iam::123456789012:user/Mary_Major)

    • A federated user identified in IAM as Mary_Major (arn:aws:sts::123456789012:federated-user/Mary_Major)

    This option does not recognize an active session of someone assuming the role of CodeCommitReview with a role session name of Mary_Major (arn:aws:sts::123456789012:assumed-role/CodeCommitReview/Mary_Major) unless you include a wildcard (*Mary_Major).

  • Fully qualified ARN: This option allows you to specify the fully qualified Amazon Resource Name (ARN) of the IAM user or role.

For more information about IAM ARNs, wildcards, and formats, see IAM Identifiers in the IAM User Guide.

" } } }, @@ -7623,5 +7813,5 @@ }, "blob":{"type":"blob"} }, - "documentation":"AWS CodeCommit

This is the AWS CodeCommit API Reference. This reference provides descriptions of the operations and data types for AWS CodeCommit API along with usage examples.

You can use the AWS CodeCommit API to work with the following objects:

Repositories, by calling the following:

  • BatchGetRepositories, which returns information about one or more repositories associated with your AWS account.

  • CreateRepository, which creates an AWS CodeCommit repository.

  • DeleteRepository, which deletes an AWS CodeCommit repository.

  • GetRepository, which returns information about a specified repository.

  • ListRepositories, which lists all AWS CodeCommit repositories associated with your AWS account.

  • UpdateRepositoryDescription, which sets or updates the description of the repository.

  • UpdateRepositoryName, which changes the name of the repository. If you change the name of a repository, no other users of that repository can access it until you send them the new HTTPS or SSH URL to use.

Branches, by calling the following:

  • CreateBranch, which creates a branch in a specified repository.

  • DeleteBranch, which deletes the specified branch in a repository unless it is the default branch.

  • GetBranch, which returns information about a specified branch.

  • ListBranches, which lists all branches for a specified repository.

  • UpdateDefaultBranch, which changes the default branch for a repository.

Files, by calling the following:

  • DeleteFile, which deletes the content of a specified file from a specified branch.

  • GetBlob, which returns the base-64 encoded content of an individual Git blob object in a repository.

  • GetFile, which returns the base-64 encoded content of a specified file.

  • GetFolder, which returns the contents of a specified folder or directory.

  • PutFile, which adds or modifies a single file in a specified repository and branch.

Commits, by calling the following:

  • BatchGetCommits, which returns information about one or more commits in a repository.

  • CreateCommit, which creates a commit for changes to a repository.

  • GetCommit, which returns information about a commit, including commit messages and author and committer information.

  • GetDifferences, which returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID, or other fully qualified reference).

Merges, by calling the following:

  • BatchDescribeMergeConflicts, which returns information about conflicts in a merge between commits in a repository.

  • CreateUnreferencedMergeCommit, which creates an unreferenced commit between two branches or commits for the purpose of comparing them and identifying any potential conflicts.

  • DescribeMergeConflicts, which returns information about merge conflicts between the base, source, and destination versions of a file in a potential merge.

  • GetMergeCommit, which returns information about the merge between a source and destination commit.

  • GetMergeConflicts, which returns information about merge conflicts between the source and destination branch in a pull request.

  • GetMergeOptions, which returns information about the available merge options between two branches or commit specifiers.

  • MergeBranchesByFastForward, which merges two branches using the fast-forward merge option.

  • MergeBranchesBySquash, which merges two branches using the squash merge option.

  • MergeBranchesByThreeWay, which merges two branches using the three-way merge option.

Pull requests, by calling the following:

Approval rule templates, by calling the following:

Comments in a repository, by calling the following:

Tags used to tag resources in AWS CodeCommit (not Git tags), by calling the following:

  • ListTagsForResource, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeCommit.

  • TagResource, which adds or updates tags for a resource in AWS CodeCommit.

  • UntagResource, which removes tags for a resource in AWS CodeCommit.

Triggers, by calling the following:

  • GetRepositoryTriggers, which returns information about triggers configured for a repository.

  • PutRepositoryTriggers, which replaces all triggers for a repository and can be used to create or delete triggers.

  • TestRepositoryTriggers, which tests the functionality of a repository trigger by sending data to the trigger target.

For information about how to use AWS CodeCommit, see the AWS CodeCommit User Guide.

" + "documentation":"AWS CodeCommit

This is the AWS CodeCommit API Reference. This reference provides descriptions of the operations and data types for AWS CodeCommit API along with usage examples.

You can use the AWS CodeCommit API to work with the following objects:

Repositories, by calling the following:

  • BatchGetRepositories, which returns information about one or more repositories associated with your AWS account.

  • CreateRepository, which creates an AWS CodeCommit repository.

  • DeleteRepository, which deletes an AWS CodeCommit repository.

  • GetRepository, which returns information about a specified repository.

  • ListRepositories, which lists all AWS CodeCommit repositories associated with your AWS account.

  • UpdateRepositoryDescription, which sets or updates the description of the repository.

  • UpdateRepositoryName, which changes the name of the repository. If you change the name of a repository, no other users of that repository can access it until you send them the new HTTPS or SSH URL to use.

Branches, by calling the following:

  • CreateBranch, which creates a branch in a specified repository.

  • DeleteBranch, which deletes the specified branch in a repository unless it is the default branch.

  • GetBranch, which returns information about a specified branch.

  • ListBranches, which lists all branches for a specified repository.

  • UpdateDefaultBranch, which changes the default branch for a repository.

Files, by calling the following:

  • DeleteFile, which deletes the content of a specified file from a specified branch.

  • GetBlob, which returns the base-64 encoded content of an individual Git blob object in a repository.

  • GetFile, which returns the base-64 encoded content of a specified file.

  • GetFolder, which returns the contents of a specified folder or directory.

  • PutFile, which adds or modifies a single file in a specified repository and branch.

Commits, by calling the following:

  • BatchGetCommits, which returns information about one or more commits in a repository.

  • CreateCommit, which creates a commit for changes to a repository.

  • GetCommit, which returns information about a commit, including commit messages and author and committer information.

  • GetDifferences, which returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID, or other fully qualified reference).

Merges, by calling the following:

  • BatchDescribeMergeConflicts, which returns information about conflicts in a merge between commits in a repository.

  • CreateUnreferencedMergeCommit, which creates an unreferenced commit between two branches or commits for the purpose of comparing them and identifying any potential conflicts.

  • DescribeMergeConflicts, which returns information about merge conflicts between the base, source, and destination versions of a file in a potential merge.

  • GetMergeCommit, which returns information about the merge between a source and destination commit.

  • GetMergeConflicts, which returns information about merge conflicts between the source and destination branch in a pull request.

  • GetMergeOptions, which returns information about the available merge options between two branches or commit specifiers.

  • MergeBranchesByFastForward, which merges two branches using the fast-forward merge option.

  • MergeBranchesBySquash, which merges two branches using the squash merge option.

  • MergeBranchesByThreeWay, which merges two branches using the three-way merge option.

Pull requests, by calling the following:

Approval rule templates, by calling the following:

Comments in a repository, by calling the following:

Tags used to tag resources in AWS CodeCommit (not Git tags), by calling the following:

  • ListTagsForResource, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeCommit.

  • TagResource, which adds or updates tags for a resource in AWS CodeCommit.

  • UntagResource, which removes tags for a resource in AWS CodeCommit.

Triggers, by calling the following:

  • GetRepositoryTriggers, which returns information about triggers configured for a repository.

  • PutRepositoryTriggers, which replaces all triggers for a repository and can be used to create or delete triggers.

  • TestRepositoryTriggers, which tests the functionality of a repository trigger by sending data to the trigger target.

For information about how to use AWS CodeCommit, see the AWS CodeCommit User Guide.

" } diff --git a/botocore/data/codeguru-reviewer/2019-09-19/service-2.json b/botocore/data/codeguru-reviewer/2019-09-19/service-2.json index c6f0340c..02c7e0dd 100644 --- a/botocore/data/codeguru-reviewer/2019-09-19/service-2.json +++ b/botocore/data/codeguru-reviewer/2019-09-19/service-2.json @@ -28,7 +28,7 @@ {"shape":"ConflictException"}, {"shape":"ThrottlingException"} ], - "documentation":"

Associates an AWS CodeCommit repository with Amazon CodeGuru Reviewer. When you associate an AWS CodeCommit repository with Amazon CodeGuru Reviewer, Amazon CodeGuru Reviewer will provide recommendations for each pull request raised within the repository. You can view recommendations in the AWS CodeCommit repository.

You can associate a GitHub repository using the Amazon CodeGuru Reviewer console.

" + "documentation":"

Use to associate an AWS CodeCommit repository or a repostory managed by AWS CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see Recommendations in Amazon CodeGuru Reviewer in the Amazon CodeGuru Reviewer User Guide.

If you associate a CodeCommit repository, it must be in the same AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.

Bitbucket and GitHub Enterprise Server repositories are managed by AWS CodeStar Connections to connect to CodeGuru Reviewer. For more information, see Connect to a repository source provider in the Amazon CodeGuru Reviewer User Guide.

You cannot use the CodeGuru Reviewer SDK or the AWS CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see Getting started with CodeGuru Reviewer in the CodeGuru Reviewer User Guide.

" }, "DescribeCodeReview":{ "name":"DescribeCodeReview", @@ -45,7 +45,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], - "documentation":"

Returns the metadaata associated with the code review along with its status.

" + "documentation":"

Returns the metadata associated with the code review along with its status.

" }, "DescribeRecommendationFeedback":{ "name":"DescribeRecommendationFeedback", @@ -79,7 +79,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], - "documentation":"

Describes a repository association.

" + "documentation":"

Returns a RepositoryAssociation object that contains information about the requested repository association.

" }, "DisassociateRepository":{ "name":"DisassociateRepository", @@ -130,7 +130,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], - "documentation":"

Lists the customer feedback for a CodeGuru Reviewer recommendation for all users. This API will be used from the console to extract the previously given feedback by the user to pre-populate the feedback emojis for all recommendations.

" + "documentation":"

Returns a list of RecommendationFeedbackSummary objects that contain customer recommendation feedback for all CodeGuru Reviewer users.

" }, "ListRecommendations":{ "name":"ListRecommendations", @@ -162,7 +162,7 @@ {"shape":"ValidationException"}, {"shape":"ThrottlingException"} ], - "documentation":"

Lists repository associations. You can optionally filter on one or more of the following recommendation properties: provider types, states, names, and owners.

" + "documentation":"

Returns a list of RepositoryAssociationSummary objects that contain summary information about a repository association. You can filter the returned list by ProviderType , Name , State , and Owner .

" }, "PutRecommendationFeedback":{ "name":"PutRecommendationFeedback", @@ -179,7 +179,7 @@ {"shape":"AccessDeniedException"}, {"shape":"ThrottlingException"} ], - "documentation":"

Stores customer feedback for a CodeGuru-Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten.

" + "documentation":"

Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten.

" } }, "shapes":{ @@ -239,10 +239,10 @@ "members":{ "Name":{ "shape":"Name", - "documentation":"

The name of the AWS CodeCommit repository.

" + "documentation":"

The name of the AWS CodeCommit repository. For more information, see repositoryName in the AWS CodeCommit API Reference.

" } }, - "documentation":"

Information about an AWS CodeCommit repository.

" + "documentation":"

Information about an AWS CodeCommit repository. The CodeCommit repository must be in the same AWS Region and AWS account where its CodeGuru Reviewer code reviews are configured.

" }, "CodeReview":{ "type":"structure", @@ -253,7 +253,7 @@ }, "CodeReviewArn":{ "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of the code review to describe.

" + "documentation":"

The Amazon Resource Name (ARN) of the CodeReview object.

" }, "RepositoryName":{ "shape":"Name", @@ -261,15 +261,15 @@ }, "Owner":{ "shape":"Owner", - "documentation":"

The owner of the repository.

" + "documentation":"

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.

" }, "ProviderType":{ "shape":"ProviderType", - "documentation":"

The provider type of the repository association.

" + "documentation":"

The type of repository that contains the reviewed code (for example, GitHub or Bitbucket).

" }, "State":{ "shape":"JobState", - "documentation":"

The state of the code review.

" + "documentation":"

The valid code review states are:

  • Completed: The code review is complete.

  • Pending: The code review started and has not completed or failed.

  • Failed: The code review failed.

  • Deleting: The code review is being deleted.

" }, "StateReason":{ "shape":"StateReason", @@ -315,7 +315,7 @@ }, "CodeReviewArn":{ "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of the code review to describe.

" + "documentation":"

The Amazon Resource Name (ARN) of the CodeReview object.

" }, "RepositoryName":{ "shape":"Name", @@ -323,7 +323,7 @@ }, "Owner":{ "shape":"Owner", - "documentation":"

The owner of the repository.

" + "documentation":"

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.

" }, "ProviderType":{ "shape":"ProviderType", @@ -331,7 +331,7 @@ }, "State":{ "shape":"JobState", - "documentation":"

The state of the code review.

" + "documentation":"

The state of the code review.

The valid code review states are:

  • Completed: The code review is complete.

  • Pending: The code review started and has not completed or failed.

  • Failed: The code review failed.

  • Deleting: The code review is being deleted.

" }, "CreatedTimeStamp":{ "shape":"TimeStamp", @@ -361,11 +361,11 @@ "members":{ "SourceCommit":{ "shape":"CommitId", - "documentation":"

Source Commit SHA.

" + "documentation":"

The SHA of the source commit.

" }, "DestinationCommit":{ "shape":"CommitId", - "documentation":"

Destination Commit SHA

" + "documentation":"

The SHA of the destination commit.

" } }, "documentation":"

The commit diff for the pull request.

" @@ -396,7 +396,7 @@ "members":{ "CodeReviewArn":{ "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of the code review to describe.

", + "documentation":"

The Amazon Resource Name (ARN) of the CodeReview object.

", "location":"uri", "locationName":"CodeReviewArn" } @@ -420,7 +420,7 @@ "members":{ "CodeReviewArn":{ "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) that identifies the code review.

", + "documentation":"

The Amazon Resource Name (ARN) of the CodeReview object.

", "location":"uri", "locationName":"CodeReviewArn" }, @@ -432,7 +432,7 @@ }, "UserId":{ "shape":"UserId", - "documentation":"

Optional parameter to describe the feedback for a given user. If this is not supplied, it defaults to the user making the request.

", + "documentation":"

Optional parameter to describe the feedback for a given user. If this is not supplied, it defaults to the user making the request.

The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide.

", "location":"querystring", "locationName":"UserId" } @@ -453,7 +453,7 @@ "members":{ "AssociationArn":{ "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) identifying the association. You can retrieve this ARN by calling ListRepositories.

", + "documentation":"

The Amazon Resource Name (ARN) of the RepositoryAssociation object. You can retrieve this ARN by calling ListRepositories.

", "location":"uri", "locationName":"AssociationArn" } @@ -474,7 +474,7 @@ "members":{ "AssociationArn":{ "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) identifying the association.

", + "documentation":"

The Amazon Resource Name (ARN) of the RepositoryAssociation object.

", "location":"uri", "locationName":"AssociationArn" } @@ -533,13 +533,13 @@ "members":{ "ProviderTypes":{ "shape":"ProviderTypes", - "documentation":"

List of provider types for filtering that needs to be applied before displaying the result. For example, \"providerTypes=[GitHub]\" will list code reviews from GitHub.

", + "documentation":"

List of provider types for filtering that needs to be applied before displaying the result. For example, providerTypes=[GitHub] lists code reviews from GitHub.

", "location":"querystring", "locationName":"ProviderTypes" }, "States":{ "shape":"JobStates", - "documentation":"

List of states for filtering that needs to be applied before displaying the result. For example, \"states=[Pending]\" will list code reviews in the Pending state.

", + "documentation":"

List of states for filtering that needs to be applied before displaying the result. For example, states=[Pending] lists code reviews in the Pending state.

The valid code review states are:

  • Completed: The code review is complete.

  • Pending: The code review started and has not completed or failed.

  • Failed: The code review failed.

  • Deleting: The code review is being deleted.

", "location":"querystring", "locationName":"States" }, @@ -588,7 +588,7 @@ "members":{ "NextToken":{ "shape":"NextToken", - "documentation":"

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

", + "documentation":"

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

", "location":"querystring", "locationName":"NextToken" }, @@ -600,19 +600,19 @@ }, "CodeReviewArn":{ "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) that identifies the code review.

", + "documentation":"

The Amazon Resource Name (ARN) of the CodeReview object.

", "location":"uri", "locationName":"CodeReviewArn" }, "UserIds":{ "shape":"UserIds", - "documentation":"

Filter on userIds that need to be applied before displaying the result. This can be used to query all the recommendation feedback for a code review from a given user.

", + "documentation":"

An AWS user's account ID or Amazon Resource Name (ARN). Use this ID to query the recommendation feedback for a code review from that user.

The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide.

", "location":"querystring", "locationName":"UserIds" }, "RecommendationIds":{ "shape":"RecommendationIds", - "documentation":"

Filter on recommendationIds that need to be applied before displaying the result. This can be used to query all the recommendation feedback for a given recommendation.

", + "documentation":"

Used to query the recommendation feedback for a given recommendation.

", "location":"querystring", "locationName":"RecommendationIds" } @@ -623,7 +623,7 @@ "members":{ "RecommendationFeedbackSummaries":{ "shape":"RecommendationFeedbackSummaries", - "documentation":"

Recommendation feedback summaries corresponding to the code reivew ARN.

" + "documentation":"

Recommendation feedback summaries corresponding to the code review ARN.

" }, "NextToken":{ "shape":"NextToken", @@ -649,7 +649,7 @@ }, "CodeReviewArn":{ "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of the code review to describe.

", + "documentation":"

The Amazon Resource Name (ARN) of the CodeReview object.

", "location":"uri", "locationName":"CodeReviewArn" } @@ -679,7 +679,7 @@ }, "States":{ "shape":"RepositoryAssociationStates", - "documentation":"

List of states to use as a filter.

", + "documentation":"

List of repository association states to use as a filter.

The valid repository association states are:

  • Associated: The repository association is complete.

  • Associating: CodeGuru Reviewer is:

    • Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.

      If your repository ProviderType is GitHub or Bitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered.

    • Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.

  • Failed: The repository failed to associate or disassociate.

  • Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.

", "location":"querystring", "locationName":"State" }, @@ -691,13 +691,13 @@ }, "Owners":{ "shape":"Owners", - "documentation":"

List of owners to use as a filter. For GitHub, this is name of the GitHub account that was used to associate the repository. For AWS CodeCommit, it is the name of the CodeCommit account that was used to associate the repository.

", + "documentation":"

List of owners to use as a filter. For AWS CodeCommit, it is the name of the CodeCommit account that was used to associate the repository. For other repository source providers, such as Bitbucket, this is name of the account that was used to associate the repository.

", "location":"querystring", "locationName":"Owner" }, "MaxResults":{ "shape":"MaxResults", - "documentation":"

The maximum number of repository association results returned by ListRepositoryAssociations in paginated output. When this parameter is used, ListRepositoryAssociations only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRepositoryAssociations request with the returned nextToken value. This value can be between 1 and 25. If this parameter is not used, ListRepositoryAssociations returns up to 25 results and a nextToken value if applicable.

", + "documentation":"

The maximum number of repository association results returned by ListRepositoryAssociations in paginated output. When this parameter is used, ListRepositoryAssociations only returns maxResults results in a single page with a nextToken response element. The remaining results of the initial request can be seen by sending another ListRepositoryAssociations request with the returned nextToken value. This value can be between 1 and 100. If this parameter is not used, ListRepositoryAssociations returns up to 100 results and a nextToken value if applicable.

", "location":"querystring", "locationName":"MaxResults" }, @@ -733,7 +733,7 @@ "members":{ "MeteredLinesOfCodeCount":{ "shape":"MeteredLinesOfCodeCount", - "documentation":"

Lines of code metered in the code review.

" + "documentation":"

Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, MeteredLinesOfCodeCount includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of code for a total of 2,725 lines of code.

" }, "FindingsCount":{ "shape":"FindingsCount", @@ -747,7 +747,7 @@ "members":{ "MeteredLinesOfCodeCount":{ "shape":"MeteredLinesOfCodeCount", - "documentation":"

Lines of code metered in the code review.

" + "documentation":"

Lines of code metered in the code review. For the initial code review pull request and all subsequent revisions, this includes all lines of code in the files added to the pull request. In subsequent revisions, for files that already existed in the pull request, this includes only the changed lines of code. In both cases, this does not include non-code lines such as comments and import statements. For example, if you submit a pull request containing 5 files, each with 500 lines of code, and in a subsequent revision you added a new file with 200 lines of code, and also modified a total of 25 lines across the initial 5 files, MeteredLinesOfCodeCount includes the first 5 files (5 * 500 = 2,500 lines), the new file (200 lines) and the 25 changed lines of code for a total of 2,725 lines of code.

" }, "FindingsCount":{ "shape":"FindingsCount", @@ -799,7 +799,8 @@ "enum":[ "CodeCommit", "GitHub", - "Bitbucket" + "Bitbucket", + "GitHubEnterpriseServer" ] }, "ProviderTypes":{ @@ -823,7 +824,7 @@ "members":{ "CodeReviewArn":{ "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) that identifies the code review.

" + "documentation":"

The Amazon Resource Name (ARN) of the CodeReview object.

" }, "RecommendationId":{ "shape":"RecommendationId", @@ -858,7 +859,7 @@ "members":{ "CodeReviewArn":{ "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) that identifies the code review.

" + "documentation":"

The Amazon Resource Name (ARN) of the CodeReview object.

" }, "RecommendationId":{ "shape":"RecommendationId", @@ -870,7 +871,7 @@ }, "UserId":{ "shape":"UserId", - "documentation":"

The user principal that made the API call.

" + "documentation":"

The ID of the user that made the API call.

The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide.

" }, "CreatedTimeStamp":{ "shape":"TimeStamp", @@ -900,7 +901,7 @@ }, "UserId":{ "shape":"UserId", - "documentation":"

The identifier for the user that gave the feedback.

" + "documentation":"

The ID of the user that gave the feedback.

The UserId is an IAM principal that can be specified as an AWS account ID or an Amazon Resource Name (ARN). For more information, see Specifying a Principal in the AWS Identity and Access Management User Guide.

" } }, "documentation":"

Information about recommendation feedback summaries.

" @@ -937,7 +938,7 @@ }, "EndLine":{ "shape":"LineNumber", - "documentation":"

Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values will be the same.

" + "documentation":"

Last line where the recommendation is applicable in the source commit or source branch. For a single line comment the start line and end line values are the same.

" }, "Description":{ "shape":"Text", @@ -955,10 +956,14 @@ }, "Bitbucket":{ "shape":"ThirdPartySourceRepository", - "documentation":"

Information about a Bitbucket Cloud repository.

" + "documentation":"

Information about a Bitbucket repository.

" + }, + "GitHubEnterpriseServer":{ + "shape":"ThirdPartySourceRepository", + "documentation":"

Information about a GitHub Enterprise Server repository.

" } }, - "documentation":"

Information about a repository.

" + "documentation":"

Information about an associated AWS CodeCommit repository or an associated repository that is managed by AWS CodeStar Connections (for example, Bitbucket). This Repository object is not used if your source code is in an associated GitHub repository.

" }, "RepositoryAssociation":{ "type":"structure", @@ -973,7 +978,7 @@ }, "ConnectionArn":{ "shape":"ConnectionArn", - "documentation":"

The Amazon Resource Name (ARN) identifying the repository connection.

" + "documentation":"

The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see Connection in the AWS CodeStar Connections API Reference.

" }, "Name":{ "shape":"Name", @@ -981,7 +986,7 @@ }, "Owner":{ "shape":"Owner", - "documentation":"

The owner of the repository.

" + "documentation":"

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.

" }, "ProviderType":{ "shape":"ProviderType", @@ -989,7 +994,7 @@ }, "State":{ "shape":"RepositoryAssociationState", - "documentation":"

The state of the repository association.

" + "documentation":"

The state of the repository association.

The valid repository association states are:

  • Associated: The repository association is complete.

  • Associating: CodeGuru Reviewer is:

    • Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.

      If your repository ProviderType is GitHub or Bitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered.

    • Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.

  • Failed: The repository failed to associate or disassociate.

  • Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.

" }, "StateReason":{ "shape":"StateReason", @@ -1004,7 +1009,7 @@ "documentation":"

The time, in milliseconds since the epoch, when the repository association was created.

" } }, - "documentation":"

Information about a repository association.

" + "documentation":"

Information about a repository association. The DescribeRepositoryAssociation operation returns a RepositoryAssociation object.

" }, "RepositoryAssociationState":{ "type":"string", @@ -1030,11 +1035,11 @@ "members":{ "AssociationArn":{ "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) identifying the repository association.

" + "documentation":"

The Amazon Resource Name (ARN) of the RepositoryAssociation object.

" }, "ConnectionArn":{ "shape":"ConnectionArn", - "documentation":"

The Amazon Resource Name (ARN) identifying the repository connection.

" + "documentation":"

The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see Connection in the AWS CodeStar Connections API Reference.

" }, "LastUpdatedTimeStamp":{ "shape":"TimeStamp", @@ -1042,7 +1047,7 @@ }, "AssociationId":{ "shape":"AssociationId", - "documentation":"

The repository association ID.

" + "documentation":"

The repository association ID.

" }, "Name":{ "shape":"Name", @@ -1050,7 +1055,7 @@ }, "Owner":{ "shape":"Owner", - "documentation":"

The owner of the repository association.

" + "documentation":"

The owner of the repository. For an AWS CodeCommit repository, this is the AWS account ID of the account that owns the repository. For a GitHub or Bitbucket repository, this is the username for the account that owns the repository.

" }, "ProviderType":{ "shape":"ProviderType", @@ -1058,10 +1063,10 @@ }, "State":{ "shape":"RepositoryAssociationState", - "documentation":"

The state of the repository association.

Associated

Amazon CodeGuru Reviewer is associated with the repository.

Associating

The association is in progress.

Failed

The association failed.

Disassociating

Amazon CodeGuru Reviewer is in the process of disassociating with the repository.

" + "documentation":"

The state of the repository association.

The valid repository association states are:

  • Associated: The repository association is complete.

  • Associating: CodeGuru Reviewer is:

    • Setting up pull request notifications. This is required for pull requests to trigger a CodeGuru Reviewer review.

      If your repository ProviderType is GitHub or Bitbucket, CodeGuru Reviewer creates webhooks in your repository to trigger CodeGuru Reviewer reviews. If you delete these webhooks, reviews of code in your repository cannot be triggered.

    • Setting up source code access. This is required for CodeGuru Reviewer to securely clone code in your repository.

  • Failed: The repository failed to associate or disassociate.

  • Disassociating: CodeGuru Reviewer is removing the repository's pull request notifications and source code access.

" } }, - "documentation":"

Information about a repository association.

" + "documentation":"

Summary information about a repository association. The ListRepositoryAssociations operation returns a list of RepositoryAssociationSummary objects.

" }, "RepositoryNames":{ "type":"list", @@ -1112,14 +1117,14 @@ }, "ConnectionArn":{ "shape":"ConnectionArn", - "documentation":"

The Amazon Resource Name (ARN) identifying the repository connection.

" + "documentation":"

The Amazon Resource Name (ARN) of an AWS CodeStar Connections connection. Its format is arn:aws:codestar-connections:region-id:aws-account_id:connection/connection-id. For more information, see Connection in the AWS CodeStar Connections API Reference.

" }, "Owner":{ "shape":"Owner", - "documentation":"

The username of the owner of the repository.

" + "documentation":"

The owner of the repository. For a GitHub, GitHub Enterprise, or Bitbucket repository, this is the username for the account that owns the repository.

" } }, - "documentation":"

Information about a third party source repository connected through CodeStar Connections.

" + "documentation":"

Information about a third-party source repository connected to CodeGuru Reviewer.

" }, "ThrottlingException":{ "type":"structure", @@ -1156,5 +1161,5 @@ "exception":true } }, - "documentation":"

This section provides documentation for the Amazon CodeGuru Reviewer API operations. Amazon CodeGuru Reviewer is a service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends fixes in your Java code.

By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the Amazon CodeGuru Reviewer User Guide.

" + "documentation":"

This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends fixes in your Java code.

By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the Amazon CodeGuru Reviewer User Guide.

" } diff --git a/botocore/data/codeguruprofiler/2019-07-18/service-2.json b/botocore/data/codeguruprofiler/2019-07-18/service-2.json index 1190d157..dc6f2587 100644 --- a/botocore/data/codeguruprofiler/2019-07-18/service-2.json +++ b/botocore/data/codeguruprofiler/2019-07-18/service-2.json @@ -12,6 +12,42 @@ "uid":"codeguruprofiler-2019-07-18" }, "operations":{ + "AddNotificationChannels":{ + "name":"AddNotificationChannels", + "http":{ + "method":"POST", + "requestUri":"/profilingGroups/{profilingGroupName}/notificationConfiguration", + "responseCode":200 + }, + "input":{"shape":"AddNotificationChannelsRequest"}, + "output":{"shape":"AddNotificationChannelsResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Add up to 2 anomaly notifications channels for a profiling group.

" + }, + "BatchGetFrameMetricData":{ + "name":"BatchGetFrameMetricData", + "http":{ + "method":"POST", + "requestUri":"/profilingGroups/{profilingGroupName}/frames/-/metrics", + "responseCode":200 + }, + "input":{"shape":"BatchGetFrameMetricDataRequest"}, + "output":{"shape":"BatchGetFrameMetricDataResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns the time series of values for a requested list of frame metrics from a time period.

" + }, "ConfigureAgent":{ "name":"ConfigureAgent", "http":{ @@ -27,7 +63,7 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

" + "documentation":"

Used by profiler agents to report their current state and to receive remote configuration updates. For example, ConfigureAgent can be used to tell and agent whether to profile or not and for how long to return profiling data.

" }, "CreateProfilingGroup":{ "name":"CreateProfilingGroup", @@ -81,7 +117,40 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Describes a profiling group.

" + "documentation":"

Returns a ProfilingGroupDescription object that contains information about the requested profiling group.

" + }, + "GetFindingsReportAccountSummary":{ + "name":"GetFindingsReportAccountSummary", + "http":{ + "method":"GET", + "requestUri":"/internal/findingsReports", + "responseCode":200 + }, + "input":{"shape":"GetFindingsReportAccountSummaryRequest"}, + "output":{"shape":"GetFindingsReportAccountSummaryResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

Returns a list of FindingsReportSummary objects that contain analysis results for all profiling groups in your AWS account.

" + }, + "GetNotificationConfiguration":{ + "name":"GetNotificationConfiguration", + "http":{ + "method":"GET", + "requestUri":"/profilingGroups/{profilingGroupName}/notificationConfiguration", + "responseCode":200 + }, + "input":{"shape":"GetNotificationConfigurationRequest"}, + "output":{"shape":"GetNotificationConfigurationResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Get the current configuration for anomaly notifications for a profiling group.

" }, "GetPolicy":{ "name":"GetPolicy", @@ -97,7 +166,7 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Gets the profiling group policy.

" + "documentation":"

Returns the JSON-formatted resource-based policy on a profiling group.

" }, "GetProfile":{ "name":"GetProfile", @@ -114,7 +183,41 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Gets the aggregated profile of a profiling group for the specified time range. If the requested time range does not align with the available aggregated profiles, it is expanded to attain alignment. If aggregated profiles are available only for part of the period requested, the profile is returned from the earliest available to the latest within the requested time range.

For example, if the requested time range is from 00:00 to 00:20 and the available profiles are from 00:15 to 00:25, the returned profile will be from 00:15 to 00:20.

You must specify exactly two of the following parameters: startTime, period, and endTime.

" + "documentation":"

Gets the aggregated profile of a profiling group for a specified time range. Amazon CodeGuru Profiler collects posted agent profiles for a profiling group into aggregated profiles. 

 <note> <p> Because aggregated profiles expire over time <code>GetProfile</code> is not idempotent. </p> </note> <p> Specify the time range for the requested aggregated profile using 1 or 2 of the following parameters: <code>startTime</code>, <code>endTime</code>, <code>period</code>. The maximum time range allowed is 7 days. If you specify all 3 parameters, an exception is thrown. If you specify only <code>period</code>, the latest aggregated profile is returned. </p> <p> Aggregated profiles are available with aggregation periods of 5 minutes, 1 hour, and 1 day, aligned to UTC. The aggregation period of an aggregated profile determines how long it is retained. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_AggregatedProfileTime.html"> <code>AggregatedProfileTime</code> </a>. The aggregated profile's aggregation period determines how long it is retained by CodeGuru Profiler. </p> <ul> <li> <p> If the aggregation period is 5 minutes, the aggregated profile is retained for 15 days. </p> </li> <li> <p> If the aggregation period is 1 hour, the aggregated profile is retained for 60 days. </p> </li> <li> <p> If the aggregation period is 1 day, the aggregated profile is retained for 3 years. </p> </li> </ul> <p>There are two use cases for calling <code>GetProfile</code>.</p> <ol> <li> <p> If you want to return an aggregated profile that already exists, use <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ListProfileTimes.html"> <code>ListProfileTimes</code> </a> to view the time ranges of existing aggregated profiles. Use them in a <code>GetProfile</code> request to return a specific, existing aggregated profile. </p> </li> <li> <p> If you want to return an aggregated profile for a time range that doesn't align with an existing aggregated profile, then CodeGuru Profiler makes a best effort to combine existing aggregated profiles from the requested time range and return them as one aggregated profile. </p> <p> If aggregated profiles do not exist for the full time range requested, then aggregated profiles for a smaller time range are returned. For example, if the requested time range is from 00:00 to 00:20, and the existing aggregated profiles are from 00:15 and 00:25, then the aggregated profiles from 00:15 to 00:20 are returned. </p> </li> </ol>
" + }, + "GetRecommendations":{ + "name":"GetRecommendations", + "http":{ + "method":"GET", + "requestUri":"/internal/profilingGroups/{profilingGroupName}/recommendations", + "responseCode":200 + }, + "input":{"shape":"GetRecommendationsRequest"}, + "output":{"shape":"GetRecommendationsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period. A list of Anomaly objects that contains details about anomalies detected in the profiling group for the same time period is also returned.

" + }, + "ListFindingsReports":{ + "name":"ListFindingsReports", + "http":{ + "method":"GET", + "requestUri":"/internal/profilingGroups/{profilingGroupName}/findingsReports", + "responseCode":200 + }, + "input":{"shape":"ListFindingsReportsRequest"}, + "output":{"shape":"ListFindingsReportsResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

List the available reports for a given profiling group and time range.

" }, "ListProfileTimes":{ "name":"ListProfileTimes", @@ -131,7 +234,7 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

List the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.

" + "documentation":"

Lists the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.

" }, "ListProfilingGroups":{ "name":"ListProfilingGroups", @@ -146,7 +249,7 @@ {"shape":"InternalServerException"}, {"shape":"ThrottlingException"} ], - "documentation":"

Lists profiling groups.

" + "documentation":"

Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.

" }, "PostAgentProfile":{ "name":"PostAgentProfile", @@ -163,7 +266,7 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

" + "documentation":"

Submits profiling data to an aggregated profile of a profiling group. To get an aggregated profile that is created with this profiling data, use GetProfile .

" }, "PutPermission":{ "name":"PutPermission", @@ -181,7 +284,25 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Provides permission to the principals. This overwrites the existing permissions, and is not additive.

", + "documentation":"

Adds permissions to a profiling group's resource-based policy that are provided using an action group. If a profiling group doesn't have a resource-based policy, one is created for it using the permissions in the action group and the roles and users in the principals parameter. 

 <p> The one supported action group that can be added is <code>agentPermission</code> which grants <code>ConfigureAgent</code> and <code>PostAgent</code> permissions. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/resource-based-policies.html">Resource-based policies in CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>, <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ConfigureAgent.html"> <code>ConfigureAgent</code> </a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_PostAgentProfile.html"> <code>PostAgentProfile</code> </a>. </p> <p> The first time you call <code>PutPermission</code> on a profiling group, do not specify a <code>revisionId</code> because it doesn't have a resource-based policy. Subsequent calls must provide a <code>revisionId</code> to specify which revision of the resource-based policy to add the permissions to. </p> <p> The response contains the profiling group's JSON-formatted resource policy. </p>
", + "idempotent":true + }, + "RemoveNotificationChannel":{ + "name":"RemoveNotificationChannel", + "http":{ + "method":"DELETE", + "requestUri":"/profilingGroups/{profilingGroupName}/notificationConfiguration/{channelId}", + "responseCode":200 + }, + "input":{"shape":"RemoveNotificationChannelRequest"}, + "output":{"shape":"RemoveNotificationChannelResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Remove one anomaly notifications channel for a profiling group.

", "idempotent":true }, "RemovePermission":{ @@ -200,7 +321,24 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Removes statement for the provided action group from the policy.

" + "documentation":"

Removes permissions from a profiling group's resource-based policy that are provided using an action group. The one supported action group that can be removed is agentPermission which grants ConfigureAgent and PostAgent permissions. For more information, see Resource-based policies in CodeGuru Profiler in the Amazon CodeGuru Profiler User Guide, ConfigureAgent , and PostAgentProfile .

" + }, + "SubmitFeedback":{ + "name":"SubmitFeedback", + "http":{ + "method":"POST", + "requestUri":"/internal/profilingGroups/{profilingGroupName}/anomalies/{anomalyInstanceId}/feedback", + "responseCode":204 + }, + "input":{"shape":"SubmitFeedbackRequest"}, + "output":{"shape":"SubmitFeedbackResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Sends feedback to CodeGuru Profiler about whether the anomaly detected by the analysis is useful or not.

" }, "UpdateProfilingGroup":{ "name":"UpdateProfilingGroup", @@ -227,6 +365,36 @@ "type":"string", "enum":["agentPermissions"] }, + "AddNotificationChannelsRequest":{ + "type":"structure", + "required":[ + "channels", + "profilingGroupName" + ], + "members":{ + "channels":{ + "shape":"Channels", + "documentation":"

One or 2 channels to report to when anomalies are detected.

" + }, + "profilingGroupName":{ + "shape":"ProfilingGroupName", + "documentation":"

The name of the profiling group that we are setting up notifications for.

", + "location":"uri", + "locationName":"profilingGroupName" + } + }, + "documentation":"

The structure representing the AddNotificationChannelsRequest.

" + }, + "AddNotificationChannelsResponse":{ + "type":"structure", + "members":{ + "notificationConfiguration":{ + "shape":"NotificationConfiguration", + "documentation":"

The new notification configuration for this profiling group.

" + } + }, + "documentation":"

The structure representing the AddNotificationChannelsResponse.

" + }, "AgentConfiguration":{ "type":"structure", "required":[ @@ -234,16 +402,20 @@ "shouldProfile" ], "members":{ + "agentParameters":{ + "shape":"AgentParameters", + "documentation":"

Parameters used by the profiler. The valid parameters are:

  • MaxStackDepth - The maximum depth of the stacks in the code that is represented in the profile. For example, if CodeGuru Profiler finds a method A, which calls method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the profiler evaluates A and B.

  • MemoryUsageLimitPercent - The percentage of memory that is used by the profiler.

  • MinimumTimeForReportingInMilliseconds - The minimum time in milliseconds between sending reports.

  • ReportingIntervalInMilliseconds - The reporting interval in milliseconds used to report profiles.

  • SamplingIntervalInMilliseconds - The sampling interval in milliseconds that is used to profile samples.

" + }, "periodInSeconds":{ "shape":"Integer", - "documentation":"

" + "documentation":"

How long a profiling agent should send profiling data using ConfigureAgent . For example, if this is set to 300, the profiling agent calls ConfigureAgent every 5 minutes to submit the profiled data collected during that period.

" }, "shouldProfile":{ "shape":"Boolean", - "documentation":"

" + "documentation":"

A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.

" } }, - "documentation":"

" + "documentation":"

The response of ConfigureAgent that specifies if an agent profiles or not and for how long to return profiling data.

" }, "AgentOrchestrationConfig":{ "type":"structure", @@ -251,10 +423,25 @@ "members":{ "profilingEnabled":{ "shape":"Boolean", - "documentation":"

" + "documentation":"

A Boolean that specifies whether the profiling agent collects profiling data or not. Set to true to enable profiling.

" } }, - "documentation":"

" + "documentation":"

Specifies whether profiling is enabled or disabled for a profiling group. It is used by ConfigureAgent to enable or disable profiling for a profiling group.

" + }, + "AgentParameterField":{ + "type":"string", + "enum":[ + "MaxStackDepth", + "MemoryUsageLimitPercent", + "MinimumTimeForReportingInMilliseconds", + "ReportingIntervalInMilliseconds", + "SamplingIntervalInMilliseconds" + ] + }, + "AgentParameters":{ + "type":"map", + "key":{"shape":"AgentParameterField"}, + "value":{"shape":"String"} }, "AgentProfile":{"type":"blob"}, "AggregatedProfile":{"type":"blob"}, @@ -263,14 +450,14 @@ "members":{ "period":{ "shape":"AggregationPeriod", - "documentation":"

The time period.

" + "documentation":"

The aggregation period. This indicates the period during which an aggregation profile collects posted agent profiles for a profiling group. Use one of three valid durations that are specified using the ISO 8601 format.

  • P1D — 1 day

  • PT1H — 1 hour

  • PT5M — 5 minutes

" }, "start":{ "shape":"Timestamp", - "documentation":"

The start time.

" + "documentation":"

The time that aggregation of posted agent profiles for a profiling group starts. The aggregation profile contains profiles posted by the agent starting at this time for an aggregation period specified by the period property of the AggregatedProfileTime object.

Specify start using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" } }, - "documentation":"

Information about the time range of the latest available aggregated profile.

" + "documentation":"

Specifies the aggregation period and aggregation start time for an aggregated profile. An aggregated profile is used to collect posted agent profiles during an aggregation period. There are three possible aggregation periods (1 day, 1 hour, or 5 minutes).

" }, "AggregationPeriod":{ "type":"string", @@ -280,27 +467,214 @@ "PT5M" ] }, + "Anomalies":{ + "type":"list", + "member":{"shape":"Anomaly"} + }, + "Anomaly":{ + "type":"structure", + "required":[ + "instances", + "metric", + "reason" + ], + "members":{ + "instances":{ + "shape":"AnomalyInstances", + "documentation":"

A list of the instances of the detected anomalies during the requested period.

" + }, + "metric":{ + "shape":"Metric", + "documentation":"

Details about the metric that the analysis used when it detected the anomaly. The metric includes the name of the frame that was analyzed with the type and thread states used to derive the metric value for that frame.

" + }, + "reason":{ + "shape":"String", + "documentation":"

The reason for which metric was flagged as anomalous.

" + } + }, + "documentation":"

Details about an anomaly in a specific metric of application profile. The anomaly is detected using analysis of the metric data over a period of time.

" + }, + "AnomalyInstance":{ + "type":"structure", + "required":[ + "id", + "startTime" + ], + "members":{ + "endTime":{ + "shape":"Timestamp", + "documentation":"

The end time of the period during which the metric is flagged as anomalous. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" + }, + "id":{ + "shape":"String", + "documentation":"

The universally unique identifier (UUID) of an instance of an anomaly in a metric.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The start time of the period during which the metric is flagged as anomalous. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" + }, + "userFeedback":{ + "shape":"UserFeedback", + "documentation":"

Feedback type on a specific instance of anomaly submitted by the user.

" + } + }, + "documentation":"

The specific duration in which the metric is flagged as anomalous.

" + }, + "AnomalyInstanceId":{ + "type":"string", + "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" + }, + "AnomalyInstances":{ + "type":"list", + "member":{"shape":"AnomalyInstance"} + }, + "BatchGetFrameMetricDataRequest":{ + "type":"structure", + "required":["profilingGroupName"], + "members":{ + "endTime":{ + "shape":"Timestamp", + "documentation":"

The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

", + "location":"querystring", + "locationName":"endTime" + }, + "frameMetrics":{ + "shape":"FrameMetrics", + "documentation":"

The details of the metrics that are used to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.

" + }, + "period":{ + "shape":"Period", + "documentation":"

The duration of the frame metrics used to return the time series values. Specify using the ISO 8601 format. The maximum period duration is one day (PT24H or P1D).

", + "location":"querystring", + "locationName":"period" + }, + "profilingGroupName":{ + "shape":"ProfilingGroupName", + "documentation":"

The name of the profiling group associated with the the frame metrics used to return the time series values.

", + "location":"uri", + "locationName":"profilingGroupName" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The start time of the time period for the frame metrics used to return the time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

", + "location":"querystring", + "locationName":"startTime" + }, + "targetResolution":{ + "shape":"AggregationPeriod", + "documentation":"

The requested resolution of time steps for the returned time series of values. If the requested target resolution is not available due to data not being retained we provide a best effort result by falling back to the most granular available resolution after the target resolution. There are 3 valid values.

  • P1D — 1 day

  • PT1H — 1 hour

  • PT5M — 5 minutes

", + "location":"querystring", + "locationName":"targetResolution" + } + }, + "documentation":"

The structure representing the BatchGetFrameMetricDataRequest.

" + }, + "BatchGetFrameMetricDataResponse":{ + "type":"structure", + "required":[ + "endTime", + "endTimes", + "frameMetricData", + "resolution", + "startTime", + "unprocessedEndTimes" + ], + "members":{ + "endTime":{ + "shape":"Timestamp", + "documentation":"

The end time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" + }, + "endTimes":{ + "shape":"ListOfTimestamps", + "documentation":"

List of instances, or time steps, in the time series. For example, if the period is one day (PT24H)), and the resolution is five minutes (PT5M), then there are 288 endTimes in the list that are each five minutes appart.

" + }, + "frameMetricData":{ + "shape":"FrameMetricData", + "documentation":"

Details of the metrics to request a time series of values. The metric includes the name of the frame, the aggregation type to calculate the metric value for the frame, and the thread states to use to get the count for the metric value of the frame.

" + }, + "resolution":{ + "shape":"AggregationPeriod", + "documentation":"

Resolution or granularity of the profile data used to generate the time series. This is the value used to jump through time steps in a time series. There are 3 valid values.

  • P1D — 1 day

  • PT1H — 1 hour

  • PT5M — 5 minutes

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The start time of the time period for the returned time series values. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" + }, + "unprocessedEndTimes":{ + "shape":"UnprocessedEndTimeMap", + "documentation":"

List of instances which remained unprocessed. This will create a missing time step in the list of end times.

" + } + }, + "documentation":"

The structure representing the BatchGetFrameMetricDataResponse.

" + }, "Boolean":{ "type":"boolean", "box":true }, + "Channel":{ + "type":"structure", + "required":[ + "eventPublishers", + "uri" + ], + "members":{ + "eventPublishers":{ + "shape":"EventPublishers", + "documentation":"

List of publishers for different type of events that may be detected in an application from the profile. Anomaly detection is the only event publisher in Profiler.

" + }, + "id":{ + "shape":"ChannelId", + "documentation":"

Unique identifier for each Channel in the notification configuration of a Profiling Group. A random UUID for channelId is used when adding a channel to the notification configuration if not specified in the request.

" + }, + "uri":{ + "shape":"ChannelUri", + "documentation":"

Unique arn of the resource to be used for notifications. We support a valid SNS topic arn as a channel uri.

" + } + }, + "documentation":"

Notification medium for users to get alerted for events that occur in application profile. We support SNS topic as a notification channel.

" + }, + "ChannelId":{ + "type":"string", + "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" + }, + "ChannelUri":{ + "type":"string", + "documentation":"

Channel URI uniquely identifies a Notification Channel. TopicArn is the uri for an SNS channel, emailId is uri for an email channel etc. Currently we only support SNS channels and thus required to be an ARN

" + }, + "Channels":{ + "type":"list", + "member":{"shape":"Channel"}, + "max":2, + "min":1 + }, "ClientToken":{ "type":"string", "max":64, "min":1, "pattern":"^[\\w-]+$" }, + "ComputePlatform":{ + "type":"string", + "enum":[ + "AWSLambda", + "Default" + ] + }, "ConfigureAgentRequest":{ "type":"structure", "required":["profilingGroupName"], "members":{ "fleetInstanceId":{ "shape":"FleetInstanceId", - "documentation":"

" + "documentation":"

A universally unique identifier (UUID) for a profiling instance. For example, if the profiling instance is an Amazon EC2 instance, it is the instance ID. If it is an AWS Fargate container, it is the container's task ID.

" + }, + "metadata":{ + "shape":"Metadata", + "documentation":"

Metadata captured about the compute platform the agent is running on. It includes information about sampling and reporting. The valid fields are:

  • COMPUTE_PLATFORM - The compute platform on which the agent is running

  • AGENT_ID - The ID for an agent instance.

  • AWS_REQUEST_ID - The AWS request ID of a Lambda invocation.

  • EXECUTION_ENVIRONMENT - The execution environment a Lambda function is running on.

  • LAMBDA_FUNCTION_ARN - The Amazon Resource Name (ARN) that is used to invoke a Lambda function.

  • LAMBDA_MEMORY_LIMIT_IN_MB - The memory allocated to a Lambda function.

  • LAMBDA_REMAINING_TIME_IN_MILLISECONDS - The time in milliseconds before execution of a Lambda function times out.

  • LAMBDA_TIME_GAP_BETWEEN_INVOKES_IN_MILLISECONDS - The time in milliseconds between two invocations of a Lambda function.

  • LAMBDA_PREVIOUS_EXECUTION_TIME_IN_MILLISECONDS - The time in milliseconds for the previous Lambda invocation.

" }, "profilingGroupName":{ "shape":"ProfilingGroupName", - "documentation":"

", + "documentation":"

The name of the profiling group for which the configured agent is collecting profiling data.

", "location":"uri", "locationName":"profilingGroupName" } @@ -313,7 +687,7 @@ "members":{ "configuration":{ "shape":"AgentConfiguration", - "documentation":"

" + "documentation":"

An AgentConfiguration object that specifies if an agent profiles or not and for how long to return profiling data.

" } }, "documentation":"

The structure representing the configureAgentResponse.

", @@ -341,18 +715,22 @@ "members":{ "agentOrchestrationConfig":{ "shape":"AgentOrchestrationConfig", - "documentation":"

The agent orchestration configuration.

" + "documentation":"

Specifies whether profiling is enabled or disabled for the created profiling group.

" }, "clientToken":{ "shape":"ClientToken", - "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

This parameter specifies a unique identifier for the new profiling group that helps ensure idempotency.

", + "documentation":"

Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental creation of duplicate profiling groups if there are failures and retries.

", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" }, + "computePlatform":{ + "shape":"ComputePlatform", + "documentation":"

The compute platform of the profiling group. Use AWSLambda if your application runs on AWS Lambda. Use Default if your application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. If not specified, Default is used.

" + }, "profilingGroupName":{ "shape":"ProfilingGroupName", - "documentation":"

The name of the profiling group.

" + "documentation":"

The name of the profiling group to create.

" } }, "documentation":"

The structure representing the createProfiliingGroupRequest.

" @@ -363,7 +741,7 @@ "members":{ "profilingGroup":{ "shape":"ProfilingGroupDescription", - "documentation":"

Information about the new profiling group

" + "documentation":"

The returned ProfilingGroupDescription object that contains information about the created profiling group.

" } }, "documentation":"

The structure representing the createProfilingGroupResponse.

", @@ -375,7 +753,7 @@ "members":{ "profilingGroupName":{ "shape":"ProfilingGroupName", - "documentation":"

The profiling group name to delete.

", + "documentation":"

The name of the profiling group to delete.

", "location":"uri", "locationName":"profilingGroupName" } @@ -394,7 +772,7 @@ "members":{ "profilingGroupName":{ "shape":"ProfilingGroupName", - "documentation":"

The profiling group name.

", + "documentation":"

The name of the profiling group to get information about.

", "location":"uri", "locationName":"profilingGroupName" } @@ -407,18 +785,186 @@ "members":{ "profilingGroup":{ "shape":"ProfilingGroupDescription", - "documentation":"

Information about a profiling group.

" + "documentation":"

The returned ProfilingGroupDescription object that contains information about the requested profiling group.

" } }, "documentation":"

The structure representing the describeProfilingGroupResponse.

", "payload":"profilingGroup" }, + "Double":{ + "type":"double", + "box":true + }, + "EventPublisher":{ + "type":"string", + "enum":["AnomalyDetection"] + }, + "EventPublishers":{ + "type":"list", + "member":{"shape":"EventPublisher"}, + "max":1, + "min":1 + }, + "FeedbackType":{ + "type":"string", + "enum":[ + "Negative", + "Positive" + ] + }, + "FindingsReportId":{ + "type":"string", + "pattern":"[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}" + }, + "FindingsReportSummaries":{ + "type":"list", + "member":{"shape":"FindingsReportSummary"} + }, + "FindingsReportSummary":{ + "type":"structure", + "members":{ + "id":{ + "shape":"FindingsReportId", + "documentation":"

The universally unique identifier (UUID) of the recommendation report.

" + }, + "profileEndTime":{ + "shape":"Timestamp", + "documentation":"

The end time of the period during which the metric is flagged as anomalous. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" + }, + "profileStartTime":{ + "shape":"Timestamp", + "documentation":"

The start time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" + }, + "profilingGroupName":{ + "shape":"String", + "documentation":"

The name of the profiling group that is associated with the analysis data.

" + }, + "totalNumberOfFindings":{ + "shape":"Integer", + "documentation":"

The total number of different recommendations that were found by the analysis.

" + } + }, + "documentation":"

Information about potential recommendations that might be created from the analysis of profiling data.

" + }, "FleetInstanceId":{ "type":"string", "max":255, "min":1, "pattern":"^[\\w-.:/]+$" }, + "FrameMetric":{ + "type":"structure", + "required":[ + "frameName", + "threadStates", + "type" + ], + "members":{ + "frameName":{ + "shape":"String", + "documentation":"

Name of the method common across the multiple occurrences of a frame in an application profile.

" + }, + "threadStates":{ + "shape":"ThreadStates", + "documentation":"

List of application runtime thread states used to get the counts for a frame a derive a metric value.

" + }, + "type":{ + "shape":"MetricType", + "documentation":"

A type of aggregation that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurrences of all frames in a profile.

" + } + }, + "documentation":"

The frame name, metric type, and thread states. These are used to derive the value of the metric for the frame.

" + }, + "FrameMetricData":{ + "type":"list", + "member":{"shape":"FrameMetricDatum"} + }, + "FrameMetricDatum":{ + "type":"structure", + "required":[ + "frameMetric", + "values" + ], + "members":{ + "frameMetric":{"shape":"FrameMetric"}, + "values":{ + "shape":"FrameMetricValues", + "documentation":"

A list of values that are associated with a frame metric.

" + } + }, + "documentation":"

Information about a frame metric and its values.

" + }, + "FrameMetricValues":{ + "type":"list", + "member":{"shape":"Double"} + }, + "FrameMetrics":{ + "type":"list", + "member":{"shape":"FrameMetric"} + }, + "GetFindingsReportAccountSummaryRequest":{ + "type":"structure", + "members":{ + "dailyReportsOnly":{ + "shape":"Boolean", + "documentation":"

A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).

", + "location":"querystring", + "locationName":"dailyReportsOnly" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results returned by GetFindingsReportAccountSummary in paginated output. When this parameter is used, GetFindingsReportAccountSummary only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another GetFindingsReportAccountSummary request with the returned nextToken value.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The nextToken value returned from a previous paginated GetFindingsReportAccountSummary request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

", + "location":"querystring", + "locationName":"nextToken" + } + }, + "documentation":"

The structure representing the GetFindingsReportAccountSummaryRequest.

" + }, + "GetFindingsReportAccountSummaryResponse":{ + "type":"structure", + "required":["reportSummaries"], + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The nextToken value to include in a future GetFindingsReportAccountSummary request. When the results of a GetFindingsReportAccountSummary request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + }, + "reportSummaries":{ + "shape":"FindingsReportSummaries", + "documentation":"

The return list of FindingsReportSummary objects taht contain summaries of analysis results for all profiling groups in your AWS account.

" + } + }, + "documentation":"

The structure representing the GetFindingsReportAccountSummaryResponse.

" + }, + "GetNotificationConfigurationRequest":{ + "type":"structure", + "required":["profilingGroupName"], + "members":{ + "profilingGroupName":{ + "shape":"ProfilingGroupName", + "documentation":"

The name of the profiling group we want to get the notification configuration for.

", + "location":"uri", + "locationName":"profilingGroupName" + } + }, + "documentation":"

The structure representing the GetNotificationConfigurationRequest.

" + }, + "GetNotificationConfigurationResponse":{ + "type":"structure", + "required":["notificationConfiguration"], + "members":{ + "notificationConfiguration":{ + "shape":"NotificationConfiguration", + "documentation":"

The current notification configuration for this profiling group.

" + } + }, + "documentation":"

The structure representing the GetNotificationConfigurationResponse.

" + }, "GetPolicyRequest":{ "type":"structure", "required":["profilingGroupName"], @@ -430,7 +976,7 @@ "locationName":"profilingGroupName" } }, - "documentation":"

The structure representing the getPolicyRequest.

" + "documentation":"

The structure representing the getPolicyRequest.

" }, "GetPolicyResponse":{ "type":"structure", @@ -441,14 +987,14 @@ "members":{ "policy":{ "shape":"String", - "documentation":"

The resource-based policy attached to the ProfilingGroup.

" + "documentation":"

The JSON-formatted resource-based policy attached to the ProfilingGroup.

" }, "revisionId":{ "shape":"RevisionId", - "documentation":"

A unique identifier for the current revision of the policy.

" + "documentation":"

A unique identifier for the current revision of the returned policy.

" } }, - "documentation":"

The structure representing the getPolicyResponse.

" + "documentation":"

The structure representing the getPolicyResponse.

" }, "GetProfileRequest":{ "type":"structure", @@ -456,25 +1002,25 @@ "members":{ "accept":{ "shape":"String", - "documentation":"

The format of the profile to return. You can choose application/json or the default application/x-amzn-ion.

", + "documentation":"

The format of the returned profiling data. The format maps to the Accept and Content-Type headers of the HTTP request. You can specify one of the following: or the default . 

 <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
", "location":"header", "locationName":"Accept" }, "endTime":{ "shape":"Timestamp", - "documentation":"

You must specify exactly two of the following parameters: startTime, period, and endTime.

", + "documentation":"

The end time of the requested profile. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

If you specify endTime, then you must also specify period or startTime, but not both.

", "location":"querystring", "locationName":"endTime" }, "maxDepth":{ "shape":"MaxDepth", - "documentation":"

The maximum depth of the graph.

", + "documentation":"

The maximum depth of the stacks in the code that is represented in the aggregated profile. For example, if CodeGuru Profiler finds a method A, which calls method B, which calls method C, which calls method D, then the depth is 4. If the maxDepth is set to 2, then the aggregated profile contains representations of methods A and B.

", "location":"querystring", "locationName":"maxDepth" }, "period":{ "shape":"Period", - "documentation":"

The period of the profile to get. The time range must be in the past and not longer than one week.

You must specify exactly two of the following parameters: startTime, period, and endTime.

", + "documentation":"

Used with startTime or endTime to specify the time range for the returned aggregated profile. Specify using the ISO 8601 format. For example, P1DT1H1M1S. 

 <p> To get the latest aggregated profile, specify only <code>period</code>. </p>
", "location":"querystring", "locationName":"period" }, @@ -486,7 +1032,7 @@ }, "startTime":{ "shape":"Timestamp", - "documentation":"

The start time of the profile to get.

You must specify exactly two of the following parameters: startTime, period, and endTime.

", + "documentation":"

The start time of the profile to get. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

 <p> If you specify <code>startTime</code>, then you must also specify <code>period</code> or <code>endTime</code>, but not both. </p>
", "location":"querystring", "locationName":"startTime" } @@ -520,6 +1066,74 @@ "documentation":"

The structure representing the getProfileResponse.

", "payload":"profile" }, + "GetRecommendationsRequest":{ + "type":"structure", + "required":[ + "endTime", + "profilingGroupName", + "startTime" + ], + "members":{ + "endTime":{ + "shape":"Timestamp", + "documentation":"

The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

", + "location":"querystring", + "locationName":"endTime" + }, + "locale":{ + "shape":"Locale", + "documentation":"

The language used to provide analysis. Specify using a string that is one of the following BCP 47 language codes.

  • de-DE - German, Germany

  • en-GB - English, United Kingdom

  • en-US - English, United States

  • es-ES - Spanish, Spain

  • fr-FR - French, France

  • it-IT - Italian, Italy

  • ja-JP - Japanese, Japan

  • ko-KR - Korean, Republic of Korea

  • pt-BR - Portugese, Brazil

  • zh-CN - Chinese, China

  • zh-TW - Chinese, Taiwan

", + "location":"querystring", + "locationName":"locale" + }, + "profilingGroupName":{ + "shape":"ProfilingGroupName", + "documentation":"

The name of the profiling group to get analysis data about.

", + "location":"uri", + "locationName":"profilingGroupName" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

", + "location":"querystring", + "locationName":"startTime" + } + }, + "documentation":"

The structure representing the GetRecommendationsRequest.

" + }, + "GetRecommendationsResponse":{ + "type":"structure", + "required":[ + "anomalies", + "profileEndTime", + "profileStartTime", + "profilingGroupName", + "recommendations" + ], + "members":{ + "anomalies":{ + "shape":"Anomalies", + "documentation":"

The list of anomalies that the analysis has found for this profile.

" + }, + "profileEndTime":{ + "shape":"Timestamp", + "documentation":"

The end time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" + }, + "profileStartTime":{ + "shape":"Timestamp", + "documentation":"

The start time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" + }, + "profilingGroupName":{ + "shape":"ProfilingGroupName", + "documentation":"

The name of the profiling group the analysis data is about.

" + }, + "recommendations":{ + "shape":"Recommendations", + "documentation":"

The list of recommendations that the analysis found for this profile.

" + } + }, + "documentation":"

The structure representing the GetRecommendationsResponse.

" + }, "Integer":{ "type":"integer", "box":true @@ -535,6 +1149,72 @@ "exception":true, "fault":true }, + "ListFindingsReportsRequest":{ + "type":"structure", + "required":[ + "endTime", + "profilingGroupName", + "startTime" + ], + "members":{ + "dailyReportsOnly":{ + "shape":"Boolean", + "documentation":"

A Boolean value indicating whether to only return reports from daily profiles. If set to True, only analysis data from daily profiles is returned. If set to False, analysis data is returned from smaller time windows (for example, one hour).

", + "location":"querystring", + "locationName":"dailyReportsOnly" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

", + "location":"querystring", + "locationName":"endTime" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of report results returned by ListFindingsReports in paginated output. When this parameter is used, ListFindingsReports only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListFindingsReports request with the returned nextToken value.

", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The nextToken value returned from a previous paginated ListFindingsReportsRequest request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

", + "location":"querystring", + "locationName":"nextToken" + }, + "profilingGroupName":{ + "shape":"ProfilingGroupName", + "documentation":"

The name of the profiling group from which to search for analysis data.

", + "location":"uri", + "locationName":"profilingGroupName" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

", + "location":"querystring", + "locationName":"startTime" + } + }, + "documentation":"

The structure representing the ListFindingsReportsRequest.

" + }, + "ListFindingsReportsResponse":{ + "type":"structure", + "required":["findingsReportSummaries"], + "members":{ + "findingsReportSummaries":{ + "shape":"FindingsReportSummaries", + "documentation":"

The list of analysis results summaries.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The nextToken value to include in a future ListFindingsReports request. When the results of a ListFindingsReports request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

" + } + }, + "documentation":"

The structure representing the ListFindingsReportsResponse.

" + }, + "ListOfTimestamps":{ + "type":"list", + "member":{"shape":"TimestampStructure"} + }, "ListProfileTimesRequest":{ "type":"structure", "required":[ @@ -570,7 +1250,7 @@ }, "period":{ "shape":"AggregationPeriod", - "documentation":"

The aggregation period.

", + "documentation":"

The aggregation period. This specifies the period during which an aggregation profile collects posted agent profiles for a profiling group. There are 3 valid values.

  • P1D — 1 day

  • PT1H — 1 hour

  • PT5M — 5 minutes

", "location":"querystring", "locationName":"period" }, @@ -609,7 +1289,7 @@ "members":{ "includeDescription":{ "shape":"Boolean", - "documentation":"

A Boolean value indicating whether to include a description.

", + "documentation":"

A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned.

", "location":"querystring", "locationName":"includeDescription" }, @@ -638,15 +1318,41 @@ }, "profilingGroupNames":{ "shape":"ProfilingGroupNames", - "documentation":"

Information about profiling group names.

" + "documentation":"

A returned list of profiling group names. A list of the names is returned only if includeDescription is false, otherwise a list of ProfilingGroupDescription objects is returned.

" }, "profilingGroups":{ "shape":"ProfilingGroupDescriptions", - "documentation":"

Information about profiling groups.

" + "documentation":"

A returned list ProfilingGroupDescription objects. A list of ProfilingGroupDescription objects is returned only if includeDescription is true, otherwise a list of profiling group names is returned.

" } }, "documentation":"

The structure representing the listProfilingGroupsResponse.

" }, + "Locale":{ + "type":"string", + "documentation":"

BCP47 language code. Supported locales: de-DE, en-GB, en-US, es-ES, fr-FR, it-IT, ja-JP, ko-KR, pt-BR, zh-CN, zh-TW

" + }, + "Match":{ + "type":"structure", + "members":{ + "frameAddress":{ + "shape":"String", + "documentation":"

The location in the profiling graph that contains a recommendation found during analysis.

" + }, + "targetFramesIndex":{ + "shape":"Integer", + "documentation":"

The target frame that triggered a match.

" + }, + "thresholdBreachValue":{ + "shape":"Double", + "documentation":"

The value in the profile data that exceeded the recommendation threshold.

" + } + }, + "documentation":"

The part of a profile that contains a recommendation found during analysis.

" + }, + "Matches":{ + "type":"list", + "member":{"shape":"Match"} + }, "MaxDepth":{ "type":"integer", "box":true, @@ -659,6 +1365,62 @@ "max":1000, "min":1 }, + "Metadata":{ + "type":"map", + "key":{"shape":"MetadataField"}, + "value":{"shape":"String"} + }, + "MetadataField":{ + "type":"string", + "enum":[ + "AgentId", + "AwsRequestId", + "ComputePlatform", + "ExecutionEnvironment", + "LambdaFunctionArn", + "LambdaMemoryLimitInMB", + "LambdaPreviousExecutionTimeInMilliseconds", + "LambdaRemainingTimeInMilliseconds", + "LambdaTimeGapBetweenInvokesInMilliseconds" + ] + }, + "Metric":{ + "type":"structure", + "required":[ + "frameName", + "threadStates", + "type" + ], + "members":{ + "frameName":{ + "shape":"String", + "documentation":"

The name of the method that appears as a frame in any stack in a profile.

" + }, + "threadStates":{ + "shape":"Strings", + "documentation":"

The list of application runtime thread states that is used to calculate the metric value for the frame.

" + }, + "type":{ + "shape":"MetricType", + "documentation":"

A type that specifies how a metric for a frame is analyzed. The supported value AggregatedRelativeTotalTime is an aggregation of the metric value for one frame that is calculated across the occurences of all frames in a profile.

" + } + }, + "documentation":"

Details about the metric that the analysis used when it detected the anomaly. The metric what is analyzed to create recommendations. It includes the name of the frame that was analyzed and the type and thread states used to derive the metric value for that frame.

" + }, + "MetricType":{ + "type":"string", + "enum":["AggregatedRelativeTotalTime"] + }, + "NotificationConfiguration":{ + "type":"structure", + "members":{ + "channels":{ + "shape":"Channels", + "documentation":"

List of up to two channels to be used for sending notifications for events detected from the application profile.

" + } + }, + "documentation":"

The configuration for notifications stored for each profiling group. This includes up to to two channels and a list of event publishers associated with each channel.

" + }, "OrderBy":{ "type":"string", "enum":[ @@ -672,6 +1434,45 @@ "min":1, "pattern":"^[\\w-]+$" }, + "Pattern":{ + "type":"structure", + "members":{ + "countersToAggregate":{ + "shape":"Strings", + "documentation":"

A list of the different counters used to determine if there is a match.

" + }, + "description":{ + "shape":"String", + "documentation":"

The description of the recommendation. This explains a potential inefficiency in a profiled application.

" + }, + "id":{ + "shape":"String", + "documentation":"

The universally unique identifier (UUID) of this pattern.

" + }, + "name":{ + "shape":"String", + "documentation":"

The name for this pattern.

" + }, + "resolutionSteps":{ + "shape":"String", + "documentation":"

A string that contains the steps recommended to address the potential inefficiency.

" + }, + "targetFrames":{ + "shape":"TargetFrames", + "documentation":"

A list of frame names that were searched during the analysis that generated a recommendation.

" + }, + "thresholdPercent":{ + "shape":"Percentage", + "documentation":"

The percentage of time an application spends in one method that triggers a recommendation. The percentage of time is the same as the percentage of the total gathered sample counts during analysis.

" + } + }, + "documentation":"

A set of rules used to make a recommendation during an analysis.

" + }, + "Percentage":{ + "type":"double", + "max":100, + "min":0 + }, "Period":{ "type":"string", "max":64, @@ -687,24 +1488,24 @@ "members":{ "agentProfile":{ "shape":"AgentProfile", - "documentation":"

" + "documentation":"

The submitted profiling data.

" }, "contentType":{ "shape":"String", - "documentation":"

", + "documentation":"

The format of the submitted profiling data. The format maps to the Accept and Content-Type headers of the HTTP request. You can specify one of the following: or the default . 

 <ul> <li> <p> <code>application/json</code> — standard JSON format </p> </li> <li> <p> <code>application/x-amzn-ion</code> — the Amazon Ion data format. For more information, see <a href="http://amzn.github.io/ion-docs/">Amazon Ion</a>. </p> </li> </ul>
", "location":"header", "locationName":"Content-Type" }, "profileToken":{ "shape":"ClientToken", - "documentation":"

", + "documentation":"

Amazon CodeGuru Profiler uses this universally unique identifier (UUID) to prevent the accidental submission of duplicate profiling data if there are failures and retries.

", "idempotencyToken":true, "location":"querystring", "locationName":"profileToken" }, "profilingGroupName":{ "shape":"ProfilingGroupName", - "documentation":"

", + "documentation":"

The name of the profiling group with the aggregated profile that receives the submitted profiling data.

", "location":"uri", "locationName":"profilingGroupName" } @@ -730,10 +1531,10 @@ "members":{ "start":{ "shape":"Timestamp", - "documentation":"

The start time of the profile.

" + "documentation":"

The start time of a profile. It is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" } }, - "documentation":"

Information about the profile time.

" + "documentation":"

Contains the start time of a profile.

" }, "ProfileTimes":{ "type":"list", @@ -745,15 +1546,19 @@ "members":{ "agentOrchestrationConfig":{ "shape":"AgentOrchestrationConfig", - "documentation":"

" + "documentation":"

An AgentOrchestrationConfig object that indicates if the profiling group is enabled for profiled or not.

" }, "arn":{ "shape":"ProfilingGroupArn", - "documentation":"

The Amazon Resource Name (ARN) identifying the profiling group.

" + "documentation":"

The Amazon Resource Name (ARN) identifying the profiling group resource.

" + }, + "computePlatform":{ + "shape":"ComputePlatform", + "documentation":"

The compute platform of the profiling group. If it is set to AWSLambda, then the profiled application runs on AWS Lambda. If it is set to Default, then the profiled application runs on a compute platform that is not AWS Lambda, such an Amazon EC2 instance, an on-premises server, or a different platform. The default is Default.

" }, "createdAt":{ "shape":"Timestamp", - "documentation":"

The time, in milliseconds since the epoch, when the profiling group was created.

" + "documentation":"

The time when the profiling group was created. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" }, "name":{ "shape":"ProfilingGroupName", @@ -761,14 +1566,14 @@ }, "profilingStatus":{ "shape":"ProfilingStatus", - "documentation":"

The status of the profiling group.

" + "documentation":"

A ProfilingStatus object that includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile.

" }, "updatedAt":{ "shape":"Timestamp", - "documentation":"

The time, in milliseconds since the epoch, when the profiling group was last updated.

" + "documentation":"

The date and time when the profiling group was last updated. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" } }, - "documentation":"

The description of a profiling group.

" + "documentation":"

Contains information about a profiling group.

" }, "ProfilingGroupDescriptions":{ "type":"list", @@ -789,18 +1594,18 @@ "members":{ "latestAgentOrchestratedAt":{ "shape":"Timestamp", - "documentation":"

The time, in milliseconds since the epoch, when the latest agent was orchestrated.

" + "documentation":"

The date and time when the profiling agent most recently pinged back. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" }, "latestAgentProfileReportedAt":{ "shape":"Timestamp", - "documentation":"

The time, in milliseconds since the epoch, when the latest agent was reported..

" + "documentation":"

The date and time when the most recent profile was received. Specify using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" }, "latestAggregatedProfile":{ "shape":"AggregatedProfileTime", - "documentation":"

The latest aggregated profile

" + "documentation":"

An AggregatedProfileTime object that contains the aggregation period and start time for an aggregated profile.

" } }, - "documentation":"

Information about the profiling status.

" + "documentation":"

Profiling status includes information about the last time a profile agent pinged back, the last time a profile was received, and the aggregation period and start time for the most recent aggregated profile.

" }, "PutPermissionRequest":{ "type":"structure", @@ -812,26 +1617,26 @@ "members":{ "actionGroup":{ "shape":"ActionGroup", - "documentation":"

The list of actions that the users and roles can perform on the profiling group.

", + "documentation":"

Specifies an action group that contains permissions to add to a profiling group resource. One action group is supported, agentPermissions, which grants permission to perform actions required by the profiling agent, ConfigureAgent and PostAgentProfile permissions.

", "location":"uri", "locationName":"actionGroup" }, "principals":{ "shape":"Principals", - "documentation":"

The list of role and user ARNs or the accountId that needs access (wildcards are not allowed).

" + "documentation":"

A list ARNs for the roles and users you want to grant access to the profiling group. Wildcards are not are supported in the ARNs.

" }, "profilingGroupName":{ "shape":"ProfilingGroupName", - "documentation":"

The name of the profiling group.

", + "documentation":"

The name of the profiling group to grant access to.

", "location":"uri", "locationName":"profilingGroupName" }, "revisionId":{ "shape":"RevisionId", - "documentation":"

A unique identifier for the current revision of the policy. This is required, if a policy exists for the profiling group. This is not required when creating the policy for the first time.

" + "documentation":"

A universally unique identifier (UUID) for the revision of the policy you are adding to the profiling group. Do not specify this when you add permissions to a profiling group for the first time. If a policy already exists on the profiling group, you must specify the revisionId.

" } }, - "documentation":"

The structure representing the putPermissionRequest.

" + "documentation":"

The structure representing the putPermissionRequest.

" }, "PutPermissionResponse":{ "type":"structure", @@ -842,14 +1647,88 @@ "members":{ "policy":{ "shape":"String", - "documentation":"

The resource-based policy.

" + "documentation":"

The JSON-formatted resource-based policy on the profiling group that includes the added permissions.

" }, "revisionId":{ "shape":"RevisionId", - "documentation":"

A unique identifier for the current revision of the policy.

" + "documentation":"

A universally unique identifier (UUID) for the revision of the resource-based policy that includes the added permissions. The JSON-formatted policy is in the policy element of the response.

" } }, - "documentation":"

The structure representing the putPermissionResponse.

" + "documentation":"

The structure representing the putPermissionResponse.

" + }, + "Recommendation":{ + "type":"structure", + "required":[ + "allMatchesCount", + "allMatchesSum", + "endTime", + "pattern", + "startTime", + "topMatches" + ], + "members":{ + "allMatchesCount":{ + "shape":"Integer", + "documentation":"

How many different places in the profile graph triggered a match.

" + }, + "allMatchesSum":{ + "shape":"Double", + "documentation":"

How much of the total sample count is potentially affected.

" + }, + "endTime":{ + "shape":"Timestamp", + "documentation":"

End time of the profile that was used by this analysis. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" + }, + "pattern":{ + "shape":"Pattern", + "documentation":"

The pattern that analysis recognized in the profile to make this recommendation.

" + }, + "startTime":{ + "shape":"Timestamp", + "documentation":"

The start time of the profile that was used by this analysis. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" + }, + "topMatches":{ + "shape":"Matches", + "documentation":"

List of the matches with most impact.

" + } + }, + "documentation":"

A potential improvement that was found from analyzing the profiling data.

" + }, + "Recommendations":{ + "type":"list", + "member":{"shape":"Recommendation"} + }, + "RemoveNotificationChannelRequest":{ + "type":"structure", + "required":[ + "channelId", + "profilingGroupName" + ], + "members":{ + "channelId":{ + "shape":"ChannelId", + "documentation":"

The id of the channel that we want to stop receiving notifications.

", + "location":"uri", + "locationName":"channelId" + }, + "profilingGroupName":{ + "shape":"ProfilingGroupName", + "documentation":"

The name of the profiling group we want to change notification configuration for.

", + "location":"uri", + "locationName":"profilingGroupName" + } + }, + "documentation":"

The structure representing the RemoveNotificationChannelRequest.

" + }, + "RemoveNotificationChannelResponse":{ + "type":"structure", + "members":{ + "notificationConfiguration":{ + "shape":"NotificationConfiguration", + "documentation":"

The new notification configuration for this profiling group.

" + } + }, + "documentation":"

The structure representing the RemoveNotificationChannelResponse.

" }, "RemovePermissionRequest":{ "type":"structure", @@ -861,7 +1740,7 @@ "members":{ "actionGroup":{ "shape":"ActionGroup", - "documentation":"

The list of actions that the users and roles can perform on the profiling group.

", + "documentation":"

Specifies an action group that contains the permissions to remove from a profiling group's resource-based policy. One action group is supported, agentPermissions, which grants ConfigureAgent and PostAgentProfile permissions.

", "location":"uri", "locationName":"actionGroup" }, @@ -873,12 +1752,12 @@ }, "revisionId":{ "shape":"RevisionId", - "documentation":"

A unique identifier for the current revision of the policy.

", + "documentation":"

A universally unique identifier (UUID) for the revision of the resource-based policy from which you want to remove permissions.

", "location":"querystring", "locationName":"revisionId" } }, - "documentation":"

The structure representing the removePermissionRequest.

" + "documentation":"

 The structure representing the <code>removePermissionRequest</code>.</p>
" }, "RemovePermissionResponse":{ "type":"structure", @@ -889,14 +1768,14 @@ "members":{ "policy":{ "shape":"String", - "documentation":"

The resource-based policy.

" + "documentation":"

The JSON-formatted resource-based policy on the profiling group after the specified permissions were removed.

" }, "revisionId":{ "shape":"RevisionId", - "documentation":"

A unique identifier for the current revision of the policy.

" + "documentation":"

A universally unique identifier (UUID) for the revision of the resource-based policy after the specified permissions were removed. The updated JSON-formatted policy is in the policy element of the response.

" } }, - "documentation":"

The structure representing the removePermissionResponse.

" + "documentation":"

The structure representing the removePermissionResponse.

" }, "ResourceNotFoundException":{ "type":"structure", @@ -929,6 +1808,59 @@ "exception":true }, "String":{"type":"string"}, + "Strings":{ + "type":"list", + "member":{"shape":"String"} + }, + "SubmitFeedbackRequest":{ + "type":"structure", + "required":[ + "anomalyInstanceId", + "profilingGroupName", + "type" + ], + "members":{ + "anomalyInstanceId":{ + "shape":"AnomalyInstanceId", + "documentation":"

The universally unique identifier (UUID) of the AnomalyInstance object that is included in the analysis data.

", + "location":"uri", + "locationName":"anomalyInstanceId" + }, + "comment":{ + "shape":"String", + "documentation":"

Optional feedback about this anomaly.

" + }, + "profilingGroupName":{ + "shape":"ProfilingGroupName", + "documentation":"

The name of the profiling group that is associated with the analysis data.

", + "location":"uri", + "locationName":"profilingGroupName" + }, + "type":{ + "shape":"FeedbackType", + "documentation":"

The feedback tpye. Thee are two valid values, Positive and Negative.

" + } + }, + "documentation":"

The structure representing the SubmitFeedbackRequest.

" + }, + "SubmitFeedbackResponse":{ + "type":"structure", + "members":{ + }, + "documentation":"

The structure representing the SubmitFeedbackResponse.

" + }, + "TargetFrame":{ + "type":"list", + "member":{"shape":"String"} + }, + "TargetFrames":{ + "type":"list", + "member":{"shape":"TargetFrame"} + }, + "ThreadStates":{ + "type":"list", + "member":{"shape":"String"} + }, "ThrottlingException":{ "type":"structure", "required":["message"], @@ -946,6 +1878,22 @@ "type":"timestamp", "timestampFormat":"iso8601" }, + "TimestampStructure":{ + "type":"structure", + "required":["value"], + "members":{ + "value":{ + "shape":"Timestamp", + "documentation":"

A Timestamp. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" + } + }, + "documentation":"

A data type that contains a Timestamp object. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC.

" + }, + "UnprocessedEndTimeMap":{ + "type":"map", + "key":{"shape":"String"}, + "value":{"shape":"ListOfTimestamps"} + }, "UpdateProfilingGroupRequest":{ "type":"structure", "required":[ @@ -955,7 +1903,7 @@ "members":{ "agentOrchestrationConfig":{ "shape":"AgentOrchestrationConfig", - "documentation":"

" + "documentation":"

Specifies whether profiling is enabled or disabled for a profiling group.

" }, "profilingGroupName":{ "shape":"ProfilingGroupName", @@ -972,12 +1920,23 @@ "members":{ "profilingGroup":{ "shape":"ProfilingGroupDescription", - "documentation":"

Updated information about the profiling group.

" + "documentation":"

A ProfilingGroupDescription that contains information about the returned updated profiling group.

" } }, "documentation":"

The structure representing the updateProfilingGroupResponse.

", "payload":"profilingGroup" }, + "UserFeedback":{ + "type":"structure", + "required":["type"], + "members":{ + "type":{ + "shape":"FeedbackType", + "documentation":"

Optional Positive or Negative feedback submitted by the user about whether the recommendation is useful or not.

" + } + }, + "documentation":"

Feedback that can be submitted for each instance of an anomaly by the user. Feedback is be used for improvements in generating recommendations for the application.

" + }, "ValidationException":{ "type":"structure", "required":["message"], @@ -992,5 +1951,5 @@ "exception":true } }, - "documentation":"

This section provides documentation for the Amazon CodeGuru Profiler API operations.

" + "documentation":"

This section provides documentation for the Amazon CodeGuru Profiler API operations.

 <p>Amazon CodeGuru Profiler collects runtime performance data from your live applications, and provides recommendations that can help you fine-tune your application performance. Using machine learning algorithms, CodeGuru Profiler can help you find your most expensive lines of code and suggest ways you can improve efficiency and remove CPU bottlenecks. </p> <p>Amazon CodeGuru Profiler provides different visualizations of profiling data to help you identify what code is running on the CPU, see how much time is consumed, and suggest ways to reduce CPU utilization. </p> <note> <p>Amazon CodeGuru Profiler currently supports applications written in all Java virtual machine (JVM) languages. While CodeGuru Profiler supports both visualizations and recommendations for applications written in Java, it can also generate visualizations and a subset of recommendations for applications written in other JVM languages.</p> </note> <p> For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-ug/what-is-codeguru-profiler.html">What is Amazon CodeGuru Profiler</a> in the <i>Amazon CodeGuru Profiler User Guide</i>. </p>
" } diff --git a/botocore/data/codestar-connections/2019-12-01/service-2.json b/botocore/data/codestar-connections/2019-12-01/service-2.json index 22e63b89..01ec2ed4 100644 --- a/botocore/data/codestar-connections/2019-12-01/service-2.json +++ b/botocore/data/codestar-connections/2019-12-01/service-2.json @@ -22,10 +22,25 @@ "input":{"shape":"CreateConnectionInput"}, "output":{"shape":"CreateConnectionOutput"}, "errors":[ - {"shape":"LimitExceededException"} + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceUnavailableException"} ], "documentation":"

Creates a connection that can then be given to other AWS services like CodePipeline so that it can access third-party code repositories. The connection is in pending status until the third-party connection handshake is completed from the console.

" }, + "CreateHost":{ + "name":"CreateHost", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateHostInput"}, + "output":{"shape":"CreateHostOutput"}, + "errors":[ + {"shape":"LimitExceededException"} + ], + "documentation":"

Creates a resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider.

A host created through the CLI or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by setting up the host in the console.

" + }, "DeleteConnection":{ "name":"DeleteConnection", "http":{ @@ -39,6 +54,20 @@ ], "documentation":"

The connection to be deleted.

" }, + "DeleteHost":{ + "name":"DeleteHost", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteHostInput"}, + "output":{"shape":"DeleteHostOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceUnavailableException"} + ], + "documentation":"

The host to be deleted. Before you delete a host, all connections associated to the host must be deleted.

A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state.

" + }, "GetConnection":{ "name":"GetConnection", "http":{ @@ -48,10 +77,24 @@ "input":{"shape":"GetConnectionInput"}, "output":{"shape":"GetConnectionOutput"}, "errors":[ - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ResourceUnavailableException"} ], "documentation":"

Returns the connection ARN and details such as status, owner, and provider type.

" }, + "GetHost":{ + "name":"GetHost", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetHostInput"}, + "output":{"shape":"GetHostOutput"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.

" + }, "ListConnections":{ "name":"ListConnections", "http":{ @@ -62,6 +105,16 @@ "output":{"shape":"ListConnectionsOutput"}, "documentation":"

Lists the connections associated with your account.

" }, + "ListHosts":{ + "name":"ListHosts", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListHostsInput"}, + "output":{"shape":"ListHostsOutput"}, + "documentation":"

Lists the hosts associated with your account.

" + }, "ListTagsForResource":{ "name":"ListTagsForResource", "http":{ @@ -128,7 +181,7 @@ }, "ProviderType":{ "shape":"ProviderType", - "documentation":"

The name of the external provider where your third-party code repository is configured. Currently, the valid provider type is Bitbucket.

" + "documentation":"

The name of the external provider where your third-party code repository is configured. The valid provider type is Bitbucket.

" }, "OwnerAccountId":{ "shape":"AccountId", @@ -137,9 +190,13 @@ "ConnectionStatus":{ "shape":"ConnectionStatus", "documentation":"

The current status of the connection.

" + }, + "HostArn":{ + "shape":"HostArn", + "documentation":"

The Amazon Resource Name (ARN) of the host associated with the connection.

" } }, - "documentation":"

The AWS::CodeStarConnections::Connection resource can be used to connect external source providers with services like AWS CodePipeline.

Note: A connection created through CloudFormation is in `PENDING` status by default. You can make its status `AVAILABLE` by editing the connection in the CodePipeline console.

" + "documentation":"

A resource that is used to connect third-party source providers with services like AWS CodePipeline.

Note: A connection created through CloudFormation, the CLI, or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by updating the connection in the console.

" }, "ConnectionArn":{ "type":"string", @@ -166,14 +223,11 @@ }, "CreateConnectionInput":{ "type":"structure", - "required":[ - "ProviderType", - "ConnectionName" - ], + "required":["ConnectionName"], "members":{ "ProviderType":{ "shape":"ProviderType", - "documentation":"

The name of the external provider where your third-party code repository is configured. Currently, the valid provider type is Bitbucket.

" + "documentation":"

The name of the external provider where your third-party code repository is configured. The valid provider type is Bitbucket.

" }, "ConnectionName":{ "shape":"ConnectionName", @@ -182,6 +236,10 @@ "Tags":{ "shape":"TagList", "documentation":"

The key-value pair to use when tagging the resource.

" + }, + "HostArn":{ + "shape":"HostArn", + "documentation":"

The Amazon Resource Name (ARN) of the host associated with the connection to be created.

" } } }, @@ -199,6 +257,41 @@ } } }, + "CreateHostInput":{ + "type":"structure", + "required":[ + "Name", + "ProviderType", + "ProviderEndpoint" + ], + "members":{ + "Name":{ + "shape":"HostName", + "documentation":"

The name of the host to be created. The name must be unique in the calling AWS account.

" + }, + "ProviderType":{ + "shape":"ProviderType", + "documentation":"

The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.

" + }, + "ProviderEndpoint":{ + "shape":"Url", + "documentation":"

The endpoint of the infrastructure to be represented by the host after it is created.

" + }, + "VpcConfiguration":{ + "shape":"VpcConfiguration", + "documentation":"

The VPC configuration to be provisioned for the host. A VPC must be configured and the infrastructure to be represented by the host must already be connected to the VPC.

" + } + } + }, + "CreateHostOutput":{ + "type":"structure", + "members":{ + "HostArn":{ + "shape":"HostArn", + "documentation":"

The Amazon Resource Name (ARN) of the host to be created.

" + } + } + }, "DeleteConnectionInput":{ "type":"structure", "required":["ConnectionArn"], @@ -214,6 +307,21 @@ "members":{ } }, + "DeleteHostInput":{ + "type":"structure", + "required":["HostArn"], + "members":{ + "HostArn":{ + "shape":"HostArn", + "documentation":"

The Amazon Resource Name (ARN) of the host to be deleted.

" + } + } + }, + "DeleteHostOutput":{ + "type":"structure", + "members":{ + } + }, "ErrorMessage":{ "type":"string", "max":600 @@ -237,6 +345,92 @@ } } }, + "GetHostInput":{ + "type":"structure", + "required":["HostArn"], + "members":{ + "HostArn":{ + "shape":"HostArn", + "documentation":"

The Amazon Resource Name (ARN) of the requested host.

" + } + } + }, + "GetHostOutput":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"HostName", + "documentation":"

The name of the requested host.

" + }, + "Status":{ + "shape":"HostStatus", + "documentation":"

The status of the requested host.

" + }, + "ProviderType":{ + "shape":"ProviderType", + "documentation":"

The provider type of the requested host, such as GitHub Enterprise Server.

" + }, + "ProviderEndpoint":{ + "shape":"Url", + "documentation":"

The endpoint of the infrastructure represented by the requested host.

" + }, + "VpcConfiguration":{ + "shape":"VpcConfiguration", + "documentation":"

The VPC configuration of the requested host.

" + } + } + }, + "Host":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"HostName", + "documentation":"

The name of the host.

" + }, + "HostArn":{ + "shape":"HostArn", + "documentation":"

The Amazon Resource Name (ARN) of the host.

" + }, + "ProviderType":{ + "shape":"ProviderType", + "documentation":"

The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.

" + }, + "ProviderEndpoint":{ + "shape":"Url", + "documentation":"

The endpoint of the infrastructure where your provider type is installed.

" + }, + "VpcConfiguration":{ + "shape":"VpcConfiguration", + "documentation":"

The VPC configuration provisioned for the host.

" + }, + "Status":{ + "shape":"HostStatus", + "documentation":"

The status of the host, such as PENDING, AVAILABLE, VPC_CONFIG_DELETING, VPC_CONFIG_INITIALIZING, and VPC_CONFIG_FAILED_INITIALIZATION.

" + }, + "StatusMessage":{ + "shape":"HostStatusMessage", + "documentation":"

The status description for the host.

" + } + }, + "documentation":"

A resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider.

A host created through the CLI or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` by setting up the host in the console.

" + }, + "HostArn":{ + "type":"string", + "max":256, + "min":0, + "pattern":"arn:aws(-[\\w]+)*:codestar-connections:.+:[0-9]{12}:host\\/.+" + }, + "HostList":{ + "type":"list", + "member":{"shape":"Host"} + }, + "HostName":{ + "type":"string", + "max":32, + "min":1 + }, + "HostStatus":{"type":"string"}, + "HostStatusMessage":{"type":"string"}, "LimitExceededException":{ "type":"structure", "members":{ @@ -252,6 +446,10 @@ "shape":"ProviderType", "documentation":"

Filters the list of connections to those associated with a specified provider, such as Bitbucket.

" }, + "HostArnFilter":{ + "shape":"HostArn", + "documentation":"

Filters the list of connections to those associated with a specified host.

" + }, "MaxResults":{ "shape":"MaxResults", "documentation":"

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

" @@ -275,6 +473,32 @@ } } }, + "ListHostsInput":{ + "type":"structure", + "members":{ + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

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

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token that was returned from the previous ListHosts call, which can be used to return the next set of hosts in the list.

" + } + } + }, + "ListHostsOutput":{ + "type":"structure", + "members":{ + "Hosts":{ + "shape":"HostList", + "documentation":"

A list of hosts and the details for each host, such as status, endpoint, and provider type.

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

A token that can be used in the next ListHosts call. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.

" + } + } + }, "ListTagsForResourceInput":{ "type":"structure", "required":["ResourceArn"], @@ -296,7 +520,7 @@ }, "MaxResults":{ "type":"integer", - "max":5000, + "max":100, "min":0 }, "NextToken":{ @@ -306,7 +530,10 @@ }, "ProviderType":{ "type":"string", - "enum":["Bitbucket"] + "enum":[ + "Bitbucket", + "GitHubEnterpriseServer" + ] }, "ResourceNotFoundException":{ "type":"structure", @@ -316,6 +543,34 @@ "documentation":"

Resource not found. Verify the connection resource ARN and try again.

", "exception":true }, + "ResourceUnavailableException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Resource not found. Verify the ARN for the host resource and try again.

", + "exception":true + }, + "SecurityGroupId":{ + "type":"string", + "pattern":"sg-\\w{8}(\\w{9})?" + }, + "SecurityGroupIds":{ + "type":"list", + "member":{"shape":"SecurityGroupId"}, + "max":10, + "min":1 + }, + "SubnetId":{ + "type":"string", + "pattern":"subnet-\\w{8}(\\w{9})?" + }, + "SubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"}, + "max":10, + "min":1 + }, "Tag":{ "type":"structure", "required":[ @@ -378,6 +633,11 @@ "max":256, "min":0 }, + "TlsCertificate":{ + "type":"string", + "max":16384, + "min":1 + }, "UntagResourceInput":{ "type":"structure", "required":[ @@ -399,7 +659,43 @@ "type":"structure", "members":{ } + }, + "Url":{ + "type":"string", + "max":512, + "min":1 + }, + "VpcConfiguration":{ + "type":"structure", + "required":[ + "VpcId", + "SubnetIds", + "SecurityGroupIds" + ], + "members":{ + "VpcId":{ + "shape":"VpcId", + "documentation":"

The ID of the Amazon VPC connected to the infrastructure where your provider type is installed.

" + }, + "SubnetIds":{ + "shape":"SubnetIds", + "documentation":"

The ID of the subnet or subnets associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

" + }, + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"

The ID of the security group or security groups associated with the Amazon VPC connected to the infrastructure where your provider type is installed.

" + }, + "TlsCertificate":{ + "shape":"TlsCertificate", + "documentation":"

The value of the Transport Layer Security (TLS) certificate associated with the infrastructure where your provider type is installed.

" + } + }, + "documentation":"

The VPC configuration provisioned for the host.

" + }, + "VpcId":{ + "type":"string", + "pattern":"vpc-\\w{8}(\\w{9})?" } }, - "documentation":"

This AWS CodeStar Connections API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Connections API. You can use the Connections API to work with connections and installations.

Connections are configurations that you use to connect AWS resources to external code repositories. Each connection is a resource that can be given to services such as CodePipeline to connect to a third-party repository such as Bitbucket. For example, you can add the connection in CodePipeline so that it triggers your pipeline when a code change is made to your third-party code repository. Each connection is named and associated with a unique ARN that is used to reference the connection.

When you create a connection, the console initiates a third-party connection handshake. Installations are the apps that are used to conduct this handshake. For example, the installation for the Bitbucket provider type is the Bitbucket Cloud app. When you create a connection, you can choose an existing installation or create one.

You can work with connections by calling:

  • CreateConnection, which creates a uniquely named connection that can be referenced by services such as CodePipeline.

  • DeleteConnection, which deletes the specified connection.

  • GetConnection, which returns information about the connection, including the connection status.

  • ListConnections, which lists the connections associated with your account.

For information about how to use AWS CodeStar Connections, see the AWS CodePipeline User Guide.

" + "documentation":"AWS CodeStar Connections

The CodeStar Connections feature is in preview release and is subject to change.

This AWS CodeStar Connections API Reference provides descriptions and usage examples of the operations and data types for the AWS CodeStar Connections API. You can use the connections API to work with connections and installations.

Connections are configurations that you use to connect AWS resources to external code repositories. Each connection is a resource that can be given to services such as CodePipeline to connect to a third-party repository such as Bitbucket. For example, you can add the connection in CodePipeline so that it triggers your pipeline when a code change is made to your third-party code repository. Each connection is named and associated with a unique ARN that is used to reference the connection.

When you create a connection, the console initiates a third-party connection handshake. Installations are the apps that are used to conduct this handshake. For example, the installation for the Bitbucket provider type is the Bitbucket Cloud app. When you create a connection, you can choose an existing installation or create one.

When you want to create a connection to an installed provider type such as GitHub Enterprise Server, you create a host for your connections.

You can work with connections by calling:

  • CreateConnection, which creates a uniquely named connection that can be referenced by services such as CodePipeline.

  • DeleteConnection, which deletes the specified connection.

  • GetConnection, which returns information about the connection, including the connection status.

  • ListConnections, which lists the connections associated with your account.

You can work with hosts by calling:

  • CreateHost, which creates a host that represents the infrastructure where your provider is installed.

  • DeleteHost, which deletes the specified host.

  • GetHost, which returns information about the host, including the setup status.

  • ListHosts, which lists the hosts associated with your account.

You can work with tags in AWS CodeStar Connections by calling the following:

  • ListTagsForResource, which gets information about AWS tags for a specified Amazon Resource Name (ARN) in AWS CodeStar Connections.

  • TagResource, which adds or updates tags for a resource in AWS CodeStar Connections.

  • UntagResource, which removes tags for a resource in AWS CodeStar Connections.

For information about how to use AWS CodeStar Connections, see the Developer Tools User Guide.

" } diff --git a/botocore/data/cognito-idp/2016-04-18/service-2.json b/botocore/data/cognito-idp/2016-04-18/service-2.json index 48de0a16..309708fc 100644 --- a/botocore/data/cognito-idp/2016-04-18/service-2.json +++ b/botocore/data/cognito-idp/2016-04-18/service-2.json @@ -1327,7 +1327,8 @@ {"shape":"InvalidSmsRoleAccessPolicyException"}, {"shape":"InvalidSmsRoleTrustRelationshipException"} ], - "documentation":"

Initiates the authentication flow.

" + "documentation":"

Initiates the authentication flow.

", + "authtype":"none" }, "ListDevices":{ "name":"ListDevices", @@ -1559,7 +1560,8 @@ {"shape":"InternalErrorException"}, {"shape":"SoftwareTokenMFANotFoundException"} ], - "documentation":"

Responds to the authentication challenge.

" + "documentation":"

Responds to the authentication challenge.

", + "authtype":"none" }, "SetRiskConfiguration":{ "name":"SetRiskConfiguration", diff --git a/botocore/data/comprehend/2017-11-27/service-2.json b/botocore/data/comprehend/2017-11-27/service-2.json index a5607e55..f01ceefb 100644 --- a/botocore/data/comprehend/2017-11-27/service-2.json +++ b/botocore/data/comprehend/2017-11-27/service-2.json @@ -131,7 +131,7 @@ {"shape":"KmsKeyValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"

Creates a new document classifier that you can use to categorize documents. To create a classifier you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.

" + "documentation":"

Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.

" }, "CreateEndpoint":{ "name":"CreateEndpoint", @@ -395,6 +395,7 @@ "output":{"shape":"DetectEntitiesResponse"}, "errors":[ {"shape":"InvalidRequestException"}, + {"shape":"ResourceUnavailableException"}, {"shape":"TextSizeLimitExceededException"}, {"shape":"UnsupportedLanguageException"}, {"shape":"InternalServerException"} @@ -874,7 +875,7 @@ "required":["TextList"], "members":{ "TextList":{ - "shape":"StringList", + "shape":"CustomerInputStringList", "documentation":"

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.

" } } @@ -894,7 +895,8 @@ "shape":"BatchItemErrorList", "documentation":"

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

" } - } + }, + "sensitive":true }, "BatchDetectEntitiesItemResult":{ "type":"structure", @@ -918,7 +920,7 @@ ], "members":{ "TextList":{ - "shape":"StringList", + "shape":"CustomerInputStringList", "documentation":"

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.

" }, "LanguageCode":{ @@ -942,7 +944,8 @@ "shape":"BatchItemErrorList", "documentation":"

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

" } - } + }, + "sensitive":true }, "BatchDetectKeyPhrasesItemResult":{ "type":"structure", @@ -966,7 +969,7 @@ ], "members":{ "TextList":{ - "shape":"StringList", + "shape":"CustomerInputStringList", "documentation":"

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" }, "LanguageCode":{ @@ -990,7 +993,8 @@ "shape":"BatchItemErrorList", "documentation":"

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

" } - } + }, + "sensitive":true }, "BatchDetectSentimentItemResult":{ "type":"structure", @@ -1018,7 +1022,7 @@ ], "members":{ "TextList":{ - "shape":"StringList", + "shape":"CustomerInputStringList", "documentation":"

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" }, "LanguageCode":{ @@ -1042,7 +1046,8 @@ "shape":"BatchItemErrorList", "documentation":"

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

" } - } + }, + "sensitive":true }, "BatchDetectSyntaxItemResult":{ "type":"structure", @@ -1066,7 +1071,7 @@ ], "members":{ "TextList":{ - "shape":"StringList", + "shape":"CustomerInputStringList", "documentation":"

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" }, "LanguageCode":{ @@ -1090,7 +1095,8 @@ "shape":"BatchItemErrorList", "documentation":"

A list containing one object for each document that contained an error. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If there are no errors in the batch, the ErrorList is empty.

" } - } + }, + "sensitive":true }, "BatchItemError":{ "type":"structure", @@ -1173,14 +1179,15 @@ }, "NumberOfTestDocuments":{ "shape":"Integer", - "documentation":"

The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents.

" + "documentation":"

The number of documents in the input data that were used to test the classifier. Typically this is 10 to 20 percent of the input documents, up to 10,000 documents.

" }, "EvaluationMetrics":{ "shape":"ClassifierEvaluationMetrics", "documentation":"

Describes the result metrics for the test data associated with an documentation classifier.

" } }, - "documentation":"

Provides information about a document classifier.

" + "documentation":"

Provides information about a document classifier.

", + "sensitive":true }, "ClassifyDocumentRequest":{ "type":"structure", @@ -1190,7 +1197,7 @@ ], "members":{ "Text":{ - "shape":"String", + "shape":"CustomerInputString", "documentation":"

The document text to be analyzed.

" }, "EndpointArn":{ @@ -1210,7 +1217,8 @@ "shape":"ListOfLabels", "documentation":"

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not multually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

" } - } + }, + "sensitive":true }, "ClientRequestTokenString":{ "type":"string", @@ -1231,7 +1239,7 @@ "ComprehendEndpointArn":{ "type":"string", "max":256, - "pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*" + "pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier-endpoint|entity-recognizer-endpoint)/[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, "ComprehendEndpointName":{ "type":"string", @@ -1241,7 +1249,7 @@ "ComprehendModelArn":{ "type":"string", "max":256, - "pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:document-classifier/[a-zA-Z0-9](-*[a-zA-Z0-9])*" + "pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:(document-classifier|entity-recognizer)/[a-zA-Z0-9](-*[a-zA-Z0-9])*" }, "ConcurrentModificationException":{ "type":"structure", @@ -1405,6 +1413,16 @@ } } }, + "CustomerInputString":{ + "type":"string", + "min":1, + "sensitive":true + }, + "CustomerInputStringList":{ + "type":"list", + "member":{"shape":"CustomerInputString"}, + "sensitive":true + }, "DeleteDocumentClassifierRequest":{ "type":"structure", "required":["DocumentClassifierArn"], @@ -1626,7 +1644,7 @@ "required":["Text"], "members":{ "Text":{ - "shape":"String", + "shape":"CustomerInputString", "documentation":"

A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" } } @@ -1638,22 +1656,24 @@ "shape":"ListOfDominantLanguages", "documentation":"

The languages that Amazon Comprehend detected in the input text. For each language, the response returns the RFC 5646 language code and the level of confidence that Amazon Comprehend has in the accuracy of its inference. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

" } - } + }, + "sensitive":true }, "DetectEntitiesRequest":{ "type":"structure", - "required":[ - "Text", - "LanguageCode" - ], + "required":["Text"], "members":{ "Text":{ - "shape":"String", + "shape":"CustomerInputString", "documentation":"

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" }, "LanguageCode":{ "shape":"LanguageCode", - "documentation":"

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

" + "documentation":"

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

" + }, + "EndpointArn":{ + "shape":"EntityRecognizerEndpointArn", + "documentation":"

The Amazon Resource Name of an endpoint that is associated with a custom entity recognition model. Provide an endpoint if you want to detect entities by using your own custom model instead of the default model that is used by Amazon Comprehend.

If you specify an endpoint, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you provide in your request.

" } } }, @@ -1662,9 +1682,10 @@ "members":{ "Entities":{ "shape":"ListOfEntities", - "documentation":"

A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection. For a list of entity types, see how-entities.

" + "documentation":"

A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see how-entities.

" } - } + }, + "sensitive":true }, "DetectKeyPhrasesRequest":{ "type":"structure", @@ -1674,7 +1695,7 @@ ], "members":{ "Text":{ - "shape":"String", + "shape":"CustomerInputString", "documentation":"

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" }, "LanguageCode":{ @@ -1690,7 +1711,8 @@ "shape":"ListOfKeyPhrases", "documentation":"

A collection of key phrases that Amazon Comprehend identified in the input text. For each key phrase, the response provides the text of the key phrase, where the key phrase begins and ends, and the level of confidence that Amazon Comprehend has in the accuracy of the detection.

" } - } + }, + "sensitive":true }, "DetectSentimentRequest":{ "type":"structure", @@ -1700,7 +1722,7 @@ ], "members":{ "Text":{ - "shape":"String", + "shape":"CustomerInputString", "documentation":"

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" }, "LanguageCode":{ @@ -1720,7 +1742,8 @@ "shape":"SentimentScore", "documentation":"

An object that lists the sentiments, and their corresponding confidence levels.

" } - } + }, + "sensitive":true }, "DetectSyntaxRequest":{ "type":"structure", @@ -1730,7 +1753,7 @@ ], "members":{ "Text":{ - "shape":"String", + "shape":"CustomerInputString", "documentation":"

A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.

" }, "LanguageCode":{ @@ -1746,7 +1769,8 @@ "shape":"ListOfSyntaxTokens", "documentation":"

A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see how-syntax.

" } - } + }, + "sensitive":true }, "DocumentClass":{ "type":"structure", @@ -1775,11 +1799,11 @@ }, "SubmitTimeBefore":{ "shape":"Timestamp", - "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in ascending order, oldest to newest.

" + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

" }, "SubmitTimeAfter":{ "shape":"Timestamp", - "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in descending order, newest to oldest.

" + "documentation":"

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

" } }, "documentation":"

Provides information for filtering a list of document classification jobs. For more information, see the operation. You can provide only one filter parameter in each request.

" @@ -2292,6 +2316,11 @@ }, "documentation":"

Describes the training documents submitted with an entity recognizer.

" }, + "EntityRecognizerEndpointArn":{ + "type":"string", + "max":256, + "pattern":"arn:aws(-[^:]+)?:comprehend:[a-zA-Z0-9-]*:[0-9]{12}:entity-recognizer-endpoint/[a-zA-Z0-9](-*[a-zA-Z0-9])*" + }, "EntityRecognizerEntityList":{ "type":"structure", "required":["S3Uri"], @@ -2385,7 +2414,8 @@ "documentation":"

Entity types from the metadata of an entity recognizer.

" } }, - "documentation":"

Detailed information about an entity recognizer.

" + "documentation":"

Detailed information about an entity recognizer.

", + "sensitive":true }, "EntityRecognizerMetadataEntityTypesList":{ "type":"list", @@ -3166,7 +3196,7 @@ "members":{ "Message":{"shape":"String"} }, - "documentation":"

The specified name is already in use. Use a different name and try your request again.

", + "documentation":"

The specified resource name is already in use. Use a different name and try your request again.

", "exception":true }, "ResourceLimitExceededException":{ @@ -3174,7 +3204,7 @@ "members":{ "Message":{"shape":"String"} }, - "documentation":"

The maximum number of recognizers per account has been exceeded. Review the recognizers, perform cleanup, and then try your request again.

", + "documentation":"

The maximum number of resources per account has been exceeded. Review the resources, and then try your request again.

", "exception":true }, "ResourceNotFoundException":{ @@ -3190,7 +3220,7 @@ "members":{ "Message":{"shape":"String"} }, - "documentation":"

The specified resource is not available. Check to see if the resource is in the TRAINED state and try your request again.

", + "documentation":"

The specified resource is not available. Check the resource and try your request again.

", "exception":true }, "S3Uri":{ @@ -3787,10 +3817,6 @@ "type":"string", "min":1 }, - "StringList":{ - "type":"list", - "member":{"shape":"String"} - }, "SubnetId":{ "type":"string", "max":32, diff --git a/botocore/data/comprehendmedical/2018-10-30/service-2.json b/botocore/data/comprehendmedical/2018-10-30/service-2.json index 9b893949..d796a2ca 100644 --- a/botocore/data/comprehendmedical/2018-10-30/service-2.json +++ b/botocore/data/comprehendmedical/2018-10-30/service-2.json @@ -1259,7 +1259,8 @@ "ACUITY", "TEST_VALUE", "TEST_UNITS", - "DIRECTION" + "DIRECTION", + "SYSTEM_ORGAN_SITE" ] }, "ResourceNotFoundException":{ diff --git a/botocore/data/connect/2017-08-08/service-2.json b/botocore/data/connect/2017-08-08/service-2.json index d9526c5a..251f6d00 100644 --- a/botocore/data/connect/2017-08-08/service-2.json +++ b/botocore/data/connect/2017-08-08/service-2.json @@ -30,7 +30,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Creates a user account for the specified Amazon Connect instance.

" + "documentation":"

Creates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

" }, "DeleteUser":{ "name":"DeleteUser", @@ -46,7 +46,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Deletes a user account from the specified Amazon Connect instance.

" + "documentation":"

Deletes a user account from the specified Amazon Connect instance.

For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.

" }, "DescribeUser":{ "name":"DescribeUser", @@ -129,7 +129,7 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Gets the real-time metric data from the specified Amazon Connect instance.

For more information, see Real-time Metrics Reports in the Amazon Connect Administrator Guide.

" + "documentation":"

Gets the real-time metric data from the specified Amazon Connect instance.

For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

" }, "GetFederationToken":{ "name":"GetFederationToken", @@ -164,7 +164,7 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"} ], - "documentation":"

Gets historical metric data from the specified Amazon Connect instance.

For more information, see Historical Metrics Reports in the Amazon Connect Administrator Guide.

" + "documentation":"

Gets historical metric data from the specified Amazon Connect instance.

For a description of each historical metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

" }, "ListContactFlows":{ "name":"ListContactFlows", @@ -181,7 +181,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Provides information about the contact flows for the specified Amazon Connect instance.

" + "documentation":"

Provides information about the contact flows for the specified Amazon Connect instance.

For more information about contact flows, see Contact Flows in the Amazon Connect Administrator Guide.

" }, "ListHoursOfOperations":{ "name":"ListHoursOfOperations", @@ -198,7 +198,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Provides information about the hours of operation for the specified Amazon Connect instance.

" + "documentation":"

Provides information about the hours of operation for the specified Amazon Connect instance.

For more information about hours of operation, see Set the Hours of Operation for a Queue in the Amazon Connect Administrator Guide.

" }, "ListPhoneNumbers":{ "name":"ListPhoneNumbers", @@ -215,7 +215,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Provides information about the phone numbers for the specified Amazon Connect instance.

" + "documentation":"

Provides information about the phone numbers for the specified Amazon Connect instance.

For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.

" }, "ListQueues":{ "name":"ListQueues", @@ -232,7 +232,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Provides information about the queues for the specified Amazon Connect instance.

" + "documentation":"

Provides information about the queues for the specified Amazon Connect instance.

For more information about queues, see Queues: Standard and Agent in the Amazon Connect Administrator Guide.

" }, "ListRoutingProfiles":{ "name":"ListRoutingProfiles", @@ -249,7 +249,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Provides summary information about the routing profiles for the specified Amazon Connect instance.

" + "documentation":"

Provides summary information about the routing profiles for the specified Amazon Connect instance.

For more information about routing profiles, see Routing Profiles and Create a Routing Profile in the Amazon Connect Administrator Guide.

" }, "ListSecurityProfiles":{ "name":"ListSecurityProfiles", @@ -266,7 +266,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Provides summary information about the security profiles for the specified Amazon Connect instance.

" + "documentation":"

Provides summary information about the security profiles for the specified Amazon Connect instance.

For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.

" }, "ListTagsForResource":{ "name":"ListTagsForResource", @@ -283,7 +283,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], - "documentation":"

Lists the tags for the specified resource.

" + "documentation":"

Lists the tags for the specified resource.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

" }, "ListUserHierarchyGroups":{ "name":"ListUserHierarchyGroups", @@ -300,7 +300,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

" + "documentation":"

Provides summary information about the hierarchy groups for the specified Amazon Connect instance.

For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.

" }, "ListUsers":{ "name":"ListUsers", @@ -334,7 +334,7 @@ {"shape":"InternalServiceException"}, {"shape":"LimitExceededException"} ], - "documentation":"

Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

When a new chat contact is successfully created, clients need to subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

" + "documentation":"

Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

When a new chat contact is successfully created, clients need to subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

A 429 error occurs in two situations:

  • API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception from the API Gateway.

  • The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

For more information about how chat works, see Chat in the Amazon Connect Administrator Guide.

" }, "StartOutboundVoiceContact":{ "name":"StartOutboundVoiceContact", @@ -353,7 +353,7 @@ {"shape":"DestinationNotAllowedException"}, {"shape":"OutboundContactNotPermittedException"} ], - "documentation":"

Initiates a contact flow to place an outbound call to a customer.

There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

" + "documentation":"

This API places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in ContactFlowId).

Agents are not involved in initiating the outbound API (that is, dialing the contact). If the contact flow places an outbound call to a contact, and then puts the contact in queue, that's when the call is routed to the agent, like any other inbound case.

There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.

UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

" }, "StopContact":{ "name":"StopContact", @@ -386,7 +386,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ThrottlingException"} ], - "documentation":"

Adds the specified tags to the specified resource.

The supported resource type is users.

" + "documentation":"

Adds the specified tags to the specified resource.

The supported resource type is users.

For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.

" }, "UntagResource":{ "name":"UntagResource", @@ -450,7 +450,7 @@ {"shape":"ThrottlingException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Updates the identity information for the specified user.

" + "documentation":"

Updates the identity information for the specified user.

Someone with the ability to invoke UpdateUserIndentityInfo can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. We strongly recommend limiting who has the ability to invoke UpdateUserIndentityInfo. For more information, see Best Practices for Security Profiles in the Amazon Connect Administrator Guide.

" }, "UpdateUserPhoneConfig":{ "name":"UpdateUserPhoneConfig", @@ -754,7 +754,7 @@ "documentation":"

The unit for the metric.

" } }, - "documentation":"

Contains information about a real-time metric.

" + "documentation":"

Contains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

" }, "CurrentMetricData":{ "type":"structure", @@ -1028,7 +1028,7 @@ }, "CurrentMetrics":{ "shape":"CurrentMetrics", - "documentation":"

The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available:

AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

AGENTS_AVAILABLE

Unit: COUNT

AGENTS_ERROR

Unit: COUNT

AGENTS_NON_PRODUCTIVE

Unit: COUNT

AGENTS_ON_CALL

Unit: COUNT

AGENTS_ON_CONTACT

Unit: COUNT

AGENTS_ONLINE

Unit: COUNT

AGENTS_STAFFED

Unit: COUNT

CONTACTS_IN_QUEUE

Unit: COUNT

CONTACTS_SCHEDULED

Unit: COUNT

OLDEST_CONTACT_AGE

Unit: SECONDS

SLOTS_ACTIVE

Unit: COUNT

SLOTS_AVAILABLE

Unit: COUNT

" + "documentation":"

The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.

AGENTS_AFTER_CONTACT_WORK

Unit: COUNT

Name in real-time metrics report: ACW

AGENTS_AVAILABLE

Unit: COUNT

Name in real-time metrics report: Available

AGENTS_ERROR

Unit: COUNT

Name in real-time metrics report: Error

AGENTS_NON_PRODUCTIVE

Unit: COUNT

Name in real-time metrics report: NPT (Non-Productive Time)

AGENTS_ON_CALL

Unit: COUNT

Name in real-time metrics report: On contact

AGENTS_ON_CONTACT

Unit: COUNT

Name in real-time metrics report: On contact

AGENTS_ONLINE

Unit: COUNT

Name in real-time metrics report: Online

AGENTS_STAFFED

Unit: COUNT

Name in real-time metrics report: Staffed

CONTACTS_IN_QUEUE

Unit: COUNT

Name in real-time metrics report: In queue

CONTACTS_SCHEDULED

Unit: COUNT

Name in real-time metrics report: Scheduled

OLDEST_CONTACT_AGE

Unit: SECONDS

When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:

{ \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0 }

The actual OLDEST_CONTACT_AGE is 24 seconds.

Name in real-time metrics report: Oldest

SLOTS_ACTIVE

Unit: COUNT

Name in real-time metrics report: Active

SLOTS_AVAILABLE

Unit: COUNT

Name in real-time metrics report: Availability

" }, "NextToken":{ "shape":"NextToken", @@ -1113,7 +1113,7 @@ }, "HistoricalMetrics":{ "shape":"HistoricalMetrics", - "documentation":"

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available:

ABANDON_TIME

Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUM

CONTACTS_MISSED

Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM

HANDLE_TIME

Unit: SECONDS

Statistic: AVG

HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_TIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVG

QUEUED_TIME

Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL

Unit: PERCENT

Statistic: AVG

Threshold: Only \"Less than\" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600

" + "documentation":"

The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

ABANDON_TIME

Unit: SECONDS

Statistic: AVG

AFTER_CONTACT_WORK_TIME

Unit: SECONDS

Statistic: AVG

API_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CALLBACK_CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_ABANDONED

Unit: COUNT

Statistic: SUM

CONTACTS_AGENT_HUNG_UP_FIRST

Unit: COUNT

Statistic: SUM

CONTACTS_CONSULTED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_INCOMING

Unit: COUNT

Statistic: SUM

CONTACTS_HANDLED_OUTBOUND

Unit: COUNT

Statistic: SUM

CONTACTS_HOLD_ABANDONS

Unit: COUNT

Statistic: SUM

CONTACTS_MISSED

Unit: COUNT

Statistic: SUM

CONTACTS_QUEUED

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_IN_FROM_QUEUE

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT

Unit: COUNT

Statistic: SUM

CONTACTS_TRANSFERRED_OUT_FROM_QUEUE

Unit: COUNT

Statistic: SUM

HANDLE_TIME

Unit: SECONDS

Statistic: AVG

HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_AND_HOLD_TIME

Unit: SECONDS

Statistic: AVG

INTERACTION_TIME

Unit: SECONDS

Statistic: AVG

OCCUPANCY

Unit: PERCENT

Statistic: AVG

QUEUE_ANSWER_TIME

Unit: SECONDS

Statistic: AVG

QUEUED_TIME

Unit: SECONDS

Statistic: MAX

SERVICE_LEVEL

Unit: PERCENT

Statistic: AVG

Threshold: Only \"Less than\" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600

" }, "NextToken":{ "shape":"NextToken", @@ -1294,7 +1294,7 @@ "documentation":"

The unit for the metric.

" } }, - "documentation":"

Contains information about a historical metric.

" + "documentation":"

Contains information about a historical metric. For a description of each metric, see Historical Metrics Definitions in the Amazon Connect Administrator Guide.

" }, "HistoricalMetricData":{ "type":"structure", @@ -2289,7 +2289,7 @@ }, "ContactFlowId":{ "shape":"ContactFlowId", - "documentation":"

The identifier of the contact flow for the chat.

" + "documentation":"

The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

" }, "Attributes":{ "shape":"Attributes", @@ -2341,7 +2341,7 @@ }, "ContactFlowId":{ "shape":"ContactFlowId", - "documentation":"

The identifier of the contact flow for the outbound call.

" + "documentation":"

The identifier of the contact flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

" }, "InstanceId":{ "shape":"InstanceId", @@ -2779,5 +2779,5 @@ "Value":{"type":"double"}, "timestamp":{"type":"timestamp"} }, - "documentation":"

Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Amazon Connect provides rich metrics and real-time reporting that allow you to optimize contact routing. You can also resolve customer issues more efficiently by putting customers in touch with the right agents.

There are limits to the number of Amazon Connect resources that you can create and limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Limits in the Amazon Connect Administrator Guide.

" + "documentation":"

Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Amazon Connect provides rich metrics and real-time reporting that allow you to optimize contact routing. You can also resolve customer issues more efficiently by putting customers in touch with the right agents.

There are limits to the number of Amazon Connect resources that you can create and limits to the number of requests that you can make per second. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.

To connect programmatically to an AWS service, you use an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.

" } diff --git a/botocore/data/dms/2016-01-01/service-2.json b/botocore/data/dms/2016-01-01/service-2.json index bb491bce..96b25bdf 100644 --- a/botocore/data/dms/2016-01-01/service-2.json +++ b/botocore/data/dms/2016-01-01/service-2.json @@ -808,7 +808,7 @@ "documentation":"

The name of the Availability Zone.

" } }, - "documentation":"

The name of the Availability Zone for use during database migration.

" + "documentation":"

The name of an Availability Zone for use during database migration.

" }, "AvailabilityZonesList":{ "type":"list", @@ -887,7 +887,7 @@ }, "Status":{ "shape":"String", - "documentation":"

The connection status.

" + "documentation":"

The connection status. This parameter can return one of the following values:

  • \"successful\"

  • \"testing\"

  • \"failed\"

  • \"deleting\"

" }, "LastFailureMessage":{ "shape":"String", @@ -926,7 +926,7 @@ }, "EngineName":{ "shape":"String", - "documentation":"

The type of engine for the endpoint. Valid values, depending on the EndpointType value, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"redshift\", \"s3\", \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\", and \"sqlserver\".

" + "documentation":"

The type of engine for the endpoint. Valid values, depending on the EndpointType value, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"redshift\", \"s3\", \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\", \"sqlserver\", and \"neptune\".

" }, "Username":{ "shape":"String", @@ -994,19 +994,19 @@ }, "KinesisSettings":{ "shape":"KinesisSettings", - "documentation":"

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration User Guide.

" + "documentation":"

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

" }, "KafkaSettings":{ "shape":"KafkaSettings", - "documentation":"

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using Apache Kafka as a Target for AWS Database Migration Service in the AWS Database Migration User Guide.

" + "documentation":"

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using Apache Kafka as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

" }, "ElasticsearchSettings":{ "shape":"ElasticsearchSettings", - "documentation":"

Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide.

" + "documentation":"

Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration Service User Guide.

" }, "NeptuneSettings":{ "shape":"NeptuneSettings", - "documentation":"

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings in the AWS Database Migration Service User Guide.

" + "documentation":"

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target in the AWS Database Migration Service User Guide.

" }, "RedshiftSettings":{"shape":"RedshiftSettings"} }, @@ -1079,7 +1079,7 @@ "members":{ "ReplicationInstanceIdentifier":{ "shape":"String", - "documentation":"

The replication instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

" + "documentation":"

The replication instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain 1-63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Can't end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

" }, "AllocatedStorage":{ "shape":"IntegerOptional", @@ -1087,7 +1087,7 @@ }, "ReplicationInstanceClass":{ "shape":"String", - "documentation":"

The compute and memory capacity of the replication instance as specified by the replication instance class.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

" + "documentation":"

The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".

For more information on the settings and capacities for the available replication instance classes, see Selecting the right AWS DMS replication instance for your migration.

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", @@ -1131,7 +1131,7 @@ }, "DnsNameServers":{ "shape":"String", - "documentation":"

A list of DNS name servers supported for the replication instance.

" + "documentation":"

A list of custom DNS name servers supported for the replication instance to access your on-premise source or target database. This list overrides the default name servers supported by the replication instance. You can specify a comma-separated list of internet addresses for up to four on-premise DNS name servers. For example: \"1.1.1.1,2.2.2.2,3.3.3.3,4.4.4.4\"

" } }, "documentation":"

" @@ -1196,7 +1196,7 @@ "members":{ "ReplicationTaskIdentifier":{ "shape":"String", - "documentation":"

An identifier for the replication task.

Constraints:

  • Must contain from 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" + "documentation":"

An identifier for the replication task.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" }, "SourceEndpointArn":{ "shape":"String", @@ -1216,7 +1216,7 @@ }, "TableMappings":{ "shape":"String", - "documentation":"

The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the AWS Database Migration User Guide.

" + "documentation":"

The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the AWS Database Migration Service User Guide.

" }, "ReplicationTaskSettings":{ "shape":"String", @@ -1240,7 +1240,7 @@ }, "TaskData":{ "shape":"String", - "documentation":"

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration User Guide.

" + "documentation":"

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

" } }, "documentation":"

" @@ -2090,7 +2090,7 @@ }, "EngineName":{ "shape":"String", - "documentation":"

The database engine name. Valid values, depending on the EndpointType, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"redshift\", \"s3\", \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\", and \"sqlserver\".

" + "documentation":"

The database engine name. Valid values, depending on the EndpointType, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"redshift\", \"s3\", \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\", \"sqlserver\", and \"neptune\".

" }, "EngineDisplayName":{ "shape":"String", @@ -2178,7 +2178,7 @@ }, "NeptuneSettings":{ "shape":"NeptuneSettings", - "documentation":"

The settings for the MongoDB source endpoint. For more information, see the NeptuneSettings structure.

" + "documentation":"

The settings for the Amazon Neptune target endpoint. For more information, see the NeptuneSettings structure.

" }, "RedshiftSettings":{ "shape":"RedshiftSettings", @@ -2264,7 +2264,7 @@ }, "SubscriptionCreationTime":{ "shape":"String", - "documentation":"

The time the RDS event notification subscription was created.

" + "documentation":"

The time the AWS DMS event notification subscription was created.

" }, "SourceType":{ "shape":"String", @@ -2552,7 +2552,7 @@ }, "EngineName":{ "shape":"String", - "documentation":"

The type of engine for the endpoint. Valid values, depending on the EndpointType, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"redshift\", \"s3\", \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\", and \"sqlserver\".

" + "documentation":"

The type of engine for the endpoint. Valid values, depending on the EndpointType, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"redshift\", \"s3\", \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\", \"sqlserver\", and \"neptune\".

" }, "Username":{ "shape":"String", @@ -2612,19 +2612,19 @@ }, "KinesisSettings":{ "shape":"KinesisSettings", - "documentation":"

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration User Guide.

" + "documentation":"

Settings in JSON format for the target endpoint for Amazon Kinesis Data Streams. For more information about the available settings, see Using Amazon Kinesis Data Streams as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

" }, "KafkaSettings":{ "shape":"KafkaSettings", - "documentation":"

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using Apache Kafka as a Target for AWS Database Migration Service in the AWS Database Migration User Guide.

" + "documentation":"

Settings in JSON format for the target Apache Kafka endpoint. For more information about the available settings, see Using Apache Kafka as a Target for AWS Database Migration Service in the AWS Database Migration Service User Guide.

" }, "ElasticsearchSettings":{ "shape":"ElasticsearchSettings", - "documentation":"

Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration User Guide.

" + "documentation":"

Settings in JSON format for the target Elasticsearch endpoint. For more information about the available settings, see Extra Connection Attributes When Using Elasticsearch as a Target for AWS DMS in the AWS Database Migration Service User Guide.

" }, "NeptuneSettings":{ "shape":"NeptuneSettings", - "documentation":"

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.EndpointSettings in the AWS Database Migration Service User Guide.

" + "documentation":"

Settings in JSON format for the target Amazon Neptune endpoint. For more information about the available settings, see Specifying Endpoint Settings for Amazon Neptune as a Target in the AWS Database Migration Service User Guide.

" }, "RedshiftSettings":{"shape":"RedshiftSettings"} }, @@ -2695,7 +2695,7 @@ }, "ReplicationInstanceClass":{ "shape":"String", - "documentation":"

The compute and memory capacity of the replication instance.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

" + "documentation":"

The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".

For more information on the settings and capacities for the available replication instance classes, see Selecting the right AWS DMS replication instance for your migration.

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", @@ -2780,7 +2780,7 @@ }, "ReplicationTaskIdentifier":{ "shape":"String", - "documentation":"

The replication task identifier.

Constraints:

  • Must contain from 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" + "documentation":"

The replication task identifier.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" }, "MigrationType":{ "shape":"MigrationTypeValue", @@ -2808,7 +2808,7 @@ }, "TaskData":{ "shape":"String", - "documentation":"

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration User Guide.

" + "documentation":"

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

" } }, "documentation":"

" @@ -2848,27 +2848,27 @@ }, "AuthType":{ "shape":"AuthTypeValue", - "documentation":"

The authentication type you use to access the MongoDB source endpoint.

Valid values: NO, PASSWORD

When NO is selected, user name and password parameters are not used and can be empty.

" + "documentation":"

The authentication type you use to access the MongoDB source endpoint.

When when set to \"no\", user name and password parameters are not used and can be empty.

" }, "AuthMechanism":{ "shape":"AuthMechanismValue", - "documentation":"

The authentication mechanism you use to access the MongoDB source endpoint.

Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1

DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This setting isn't used when authType=No.

" + "documentation":"

The authentication mechanism you use to access the MongoDB source endpoint.

For the default value, in MongoDB version 2.x, \"default\" is \"mongodb_cr\". For MongoDB version 3.x or later, \"default\" is \"scram_sha_1\". This setting isn't used when AuthType is set to \"no\".

" }, "NestingLevel":{ "shape":"NestingLevelValue", - "documentation":"

Specifies either document or table mode.

Valid values: NONE, ONE

Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.

" + "documentation":"

Specifies either document or table mode.

Default value is \"none\". Specify \"none\" to use document mode. Specify \"one\" to use table mode.

" }, "ExtractDocId":{ "shape":"String", - "documentation":"

Specifies the document ID. Use this setting when NestingLevel is set to NONE.

Default value is false.

" + "documentation":"

Specifies the document ID. Use this setting when NestingLevel is set to \"none\".

Default value is \"false\".

" }, "DocsToInvestigate":{ "shape":"String", - "documentation":"

Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to ONE.

Must be a positive value greater than 0. Default value is 1000.

" + "documentation":"

Indicates the number of documents to preview to determine the document organization. Use this setting when NestingLevel is set to \"one\".

Must be a positive value greater than 0. Default value is 1000.

" }, "AuthSource":{ "shape":"String", - "documentation":"

The MongoDB database name. This setting isn't used when authType=NO.

The default is admin.

" + "documentation":"

The MongoDB database name. This setting isn't used when AuthType is set to \"no\".

The default is \"admin\".

" }, "KmsKeyId":{ "shape":"String", @@ -2886,15 +2886,15 @@ "members":{ "ServiceAccessRoleArn":{ "shape":"String", - "documentation":"

The ARN of the service role you have created for the Neptune target endpoint. For more information, see https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.Neptune.html#CHAP_Target.Neptune.ServiceRole in the AWS Database Migration Service User Guide.

" + "documentation":"

The Amazon Resource Name (ARN) of the service role that you created for the Neptune target endpoint. For more information, see Creating an IAM Service Role for Accessing Amazon Neptune as a Target in the AWS Database Migration Service User Guide.

" }, "S3BucketName":{ "shape":"String", - "documentation":"

The name of the S3 bucket for AWS DMS to temporarily store migrated graph data in CSV files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these CSV files.

" + "documentation":"

The name of the Amazon S3 bucket where AWS DMS can temporarily store migrated graph data in .csv files before bulk-loading it to the Neptune target database. AWS DMS maps the SQL source data to graph data before storing it in these .csv files.

" }, "S3BucketFolder":{ "shape":"String", - "documentation":"

A folder path where you where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName

" + "documentation":"

A folder path where you want AWS DMS to store migrated graph data in the S3 bucket specified by S3BucketName

" }, "ErrorRetryDuration":{ "shape":"IntegerOptional", @@ -2902,15 +2902,15 @@ }, "MaxFileSize":{ "shape":"IntegerOptional", - "documentation":"

The maximum size in KB of migrated graph data stored in a CSV file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1048576 KB. If successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.

" + "documentation":"

The maximum size in kilobytes of migrated graph data stored in a .csv file before AWS DMS bulk-loads the data to the Neptune target database. The default is 1,048,576 KB. If the bulk load is successful, AWS DMS clears the bucket, ready to store the next batch of migrated graph data.

" }, "MaxRetryCount":{ "shape":"IntegerOptional", - "documentation":"

The number of times for AWS DMS to retry a bulk-load of migrated graph data to the Neptune target database before raising an error. The default is 5.

" + "documentation":"

The number of times for AWS DMS to retry a bulk load of migrated graph data to the Neptune target database before raising an error. The default is 5.

" }, "IamAuthEnabled":{ "shape":"BooleanOptional", - "documentation":"

If you want IAM authorization enabled for this endpoint, set this parameter to true and attach the appropriate role policy document to your service role specified by ServiceAccessRoleArn. The default is false.

" + "documentation":"

If you want AWS Identity and Access Management (IAM) authorization enabled for this endpoint, set this parameter to true. Then attach the appropriate IAM policy document to your service role specified by ServiceAccessRoleArn. The default is false.

" } }, "documentation":"

Provides information that defines an Amazon Neptune endpoint.

" @@ -2931,7 +2931,7 @@ }, "ReplicationInstanceClass":{ "shape":"String", - "documentation":"

The compute and memory capacity of the replication instance.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

" + "documentation":"

The compute and memory capacity of the replication instance as defined for the specified replication instance class. For example to specify the instance class dms.c4.large, set this parameter to \"dms.c4.large\".

For more information on the settings and capacities for the available replication instance classes, see Selecting the right AWS DMS replication instance for your migration.

" }, "StorageType":{ "shape":"String", @@ -3281,15 +3281,15 @@ "members":{ "ReplicationInstanceIdentifier":{ "shape":"String", - "documentation":"

The replication instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

" + "documentation":"

The replication instance identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain 1-63 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: myrepinstance

" }, "ReplicationInstanceClass":{ "shape":"String", - "documentation":"

The compute and memory capacity of the replication instance.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

" + "documentation":"

The compute and memory capacity of the replication instance as defined for the specified replication instance class.

For more information on the settings and capacities for the available replication instance classes, see Selecting the right AWS DMS replication instance for your migration.

" }, "ReplicationInstanceStatus":{ "shape":"String", - "documentation":"

The status of the replication instance.

" + "documentation":"

The status of the replication instance. The possible return values include:

  • \"available\"

  • \"creating\"

  • \"deleted\"

  • \"deleting\"

  • \"failed\"

  • \"modifying\"

  • \"upgrading\"

  • \"rebooting\"

  • \"resetting-master-credentials\"

  • \"storage-full\"

  • \"incompatible-credentials\"

  • \"incompatible-network\"

  • \"maintenance\"

" }, "AllocatedStorage":{ "shape":"Integer", @@ -3371,7 +3371,7 @@ }, "DnsNameServers":{ "shape":"String", - "documentation":"

The DNS name servers for the replication instance.

" + "documentation":"

The DNS name servers supported for the replication instance to access your on-premise source or target database.

" } }, "documentation":"

Provides information that defines a replication instance.

" @@ -3415,7 +3415,7 @@ "members":{ "ReplicationInstanceClass":{ "shape":"String", - "documentation":"

The compute and memory capacity of the replication instance.

Valid Values: dms.t2.micro | dms.t2.small | dms.t2.medium | dms.t2.large | dms.c4.large | dms.c4.xlarge | dms.c4.2xlarge | dms.c4.4xlarge

" + "documentation":"

The compute and memory capacity of the replication instance as defined for the specified replication instance class.

For more information on the settings and capacities for the available replication instance classes, see Selecting the right AWS DMS replication instance for your migration.

" }, "AllocatedStorage":{ "shape":"IntegerOptional", @@ -3478,7 +3478,7 @@ "members":{ "ReplicationTaskIdentifier":{ "shape":"String", - "documentation":"

The user-assigned replication task identifier or name.

Constraints:

  • Must contain from 1 to 255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" + "documentation":"

The user-assigned replication task identifier or name.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

" }, "SourceEndpointArn":{ "shape":"String", @@ -3514,7 +3514,7 @@ }, "StopReason":{ "shape":"String", - "documentation":"

The reason the replication task was stopped.

" + "documentation":"

The reason the replication task was stopped. This response parameter can return one of the following values:

  • \"STOP_REASON_FULL_LOAD_COMPLETED\" – Full-load migration completed.

  • \"STOP_REASON_CACHED_CHANGES_APPLIED\" – Change data capture (CDC) load completed.

  • \"STOP_REASON_CACHED_CHANGES_NOT_APPLIED\" – In a full-load and CDC migration, the full-load stopped as specified before starting the CDC migration.

  • \"STOP_REASON_SERVER_TIME\" – The migration stopped at the specified server time.

" }, "ReplicationTaskCreationDate":{ "shape":"TStamp", @@ -3546,7 +3546,7 @@ }, "TaskData":{ "shape":"String", - "documentation":"

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration User Guide.

" + "documentation":"

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the AWS Database Migration Service User Guide.

" } }, "documentation":"

Provides information that describes a replication task created by the CreateReplicationTask operation.

" @@ -3964,7 +3964,7 @@ "members":{ "EngineName":{ "shape":"String", - "documentation":"

The database engine name. Valid values, depending on the EndpointType, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"redshift\", \"s3\", \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\", and \"sqlserver\".

" + "documentation":"

The database engine name. Valid values, depending on the EndpointType, include \"mysql\", \"oracle\", \"postgres\", \"mariadb\", \"aurora\", \"aurora-postgresql\", \"redshift\", \"s3\", \"db2\", \"azuredb\", \"sybase\", \"dynamodb\", \"mongodb\", \"kinesis\", \"kafka\", \"elasticsearch\", \"documentdb\", \"sqlserver\", and \"neptune\".

" }, "SupportsCDC":{ "shape":"Boolean", @@ -4099,11 +4099,11 @@ "members":{ "Key":{ "shape":"String", - "documentation":"

A key is the required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + "documentation":"

A key is the required name of the tag. The string value can be 1-128 Unicode characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" }, "Value":{ "shape":"String", - "documentation":"

A value is the optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regex: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" + "documentation":"

A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can't be prefixed with \"aws:\" or \"dms:\". The string can only contain only the set of Unicode letters, digits, white-space, '_', '.', '/', '=', '+', '-' (Java regular expressions: \"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=+\\\\-]*)$\").

" } }, "documentation":"

A user-defined key-value pair that describes metadata added to an AWS DMS resource and that is used by operations such as the following:

  • AddTagsToResource

  • ListTagsForResource

  • RemoveTagsFromResource

" @@ -4160,14 +4160,14 @@ "members":{ "VpcSecurityGroupId":{ "shape":"String", - "documentation":"

The VPC security group Id.

" + "documentation":"

The VPC security group ID.

" }, "Status":{ "shape":"String", "documentation":"

The status of the VPC security group.

" } }, - "documentation":"

Describes status of a security group associated with the virtual private cloud hosting your replication and DB instances.

" + "documentation":"

Describes the status of a security group associated with the virtual private cloud (VPC) hosting your replication and DB instances.

" }, "VpcSecurityGroupMembershipList":{ "type":"list", diff --git a/botocore/data/docdb/2014-10-31/paginators-1.json b/botocore/data/docdb/2014-10-31/paginators-1.json index f747ff67..a11f1999 100644 --- a/botocore/data/docdb/2014-10-31/paginators-1.json +++ b/botocore/data/docdb/2014-10-31/paginators-1.json @@ -1,5 +1,29 @@ { "pagination": { + "DescribeCertificates": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Certificates" + }, + "DescribeDBClusterParameterGroups": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBClusterParameterGroups" + }, + "DescribeDBClusterParameters": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "Parameters" + }, + "DescribeDBClusterSnapshots": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "DBClusterSnapshots" + }, "DescribeDBClusters": { "input_token": "Marker", "limit_key": "MaxRecords", @@ -35,6 +59,12 @@ "limit_key": "MaxRecords", "output_token": "Marker", "result_key": "OrderableDBInstanceOptions" + }, + "DescribePendingMaintenanceActions": { + "input_token": "Marker", + "limit_key": "MaxRecords", + "output_token": "Marker", + "result_key": "PendingMaintenanceActions" } } } diff --git a/botocore/data/docdb/2014-10-31/service-2.json b/botocore/data/docdb/2014-10-31/service-2.json index aa6e0d30..ee0cb74b 100644 --- a/botocore/data/docdb/2014-10-31/service-2.json +++ b/botocore/data/docdb/2014-10-31/service-2.json @@ -43,7 +43,7 @@ {"shape":"InvalidDBClusterStateFault"}, {"shape":"InvalidDBInstanceStateFault"} ], - "documentation":"

Applies a pending maintenance action to a resource (for example, to a DB instance).

" + "documentation":"

Applies a pending maintenance action to a resource (for example, to an Amazon DocumentDB instance).

" }, "CopyDBClusterParameterGroup":{ "name":"CopyDBClusterParameterGroup", @@ -82,7 +82,7 @@ {"shape":"SnapshotQuotaExceededFault"}, {"shape":"KMSKeyNotAccessibleFault"} ], - "documentation":"

Copies a snapshot of a cluster.

To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot.

To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that DB cluster snapshot is in the copying status.

" + "documentation":"

Copies a snapshot of a cluster.

To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same AWS Region.

To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.

" }, "CreateDBCluster":{ "name":"CreateDBCluster", @@ -129,7 +129,7 @@ {"shape":"DBParameterGroupQuotaExceededFault"}, {"shape":"DBParameterGroupAlreadyExistsFault"} ], - "documentation":"

Creates a new cluster parameter group.

Parameters in a cluster parameter group apply to all of the instances in a DB cluster.

A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. To provide custom values for any of the parameters, you must modify the group after you create it. After you create a DB cluster parameter group, you must associate it with your cluster. For the new DB cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover.

After you create a cluster parameter group, you should wait at least 5 minutes before creating your first cluster that uses that cluster parameter group as the default parameter group. This allows Amazon DocumentDB to fully complete the create action before the cluster parameter group is used as the default for a new cluster. This step is especially important for parameters that are critical when creating the default database for a cluster, such as the character set for the default database defined by the character_set_database parameter.

" + "documentation":"

Creates a new cluster parameter group.

Parameters in a cluster parameter group apply to all of the instances in a cluster.

A cluster parameter group is initially created with the default parameters for the database engine used by instances in the cluster. In Amazon DocumentDB, you cannot make modifications directly to the default.docdb3.6 cluster parameter group. If your Amazon DocumentDB cluster is using the default cluster parameter group and you want to modify a value in it, you must first create a new parameter group or copy an existing parameter group, modify it, and then apply the modified parameter group to your cluster. For the new cluster parameter group and associated settings to take effect, you must then reboot the instances in the cluster without failover. For more information, see Modifying Amazon DocumentDB Cluster Parameter Groups.

" }, "CreateDBClusterSnapshot":{ "name":"CreateDBClusterSnapshot", @@ -795,14 +795,14 @@ "members":{ "ResourceName":{ "shape":"String", - "documentation":"

The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name (ARN).

" + "documentation":"

The Amazon DocumentDB resource that the tags are added to. This value is an Amazon Resource Name .

" }, "Tags":{ "shape":"TagList", - "documentation":"

The tags to be assigned to the Amazon DocumentDB resource.

" + "documentation":"

The tags to be assigned to the Amazon DocumentDB resource.

" } }, - "documentation":"

Represents the input to AddTagsToResource.

" + "documentation":"

Represents the input to AddTagsToResource.

" }, "ApplyMethod":{ "type":"string", @@ -829,10 +829,10 @@ }, "OptInType":{ "shape":"String", - "documentation":"

A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can't be undone.

Valid values:

  • immediate - Apply the maintenance action immediately.

  • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

  • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

" + "documentation":"

A value that specifies the type of opt-in request or undoes an opt-in request. An opt-in request of type immediate can't be undone.

Valid values:

  • immediate - Apply the maintenance action immediately.

  • next-maintenance - Apply the maintenance action during the next maintenance window for the resource.

  • undo-opt-in - Cancel any existing next-maintenance opt-in requests.

" } }, - "documentation":"

Represents the input to ApplyPendingMaintenanceAction.

" + "documentation":"

Represents the input to ApplyPendingMaintenanceAction.

" }, "ApplyPendingMaintenanceActionResult":{ "type":"structure", @@ -973,11 +973,11 @@ "members":{ "SourceDBClusterParameterGroupIdentifier":{ "shape":"String", - "documentation":"

The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.

Constraints:

  • Must specify a valid cluster parameter group.

  • If the source cluster parameter group is in the same AWS Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.

  • If the source parameter group is in a different AWS Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:cluster-pg:custom-cluster-group1.

" + "documentation":"

The identifier or Amazon Resource Name (ARN) for the source cluster parameter group.

Constraints:

  • Must specify a valid cluster parameter group.

  • If the source cluster parameter group is in the same AWS Region as the copy, specify a valid parameter group identifier; for example, my-db-cluster-param-group, or a valid ARN.

  • If the source parameter group is in a different AWS Region than the copy, specify a valid cluster parameter group ARN; for example, arn:aws:rds:us-east-1:123456789012:sample-cluster:sample-parameter-group.

" }, "TargetDBClusterParameterGroupIdentifier":{ "shape":"String", - "documentation":"

The identifier for the copied cluster parameter group.

Constraints:

  • Cannot be null, empty, or blank.

  • Must contain from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-param-group1

" + "documentation":"

The identifier for the copied cluster parameter group.

Constraints:

  • Cannot be null, empty, or blank.

  • Must contain from 1 to 255 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-param-group1

" }, "TargetDBClusterParameterGroupDescription":{ "shape":"String", @@ -988,7 +988,7 @@ "documentation":"

The tags that are to be assigned to the parameter group.

" } }, - "documentation":"

Represents the input to CopyDBClusterParameterGroup.

" + "documentation":"

Represents the input to CopyDBClusterParameterGroup.

" }, "CopyDBClusterParameterGroupResult":{ "type":"structure", @@ -1005,19 +1005,19 @@ "members":{ "SourceDBClusterSnapshotIdentifier":{ "shape":"String", - "documentation":"

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

You can't copy an encrypted, shared cluster snapshot from one AWS Region to another.

Constraints:

  • Must specify a valid system snapshot in the \"available\" state.

  • If the source snapshot is in the same AWS Region as the copy, specify a valid snapshot identifier.

  • If the source snapshot is in a different AWS Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

" + "documentation":"

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

  • Must specify a valid system snapshot in the available state.

  • If the source snapshot is in the same AWS Region as the copy, specify a valid snapshot identifier.

  • If the source snapshot is in a different AWS Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

" }, "TargetDBClusterSnapshotIdentifier":{ "shape":"String", - "documentation":"

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

" + "documentation":"

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

" }, "KmsKeyId":{ "shape":"String", - "documentation":"

The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key.

If you copy an encrypted cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same AWS KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

To copy an encrypted cluster snapshot to another AWS Region, set KmsKeyId to the AWS KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. AWS KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one Region in another Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

" + "documentation":"

The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key.

If you copy an encrypted cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for KmsKeyId, then the copy of the cluster snapshot is encrypted with the same AWS KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId.

To copy an encrypted cluster snapshot to another AWS Region, set KmsKeyId to the AWS KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. AWS KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

" }, "PreSignedUrl":{ "shape":"String", - "documentation":"

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying an encrypted cluster snapshot from another AWS Region.

The presigned URL must be a valid request for the CopyDBSClusterSnapshot API action that can be executed in the source AWS Region that contains the encrypted DB cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • KmsKeyId - The AWS KMS key identifier for the key to use to encrypt the copy of the cluster snapshot in the destination AWS Region. This is the same identifier for both the CopyDBClusterSnapshot action that is called in the destination AWS Region, and the action contained in the presigned URL.

  • DestinationRegion - The name of the AWS Region that the DB cluster snapshot will be created in.

  • SourceDBClusterSnapshotIdentifier - The cluster snapshot identifier for the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted cluster snapshot from the us-west-2 AWS Region, then your SourceDBClusterSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:cluster-snapshot:my-cluster-snapshot-20161115.

" + "documentation":"

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another AWS Region.

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • SourceRegion - The ID of the region that contains the snapshot to be copied.

  • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 AWS Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot.

  • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

" }, "CopyTags":{ "shape":"BooleanOptional", @@ -1028,7 +1028,7 @@ "documentation":"

The tags to be assigned to the cluster snapshot.

" } }, - "documentation":"

Represents the input to CopyDBClusterSnapshot.

" + "documentation":"

Represents the input to CopyDBClusterSnapshot.

" }, "CopyDBClusterSnapshotResult":{ "type":"structure", @@ -1055,15 +1055,15 @@ }, "DBClusterIdentifier":{ "shape":"String", - "documentation":"

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

" + "documentation":"

The cluster identifier. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

" }, "DBClusterParameterGroupName":{ "shape":"String", - "documentation":"

The name of the cluster parameter group to associate with this cluster.

" + "documentation":"

The name of the cluster parameter group to associate with this cluster.

" }, "VpcSecurityGroupIds":{ "shape":"VpcSecurityGroupIdList", - "documentation":"

A list of EC2 VPC security groups to associate with this cluster.

" + "documentation":"

A list of EC2 VPC security groups to associate with this cluster.

" }, "DBSubnetGroupName":{ "shape":"String", @@ -1083,7 +1083,7 @@ }, "MasterUsername":{ "shape":"String", - "documentation":"

The name of the master user for the cluster.

Constraints:

  • Must be from 1 to 63 letters or numbers.

  • The first character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

" + "documentation":"

The name of the master user for the cluster.

Constraints:

  • Must be from 1 to 63 letters or numbers.

  • The first character must be a letter.

  • Cannot be a reserved word for the chosen database engine.

" }, "MasterUserPassword":{ "shape":"String", @@ -1091,7 +1091,7 @@ }, "PreferredBackupWindow":{ "shape":"String", - "documentation":"

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

" + "documentation":"

The daily time range during which automated backups are created if automated backups are enabled using the BackupRetentionPeriod parameter.

The default is a 30-minute window selected at random from an 8-hour block of time for each AWS Region.

Constraints:

  • Must be in the format hh24:mi-hh24:mi.

  • Must be in Universal Coordinated Time (UTC).

  • Must not conflict with the preferred maintenance window.

  • Must be at least 30 minutes.

" }, "PreferredMaintenanceWindow":{ "shape":"String", @@ -1107,18 +1107,18 @@ }, "KmsKeyId":{ "shape":"String", - "documentation":"

The AWS KMS key identifier for an encrypted cluster.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If an encryption key is not specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key.

  • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, Amazon DocumentDB uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a replica of an encrypted cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region.

" + "documentation":"

The AWS KMS key identifier for an encrypted cluster.

The AWS KMS key identifier is the Amazon Resource Name (ARN) for the AWS KMS encryption key. If you are creating a cluster using the same AWS account that owns the AWS KMS encryption key that is used to encrypt the new cluster, you can use the AWS KMS key alias instead of the ARN for the AWS KMS encryption key.

If an encryption key is not specified in KmsKeyId:

  • If ReplicationSourceIdentifier identifies an encrypted source, then Amazon DocumentDB uses the encryption key that is used to encrypt the source. Otherwise, Amazon DocumentDB uses your default encryption key.

  • If the StorageEncrypted parameter is true and ReplicationSourceIdentifier is not specified, Amazon DocumentDB uses your default encryption key.

AWS KMS creates the default encryption key for your AWS account. Your AWS account has a different default encryption key for each AWS Region.

If you create a replica of an encrypted cluster in another AWS Region, you must set KmsKeyId to a KMS key ID that is valid in the destination AWS Region. This key is used to encrypt the replica in that AWS Region.

" }, "EnableCloudwatchLogsExports":{ "shape":"LogTypeList", - "documentation":"

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs.

" + "documentation":"

A list of log types that need to be enabled for exporting to Amazon CloudWatch Logs. You can enable audit logs or profiler logs. For more information, see Auditing Amazon DocumentDB Events and Profiling Amazon DocumentDB Operations.

" }, "DeletionProtection":{ "shape":"BooleanOptional", "documentation":"

Specifies whether this cluster can be deleted. If DeletionProtection is enabled, the cluster cannot be deleted unless it is modified and DeletionProtection is disabled. DeletionProtection protects clusters from being accidentally deleted.

" } }, - "documentation":"

Represents the input to CreateDBCluster.

" + "documentation":"

Represents the input to CreateDBCluster.

" }, "CreateDBClusterParameterGroupMessage":{ "type":"structure", @@ -1168,7 +1168,7 @@ "members":{ "DBClusterSnapshotIdentifier":{ "shape":"String", - "documentation":"

The identifier of the cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot1

" + "documentation":"

The identifier of the cluster snapshot. This parameter is stored as a lowercase string.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • The first character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot1

" }, "DBClusterIdentifier":{ "shape":"String", @@ -1210,7 +1210,7 @@ }, "AvailabilityZone":{ "shape":"String", - "documentation":"

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

Constraint: The AvailabilityZone parameter can't be specified if the MultiAZ parameter is set to true. The specified Availability Zone must be in the same AWS Region as the current endpoint.

" + "documentation":"

The Amazon EC2 Availability Zone that the instance is created in.

Default: A random, system-chosen Availability Zone in the endpoint's AWS Region.

Example: us-east-1d

" }, "PreferredMaintenanceWindow":{ "shape":"String", @@ -3546,7 +3546,7 @@ "documentation":"

A list that provides details about the pending maintenance actions for the resource.

" } }, - "documentation":"

Represents the output of ApplyPendingMaintenanceAction.

", + "documentation":"

Represents the output of ApplyPendingMaintenanceAction.

", "wrapper":true }, "RestoreDBClusterFromSnapshotMessage":{ diff --git a/botocore/data/docdb/2014-10-31/service-2.sdk-extras.json b/botocore/data/docdb/2014-10-31/service-2.sdk-extras.json new file mode 100644 index 00000000..244190e0 --- /dev/null +++ b/botocore/data/docdb/2014-10-31/service-2.sdk-extras.json @@ -0,0 +1,15 @@ + { + "version": 1.0, + "merge": { + "shapes": { + "CopyDBClusterSnapshotMessage": { + "members": { + "SourceRegion": { + "shape": "String", + "documentation": "

The ID of the region that contains the snapshot to be copied.

" + } + } + } + } + } +} diff --git a/botocore/data/ebs/2019-11-02/service-2.json b/botocore/data/ebs/2019-11-02/service-2.json index c562c9fb..5816fa30 100644 --- a/botocore/data/ebs/2019-11-02/service-2.json +++ b/botocore/data/ebs/2019-11-02/service-2.json @@ -12,6 +12,25 @@ "uid":"ebs-2019-11-02" }, "operations":{ + "CompleteSnapshot":{ + "name":"CompleteSnapshot", + "http":{ + "method":"POST", + "requestUri":"/snapshots/completion/{snapshotId}", + "responseCode":202 + }, + "input":{"shape":"CompleteSnapshotRequest"}, + "output":{"shape":"CompleteSnapshotResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"RequestThrottledException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

" + }, "GetSnapshotBlock":{ "name":"GetSnapshotBlock", "http":{ @@ -21,8 +40,12 @@ "input":{"shape":"GetSnapshotBlockRequest"}, "output":{"shape":"GetSnapshotBlockResponse"}, "errors":[ + {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"RequestThrottledException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"} ], "documentation":"

Returns the data in a block in an Amazon Elastic Block Store snapshot.

" }, @@ -35,8 +58,12 @@ "input":{"shape":"ListChangedBlocksRequest"}, "output":{"shape":"ListChangedBlocksResponse"}, "errors":[ + {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"RequestThrottledException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"} ], "documentation":"

Returns the block indexes and block tokens for blocks that are different between two Amazon Elastic Block Store snapshots of the same volume/snapshot lineage.

" }, @@ -49,13 +76,79 @@ "input":{"shape":"ListSnapshotBlocksRequest"}, "output":{"shape":"ListSnapshotBlocksResponse"}, "errors":[ + {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"RequestThrottledException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"} ], "documentation":"

Returns the block indexes and block tokens for blocks in an Amazon Elastic Block Store snapshot.

" + }, + "PutSnapshotBlock":{ + "name":"PutSnapshotBlock", + "http":{ + "method":"PUT", + "requestUri":"/snapshots/{snapshotId}/blocks/{blockIndex}", + "responseCode":201 + }, + "input":{"shape":"PutSnapshotBlockRequest"}, + "output":{"shape":"PutSnapshotBlockResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"RequestThrottledException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Writes a block of data to a block in the snapshot. If the specified block contains data, the existing data is overwritten. The target snapshot must be in the pending state.

Data written to a snapshot must be aligned with 512-byte sectors.

", + "authtype":"v4-unsigned-body" + }, + "StartSnapshot":{ + "name":"StartSnapshot", + "http":{ + "method":"POST", + "requestUri":"/snapshots", + "responseCode":201 + }, + "input":{"shape":"StartSnapshotRequest"}, + "output":{"shape":"StartSnapshotResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ValidationException"}, + {"shape":"RequestThrottledException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"InternalServerException"}, + {"shape":"ConcurrentLimitExceededException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Creates a new Amazon EBS snapshot. The new snapshot enters the pending state after the request completes.

After creating the snapshot, use PutSnapshotBlock to write blocks of data to the snapshot.

" } }, "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "required":["Reason"], + "members":{ + "Message":{"shape":"ErrorMessage"}, + "Reason":{ + "shape":"AccessDeniedExceptionReason", + "documentation":"

The reason for the exception.

" + } + }, + "documentation":"

You do not have sufficient access to perform this action.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "AccessDeniedExceptionReason":{ + "type":"string", + "enum":[ + "UNAUTHORIZED_ACCOUNT", + "DEPENDENCY_ACCESS_DENIED" + ] + }, "Block":{ "type":"structure", "members":{ @@ -75,7 +168,10 @@ "sensitive":true, "streaming":true }, - "BlockIndex":{"type":"integer"}, + "BlockIndex":{ + "type":"integer", + "min":0 + }, "BlockSize":{"type":"integer"}, "BlockToken":{ "type":"string", @@ -87,6 +183,7 @@ "member":{"shape":"Block"}, "sensitive":true }, + "Boolean":{"type":"boolean"}, "ChangedBlock":{ "type":"structure", "members":{ @@ -110,16 +207,99 @@ "type":"list", "member":{"shape":"ChangedBlock"} }, + "ChangedBlocksCount":{ + "type":"integer", + "min":0 + }, "Checksum":{ "type":"string", - "max":64 + "max":64, + "pattern":"^[A-Za-z0-9+/=]+$" + }, + "ChecksumAggregationMethod":{ + "type":"string", + "enum":["LINEAR"], + "max":32, + "pattern":"^[A-Za-z0-9]+$" }, "ChecksumAlgorithm":{ "type":"string", "enum":["SHA256"], - "max":32 + "max":32, + "pattern":"^[A-Za-z0-9]+$" + }, + "CompleteSnapshotRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "ChangedBlocksCount" + ], + "members":{ + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The ID of the snapshot.

", + "location":"uri", + "locationName":"snapshotId" + }, + "ChangedBlocksCount":{ + "shape":"ChangedBlocksCount", + "documentation":"

The number of blocks that were written to the snapshot.

", + "location":"header", + "locationName":"x-amz-ChangedBlocksCount" + }, + "Checksum":{ + "shape":"Checksum", + "documentation":"

An aggregated Base-64 SHA256 checksum based on the checksums of each written block.

To generate the aggregated checksum using the linear aggregation method, arrange the checksums for each written block in ascending order of their block index, concatenate them to form a single string, and then generate the checksum on the entire string using the SHA256 algorithm.

", + "location":"header", + "locationName":"x-amz-Checksum" + }, + "ChecksumAlgorithm":{ + "shape":"ChecksumAlgorithm", + "documentation":"

The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.

", + "location":"header", + "locationName":"x-amz-Checksum-Algorithm" + }, + "ChecksumAggregationMethod":{ + "shape":"ChecksumAggregationMethod", + "documentation":"

The aggregation method used to generate the checksum. Currently, the only supported aggregation method is LINEAR.

", + "location":"header", + "locationName":"x-amz-Checksum-Aggregation-Method" + } + } + }, + "CompleteSnapshotResponse":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"Status", + "documentation":"

The status of the snapshot.

" + } + } + }, + "ConcurrentLimitExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

You have reached the limit for concurrent API requests. For more information, see Optimizing performance of the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "ConflictException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The request uses the same client token as a previous, but non-identical request.

", + "error":{"httpStatusCode":503}, + "exception":true }, "DataLength":{"type":"integer"}, + "Description":{ + "type":"string", + "max":255, + "pattern":"^[\\S\\s]+$" + }, "ErrorMessage":{ "type":"string", "max":256 @@ -180,6 +360,28 @@ }, "payload":"BlockData" }, + "IdempotencyToken":{ + "type":"string", + "max":255, + "pattern":"^[\\S]+$" + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

An internal error has occurred.

", + "error":{"httpStatusCode":500}, + "exception":true, + "fault":true + }, + "KmsKeyArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"arn:aws[a-z\\-]*:kms:.*:[0-9]{12}:key/.*", + "sensitive":true + }, "ListChangedBlocksRequest":{ "type":"structure", "required":["SecondSnapshotId"], @@ -301,27 +503,283 @@ "max":10000, "min":100 }, + "OwnerId":{ + "type":"string", + "max":24, + "min":1, + "pattern":"\\S+" + }, "PageToken":{ "type":"string", "max":256, "pattern":"^[A-Za-z0-9+/=]+$" }, + "Progress":{ + "type":"integer", + "max":100, + "min":0 + }, + "PutSnapshotBlockRequest":{ + "type":"structure", + "required":[ + "SnapshotId", + "BlockIndex", + "BlockData", + "DataLength", + "Checksum", + "ChecksumAlgorithm" + ], + "members":{ + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The ID of the snapshot.

", + "location":"uri", + "locationName":"snapshotId" + }, + "BlockIndex":{ + "shape":"BlockIndex", + "documentation":"

The block index of the block in which to write the data. A block index is the offset position of a block within a snapshot, and it is used to identify the block. To identify the logical offset of the data in the logical volume, multiply the block index with the block size (Block index * 512 bytes).

", + "location":"uri", + "locationName":"blockIndex" + }, + "BlockData":{ + "shape":"BlockData", + "documentation":"

The data to write to the block.

The block data is not signed as part of the Signature Version 4 signing process. As a result, you must generate and provide a Base64-encoded SHA256 checksum for the block data using the x-amz-Checksum header. Also, you must specify the checksum algorithm using the x-amz-Checksum-Algorithm header. The checksum that you provide is part of the Signature Version 4 signing process. It is validated against a checksum generated by Amazon EBS to ensure the validity and authenticity of the data. If the checksums do not correspond, the request fails. For more information, see Using checksums with the EBS direct APIs in the Amazon Elastic Compute Cloud User Guide.

" + }, + "DataLength":{ + "shape":"DataLength", + "documentation":"

The size of the data to write to the block, in bytes. Currently, the only supported size is 524288.

Valid values: 524288

", + "location":"header", + "locationName":"x-amz-Data-Length" + }, + "Progress":{ + "shape":"Progress", + "documentation":"

The progress of the write process, as a percentage.

", + "location":"header", + "locationName":"x-amz-Progress" + }, + "Checksum":{ + "shape":"Checksum", + "documentation":"

A Base64-encoded SHA256 checksum of the data. Only SHA256 checksums are supported.

", + "location":"header", + "locationName":"x-amz-Checksum" + }, + "ChecksumAlgorithm":{ + "shape":"ChecksumAlgorithm", + "documentation":"

The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.

", + "location":"header", + "locationName":"x-amz-Checksum-Algorithm" + } + }, + "payload":"BlockData" + }, + "PutSnapshotBlockResponse":{ + "type":"structure", + "members":{ + "Checksum":{ + "shape":"Checksum", + "documentation":"

The SHA256 checksum generated for the block data by Amazon EBS.

", + "location":"header", + "locationName":"x-amz-Checksum" + }, + "ChecksumAlgorithm":{ + "shape":"ChecksumAlgorithm", + "documentation":"

The algorithm used by Amazon EBS to generate the checksum.

", + "location":"header", + "locationName":"x-amz-Checksum-Algorithm" + } + } + }, + "RequestThrottledException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "Reason":{ + "shape":"RequestThrottledExceptionReason", + "documentation":"

The reason for the exception.

" + } + }, + "documentation":"

The number of API requests has exceed the maximum allowed API request throttling limit.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "RequestThrottledExceptionReason":{ + "type":"string", + "enum":[ + "ACCOUNT_THROTTLED", + "DEPENDENCY_REQUEST_THROTTLED" + ] + }, "ResourceNotFoundException":{ "type":"structure", "members":{ - "Message":{"shape":"ErrorMessage"} + "Message":{"shape":"ErrorMessage"}, + "Reason":{ + "shape":"ResourceNotFoundExceptionReason", + "documentation":"

The reason for the exception.

" + } }, "documentation":"

The specified resource does not exist.

", "error":{"httpStatusCode":404}, "exception":true }, + "ResourceNotFoundExceptionReason":{ + "type":"string", + "enum":[ + "SNAPSHOT_NOT_FOUND", + "DEPENDENCY_RESOURCE_NOT_FOUND" + ] + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"}, + "Reason":{ + "shape":"ServiceQuotaExceededExceptionReason", + "documentation":"

The reason for the exception.

" + } + }, + "documentation":"

Your current service quotas do not allow you to perform this action.

", + "error":{"httpStatusCode":402}, + "exception":true + }, + "ServiceQuotaExceededExceptionReason":{ + "type":"string", + "enum":["DEPENDENCY_SERVICE_QUOTA_EXCEEDED"] + }, "SnapshotId":{ "type":"string", "max":64, "min":1, "pattern":"^snap-[0-9a-f]+$" }, + "StartSnapshotRequest":{ + "type":"structure", + "required":["VolumeSize"], + "members":{ + "VolumeSize":{ + "shape":"VolumeSize", + "documentation":"

The size of the volume, in GiB. The maximum size is 16384 GiB (16 TiB).

" + }, + "ParentSnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.

If your account is enabled for encryption by default, you cannot use an unencrypted snapshot as a parent snapshot. You must first create an encrypted copy of the parent snapshot using CopySnapshot.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags to apply to the snapshot.

" + }, + "Description":{ + "shape":"Description", + "documentation":"

A description for the snapshot.

" + }, + "ClientToken":{ + "shape":"IdempotencyToken", + "documentation":"

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.

If you do not specify a client token, one is automatically generated by the AWS SDK.

For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

", + "idempotencyToken":true + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Indicates whether to encrypt the snapshot. To create an encrypted snapshot, specify true. To create an unencrypted snapshot, omit this parameter.

If you specify a value for ParentSnapshotId, omit this parameter.

If you specify true, the snapshot is encrypted using the CMK specified using the KmsKeyArn parameter. If no value is specified for KmsKeyArn, the default CMK for your account is used. If no default CMK has been specified for your account, the AWS managed CMK is used. To set a default CMK for your account, use ModifyEbsDefaultKmsKeyId.

If your account is enabled for encryption by default, you cannot set this parameter to false. In this case, you can omit this parameter.

For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

" + }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) to be used to encrypt the snapshot. If you do not specify a CMK, the default AWS managed CMK is used.

If you specify a ParentSnapshotId, omit this parameter; the snapshot will be encrypted using the same CMK that was used to encrypt the parent snapshot.

If Encrypted is set to true, you must specify a CMK ARN.

" + }, + "Timeout":{ + "shape":"Timeout", + "documentation":"

The amount of time (in minutes) after which the snapshot is automatically cancelled if:

  • No blocks are written to the snapshot.

  • The snapshot is not completed after writing the last block of data.

If no value is specified, the timeout defaults to 60 minutes.

" + } + } + }, + "StartSnapshotResponse":{ + "type":"structure", + "members":{ + "Description":{ + "shape":"Description", + "documentation":"

The description of the snapshot.

" + }, + "SnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The ID of the snapshot.

" + }, + "OwnerId":{ + "shape":"OwnerId", + "documentation":"

The AWS account ID of the snapshot owner.

" + }, + "Status":{ + "shape":"Status", + "documentation":"

The status of the snapshot.

" + }, + "StartTime":{ + "shape":"TimeStamp", + "documentation":"

The timestamp when the snapshot was created.

" + }, + "VolumeSize":{ + "shape":"VolumeSize", + "documentation":"

The size of the volume, in GiB.

" + }, + "BlockSize":{ + "shape":"BlockSize", + "documentation":"

The size of the blocks in the snapshot, in bytes.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags applied to the snapshot. You can specify up to 50 tags per snapshot. For more information, see Tagging your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.

" + }, + "ParentSnapshotId":{ + "shape":"SnapshotId", + "documentation":"

The ID of the parent snapshot.

" + }, + "KmsKeyArn":{ + "shape":"KmsKeyArn", + "documentation":"

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) used to encrypt the snapshot.

" + } + } + }, + "Status":{ + "type":"string", + "enum":[ + "completed", + "pending", + "error" + ], + "max":32 + }, + "Tag":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

The key of the tag.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The value of the tag.

" + } + }, + "documentation":"

Describes a tag.

" + }, + "TagKey":{ + "type":"string", + "max":127, + "pattern":"^[\\S\\s]+$" + }, + "TagValue":{ + "type":"string", + "max":255, + "pattern":"^[\\S\\s]+$" + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"} + }, "TimeStamp":{"type":"timestamp"}, + "Timeout":{ + "type":"integer", + "max":60, + "min":10 + }, "ValidationException":{ "type":"structure", "members":{ @@ -342,10 +800,19 @@ "INVALID_PAGE_TOKEN", "INVALID_BLOCK_TOKEN", "INVALID_SNAPSHOT_ID", - "UNRELATED_SNAPSHOTS" + "UNRELATED_SNAPSHOTS", + "INVALID_BLOCK", + "INVALID_CONTENT_ENCODING", + "INVALID_TAG", + "INVALID_DEPENDENCY_REQUEST", + "INVALID_PARAMETER_VALUE", + "INVALID_VOLUME_SIZE" ] }, - "VolumeSize":{"type":"long"} + "VolumeSize":{ + "type":"long", + "min":1 + } }, - "documentation":"

You can use the Amazon Elastic Block Store (EBS) direct APIs to directly read the data on your EBS snapshots, and identify the difference between two snapshots. You can view the details of blocks in an EBS snapshot, compare the block difference between two snapshots, and directly access the data in a snapshot. If you’re an independent software vendor (ISV) who offers backup services for EBS, the EBS direct APIs make it easier and more cost-effective to track incremental changes on your EBS volumes via EBS snapshots. This can be done without having to create new volumes from EBS snapshots.

This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an EBS Snapshot in the Amazon Elastic Compute Cloud User Guide. For more information about the supported AWS Regions, endpoints, and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in the AWS General Reference.

" + "documentation":"

You can use the Amazon Elastic Block Store (EBS) direct APIs to directly read the data on your EBS snapshots, and identify the difference between two snapshots. You can view the details of blocks in an EBS snapshot, compare the block difference between two snapshots, and directly access the data in a snapshot. If you're an independent software vendor (ISV) who offers backup services for EBS, the EBS direct APIs make it easier and more cost-effective to track incremental changes on your EBS volumes via EBS snapshots. This can be done without having to create new volumes from EBS snapshots.

This API reference provides detailed information about the actions, data types, parameters, and errors of the EBS direct APIs. For more information about the elements that make up the EBS direct APIs, and examples of how to use them effectively, see Accessing the Contents of an EBS Snapshot in the Amazon Elastic Compute Cloud User Guide. For more information about the supported AWS Regions, endpoints, and service quotas for the EBS direct APIs, see Amazon Elastic Block Store Endpoints and Quotas in the AWS General Reference.

" } diff --git a/botocore/data/ec2/2016-11-15/paginators-1.json b/botocore/data/ec2/2016-11-15/paginators-1.json index da37086b..8275797f 100644 --- a/botocore/data/ec2/2016-11-15/paginators-1.json +++ b/botocore/data/ec2/2016-11-15/paginators-1.json @@ -523,6 +523,24 @@ "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "MulticastGroups" + }, + "DescribeManagedPrefixLists": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "PrefixLists" + }, + "GetManagedPrefixListAssociations": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "PrefixListAssociations" + }, + "GetManagedPrefixListEntries": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Entries" } } } diff --git a/botocore/data/ec2/2016-11-15/service-2.json b/botocore/data/ec2/2016-11-15/service-2.json index 02b09610..61b43bc8 100644 --- a/botocore/data/ec2/2016-11-15/service-2.json +++ b/botocore/data/ec2/2016-11-15/service-2.json @@ -484,7 +484,7 @@ }, "input":{"shape":"CreateDhcpOptionsRequest"}, "output":{"shape":"CreateDhcpOptionsResult"}, - "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.

  • domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.

  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.

  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.

  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" + "documentation":"

Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.

  • domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.

  • domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, ExampleCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.

  • ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.

  • netbios-name-servers - The IP addresses of up to four NetBIOS name servers.

  • netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.

Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateEgressOnlyInternetGateway":{ "name":"CreateEgressOnlyInternetGateway", @@ -606,6 +606,16 @@ "output":{"shape":"CreateLocalGatewayRouteTableVpcAssociationResult"}, "documentation":"

Associates the specified VPC with the specified local gateway route table.

" }, + "CreateManagedPrefixList":{ + "name":"CreateManagedPrefixList", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateManagedPrefixListRequest"}, + "output":{"shape":"CreateManagedPrefixListResult"}, + "documentation":"

Creates a managed prefix list. You can specify one or more entries for the prefix list. Each entry consists of a CIDR block and an optional description.

You must specify the maximum number of entries for the prefix list. The maximum number of entries cannot be changed later.

" + }, "CreateNatGateway":{ "name":"CreateNatGateway", "http":{ @@ -663,7 +673,7 @@ }, "input":{"shape":"CreatePlacementGroupRequest"}, "output":{"shape":"CreatePlacementGroupResult"}, - "documentation":"

Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.

A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.

For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group.

A cluster placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A spread placement group places instances on distinct hardware. A partition placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition.

For more information, see Placement groups in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateReservedInstancesListing":{ "name":"CreateReservedInstancesListing", @@ -733,7 +743,7 @@ }, "input":{"shape":"CreateSpotDatafeedSubscriptionRequest"}, "output":{"shape":"CreateSpotDatafeedSubscriptionResult"}, - "documentation":"

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances.

" + "documentation":"

Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.

" }, "CreateSubnet":{ "name":"CreateSubnet", @@ -743,7 +753,7 @@ }, "input":{"shape":"CreateSubnetRequest"}, "output":{"shape":"CreateSubnetResult"}, - "documentation":"

Creates a subnet in an existing VPC.

When you create each subnet, you provide the VPC ID and IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The size of the subnet's IPv4 CIDR block can be the same as a VPC's IPv4 CIDR block, or a subset of a VPC's IPv4 CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest IPv4 subnet (and VPC) you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses).

If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.

AWS reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" + "documentation":"

Creates a subnet in a specified VPC.

You must specify an IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The allowed block size is between a /16 netmask (65,536 IP addresses) and /28 netmask (16 IP addresses). The CIDR block must not overlap with the CIDR block of an existing subnet in the VPC.

If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.

AWS reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use.

If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle.

When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available.

For more information about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.

" }, "CreateTags":{ "name":"CreateTags", @@ -1079,6 +1089,16 @@ "output":{"shape":"DeleteLocalGatewayRouteTableVpcAssociationResult"}, "documentation":"

Deletes the specified association between a VPC and local gateway route table.

" }, + "DeleteManagedPrefixList":{ + "name":"DeleteManagedPrefixList", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteManagedPrefixListRequest"}, + "output":{"shape":"DeleteManagedPrefixListResult"}, + "documentation":"

Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.

" + }, "DeleteNatGateway":{ "name":"DeleteNatGateway", "http":{ @@ -1133,7 +1153,7 @@ "requestUri":"/" }, "input":{"shape":"DeletePlacementGroupRequest"}, - "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see Placement groups in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteQueuedReservedInstances":{ "name":"DeleteQueuedReservedInstances", @@ -1840,7 +1860,7 @@ }, "input":{"shape":"DescribeInstanceCreditSpecificationsRequest"}, "output":{"shape":"DescribeInstanceCreditSpecificationsResult"}, - "documentation":"

Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited.

If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.

If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.

For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are standard and unlimited.

If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the unlimited credit option, as well as instances that were previously configured as T2, T3, and T3a with the unlimited credit option. For example, if you resize a T2 instance, while it is configured as unlimited, to an M4 instance, Amazon EC2 returns the M4 instance.

If you specify one or more instance IDs, Amazon EC2 returns the credit option (standard or unlimited) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned.

Recently terminated instances might appear in the returned results. This interval is usually less than one hour.

If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally.

For more information, see Burstable performance instances in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeInstanceEventNotificationAttributes":{ "name":"DescribeInstanceEventNotificationAttributes", @@ -1860,7 +1880,7 @@ }, "input":{"shape":"DescribeInstanceStatusRequest"}, "output":{"shape":"DescribeInstanceStatusResult"}, - "documentation":"

Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status Checks for Your Instances and Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled Events for Your Instances in the Amazon Elastic Compute Cloud User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances.

Instance status includes the following components:

  • Status checks - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see Status checks for your instances and Troubleshooting instances with failed status checks in the Amazon Elastic Compute Cloud User Guide.

  • Scheduled events - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see Scheduled events for your instances in the Amazon Elastic Compute Cloud User Guide.

  • Instance state - You can manage your instances from the moment you launch them through their termination. For more information, see Instance lifecycle in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeInstanceTypeOfferings":{ "name":"DescribeInstanceTypeOfferings", @@ -2002,6 +2022,16 @@ "output":{"shape":"DescribeLocalGatewaysResult"}, "documentation":"

Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.

" }, + "DescribeManagedPrefixLists":{ + "name":"DescribeManagedPrefixLists", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeManagedPrefixListsRequest"}, + "output":{"shape":"DescribeManagedPrefixListsResult"}, + "documentation":"

Describes your managed prefix lists and any AWS-managed prefix lists.

To view the entries for your prefix list, use GetManagedPrefixListEntries.

" + }, "DescribeMovingAddresses":{ "name":"DescribeMovingAddresses", "http":{ @@ -2070,7 +2100,7 @@ }, "input":{"shape":"DescribePlacementGroupsRequest"}, "output":{"shape":"DescribePlacementGroupsResult"}, - "documentation":"

Describes the specified placement groups or all of your placement groups. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribePrefixLists":{ "name":"DescribePrefixLists", @@ -2080,7 +2110,7 @@ }, "input":{"shape":"DescribePrefixListsRequest"}, "output":{"shape":"DescribePrefixListsResult"}, - "documentation":"

Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a gateway VPC endpoint. Currently, the services that support this action are Amazon S3 and Amazon DynamoDB.

" + "documentation":"

Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service.

We recommend that you use DescribeManagedPrefixLists instead.

" }, "DescribePrincipalIdFormat":{ "name":"DescribePrincipalIdFormat", @@ -2230,7 +2260,7 @@ }, "input":{"shape":"DescribeSpotDatafeedSubscriptionRequest"}, "output":{"shape":"DescribeSpotDatafeedSubscriptionResult"}, - "documentation":"

Describes the data feed for Spot Instances. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances.

" + "documentation":"

Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.

" }, "DescribeSpotFleetInstances":{ "name":"DescribeSpotFleetInstances", @@ -2280,7 +2310,7 @@ }, "input":{"shape":"DescribeSpotPriceHistoryRequest"}, "output":{"shape":"DescribeSpotPriceHistoryResult"}, - "documentation":"

Describes the Spot price history. For more information, see Spot Instance Pricing History in the Amazon EC2 User Guide for Linux Instances.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" + "documentation":"

Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances.

When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.

" }, "DescribeStaleSecurityGroups":{ "name":"DescribeStaleSecurityGroups", @@ -2922,7 +2952,7 @@ }, "input":{"shape":"GetDefaultCreditSpecificationRequest"}, "output":{"shape":"GetDefaultCreditSpecificationResult"}, - "documentation":"

Describes the default credit option for CPU usage of a burstable performance instance family.

For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Describes the default credit option for CPU usage of a burstable performance instance family.

For more information, see Burstable performance instances in the Amazon Elastic Compute Cloud User Guide.

" }, "GetEbsDefaultKmsKeyId":{ "name":"GetEbsDefaultKmsKeyId", @@ -2964,6 +2994,26 @@ "output":{"shape":"GetLaunchTemplateDataResult"}, "documentation":"

Retrieves the configuration data of the specified instance. You can use this data to create a launch template.

" }, + "GetManagedPrefixListAssociations":{ + "name":"GetManagedPrefixListAssociations", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetManagedPrefixListAssociationsRequest"}, + "output":{"shape":"GetManagedPrefixListAssociationsResult"}, + "documentation":"

Gets information about the resources that are associated with the specified managed prefix list.

" + }, + "GetManagedPrefixListEntries":{ + "name":"GetManagedPrefixListEntries", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetManagedPrefixListEntriesRequest"}, + "output":{"shape":"GetManagedPrefixListEntriesResult"}, + "documentation":"

Gets information about the entries for a specified managed prefix list.

" + }, "GetPasswordData":{ "name":"GetPasswordData", "http":{ @@ -3092,7 +3142,7 @@ }, "input":{"shape":"ModifyAvailabilityZoneGroupRequest"}, "output":{"shape":"ModifyAvailabilityZoneGroupResult"}, - "documentation":"

Enables or disables an Availability Zone group for your account.

Use describe-availability-zones to view the value for GroupName.

" + "documentation":"

Enables or disables an Availability Zone group for your account.

Use DescribeAvailabilityZones to view the value for GroupName.

" }, "ModifyCapacityReservation":{ "name":"ModifyCapacityReservation", @@ -3122,7 +3172,7 @@ }, "input":{"shape":"ModifyDefaultCreditSpecificationRequest"}, "output":{"shape":"ModifyDefaultCreditSpecificationResult"}, - "documentation":"

Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per AWS Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.

ModifyDefaultCreditSpecification is an asynchronous operation, which works at an AWS Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call GetDefaultCreditSpecification and check DefaultCreditSpecification for updates.

For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per AWS Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option.

ModifyDefaultCreditSpecification is an asynchronous operation, which works at an AWS Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call GetDefaultCreditSpecification and check DefaultCreditSpecification for updates.

For more information, see Burstable performance instances in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifyEbsDefaultKmsKeyId":{ "name":"ModifyEbsDefaultKmsKeyId", @@ -3198,7 +3248,7 @@ "requestUri":"/" }, "input":{"shape":"ModifyInstanceAttributeRequest"}, - "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.

To modify some attributes, the instance must be stopped. For more information, see Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Modifies the specified attribute of the specified instance. You can specify only one attribute at a time.

Note: Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance in a VPC can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the ModifyNetworkInterfaceAttribute action.

To modify some attributes, the instance must be stopped. For more information, see Modifying attributes of a stopped instance in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifyInstanceCapacityReservationAttributes":{ "name":"ModifyInstanceCapacityReservationAttributes", @@ -3218,7 +3268,7 @@ }, "input":{"shape":"ModifyInstanceCreditSpecificationRequest"}, "output":{"shape":"ModifyInstanceCreditSpecificationResult"}, - "documentation":"

Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited.

For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are standard and unlimited.

For more information, see Burstable performance instances in the Amazon Elastic Compute Cloud User Guide.

" }, "ModifyInstanceEventStartTime":{ "name":"ModifyInstanceEventStartTime", @@ -3238,7 +3288,7 @@ }, "input":{"shape":"ModifyInstanceMetadataOptionsRequest"}, "output":{"shape":"ModifyInstanceMetadataOptionsResult"}, - "documentation":"

Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance Metadata and User Data.

" + "documentation":"

Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see Instance metadata and user data.

" }, "ModifyInstancePlacement":{ "name":"ModifyInstancePlacement", @@ -3260,6 +3310,16 @@ "output":{"shape":"ModifyLaunchTemplateResult"}, "documentation":"

Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified.

" }, + "ModifyManagedPrefixList":{ + "name":"ModifyManagedPrefixList", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ModifyManagedPrefixListRequest"}, + "output":{"shape":"ModifyManagedPrefixListResult"}, + "documentation":"

Modifies the specified managed prefix list.

Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version.

If you specify a current version number that does not match the true current version number, the request fails.

" + }, "ModifyNetworkInterfaceAttribute":{ "name":"ModifyNetworkInterfaceAttribute", "http":{ @@ -3473,7 +3533,7 @@ }, "input":{"shape":"MonitorInstancesRequest"}, "output":{"shape":"MonitorInstancesResult"}, - "documentation":"

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

To disable detailed monitoring, see .

" + "documentation":"

Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring your instances and volumes in the Amazon Elastic Compute Cloud User Guide.

To disable detailed monitoring, see .

" }, "MoveAddressToVpc":{ "name":"MoveAddressToVpc", @@ -3532,7 +3592,7 @@ "requestUri":"/" }, "input":{"shape":"RebootInstancesRequest"}, - "documentation":"

Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored.

If an instance does not cleanly shut down within four minutes, Amazon EC2 performs a hard reboot.

For more information about troubleshooting, see Getting console output and rebooting instances in the Amazon Elastic Compute Cloud User Guide.

" }, "RegisterImage":{ "name":"RegisterImage", @@ -3708,7 +3768,7 @@ }, "input":{"shape":"RequestSpotFleetRequest"}, "output":{"shape":"RequestSpotFleetResponse"}, - "documentation":"

Creates a Spot Fleet request.

The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.

You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the spot-fleet-request and instance resource types are supported.

For more information, see Spot Fleet Requests in the Amazon EC2 User Guide for Linux Instances.

" + "documentation":"

Creates a Spot Fleet request.

The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.

You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the spot-fleet-request and instance resource types are supported.

For more information, see Spot Fleet requests in the Amazon EC2 User Guide for Linux Instances.

" }, "RequestSpotInstances":{ "name":"RequestSpotInstances", @@ -3718,7 +3778,7 @@ }, "input":{"shape":"RequestSpotInstancesRequest"}, "output":{"shape":"RequestSpotInstancesResult"}, - "documentation":"

Creates a Spot Instance request.

For more information, see Spot Instance Requests in the Amazon EC2 User Guide for Linux Instances.

" + "documentation":"

Creates a Spot Instance request.

For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.

" }, "ResetEbsDefaultKmsKeyId":{ "name":"ResetEbsDefaultKmsKeyId", @@ -3786,6 +3846,16 @@ "output":{"shape":"RestoreAddressToClassicResult"}, "documentation":"

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

" }, + "RestoreManagedPrefixListVersion":{ + "name":"RestoreManagedPrefixListVersion", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"RestoreManagedPrefixListVersionRequest"}, + "output":{"shape":"RestoreManagedPrefixListVersionResult"}, + "documentation":"

Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.

" + }, "RevokeClientVpnIngress":{ "name":"RevokeClientVpnIngress", "http":{ @@ -3822,7 +3892,7 @@ }, "input":{"shape":"RunInstancesRequest"}, "output":{"shape":"Reservation"}, - "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

You can specify a number of options, or leave the default options. The following rules apply:

  • [EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.

  • [EC2-Classic] If don't specify an Availability Zone, we choose one for you.

  • Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance Types Available Only in a VPC.

  • [EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.

  • Not all instance types support IPv6 addresses. For more information, see Instance Types.

  • If you don't specify a security group ID, we use the default security group. For more information, see Security Groups.

  • If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.

You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging Your Amazon EC2 Resources.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.

For troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Launches the specified number of instances using an AMI for which you have permissions.

You can specify a number of options, or leave the default options. The following rules apply:

  • [EC2-VPC] If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.

  • [EC2-Classic] If don't specify an Availability Zone, we choose one for you.

  • Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance types available only in a VPC.

  • [EC2-VPC] All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.

  • Not all instance types support IPv6 addresses. For more information, see Instance types.

  • If you don't specify a security group ID, we use the default security group. For more information, see Security groups.

  • If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.

You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

An instance is ready for you to use when it's in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources.

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs in the Amazon Elastic Compute Cloud User Guide.

For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance in the Amazon Elastic Compute Cloud User Guide.

" }, "RunScheduledInstances":{ "name":"RunScheduledInstances", @@ -3871,7 +3941,7 @@ "requestUri":"/" }, "input":{"shape":"SendDiagnosticInterruptRequest"}, - "documentation":"

Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).

In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.

Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.

For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a Diagnostic Interrupt (Linux instances) or Send a Diagnostic Interrupt (Windows instances).

" + "documentation":"

Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).

In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.

Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.

For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt (Linux instances) or Send a Diagnostic Interrupt (Windows instances).

" }, "StartInstances":{ "name":"StartInstances", @@ -3881,7 +3951,7 @@ }, "input":{"shape":"StartInstancesRequest"}, "output":{"shape":"StartInstancesResult"}, - "documentation":"

Starts an Amazon EBS-backed instance that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Starts an Amazon EBS-backed instance that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

For more information, see Stopping instances in the Amazon Elastic Compute Cloud User Guide.

" }, "StartVpcEndpointServicePrivateDnsVerification":{ "name":"StartVpcEndpointServicePrivateDnsVerification", @@ -3901,7 +3971,7 @@ }, "input":{"shape":"StopInstancesRequest"}, "output":{"shape":"StopInstancesResult"}, - "documentation":"

Stops an Amazon EBS-backed instance.

You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating Interrupted Spot Instances in the Amazon Elastic Compute Cloud User Guide.

When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.

Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Stops an Amazon EBS-backed instance.

You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.

We don't charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

You can't stop or hibernate instance store-backed instances. You can't use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon Elastic Compute Cloud User Guide.

When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.

Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon Elastic Compute Cloud User Guide.

When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshooting stopping your instance in the Amazon Elastic Compute Cloud User Guide.

" }, "TerminateClientVpnConnections":{ "name":"TerminateClientVpnConnections", @@ -3921,7 +3991,7 @@ }, "input":{"shape":"TerminateInstancesRequest"}, "output":{"shape":"TerminateInstancesResult"}, - "documentation":"

Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance Lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Shuts down the specified instances. This operation is idempotent; if you terminate an instance more than once, each call succeeds.

If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop it or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the DeleteOnTermination block device mapping parameter set to true are automatically deleted. For more information about the differences between stopping and terminating instances, see Instance lifecycle in the Amazon Elastic Compute Cloud User Guide.

For more information about troubleshooting, see Troubleshooting terminating your instance in the Amazon Elastic Compute Cloud User Guide.

" }, "UnassignIpv6Addresses":{ "name":"UnassignIpv6Addresses", @@ -3950,7 +4020,7 @@ }, "input":{"shape":"UnmonitorInstancesRequest"}, "output":{"shape":"UnmonitorInstancesResult"}, - "documentation":"

Disables detailed monitoring for a running instance. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon Elastic Compute Cloud User Guide.

" }, "UpdateSecurityGroupRuleDescriptionsEgress":{ "name":"UpdateSecurityGroupRuleDescriptionsEgress", @@ -4218,6 +4288,27 @@ "fulfilled" ] }, + "AddPrefixListEntries":{ + "type":"list", + "member":{"shape":"AddPrefixListEntry"}, + "max":1000, + "min":0 + }, + "AddPrefixListEntry":{ + "type":"structure", + "required":["Cidr"], + "members":{ + "Cidr":{ + "shape":"String", + "documentation":"

The CIDR block.

" + }, + "Description":{ + "shape":"String", + "documentation":"

A description for the entry.

Constraints: Up to 255 characters in length.

" + } + }, + "documentation":"

An entry for a prefix list.

" + }, "Address":{ "type":"structure", "members":{ @@ -5459,7 +5550,7 @@ "members":{ "State":{ "shape":"AvailabilityZoneState", - "documentation":"

The state of the Availability Zone or Local Zone.

", + "documentation":"

The state of the Zone.

", "locationName":"zoneState" }, "OptInStatus":{ @@ -5469,7 +5560,7 @@ }, "Messages":{ "shape":"AvailabilityZoneMessageList", - "documentation":"

Any messages about the Availability Zone or Local Zone.

", + "documentation":"

Any messages about the Zone.

", "locationName":"messageSet" }, "RegionName":{ @@ -5479,12 +5570,12 @@ }, "ZoneName":{ "shape":"String", - "documentation":"

The name of the Availability Zone or Local Zone.

", + "documentation":"

The name of the Zone.

", "locationName":"zoneName" }, "ZoneId":{ "shape":"String", - "documentation":"

The ID of the Availability Zone or Local Zone.

", + "documentation":"

The ID of the Zone.

", "locationName":"zoneId" }, "GroupName":{ @@ -5496,9 +5587,24 @@ "shape":"String", "documentation":"

The name of the location from which the address is advertised.

", "locationName":"networkBorderGroup" + }, + "ZoneType":{ + "shape":"String", + "documentation":"

The type of zone. The valid values are availability-zone and local-zone.

", + "locationName":"zoneType" + }, + "ParentZoneName":{ + "shape":"String", + "documentation":"

The name of the zone that handles some of the Local Zone control plane operations, such as API calls.

", + "locationName":"parentZoneName" + }, + "ParentZoneId":{ + "shape":"String", + "documentation":"

The ID of the zone that handles some of the Local Zone control plane operations, such as API calls.

", + "locationName":"parentZoneId" } }, - "documentation":"

Describes an Availability Zone or Local Zone.

" + "documentation":"

Describes a Zone.

" }, "AvailabilityZoneList":{ "type":"list", @@ -5512,11 +5618,11 @@ "members":{ "Message":{ "shape":"String", - "documentation":"

The message about the Availability Zone or Local Zone.

", + "documentation":"

The message about the Zone.

", "locationName":"message" } }, - "documentation":"

Describes a message about an Availability Zone or Local Zone.

" + "documentation":"

Describes a message about a Zone.

" }, "AvailabilityZoneMessageList":{ "type":"list", @@ -6297,7 +6403,7 @@ "members":{ "CapacityReservationPreference":{ "shape":"CapacityReservationPreference", - "documentation":"

Indicates the instance's Capacity Reservation preferences. Possible preferences include:

  • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

  • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.

" + "documentation":"

Indicates the instance's Capacity Reservation preferences. Possible preferences include:

  • open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).

  • none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.

When CapacityReservationPreference is not specified, it defaults to open.

" }, "CapacityReservationTarget":{ "shape":"CapacityReservationTarget", @@ -7754,6 +7860,11 @@ "documentation":"

A DHCP configuration option.

", "locationName":"dhcpConfiguration" }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to assign to the DHCP option.

", + "locationName":"TagSpecification" + }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -7786,6 +7897,11 @@ "VpcId":{ "shape":"VpcId", "documentation":"

The ID of the VPC for which to create the egress-only internet gateway.

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to assign to the egress-only internet gateway.

", + "locationName":"TagSpecification" } } }, @@ -8180,6 +8296,11 @@ "CreateInternetGatewayRequest":{ "type":"structure", "members":{ + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to assign to the internet gateway.

", + "locationName":"TagSpecification" + }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -8387,6 +8508,57 @@ } } }, + "CreateManagedPrefixListRequest":{ + "type":"structure", + "required":[ + "PrefixListName", + "MaxEntries", + "AddressFamily" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "PrefixListName":{ + "shape":"String", + "documentation":"

A name for the prefix list.

Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.

" + }, + "Entries":{ + "shape":"AddPrefixListEntries", + "documentation":"

One or more entries for the prefix list.

", + "locationName":"Entry" + }, + "MaxEntries":{ + "shape":"Integer", + "documentation":"

The maximum number of entries for the prefix list.

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to apply to the prefix list during creation.

", + "locationName":"TagSpecification" + }, + "AddressFamily":{ + "shape":"String", + "documentation":"

The IP address type.

Valid Values: IPv4 | IPv6

" + }, + "ClientToken":{ + "shape":"String", + "documentation":"

Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

Constraints: Up to 255 UTF-8 characters in length.

", + "idempotencyToken":true + } + } + }, + "CreateManagedPrefixListResult":{ + "type":"structure", + "members":{ + "PrefixList":{ + "shape":"ManagedPrefixList", + "documentation":"

Information about the prefix list.

", + "locationName":"prefixList" + } + } + }, "CreateNatGatewayRequest":{ "type":"structure", "required":[ @@ -8445,7 +8617,7 @@ "members":{ "CidrBlock":{ "shape":"String", - "documentation":"

The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).

", + "documentation":"

The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24). We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", "locationName":"cidrBlock" }, "DryRun":{ @@ -8508,6 +8680,11 @@ "shape":"VpcId", "documentation":"

The ID of the VPC.

", "locationName":"vpcId" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to assign to the network ACL.

", + "locationName":"TagSpecification" } } }, @@ -8614,6 +8791,11 @@ "shape":"SubnetId", "documentation":"

The ID of the subnet to associate with the network interface.

", "locationName":"subnetId" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to apply to the new network interface.

", + "locationName":"TagSpecification" } }, "documentation":"

Contains the parameters for CreateNetworkInterface.

" @@ -8716,7 +8898,7 @@ "members":{ "DestinationCidrBlock":{ "shape":"String", - "documentation":"

The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match.

", + "documentation":"

The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

", "locationName":"destinationCidrBlock" }, "DestinationIpv6CidrBlock":{ @@ -8724,6 +8906,10 @@ "documentation":"

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

", "locationName":"destinationIpv6CidrBlock" }, + "DestinationPrefixListId":{ + "shape":"PrefixListResourceId", + "documentation":"

The ID of a prefix list used for the destination match.

" + }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -8830,6 +9016,11 @@ "shape":"VpcId", "documentation":"

[EC2-VPC] The ID of the VPC. Required for EC2-VPC.

" }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to assign to the security group.

", + "locationName":"TagSpecification" + }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -8844,6 +9035,11 @@ "shape":"String", "documentation":"

The ID of the security group.

", "locationName":"groupId" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags assigned to the security group.

", + "locationName":"tagSet" } } }, @@ -8948,6 +9144,11 @@ "VpcId" ], "members":{ + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to assign to the subnet.

", + "locationName":"TagSpecification" + }, "AvailabilityZone":{ "shape":"String", "documentation":"

The Availability Zone or Local Zone for the subnet.

Default: AWS selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.

To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a. For information about the Regions that support Local Zones, see Available Regions in the Amazon Elastic Compute Cloud User Guide.

To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.

" @@ -8958,7 +9159,7 @@ }, "CidrBlock":{ "shape":"String", - "documentation":"

The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24.

" + "documentation":"

The IPv4 network range for the subnet, in CIDR notation. For example, 10.0.0.0/24. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

" }, "Ipv6CidrBlock":{ "shape":"String", @@ -9778,7 +9979,7 @@ "members":{ "CidrBlock":{ "shape":"String", - "documentation":"

The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16.

" + "documentation":"

The IPv4 network range for the VPC, in CIDR notation. For example, 10.0.0.0/16. We modify the specified CIDR block to its canonical form; for example, if you specify 100.68.0.18/18, we modify it to 100.68.0.0/18.

" }, "AmazonProvidedIpv6CidrBlock":{ "shape":"Boolean", @@ -9806,6 +10007,11 @@ "Ipv6CidrBlockNetworkBorderGroup":{ "shape":"String", "documentation":"

The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.

You must set AmazonProvidedIpv6CidrBlock to true to use this parameter.

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to assign to the VPC.

", + "locationName":"TagSpecification" } } }, @@ -10540,6 +10746,30 @@ } } }, + "DeleteManagedPrefixListRequest":{ + "type":"structure", + "required":["PrefixListId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "PrefixListId":{ + "shape":"PrefixListResourceId", + "documentation":"

The ID of the prefix list.

" + } + } + }, + "DeleteManagedPrefixListResult":{ + "type":"structure", + "members":{ + "PrefixList":{ + "shape":"ManagedPrefixList", + "documentation":"

Information about the prefix list.

", + "locationName":"prefixList" + } + } + }, "DeleteNatGatewayRequest":{ "type":"structure", "required":["NatGatewayId"], @@ -10750,6 +10980,10 @@ "documentation":"

The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.

", "locationName":"destinationIpv6CidrBlock" }, + "DestinationPrefixListId":{ + "shape":"PrefixListResourceId", + "documentation":"

The ID of the prefix list for the route.

" + }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -11517,17 +11751,17 @@ "members":{ "Filters":{ "shape":"FilterList", - "documentation":"

The filters.

  • group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1).

  • message - The Availability Zone or Local Zone message.

  • opt-in-status - The opt in status (opted-in, and not-opted-in | opt-in-not-required).

  • region-name - The name of the Region for the Availability Zone or Local Zone (for example, us-east-1).

  • state - The state of the Availability Zone or Local Zone (available | information | impaired | unavailable).

  • zone-id - The ID of the Availability Zone (for example, use1-az1) or the Local Zone (for example, use usw2-lax1-az1).

  • zone-name - The name of the Availability Zone (for example, us-east-1a) or the Local Zone (for example, use us-west-2-lax-1a).

", + "documentation":"

The filters.

  • group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1).

  • message - The Zone message.

  • opt-in-status - The opt in status (opted-in, and not-opted-in | opt-in-not-required).

  • region-name - The name of the Region for the Zone (for example, us-east-1).

  • state - The state of the Availability Zone or Local Zone (available | information | impaired | unavailable).

  • zone-id - The ID of the Availability Zone (for example, use1-az1) or the Local Zone (for example, use usw2-lax1-az1).

  • zone-name - The name of the Availability Zone (for example, us-east-1a) or the Local Zone (for example, use us-west-2-lax-1a).

", "locationName":"Filter" }, "ZoneNames":{ "shape":"ZoneNameStringList", - "documentation":"

The names of the Availability Zones and Local Zones.

", + "documentation":"

The names of the Zones.

", "locationName":"ZoneName" }, "ZoneIds":{ "shape":"ZoneIdStringList", - "documentation":"

The IDs of the Availability Zones and Local Zones.

", + "documentation":"

The IDs of the Zones.

", "locationName":"ZoneId" }, "AllAvailabilityZones":{ @@ -11546,7 +11780,7 @@ "members":{ "AvailabilityZones":{ "shape":"AvailabilityZoneList", - "documentation":"

Information about the Availability Zones and Local Zones.

", + "documentation":"

Information about the Zones.

", "locationName":"availabilityZoneInfo" } } @@ -13848,6 +14082,48 @@ } } }, + "DescribeManagedPrefixListsRequest":{ + "type":"structure", + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "Filters":{ + "shape":"FilterList", + "documentation":"

One or more filters.

  • owner-id - The ID of the prefix list owner.

  • prefix-list-id - The ID of the prefix list.

  • prefix-list-name - The name of the prefix list.

", + "locationName":"Filter" + }, + "MaxResults":{ + "shape":"PrefixListMaxResults", + "documentation":"

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

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next page of results.

" + }, + "PrefixListIds":{ + "shape":"ValueStringList", + "documentation":"

One or more prefix list IDs.

", + "locationName":"PrefixListId" + } + } + }, + "DescribeManagedPrefixListsResult":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "documentation":"

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

", + "locationName":"nextToken" + }, + "PrefixLists":{ + "shape":"ManagedPrefixListSet", + "documentation":"

Information about the prefix lists.

", + "locationName":"prefixListSet" + } + } + }, "DescribeMovingAddressesMaxResults":{ "type":"integer", "max":1000, @@ -14100,7 +14376,7 @@ "members":{ "Filters":{ "shape":"FilterList", - "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IPv4 addresses associated with the network interface.

  • addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

  • association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface (IPv4).

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.attach-time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.nat-gateway-id - The ID of the NAT gateway to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IPv4 address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface (IPv4).

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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

  • vpc-id - The ID of the VPC for the network interface.

", + "documentation":"

One or more filters.

  • addresses.private-ip-address - The private IPv4 addresses associated with the network interface.

  • addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.

  • addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).

  • addresses.association.owner-id - The owner ID of the addresses associated with the network interface.

  • association.association-id - The association ID returned when the network interface was associated with an IPv4 address.

  • association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.

  • association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.

  • association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.

  • association.public-dns-name - The public DNS name for the network interface (IPv4).

  • attachment.attachment-id - The ID of the interface attachment.

  • attachment.attach-time - The time that the network interface was attached to an instance.

  • attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.

  • attachment.device-index - The device index to which the network interface is attached.

  • attachment.instance-id - The ID of the instance to which the network interface is attached.

  • attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.

  • attachment.status - The status of the attachment (attaching | attached | detaching | detached).

  • availability-zone - The Availability Zone of the network interface.

  • description - The description of the network interface.

  • group-id - The ID of a security group associated with the network interface.

  • group-name - The name of a security group associated with the network interface.

  • ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.

  • mac-address - The MAC address of the network interface.

  • network-interface-id - The ID of the network interface.

  • owner-id - The AWS account ID of the network interface owner.

  • private-ip-address - The private IPv4 address or addresses of the network interface.

  • private-dns-name - The private DNS name of the network interface (IPv4).

  • requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).

  • requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).

  • source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.

  • status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.

  • subnet-id - The ID of the subnet for the network interface.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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

  • vpc-id - The ID of the VPC for the network interface.

", "locationName":"filter" }, "DryRun":{ @@ -14725,7 +15001,7 @@ "members":{ "Filters":{ "shape":"FilterList", - "documentation":"

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.

  • egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

  • egress.ip-permission.prefix-list-id - The ID (prefix) of the AWS service to which a security group rule allows outbound access.

  • egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp or a protocol number).

  • egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

  • ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.

  • ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule.

  • ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

  • ip-permission.prefix-list-id - The ID (prefix) of the AWS service from which a security group rule allows inbound access.

  • ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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

  • vpc-id - The ID of the VPC specified when the security group was created.

", + "documentation":"

The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.

  • description - The description of the security group.

  • egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.

  • egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.group-name - The name of a security group that has been referenced in an outbound security group rule.

  • egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.

  • egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.

  • egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp or a protocol number).

  • egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.

  • group-id - The ID of the security group.

  • group-name - The name of the security group.

  • ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.

  • ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.

  • ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.

  • ip-permission.group-name - The name of a security group that has been referenced in an inbound security group rule.

  • ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.

  • ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.

  • ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number).

  • ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.

  • ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule.

  • owner-id - The AWS account ID of the owner of the security group.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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

  • vpc-id - The ID of the VPC specified when the security group was created.

", "locationName":"Filter" }, "GroupIds":{ @@ -15061,7 +15337,7 @@ "members":{ "Filters":{ "shape":"FilterList", - "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot Instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot Instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.

  • launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.

  • launch.group-id - The ID of the security group for the instance.

  • launch.group-name - The name of the security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m3.medium).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.

  • launch.ramdisk-id - The RAM disk ID.

  • launched-availability-zone - The Availability Zone in which the request is launched.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.description - A description of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot Instance request ID.

  • spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.

  • state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot Request Status in the Amazon EC2 User Guide for Linux Instances.

  • status-code - The short code describing the most recent evaluation of your Spot Instance request.

  • status-message - The message explaining the status of the Spot Instance request.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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

  • type - The type of Spot Instance request (one-time | persistent).

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", + "documentation":"

One or more filters.

  • availability-zone-group - The Availability Zone group.

  • create-time - The time stamp when the Spot Instance request was created.

  • fault-code - The fault code related to the request.

  • fault-message - The fault message related to the request.

  • instance-id - The ID of the instance that fulfilled the request.

  • launch-group - The Spot Instance launch group.

  • launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.

  • launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).

  • launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.

  • launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.

  • launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.

  • launch.group-id - The ID of the security group for the instance.

  • launch.group-name - The name of the security group for the instance.

  • launch.image-id - The ID of the AMI.

  • launch.instance-type - The type of instance (for example, m3.medium).

  • launch.kernel-id - The kernel ID.

  • launch.key-name - The name of the key pair the instance launched with.

  • launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.

  • launch.ramdisk-id - The RAM disk ID.

  • launched-availability-zone - The Availability Zone in which the request is launched.

  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.

  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.

  • network-interface.description - A description of the network interface.

  • network-interface.device-index - The index of the device for the network interface attachment on the instance.

  • network-interface.group-id - The ID of the security group associated with the network interface.

  • network-interface.network-interface-id - The ID of the network interface.

  • network-interface.private-ip-address - The primary private IP address of the network interface.

  • network-interface.subnet-id - The ID of the subnet for the instance.

  • product-description - The product description associated with the instance (Linux/UNIX | Windows).

  • spot-instance-request-id - The Spot Instance request ID.

  • spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.

  • state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.

  • status-code - The short code describing the most recent evaluation of your Spot Instance request.

  • status-message - The message explaining the status of the Spot Instance request.

  • tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

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

  • type - The type of Spot Instance request (one-time | persistent).

  • valid-from - The start date of the request.

  • valid-until - The end date of the request.

", "locationName":"Filter" }, "DryRun":{ @@ -17301,12 +17577,12 @@ "members":{ "DeleteOnTermination":{ "shape":"Boolean", - "documentation":"

Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS Volumes on Instance Termination in the Amazon Elastic Compute Cloud User Guide.

", + "documentation":"

Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"deleteOnTermination" }, "Iops":{ "shape":"Integer", - "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1 IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", + "documentation":"

The number of I/O operations per second (IOPS) that the volume supports. For io1 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.

Constraints: Range is 100-16,000 IOPS for gp2 volumes and 100 to 64,000IOPS for io1 volumes in most Regions. Maximum io1 IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.

Condition: This parameter is required for requests to create io1 volumes; it is not used in requests to create gp2, st1, sc1, or standard volumes.

", "locationName":"iops" }, "SnapshotId":{ @@ -17330,7 +17606,7 @@ }, "Encrypted":{ "shape":"Boolean", - "documentation":"

Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types.

This parameter is not returned by .

", + "documentation":"

Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

In no case can you remove encryption from an encrypted volume.

Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.

This parameter is not returned by .

", "locationName":"encrypted" } }, @@ -19615,6 +19891,89 @@ } } }, + "GetManagedPrefixListAssociationsMaxResults":{ + "type":"integer", + "max":255, + "min":5 + }, + "GetManagedPrefixListAssociationsRequest":{ + "type":"structure", + "required":["PrefixListId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "PrefixListId":{ + "shape":"PrefixListResourceId", + "documentation":"

The ID of the prefix list.

" + }, + "MaxResults":{ + "shape":"GetManagedPrefixListAssociationsMaxResults", + "documentation":"

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

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next page of results.

" + } + } + }, + "GetManagedPrefixListAssociationsResult":{ + "type":"structure", + "members":{ + "PrefixListAssociations":{ + "shape":"PrefixListAssociationSet", + "documentation":"

Information about the associations.

", + "locationName":"prefixListAssociationSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"

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

", + "locationName":"nextToken" + } + } + }, + "GetManagedPrefixListEntriesRequest":{ + "type":"structure", + "required":["PrefixListId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "PrefixListId":{ + "shape":"PrefixListResourceId", + "documentation":"

The ID of the prefix list.

" + }, + "TargetVersion":{ + "shape":"Long", + "documentation":"

The version of the prefix list for which to return the entries. The default is the current version.

" + }, + "MaxResults":{ + "shape":"PrefixListMaxResults", + "documentation":"

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

" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

The token for the next page of results.

" + } + } + }, + "GetManagedPrefixListEntriesResult":{ + "type":"structure", + "members":{ + "Entries":{ + "shape":"PrefixListEntrySet", + "documentation":"

Information about the prefix list entries.

", + "locationName":"entrySet" + }, + "NextToken":{ + "shape":"NextToken", + "documentation":"

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

", + "locationName":"nextToken" + } + } + }, "GetPasswordDataRequest":{ "type":"structure", "required":["InstanceId"], @@ -20014,7 +20373,7 @@ "locationName":"configured" } }, - "documentation":"

Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.

" }, "HibernationOptionsRequest":{ "type":"structure", @@ -20024,7 +20383,7 @@ "documentation":"

If you set this parameter to true, your instance is enabled for hibernation.

Default: false

" } }, - "documentation":"

Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.

" }, "HistoryRecord":{ "type":"structure", @@ -23404,7 +23763,7 @@ }, "PrefixListIds":{ "shape":"PrefixListIdList", - "documentation":"

[VPC only] The prefix list IDs for an AWS service. With outbound rules, this is the AWS service to access through a VPC endpoint from instances associated with the security group.

", + "documentation":"

[VPC only] The prefix list IDs.

", "locationName":"prefixListIds" }, "ToPort":{ @@ -25317,6 +25676,69 @@ ] }, "Long":{"type":"long"}, + "ManagedPrefixList":{ + "type":"structure", + "members":{ + "PrefixListId":{ + "shape":"PrefixListResourceId", + "documentation":"

The ID of the prefix list.

", + "locationName":"prefixListId" + }, + "AddressFamily":{ + "shape":"String", + "documentation":"

The IP address version.

", + "locationName":"addressFamily" + }, + "State":{ + "shape":"PrefixListState", + "documentation":"

The state of the prefix list.

", + "locationName":"state" + }, + "StateMessage":{ + "shape":"String", + "documentation":"

The state message.

", + "locationName":"stateMessage" + }, + "PrefixListArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) for the prefix list.

", + "locationName":"prefixListArn" + }, + "PrefixListName":{ + "shape":"String", + "documentation":"

The name of the prefix list.

", + "locationName":"prefixListName" + }, + "MaxEntries":{ + "shape":"Integer", + "documentation":"

The maximum number of entries for the prefix list.

", + "locationName":"maxEntries" + }, + "Version":{ + "shape":"Long", + "documentation":"

The version of the prefix list.

", + "locationName":"version" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

The tags for the prefix list.

", + "locationName":"tagSet" + }, + "OwnerId":{ + "shape":"String", + "documentation":"

The ID of the owner of the prefix list.

", + "locationName":"ownerId" + } + }, + "documentation":"

Describes a managed prefix list.

" + }, + "ManagedPrefixListSet":{ + "type":"list", + "member":{ + "shape":"ManagedPrefixList", + "locationName":"item" + } + }, "MarketType":{ "type":"string", "enum":["spot"] @@ -25779,7 +26201,7 @@ }, "BlockDeviceMappings":{ "shape":"InstanceBlockDeviceMappingSpecificationList", - "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.

", + "documentation":"

Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.

To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the block device mapping when launching an instance in the Amazon Elastic Compute Cloud User Guide.

", "locationName":"blockDeviceMapping" }, "DisableApiTermination":{ @@ -25819,7 +26241,7 @@ }, "InstanceType":{ "shape":"AttributeValue", - "documentation":"

Changes the instance type to the specified value. For more information, see Instance Types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", + "documentation":"

Changes the instance type to the specified value. For more information, see Instance types. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.

", "locationName":"instanceType" }, "Kernel":{ @@ -26074,6 +26496,48 @@ } } }, + "ModifyManagedPrefixListRequest":{ + "type":"structure", + "required":["PrefixListId"], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "PrefixListId":{ + "shape":"PrefixListResourceId", + "documentation":"

The ID of the prefix list.

" + }, + "CurrentVersion":{ + "shape":"Long", + "documentation":"

The current version of the prefix list.

" + }, + "PrefixListName":{ + "shape":"String", + "documentation":"

A name for the prefix list.

" + }, + "AddEntries":{ + "shape":"AddPrefixListEntries", + "documentation":"

One or more entries to add to the prefix list.

", + "locationName":"AddEntry" + }, + "RemoveEntries":{ + "shape":"RemovePrefixListEntries", + "documentation":"

One or more entries to remove from the prefix list.

", + "locationName":"RemoveEntry" + } + } + }, + "ModifyManagedPrefixListResult":{ + "type":"structure", + "members":{ + "PrefixList":{ + "shape":"ManagedPrefixList", + "documentation":"

Information about the prefix list.

", + "locationName":"prefixList" + } + } + }, "ModifyNetworkInterfaceAttributeRequest":{ "type":"structure", "required":["NetworkInterfaceId"], @@ -28406,6 +28870,52 @@ }, "documentation":"

Describes prefixes for AWS services.

" }, + "PrefixListAssociation":{ + "type":"structure", + "members":{ + "ResourceId":{ + "shape":"String", + "documentation":"

The ID of the resource.

", + "locationName":"resourceId" + }, + "ResourceOwner":{ + "shape":"String", + "documentation":"

The owner of the resource.

", + "locationName":"resourceOwner" + } + }, + "documentation":"

Describes the resource with which a prefix list is associated.

" + }, + "PrefixListAssociationSet":{ + "type":"list", + "member":{ + "shape":"PrefixListAssociation", + "locationName":"item" + } + }, + "PrefixListEntry":{ + "type":"structure", + "members":{ + "Cidr":{ + "shape":"String", + "documentation":"

The CIDR block.

", + "locationName":"cidr" + }, + "Description":{ + "shape":"String", + "documentation":"

The description.

", + "locationName":"description" + } + }, + "documentation":"

Describes a prefix list entry.

" + }, + "PrefixListEntrySet":{ + "type":"list", + "member":{ + "shape":"PrefixListEntry", + "locationName":"item" + } + }, "PrefixListId":{ "type":"structure", "members":{ @@ -28436,6 +28946,11 @@ "locationName":"item" } }, + "PrefixListMaxResults":{ + "type":"integer", + "max":1000, + "min":1 + }, "PrefixListResourceId":{"type":"string"}, "PrefixListResourceIdStringList":{ "type":"list", @@ -28451,6 +28966,23 @@ "locationName":"item" } }, + "PrefixListState":{ + "type":"string", + "enum":[ + "create-in-progress", + "create-complete", + "create-failed", + "modify-in-progress", + "modify-complete", + "modify-failed", + "restore-in-progress", + "restore-complete", + "restore-failed", + "delete-in-progress", + "delete-complete", + "delete-failed" + ] + }, "PriceSchedule":{ "type":"structure", "members":{ @@ -28947,6 +29479,11 @@ "OfferingId":{ "shape":"OfferingId", "documentation":"

The ID of the offering.

" + }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The tags to apply to the Dedicated Host Reservation during purchase.

", + "locationName":"TagSpecification" } } }, @@ -29526,6 +30063,23 @@ } } }, + "RemovePrefixListEntries":{ + "type":"list", + "member":{"shape":"RemovePrefixListEntry"}, + "max":1000, + "min":0 + }, + "RemovePrefixListEntry":{ + "type":"structure", + "required":["Cidr"], + "members":{ + "Cidr":{ + "shape":"String", + "documentation":"

The CIDR block.

" + } + }, + "documentation":"

An entry for a prefix list.

" + }, "ReplaceIamInstanceProfileAssociationRequest":{ "type":"structure", "required":[ @@ -29663,6 +30217,10 @@ "documentation":"

The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.

", "locationName":"destinationIpv6CidrBlock" }, + "DestinationPrefixListId":{ + "shape":"PrefixListResourceId", + "documentation":"

The ID of the prefix list for the route.

" + }, "DryRun":{ "shape":"Boolean", "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

", @@ -30084,6 +30642,11 @@ "documentation":"

The end date of the request. If this is a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date is reached. The default end date is 7 days from the current date.

", "locationName":"validUntil" }, + "TagSpecifications":{ + "shape":"TagSpecificationList", + "documentation":"

The key-value pair for tagging the Spot Instance request on creation. The value for ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags.

", + "locationName":"TagSpecification" + }, "InstanceInterruptionBehavior":{ "shape":"InstanceInterruptionBehavior", "documentation":"

The behavior when a Spot Instance is interrupted. The default is terminate.

" @@ -30886,6 +31449,11 @@ } } }, + "ResourceArn":{ + "type":"string", + "max":1283, + "min":1 + }, "ResourceIdList":{ "type":"list", "member":{"shape":"TaggableResourceId"} @@ -31146,6 +31714,42 @@ } } }, + "RestoreManagedPrefixListVersionRequest":{ + "type":"structure", + "required":[ + "PrefixListId", + "PreviousVersion", + "CurrentVersion" + ], + "members":{ + "DryRun":{ + "shape":"Boolean", + "documentation":"

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

" + }, + "PrefixListId":{ + "shape":"PrefixListResourceId", + "documentation":"

The ID of the prefix list.

" + }, + "PreviousVersion":{ + "shape":"Long", + "documentation":"

The version to restore.

" + }, + "CurrentVersion":{ + "shape":"Long", + "documentation":"

The current version number for the prefix list.

" + } + } + }, + "RestoreManagedPrefixListVersionResult":{ + "type":"structure", + "members":{ + "PrefixList":{ + "shape":"ManagedPrefixList", + "documentation":"

Information about the prefix list.

", + "locationName":"prefixList" + } + } + }, "RevokeClientVpnIngressRequest":{ "type":"structure", "required":[ @@ -31558,7 +32162,7 @@ }, "InstanceType":{ "shape":"InstanceType", - "documentation":"

The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

" + "documentation":"

The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.

Default: m1.small

" }, "Ipv6AddressCount":{ "shape":"Integer", @@ -31613,7 +32217,7 @@ }, "UserData":{ "shape":"String", - "documentation":"

The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.

" + "documentation":"

The user data to make available to the instance. For more information, see Running commands on your Linux instance at launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.

" }, "AdditionalInfo":{ "shape":"String", @@ -31685,11 +32289,11 @@ }, "CreditSpecification":{ "shape":"CreditSpecificationRequest", - "documentation":"

The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.

Default: standard (T2 instances) or unlimited (T3/T3a instances)

" + "documentation":"

The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon Elastic Compute Cloud User Guide.

Default: standard (T2 instances) or unlimited (T3/T3a instances)

" }, "CpuOptions":{ "shape":"CpuOptionsRequest", - "documentation":"

The CPU options for the instance. For more information, see Optimizing CPU Options in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User Guide.

" }, "CapacityReservationSpecification":{ "shape":"CapacityReservationSpecification", @@ -31697,7 +32301,7 @@ }, "HibernationOptions":{ "shape":"HibernationOptionsRequest", - "documentation":"

Indicates whether an instance is enabled for hibernation. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Indicates whether an instance is enabled for hibernation. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.

" }, "LicenseSpecifications":{ "shape":"LicenseSpecificationListRequest", @@ -31706,7 +32310,7 @@ }, "MetadataOptions":{ "shape":"InstanceMetadataOptionsRequest", - "documentation":"

The metadata options for the instance. For more information, see Instance Metadata and User Data.

" + "documentation":"

The metadata options for the instance. For more information, see Instance metadata and user data.

" } } }, @@ -33293,7 +33897,7 @@ }, "IamFleetRole":{ "shape":"String", - "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet Prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.

", + "documentation":"

The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.

", "locationName":"iamFleetRole" }, "LaunchSpecifications":{ @@ -33490,7 +34094,7 @@ }, "State":{ "shape":"SpotInstanceState", - "documentation":"

The state of the Spot Instance request. Spot status information helps track your Spot Instance requests. For more information, see Spot Status in the Amazon EC2 User Guide for Linux Instances.

", + "documentation":"

The state of the Spot Instance request. Spot status information helps track your Spot Instance requests. For more information, see Spot status in the Amazon EC2 User Guide for Linux Instances.

", "locationName":"state" }, "Status":{ @@ -33572,7 +34176,7 @@ "members":{ "Code":{ "shape":"String", - "documentation":"

The status code. For a list of status codes, see Spot Status Codes in the Amazon EC2 User Guide for Linux Instances.

", + "documentation":"

The status code. For a list of status codes, see Spot status codes in the Amazon EC2 User Guide for Linux Instances.

", "locationName":"code" }, "Message":{ @@ -33775,7 +34379,7 @@ }, "PrefixListIds":{ "shape":"PrefixListIdSet", - "documentation":"

The prefix list IDs for an AWS service. Not applicable for stale security group rules.

", + "documentation":"

The prefix list IDs. Not applicable for stale security group rules.

", "locationName":"prefixListIds" }, "ToPort":{ @@ -33957,7 +34561,7 @@ }, "Hibernate":{ "shape":"Boolean", - "documentation":"

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.

Default: false

" + "documentation":"

Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.

Default: false

" }, "DryRun":{ "shape":"Boolean", @@ -34305,7 +34909,7 @@ "members":{ "ResourceType":{ "shape":"ResourceType", - "documentation":"

The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | dedicated-host | fleet | fpga-image | instance | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | natgateway | spot-fleet-request | placement-group | snapshot | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | vpc-endpoint (for interface VPC endpoints)| vpc-endpoint-service (for gateway VPC endpoints) | volume | vpc-flow-log.

To tag a resource after it has been created, see CreateTags.

", + "documentation":"

The type of resource to tag. Currently, the resource types that support tagging on creation are: capacity-reservation | client-vpn-endpoint | dedicated-host | dhcp-options | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | import-image-task | import-snapshot-task | instance | internet-gateway | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | placement-group | prefix-list | launch-template | natgateway | network-acl | security-group | spot-fleet-request | snapshot | subnet | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-route-table | volume |vpc | vpc-endpoint (for interface and gateway endpoints) | vpc-endpoint-service (for AWS PrivateLink) | vpc-flow-log.

To tag a resource after it has been created, see CreateTags.

", "locationName":"resourceType" }, "Tags":{ diff --git a/botocore/data/ecr/2015-09-21/service-2.json b/botocore/data/ecr/2015-09-21/service-2.json index 485b6964..4538f14a 100644 --- a/botocore/data/ecr/2015-09-21/service-2.json +++ b/botocore/data/ecr/2015-09-21/service-2.json @@ -333,7 +333,8 @@ {"shape":"LayersNotFoundException"}, {"shape":"ReferencedImagesNotFoundException"}, {"shape":"LimitExceededException"}, - {"shape":"ImageTagAlreadyExistsException"} + {"shape":"ImageTagAlreadyExistsException"}, + {"shape":"ImageDigestDoesNotMatchException"} ], "documentation":"

Creates or updates the image manifest and tags associated with an image.

When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.

This operation is used by the Amazon ECR proxy and is not generally used by customers for pulling and pushing images. In most cases, you should use the docker CLI to pull, tag, and push images.

" }, @@ -1281,6 +1282,14 @@ "member":{"shape":"ImageDetail"} }, "ImageDigest":{"type":"string"}, + "ImageDigestDoesNotMatchException":{ + "type":"structure", + "members":{ + "message":{"shape":"ExceptionMessage"} + }, + "documentation":"

The specified image digest does not match the digest that Amazon ECR calculated for the image.

", + "exception":true + }, "ImageFailure":{ "type":"structure", "members":{ @@ -1909,6 +1918,10 @@ "imageTag":{ "shape":"ImageTag", "documentation":"

The tag to associate with the image. This parameter is required for images that use the Docker Image Manifest V2 Schema 2 or OCI formats.

" + }, + "imageDigest":{ + "shape":"ImageDigest", + "documentation":"

The image digest of the image manifest corresponding to the image.

" } } }, diff --git a/botocore/data/efs/2015-02-01/examples-1.json b/botocore/data/efs/2015-02-01/examples-1.json index 4a4b982d..b5c988ca 100644 --- a/botocore/data/efs/2015-02-01/examples-1.json +++ b/botocore/data/efs/2015-02-01/examples-1.json @@ -5,7 +5,13 @@ { "input": { "CreationToken": "tokenstring", - "PerformanceMode": "generalPurpose" + "PerformanceMode": "generalPurpose", + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] }, "output": { "CreationTime": "1481841524.0", @@ -17,7 +23,13 @@ "PerformanceMode": "generalPurpose", "SizeInBytes": { "Value": 0 - } + }, + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] }, "comments": { "input": { @@ -130,7 +142,13 @@ "PerformanceMode": "generalPurpose", "SizeInBytes": { "Value": 6144 - } + }, + "Tags": [ + { + "Key": "Name", + "Value": "MyFileSystem" + } + ] } ] }, @@ -141,6 +159,29 @@ "title": "To describe an EFS file system" } ], + "DescribeLifecycleConfiguration": [ + { + "input": { + "FileSystemId": "fs-01234567" + }, + "output": { + "LifecyclePolicies": [ + { + "TransitionToIA": "AFTER_30_DAYS" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation describes a file system's LifecycleConfiguration. EFS lifecycle management uses the LifecycleConfiguration object to identify which files to move to the EFS Infrequent Access (IA) storage class. ", + "id": "to-describe-the-lifecycle-configuration-for-a-file-system-1551200664502", + "title": "To describe the lifecycle configuration for a file system" + } + ], "DescribeMountTargetSecurityGroups": [ { "input": { @@ -148,7 +189,7 @@ }, "output": { "SecurityGroups": [ - "sg-fghi4567" + "sg-4567abcd" ] }, "comments": { @@ -217,6 +258,34 @@ "id": "to-modify-the-security-groups-associated-with-a-mount-target-for-a-file-system-1481850772562", "title": "To modify the security groups associated with a mount target for a file system" } + ], + "PutLifecycleConfiguration": [ + { + "input": { + "FileSystemId": "fs-01234567", + "LifecyclePolicies": [ + { + "TransitionToIA": "AFTER_30_DAYS" + } + ] + }, + "output": { + "LifecyclePolicies": [ + { + "TransitionToIA": "AFTER_30_DAYS" + } + ] + }, + "comments": { + "input": { + }, + "output": { + } + }, + "description": "This operation enables lifecycle management on a file system by creating a new LifecycleConfiguration object. A LifecycleConfiguration object defines when files in an Amazon EFS file system are automatically transitioned to the lower-cost EFS Infrequent Access (IA) storage class. A LifecycleConfiguration applies to all files in a file system.", + "id": "creates-a-new-lifecycleconfiguration-object-for-a-file-system-1551201594692", + "title": "Creates a new lifecycleconfiguration object for a file system" + } ] } } diff --git a/botocore/data/efs/2015-02-01/service-2.json b/botocore/data/efs/2015-02-01/service-2.json index 01117b72..6fa2a241 100644 --- a/botocore/data/efs/2015-02-01/service-2.json +++ b/botocore/data/efs/2015-02-01/service-2.json @@ -23,6 +23,7 @@ "errors":[ {"shape":"BadRequest"}, {"shape":"AccessPointAlreadyExists"}, + {"shape":"IncorrectFileSystemLifeCycleState"}, {"shape":"InternalServerError"}, {"shape":"FileSystemNotFound"}, {"shape":"AccessPointLimitExceeded"} @@ -186,6 +187,24 @@ ], "documentation":"

Returns the description of a specific Amazon EFS access point if the AccessPointId is provided. If you provide an EFS FileSystemId, it returns descriptions of all access points for that file system. You can provide either an AccessPointId or a FileSystemId in the request, but not both.

This operation requires permissions for the elasticfilesystem:DescribeAccessPoints action.

" }, + "DescribeBackupPolicy":{ + "name":"DescribeBackupPolicy", + "http":{ + "method":"GET", + "requestUri":"/2015-02-01/file-systems/{FileSystemId}/backup-policy", + "responseCode":200 + }, + "input":{"shape":"DescribeBackupPolicyRequest"}, + "output":{"shape":"BackupPolicyDescription"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"FileSystemNotFound"}, + {"shape":"InternalServerError"}, + {"shape":"PolicyNotFound"}, + {"shape":"ValidationException"} + ], + "documentation":"

Returns the backup policy for the specified EFS file system.

" + }, "DescribeFileSystemPolicy":{ "name":"DescribeFileSystemPolicy", "http":{ @@ -322,6 +341,24 @@ ], "documentation":"

Modifies the set of security groups in effect for a mount target.

When you create a mount target, Amazon EFS also creates a new network interface. For more information, see CreateMountTarget. This operation replaces the security groups in effect for the network interface associated with a mount target, with the SecurityGroups provided in the request. This operation requires that the network interface of the mount target has been created and the lifecycle state of the mount target is not deleted.

The operation requires permissions for the following actions:

  • elasticfilesystem:ModifyMountTargetSecurityGroups action on the mount target's file system.

  • ec2:ModifyNetworkInterfaceAttribute action on the mount target's network interface.

" }, + "PutBackupPolicy":{ + "name":"PutBackupPolicy", + "http":{ + "method":"PUT", + "requestUri":"/2015-02-01/file-systems/{FileSystemId}/backup-policy", + "responseCode":200 + }, + "input":{"shape":"PutBackupPolicyRequest"}, + "output":{"shape":"BackupPolicyDescription"}, + "errors":[ + {"shape":"BadRequest"}, + {"shape":"FileSystemNotFound"}, + {"shape":"IncorrectFileSystemLifeCycleState"}, + {"shape":"InternalServerError"}, + {"shape":"ValidationException"} + ], + "documentation":"

Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.

" + }, "PutFileSystemPolicy":{ "name":"PutFileSystemPolicy", "http":{ @@ -501,7 +538,31 @@ }, "AvailabilityZoneId":{"type":"string"}, "AvailabilityZoneName":{"type":"string"}, - "AwsAccountId":{"type":"string"}, + "AwsAccountId":{ + "type":"string", + "max":14, + "pattern":"^(\\d{12})|(\\d{4}-\\d{4}-\\d{4})$" + }, + "BackupPolicy":{ + "type":"structure", + "required":["Status"], + "members":{ + "Status":{ + "shape":"Status", + "documentation":"

Describes the status of the file system's backup policy.

  • ENABLED - EFS is automatically backing up the file system.

  • ENABLING - EFS is turning on automatic backups for the file system.

  • DISABLED - automatic back ups are turned off for the file system.

  • DISABLED - EFS is turning off automatic backups for the file system.

" + } + }, + "documentation":"

The backup policy for the file system, showing the curent status. If ENABLED, the file system is being backed up.

" + }, + "BackupPolicyDescription":{ + "type":"structure", + "members":{ + "BackupPolicy":{ + "shape":"BackupPolicy", + "documentation":"

Describes the file system's backup policy, indicating whether automatic backups are turned on or off..

" + } + } + }, "BadRequest":{ "type":"structure", "required":["ErrorCode"], @@ -656,7 +717,8 @@ "CreationToken":{ "type":"string", "max":64, - "min":1 + "min":1, + "pattern":".+" }, "DeleteAccessPointRequest":{ "type":"structure", @@ -781,6 +843,18 @@ } } }, + "DescribeBackupPolicyRequest":{ + "type":"structure", + "required":["FileSystemId"], + "members":{ + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

Specifies which EFS file system to retrieve the BackupPolicy for.

", + "location":"uri", + "locationName":"FileSystemId" + } + } + }, "DescribeFileSystemPolicyRequest":{ "type":"structure", "required":["FileSystemId"], @@ -994,6 +1068,7 @@ "error":{"httpStatusCode":409}, "exception":true }, + "FileSystemArn":{"type":"string"}, "FileSystemDescription":{ "type":"structure", "required":[ @@ -1020,6 +1095,10 @@ "shape":"FileSystemId", "documentation":"

The ID of the file system, assigned by Amazon EFS.

" }, + "FileSystemArn":{ + "shape":"FileSystemArn", + "documentation":"

The Amazon Resource Name (ARN) for the EFS file system, in the format arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id . Example with sample data: arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567

" + }, "CreationTime":{ "shape":"Timestamp", "documentation":"

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z).

" @@ -1071,7 +1150,11 @@ "type":"list", "member":{"shape":"FileSystemDescription"} }, - "FileSystemId":{"type":"string"}, + "FileSystemId":{ + "type":"string", + "max":128, + "pattern":"^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$" + }, "FileSystemInUse":{ "type":"structure", "required":["ErrorCode"], @@ -1208,7 +1291,12 @@ "error":{"httpStatusCode":400}, "exception":true }, - "IpAddress":{"type":"string"}, + "IpAddress":{ + "type":"string", + "max":15, + "min":7, + "pattern":"^[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}$" + }, "IpAddressInUse":{ "type":"structure", "required":["ErrorCode"], @@ -1223,7 +1311,7 @@ "KmsKeyId":{ "type":"string", "max":2048, - "min":1 + "pattern":"^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(alias/[a-zA-Z0-9/_-]+))))$" }, "LifeCycleState":{ "type":"string", @@ -1295,7 +1383,12 @@ } } }, - "Marker":{"type":"string"}, + "Marker":{ + "type":"string", + "max":128, + "min":1, + "pattern":".+" + }, "MaxItems":{ "type":"integer", "min":1 @@ -1380,6 +1473,10 @@ "AvailabilityZoneName":{ "shape":"AvailabilityZoneName", "documentation":"

The name of the Availability Zone (AZ) that the mount target resides in. AZs are independently mapped to names for each AWS account. For example, the Availability Zone us-east-1a for your AWS account might not be the same location as us-east-1a for another AWS account.

" + }, + "VpcId":{ + "shape":"VpcId", + "documentation":"

The Virtual Private Cloud (VPC) ID that the mount target is configured in.

" } }, "documentation":"

Provides a description of a mount target.

" @@ -1388,7 +1485,12 @@ "type":"list", "member":{"shape":"MountTargetDescription"} }, - "MountTargetId":{"type":"string"}, + "MountTargetId":{ + "type":"string", + "max":45, + "min":13, + "pattern":"^fsmt-[0-9a-f]{8,40}$" + }, "MountTargetNotFound":{ "type":"structure", "required":["ErrorCode"], @@ -1487,6 +1589,25 @@ "type":"double", "min":1.0 }, + "PutBackupPolicyRequest":{ + "type":"structure", + "required":[ + "FileSystemId", + "BackupPolicy" + ], + "members":{ + "FileSystemId":{ + "shape":"FileSystemId", + "documentation":"

Specifies which EFS file system to update the backup policy for.

", + "location":"uri", + "locationName":"FileSystemId" + }, + "BackupPolicy":{ + "shape":"BackupPolicy", + "documentation":"

The backup policy included in the PutBackupPolicy request.

" + } + } + }, "PutFileSystemPolicyRequest":{ "type":"structure", "required":[ @@ -1550,7 +1671,12 @@ "max":16, "min":0 }, - "SecurityGroup":{"type":"string"}, + "SecurityGroup":{ + "type":"string", + "max":43, + "min":11, + "pattern":"^sg-[0-9a-f]{8,40}" + }, "SecurityGroupLimitExceeded":{ "type":"structure", "required":["ErrorCode"], @@ -1578,7 +1704,21 @@ "member":{"shape":"SecurityGroup"}, "max":5 }, - "SubnetId":{"type":"string"}, + "Status":{ + "type":"string", + "enum":[ + "ENABLED", + "ENABLING", + "DISABLED", + "DISABLING" + ] + }, + "SubnetId":{ + "type":"string", + "max":47, + "min":15, + "pattern":"^subnet-[0-9a-f]{8,40}$" + }, "SubnetNotFound":{ "type":"structure", "required":["ErrorCode"], @@ -1611,7 +1751,8 @@ "TagKey":{ "type":"string", "max":128, - "min":1 + "min":1, + "pattern":"^(?![aA]{1}[wW]{1}[sS]{1}:)([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+)$" }, "TagKeys":{ "type":"list", @@ -1640,7 +1781,8 @@ }, "TagValue":{ "type":"string", - "max":256 + "max":256, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" }, "Tags":{ "type":"list", @@ -1743,7 +1885,19 @@ "documentation":"

(Optional) The amount of throughput, in MiB/s, that you want to provision for your file system. Valid values are 1-1024. Required if ThroughputMode is changed to provisioned on update. If you're not updating the amount of provisioned throughput for your file system, you don't need to provide this value in your request.

" } } - } + }, + "ValidationException":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{"shape":"ErrorCode"}, + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

Returned if the AWS Backup service is not available in the region that the request was made.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "VpcId":{"type":"string"} }, "documentation":"Amazon Elastic File System

Amazon Elastic File System (Amazon EFS) provides simple, scalable file storage for use with Amazon EC2 instances in the AWS Cloud. With Amazon EFS, storage capacity is elastic, growing and shrinking automatically as you add and remove files, so your applications have the storage they need, when they need it. For more information, see the User Guide.

" } diff --git a/botocore/data/elasticache/2015-02-02/service-2.json b/botocore/data/elasticache/2015-02-02/service-2.json index b59c29bf..9f59d846 100644 --- a/botocore/data/elasticache/2015-02-02/service-2.json +++ b/botocore/data/elasticache/2015-02-02/service-2.json @@ -260,7 +260,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global Datastore.

A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).

When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. You cannot alter a Redis (cluster mode enabled) replication group after it has been created. However, if you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' enhanced backup and restore. For more information, see Restoring From a Backup with Cluster Resizing in the ElastiCache User Guide.

This operation is valid for Redis only.

" + "documentation":"

Creates a Redis (cluster mode disabled) or a Redis (cluster mode enabled) replication group.

This API can be used to create a standalone regional replication group or a secondary replication group associated with a Global Datastore.

A Redis (cluster mode disabled) replication group is a collection of clusters, where one of the clusters is a read/write primary and the others are read-only replicas. Writes to the primary are asynchronously propagated to the replicas.

A Redis (cluster mode enabled) replication group is a collection of 1 to 90 node groups (shards). Each node group (shard) has one read/write primary node and up to 5 read-only replica nodes. Writes to the primary are asynchronously propagated to the replicas. Redis (cluster mode enabled) replication groups partition the data across node groups (shards).

When a Redis (cluster mode disabled) replication group has been successfully created, you can add one or more read replicas to it, up to a total of 5 read replicas. If you need to increase or decrease the number of node groups (console: shards), you can avail yourself of ElastiCache for Redis' scaling. For more information, see Scaling ElastiCache for Redis Clusters in the ElastiCache User Guide.

This operation is valid for Redis only.

" }, "CreateSnapshot":{ "name":"CreateSnapshot", @@ -1129,7 +1129,7 @@ {"shape":"InvalidParameterValueException"}, {"shape":"InvalidParameterCombinationException"} ], - "documentation":"

Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

Note the following

  • A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period.

  • If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

  • If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.

  • To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:

    1. Replication group message: Test Failover API called for node group <node-group-id>

    2. Cache cluster message: Failover from master node <primary-node-id> to replica node <node-id> completed

    3. Replication group message: Failover from master node <primary-node-id> to replica node <node-id> completed

    4. Cache cluster message: Recovering cache nodes <node-id>

    5. Cache cluster message: Finished recovery for cache nodes <node-id>

    For more information see:

Also see, Testing Multi-AZ with Automatic Failover in the ElastiCache User Guide.

" + "documentation":"

Represents the input of a TestFailover operation which test automatic failover on a specified node group (called shard in the console) in a replication group (called cluster in the console).

Note the following

  • A customer can use this operation to test automatic failover on up to 5 shards (called node groups in the ElastiCache API and AWS CLI) in any rolling 24-hour period.

  • If calling this operation on shards in different clusters (called replication groups in the API and CLI), the calls can be made concurrently.

  • If calling this operation multiple times on different shards in the same Redis (cluster mode enabled) replication group, the first node replacement must complete before a subsequent call can be made.

  • To determine whether the node replacement is complete you can check Events using the Amazon ElastiCache console, the AWS CLI, or the ElastiCache API. Look for the following automatic failover related events, listed here in order of occurrance:

    1. Replication group message: Test Failover API called for node group <node-group-id>

    2. Cache cluster message: Failover from master node <primary-node-id> to replica node <node-id> completed

    3. Replication group message: Failover from master node <primary-node-id> to replica node <node-id> completed

    4. Cache cluster message: Recovering cache nodes <node-id>

    5. Cache cluster message: Finished recovery for cache nodes <node-id>

    For more information see:

Also see, Testing Multi-AZ in the ElastiCache User Guide.

" } }, "shapes":{ @@ -2104,7 +2104,7 @@ }, "NewReplicaCount":{ "shape":"Integer", - "documentation":"

The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with.

The minimum number of replicas in a shard or replication group is:

  • Redis (cluster mode disabled)

    • If Multi-AZ with Automatic Failover is enabled: 1

    • If Multi-AZ with Automatic Failover is not enable: 0

  • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

" + "documentation":"

The number of replicas you want in this node group at the end of this operation. The maximum value for NewReplicaCount is 5. The minimum value depends upon the type of Redis replication group you are working with.

The minimum number of replicas in a shard or replication group is:

  • Redis (cluster mode disabled)

    • If Multi-AZ: 1

    • If Multi-AZ: 0

  • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

" }, "PreferredAvailabilityZones":{ "shape":"PreferredAvailabilityZoneList", @@ -2384,7 +2384,7 @@ }, "AutomaticFailoverEnabled":{ "shape":"BooleanOptional", - "documentation":"

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled): T1 node types.

  • Redis (cluster mode enabled): T1 node types.

" + "documentation":"

Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails.

AutomaticFailoverEnabled must be enabled for Redis (cluster mode enabled) replication groups.

Default: false

" }, "MultiAZEnabled":{ "shape":"BooleanOptional", @@ -2595,7 +2595,7 @@ }, "NewReplicaCount":{ "shape":"IntegerOptional", - "documentation":"

The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

The minimum number of replicas in a shard or replication group is:

  • Redis (cluster mode disabled)

    • If Multi-AZ with Automatic Failover is enabled: 1

    • If Multi-AZ with Automatic Failover is not enabled: 0

  • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

" + "documentation":"

The number of read replica nodes you want at the completion of this operation. For Redis (cluster mode disabled) replication groups, this is the number of replica nodes in the replication group. For Redis (cluster mode enabled) replication groups, this is the number of replica nodes in each of the replication group's node groups.

The minimum number of replicas in a shard or replication group is:

  • Redis (cluster mode disabled)

    • If Multi-AZ is enabled: 1

    • If Multi-AZ is not enabled: 0

  • Redis (cluster mode enabled): 0 (though you will not be able to failover to a replica if your primary node fails)

" }, "ReplicaConfiguration":{ "shape":"ReplicaConfigurationList", @@ -3947,7 +3947,7 @@ }, "AutomaticFailoverEnabled":{ "shape":"BooleanOptional", - "documentation":"

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled): T1 node types.

  • Redis (cluster mode enabled): T1 node types.

" + "documentation":"

Determines whether a read replica is automatically promoted to read/write primary if the existing primary encounters a failure.

Valid values: true | false

" }, "MultiAZEnabled":{ "shape":"BooleanOptional", @@ -4725,7 +4725,7 @@ }, "AutomaticFailover":{ "shape":"AutomaticFailoverStatus", - "documentation":"

Indicates the status of Multi-AZ with automatic failover for this Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled): T1 node types.

  • Redis (cluster mode enabled): T1 node types.

" + "documentation":"

Indicates the status of automatic failover for this Redis replication group.

" }, "MultiAZ":{ "shape":"MultiAZStatus", @@ -4862,7 +4862,7 @@ }, "AutomaticFailoverStatus":{ "shape":"PendingAutomaticFailoverStatus", - "documentation":"

Indicates the status of Multi-AZ with automatic failover for this Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled): T1 node types.

  • Redis (cluster mode enabled): T1 node types.

" + "documentation":"

Indicates the status of automatic failover for this Redis replication group.

" }, "Resharding":{ "shape":"ReshardingStatus", @@ -5402,7 +5402,7 @@ }, "AutomaticFailover":{ "shape":"AutomaticFailoverStatus", - "documentation":"

Indicates the status of Multi-AZ with automatic failover for the source Redis replication group.

Amazon ElastiCache for Redis does not support Multi-AZ with automatic failover on:

  • Redis versions earlier than 2.8.6.

  • Redis (cluster mode disabled): T1 node types.

  • Redis (cluster mode enabled): T1 node types.

" + "documentation":"

Indicates the status of automatic failover for the source Redis replication group.

" }, "NodeSnapshots":{ "shape":"NodeSnapshotList", diff --git a/botocore/data/emr/2009-03-31/service-2.json b/botocore/data/emr/2009-03-31/service-2.json index 7201f2b9..1b4bdd19 100644 --- a/botocore/data/emr/2009-03-31/service-2.json +++ b/botocore/data/emr/2009-03-31/service-2.json @@ -1769,14 +1769,17 @@ }, "InstanceFleetProvisioningSpecifications":{ "type":"structure", - "required":["SpotSpecification"], "members":{ "SpotSpecification":{ "shape":"SpotProvisioningSpecification", - "documentation":"

The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior.

" + "documentation":"

The launch specification for Spot instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.

" + }, + "OnDemandSpecification":{ + "shape":"OnDemandProvisioningSpecification", + "documentation":"

The launch specification for On-Demand instances in the instance fleet, which determines the allocation strategy.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. On-Demand instances allocation strategy is available in Amazon EMR version 5.12.1 and later.

" } }, - "documentation":"

The launch specification for Spot instances in the fleet, which determines the defined duration and provisioning timeout behavior.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + "documentation":"

The launch specification for Spot instances in the fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. On-Demand and Spot instance allocation strategies are available in Amazon EMR version 5.12.1 and later.

" }, "InstanceFleetState":{ "type":"string", @@ -3044,6 +3047,21 @@ "type":"double", "min":0.0 }, + "OnDemandProvisioningAllocationStrategy":{ + "type":"string", + "enum":["lowest-price"] + }, + "OnDemandProvisioningSpecification":{ + "type":"structure", + "required":["AllocationStrategy"], + "members":{ + "AllocationStrategy":{ + "shape":"OnDemandProvisioningAllocationStrategy", + "documentation":"

Specifies the strategy to use in launching On-Demand instance fleets. Currently, the only option is lowest-price (the default), which launches the lowest price first.

" + } + }, + "documentation":"

The launch specification for On-Demand instances in the instance fleet, which determines the allocation strategy.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. On-Demand instances allocation strategy is available in Amazon EMR version 5.12.1 and later.

" + }, "OptionalArnType":{ "type":"string", "max":2048, @@ -3552,6 +3570,10 @@ }, "documentation":"

An automatic scaling configuration, which describes how the policy adds or removes instances, the cooldown period, and the number of EC2 instances that will be added each time the CloudWatch metric alarm condition is satisfied.

" }, + "SpotProvisioningAllocationStrategy":{ + "type":"string", + "enum":["capacity-optimized"] + }, "SpotProvisioningSpecification":{ "type":"structure", "required":[ @@ -3570,9 +3592,13 @@ "BlockDurationMinutes":{ "shape":"WholeNumber", "documentation":"

The defined duration for Spot instances (also known as Spot blocks) in minutes. When specified, the Spot instance does not terminate before the defined duration expires, and defined duration pricing for Spot instances applies. Valid values are 60, 120, 180, 240, 300, or 360. The duration period starts as soon as a Spot instance receives its instance ID. At the end of the duration, Amazon EC2 marks the Spot instance for termination and provides a Spot instance termination notice, which gives the instance a two-minute warning before it terminates.

" + }, + "AllocationStrategy":{ + "shape":"SpotProvisioningAllocationStrategy", + "documentation":"

Specifies the strategy to use in launching Spot instance fleets. Currently, the only option is capacity-optimized (the default), which launches instances from Spot instance pools with optimal capacity for the number of instances that are launching.

" } }, - "documentation":"

The launch specification for Spot instances in the instance fleet, which determines the defined duration and provisioning timeout behavior.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions.

" + "documentation":"

The launch specification for Spot instances in the instance fleet, which determines the defined duration, provisioning timeout behavior, and allocation strategy.

The instance fleet configuration is available only in Amazon EMR versions 4.8.0 and later, excluding 5.0.x versions. Spot instance allocation strategy is available in Amazon EMR version 5.12.1 and later.

" }, "SpotProvisioningTimeoutAction":{ "type":"string", diff --git a/botocore/data/endpoints.json b/botocore/data/endpoints.json index fd515dc5..d4db2da4 100644 --- a/botocore/data/endpoints.json +++ b/botocore/data/endpoints.json @@ -554,6 +554,7 @@ "endpoints" : { "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "eu-central-1" : { }, @@ -575,11 +576,16 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ca-central-1" : { }, "eu-central-1" : { }, + "eu-north-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, + "eu-west-3" : { }, + "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, + "us-west-1" : { }, "us-west-2" : { } } }, @@ -2444,6 +2450,7 @@ "protocols" : [ "https" ] }, "endpoints" : { + "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, "ap-south-1" : { }, @@ -2545,6 +2552,7 @@ }, "hostname" : "fms-fips.us-west-2.amazonaws.com" }, + "me-south-1" : { }, "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, @@ -2804,6 +2812,11 @@ "us-east-1" : { } } }, + "honeycode" : { + "endpoints" : { + "us-west-2" : { } + } + }, "iam" : { "endpoints" : { "aws-global" : { @@ -3367,6 +3380,51 @@ "us-west-2" : { } } }, + "macie2" : { + "endpoints" : { + "ap-east-1" : { }, + "ap-northeast-1" : { }, + "ap-northeast-2" : { }, + "ap-south-1" : { }, + "ap-southeast-1" : { }, + "ap-southeast-2" : { }, + "ca-central-1" : { }, + "eu-central-1" : { }, + "eu-north-1" : { }, + "eu-west-1" : { }, + "eu-west-2" : { }, + "eu-west-3" : { }, + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "macie2-fips.us-east-1.amazonaws.com" + }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "macie2-fips.us-east-2.amazonaws.com" + }, + "fips-us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "macie2-fips.us-west-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "macie2-fips.us-west-2.amazonaws.com" + }, + "sa-east-1" : { }, + "us-east-1" : { }, + "us-east-2" : { }, + "us-west-1" : { }, + "us-west-2" : { } + } + }, "managedblockchain" : { "endpoints" : { "ap-northeast-1" : { }, @@ -3550,6 +3608,7 @@ } }, "endpoints" : { + "ap-northeast-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "eu-central-1" : { }, @@ -3751,6 +3810,12 @@ }, "hostname" : "rds.us-east-2.amazonaws.com" }, + "us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "rds.us-west-1.amazonaws.com" + }, "us-west-2" : { "credentialScope" : { "region" : "us-west-2" @@ -3869,9 +3934,11 @@ }, "outposts" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, + "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "ca-central-1" : { }, @@ -3911,6 +3978,7 @@ "hostname" : "outposts-fips.us-west-2.amazonaws.com" }, "me-south-1" : { }, + "sa-east-1" : { }, "us-east-1" : { }, "us-east-2" : { }, "us-west-1" : { }, @@ -4084,6 +4152,7 @@ }, "ram" : { "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -4093,6 +4162,7 @@ "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -4224,6 +4294,30 @@ "eu-central-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, + "rekognition-fips.us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "hostname" : "rekognition-fips.us-east-1.amazonaws.com" + }, + "rekognition-fips.us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "hostname" : "rekognition-fips.us-east-2.amazonaws.com" + }, + "rekognition-fips.us-west-1" : { + "credentialScope" : { + "region" : "us-west-1" + }, + "hostname" : "rekognition-fips.us-west-1.amazonaws.com" + }, + "rekognition-fips.us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "hostname" : "rekognition-fips.us-west-2.amazonaws.com" + }, "us-east-1" : { }, "us-east-2" : { }, "us-west-1" : { }, @@ -4311,6 +4405,7 @@ "protocols" : [ "https" ] }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -4320,6 +4415,7 @@ "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -4338,6 +4434,7 @@ } }, "endpoints" : { + "ap-northeast-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, "eu-central-1" : { }, @@ -6074,6 +6171,18 @@ "isRegionalized" : false, "partitionEndpoint" : "aws-cn-global" }, + "ce" : { + "endpoints" : { + "aws-cn-global" : { + "credentialScope" : { + "region" : "cn-northwest-1" + }, + "hostname" : "ce.cn-northwest-1.amazonaws.com.cn" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-cn-global" + }, "cloudformation" : { "endpoints" : { "cn-north-1" : { }, @@ -6397,6 +6506,24 @@ } } }, + "organizations" : { + "endpoints" : { + "aws-cn-global" : { + "credentialScope" : { + "region" : "cn-northwest-1" + }, + "hostname" : "organizations.cn-northwest-1.amazonaws.com.cn" + }, + "fips-aws-cn-global" : { + "credentialScope" : { + "region" : "cn-northwest-1" + }, + "hostname" : "organizations.cn-northwest-1.amazonaws.com.cn" + } + }, + "isRegionalized" : false, + "partitionEndpoint" : "aws-cn-global" + }, "polly" : { "endpoints" : { "cn-northwest-1" : { } @@ -6492,11 +6619,18 @@ "snowball" : { "endpoints" : { "cn-north-1" : { }, + "cn-northwest-1" : { }, "fips-cn-north-1" : { "credentialScope" : { "region" : "cn-north-1" }, "hostname" : "snowball-fips.cn-north-1.amazonaws.com.cn" + }, + "fips-cn-northwest-1" : { + "credentialScope" : { + "region" : "cn-northwest-1" + }, + "hostname" : "snowball-fips.cn-northwest-1.amazonaws.com.cn" } } }, @@ -6775,6 +6909,12 @@ "us-gov-west-1" : { } } }, + "backup" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, "batch" : { "endpoints" : { "fips-us-gov-east-1" : { @@ -6937,6 +7077,12 @@ }, "comprehendmedical" : { "endpoints" : { + "fips-us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "comprehendmedical-fips.us-gov-west-1.amazonaws.com" + }, "us-gov-west-1" : { } } }, @@ -7003,6 +7149,16 @@ "us-gov-west-1" : { } } }, + "docdb" : { + "endpoints" : { + "us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "rds.us-gov-west-1.amazonaws.com" + } + } + }, "ds" : { "endpoints" : { "fips-us-gov-east-1" : { @@ -7369,6 +7525,12 @@ "us-gov-west-1" : { } } }, + "kinesisanalytics" : { + "endpoints" : { + "us-gov-east-1" : { }, + "us-gov-west-1" : { } + } + }, "kms" : { "endpoints" : { "ProdFips" : { @@ -7585,6 +7747,12 @@ }, "rekognition" : { "endpoints" : { + "rekognition-fips.us-gov-west-1" : { + "credentialScope" : { + "region" : "us-gov-west-1" + }, + "hostname" : "rekognition-fips.us-gov-west-1.amazonaws.com" + }, "us-gov-west-1" : { } } }, diff --git a/botocore/data/events/2015-10-07/service-2.json b/botocore/data/events/2015-10-07/service-2.json index 0b9fa715..340fee80 100644 --- a/botocore/data/events/2015-10-07/service-2.json +++ b/botocore/data/events/2015-10-07/service-2.json @@ -23,7 +23,8 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ConcurrentModificationException"}, {"shape":"InvalidStateException"}, - {"shape":"InternalException"} + {"shape":"InternalException"}, + {"shape":"OperationDisabledException"} ], "documentation":"

Activates a partner event source that has been deactivated. Once activated, your matching event bus will start receiving events from the event source.

" }, @@ -41,7 +42,8 @@ {"shape":"InvalidStateException"}, {"shape":"InternalException"}, {"shape":"ConcurrentModificationException"}, - {"shape":"LimitExceededException"} + {"shape":"LimitExceededException"}, + {"shape":"OperationDisabledException"} ], "documentation":"

Creates a new event bus within your account. This can be a custom event bus which you can use to receive events from your custom applications and services, or it can be a partner event bus which can be matched to a partner event source.

" }, @@ -57,7 +59,8 @@ {"shape":"ResourceAlreadyExistsException"}, {"shape":"InternalException"}, {"shape":"ConcurrentModificationException"}, - {"shape":"LimitExceededException"} + {"shape":"LimitExceededException"}, + {"shape":"OperationDisabledException"} ], "documentation":"

Called by an SaaS partner to create a partner event source. This operation is not used by AWS customers.

Each partner event source can be used by one AWS account to create a matching partner event bus in that AWS account. A SaaS partner must create one partner event source for each AWS account that wants to receive those event types.

A partner event source creates events based on resources within the SaaS partner's service or application.

An AWS account that creates a partner event bus that matches the partner event source can use that event bus to receive events from the partner, and then process them using AWS Events rules and targets.

Partner event source names follow this format:

partner_name/event_namespace/event_name

partner_name is determined during partner registration and identifies the partner to AWS customers. event_namespace is determined by the partner and is a way for the partner to categorize their events. event_name is determined by the partner, and should uniquely identify an event-generating resource within the partner system. The combination of event_namespace and event_name should help AWS customers decide whether to create an event bus to receive these events.

" }, @@ -72,7 +75,8 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ConcurrentModificationException"}, {"shape":"InvalidStateException"}, - {"shape":"InternalException"} + {"shape":"InternalException"}, + {"shape":"OperationDisabledException"} ], "documentation":"

You can use this operation to temporarily stop receiving events from the specified partner event source. The matching event bus is not deleted.

When you deactivate a partner event source, the source goes into PENDING state. If it remains in PENDING state for more than two weeks, it is deleted.

To activate a deactivated partner event source, use ActivateEventSource.

" }, @@ -98,7 +102,8 @@ "input":{"shape":"DeletePartnerEventSourceRequest"}, "errors":[ {"shape":"InternalException"}, - {"shape":"ConcurrentModificationException"} + {"shape":"ConcurrentModificationException"}, + {"shape":"OperationDisabledException"} ], "documentation":"

This operation is used by SaaS partners to delete a partner event source. This operation is not used by AWS customers.

When you delete an event source, the status of the corresponding partner event bus in the AWS customer account becomes DELETED.

" }, @@ -141,7 +146,8 @@ "output":{"shape":"DescribeEventSourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, - {"shape":"InternalException"} + {"shape":"InternalException"}, + {"shape":"OperationDisabledException"} ], "documentation":"

This operation lists details about a partner event source that is shared with your account.

" }, @@ -155,7 +161,8 @@ "output":{"shape":"DescribePartnerEventSourceResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, - {"shape":"InternalException"} + {"shape":"InternalException"}, + {"shape":"OperationDisabledException"} ], "documentation":"

An SaaS partner can use this operation to list details about a partner event source that they have created. AWS customers do not use this operation. Instead, AWS customers can use DescribeEventSource to see details about a partner event source that is shared with them.

" }, @@ -225,7 +232,8 @@ "input":{"shape":"ListEventSourcesRequest"}, "output":{"shape":"ListEventSourcesResponse"}, "errors":[ - {"shape":"InternalException"} + {"shape":"InternalException"}, + {"shape":"OperationDisabledException"} ], "documentation":"

You can use this to see all the partner event sources that have been shared with your AWS account. For more information about partner event sources, see CreateEventBus.

" }, @@ -239,7 +247,8 @@ "output":{"shape":"ListPartnerEventSourceAccountsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, - {"shape":"InternalException"} + {"shape":"InternalException"}, + {"shape":"OperationDisabledException"} ], "documentation":"

An SaaS partner can use this operation to display the AWS account ID that a particular partner event source name is associated with. This operation is not used by AWS customers.

" }, @@ -252,7 +261,8 @@ "input":{"shape":"ListPartnerEventSourcesRequest"}, "output":{"shape":"ListPartnerEventSourcesResponse"}, "errors":[ - {"shape":"InternalException"} + {"shape":"InternalException"}, + {"shape":"OperationDisabledException"} ], "documentation":"

An SaaS partner can use this operation to list all the partner event source names that they have created. This operation is not used by AWS customers.

" }, @@ -334,7 +344,8 @@ "input":{"shape":"PutPartnerEventsRequest"}, "output":{"shape":"PutPartnerEventsResponse"}, "errors":[ - {"shape":"InternalException"} + {"shape":"InternalException"}, + {"shape":"OperationDisabledException"} ], "documentation":"

This is used by SaaS partners to write events to a customer's partner event bus. AWS customers do not use this operation.

" }, @@ -351,7 +362,7 @@ {"shape":"InternalException"}, {"shape":"ConcurrentModificationException"} ], - "documentation":"

Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus. CloudWatch Events rules in your account are triggered by these events arriving to an event bus in your account.

For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.

To enable multiple AWS accounts to put events to your event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as \"*\" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization.

If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.

The permission policy on the default event bus cannot exceed 10 KB in size.

" + "documentation":"

Running PutPermission permits the specified AWS account or AWS organization to put events to the specified event bus. Amazon EventBridge (CloudWatch Events) rules in your account are triggered by these events arriving to an event bus in your account.

For another account to send events to your account, that external account must have an EventBridge rule with your account's event bus as a target.

To enable multiple AWS accounts to put events to your event bus, run PutPermission once for each of these accounts. Or, if all the accounts are members of the same AWS organization, you can run PutPermission once specifying Principal as \"*\" and specifying the AWS organization ID in Condition, to grant permissions to all accounts in that organization.

If you grant permissions using an organization, then accounts in that organization must specify a RoleArn with proper permissions when they use PutTarget to add your account's event bus as a target. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.

The permission policy on the default event bus cannot exceed 10 KB in size.

" }, "PutRule":{ "name":"PutRule", @@ -386,7 +397,7 @@ {"shape":"ManagedRuleException"}, {"shape":"InternalException"} ], - "documentation":"

Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

Targets are the resources that are invoked when a rule is triggered.

You can configure the following as targets for Events:

  • EC2 instances

  • SSM Run Command

  • SSM Automation

  • AWS Lambda functions

  • Data streams in Amazon Kinesis Data Streams

  • Data delivery streams in Amazon Kinesis Data Firehose

  • Amazon ECS tasks

  • AWS Step Functions state machines

  • AWS Batch jobs

  • AWS CodeBuild projects

  • Pipelines in AWS CodePipeline

  • Amazon Inspector assessment templates

  • Amazon SNS topics

  • Amazon SQS queues, including FIFO queues

  • The default event bus of another AWS account

Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call.

For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.

To be able to make API calls against the resources that you own, Amazon CloudWatch Events needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, and AWS Step Functions state machines, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide.

If another AWS account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon CloudWatch Pricing.

Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different AWS account.

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.

For more information about enabling cross-account events, see PutPermission.

Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:

  • If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).

  • If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.

  • If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).

  • If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation.

When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.

This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

" + "documentation":"

Adds the specified targets to the specified rule, or updates the targets if they are already associated with the rule.

Targets are the resources that are invoked when a rule is triggered.

You can configure the following as targets for Events:

  • EC2 instances

  • SSM Run Command

  • SSM Automation

  • AWS Lambda functions

  • Data streams in Amazon Kinesis Data Streams

  • Data delivery streams in Amazon Kinesis Data Firehose

  • Amazon ECS tasks

  • AWS Step Functions state machines

  • AWS Batch jobs

  • AWS CodeBuild projects

  • Pipelines in AWS CodePipeline

  • Amazon Inspector assessment templates

  • Amazon SNS topics

  • Amazon SQS queues, including FIFO queues

  • The default event bus of another AWS account

  • Amazon API Gateway REST APIs

Creating rules with built-in targets is supported only in the AWS Management Console. The built-in targets are EC2 CreateSnapshot API call, EC2 RebootInstances API call, EC2 StopInstances API call, and EC2 TerminateInstances API call.

For some target types, PutTargets provides target-specific parameters. If the target is a Kinesis data stream, you can optionally specify which shard the event goes to by using the KinesisParameters argument. To invoke a command on multiple EC2 instances with one rule, you can use the RunCommandParameters field.

To be able to make API calls against the resources that you own, Amazon EventBridge (CloudWatch Events) needs the appropriate permissions. For AWS Lambda and Amazon SNS resources, EventBridge relies on resource-based policies. For EC2 instances, Kinesis data streams, AWS Step Functions state machines and API Gateway REST APIs, EventBridge relies on IAM roles that you specify in the RoleARN argument in PutTargets. For more information, see Authentication and Access Control in the Amazon EventBridge User Guide.

If another AWS account is in the same region and has granted you permission (using PutPermission), you can send events to that account. Set that account's event bus as a target of the rules in your account. To send the matched events to the other account, specify that account's event bus as the Arn value when you run PutTargets. If your account sends events to another account, your account is charged for each sent event. Each event sent to another account is charged as a custom event. The account receiving the event is not charged. For more information, see Amazon EventBridge (CloudWatch Events) Pricing.

Input, InputPath, and InputTransformer are not available with PutTarget if the target is an event bus of a different AWS account.

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.

For more information about enabling cross-account events, see PutPermission.

Input, InputPath, and InputTransformer are mutually exclusive and optional parameters of a target. When a rule is triggered due to a matched event:

  • If none of the following arguments are specified for a target, then the entire event is passed to the target in JSON format (unless the target is Amazon EC2 Run Command or Amazon ECS task, in which case nothing from the event is passed to the target).

  • If Input is specified in the form of valid JSON, then the matched event is overridden with this constant.

  • If InputPath is specified in the form of JSONPath (for example, $.detail), then only the part of the event specified in the path is passed to the target (for example, only the detail part of the event is passed).

  • If InputTransformer is specified, then one or more specified JSONPaths are extracted from the event and used as values in a template that you specify as the input to the target.

When you specify InputPath or InputTransformer, you must use JSON dot notation, not bracket notation.

When you add targets to a rule and the associated rule triggers soon after, new or updated targets might not be immediately invoked. Allow a short period of time for changes to take effect.

This action can partially fail if too many requests are made at the same time. If that happens, FailedEntryCount is non-zero in the response and each entry in FailedEntries provides the ID of the failed target and the error code.

" }, "RemovePermission":{ "name":"RemovePermission", @@ -462,7 +473,7 @@ {"shape":"ConcurrentModificationException"}, {"shape":"ManagedRuleException"} ], - "documentation":"

Removes one or more tags from the specified EventBridge resource. In CloudWatch Events, rules and event buses can be tagged.

" + "documentation":"

Removes one or more tags from the specified EventBridge resource. In Amazon EventBridge (CloudWatch Events, rules and event buses can be tagged.

" } }, "shapes":{ @@ -998,6 +1009,39 @@ ] }, "EventTime":{"type":"timestamp"}, + "HeaderKey":{ + "type":"string", + "max":512, + "pattern":"^[!#$%&'*+-.^_`|~0-9a-zA-Z]+$" + }, + "HeaderParametersMap":{ + "type":"map", + "key":{"shape":"HeaderKey"}, + "value":{"shape":"HeaderValue"} + }, + "HeaderValue":{ + "type":"string", + "max":512, + "pattern":"^[ \\t]*[\\x20-\\x7E]+([ \\t]+[\\x20-\\x7E]+)*[ \\t]*$" + }, + "HttpParameters":{ + "type":"structure", + "members":{ + "PathParameterValues":{ + "shape":"PathParameterList", + "documentation":"

The path parameter values to be used to populate API Gateway REST API path wildcards (\"*\").

" + }, + "HeaderParameters":{ + "shape":"HeaderParametersMap", + "documentation":"

The headers that need to be sent as part of request invoking the API Gateway REST API.

" + }, + "QueryStringParameters":{ + "shape":"QueryStringParametersMap", + "documentation":"

The query string keys/values that need to be sent as part of request invoking the API Gateway REST API.

" + } + }, + "documentation":"

These are custom parameter to be used when the target is an API Gateway REST APIs.

" + }, "InputTransformer":{ "type":"structure", "required":["InputTemplate"], @@ -1355,6 +1399,13 @@ "min":1, "pattern":"[\\.\\-_A-Za-z0-9]+" }, + "OperationDisabledException":{ + "type":"structure", + "members":{ + }, + "documentation":"

The operation you are attempting is not available in this region.

", + "exception":true + }, "PartnerEventSource":{ "type":"structure", "members":{ @@ -1405,6 +1456,14 @@ "min":1, "pattern":"aws\\.partner/[\\.\\-_A-Za-z0-9]+/[/\\.\\-_A-Za-z0-9]*" }, + "PathParameter":{ + "type":"string", + "pattern":"^(?!\\s*$).+" + }, + "PathParameterList":{ + "type":"list", + "member":{"shape":"PathParameter"} + }, "PolicyLengthExceededException":{ "type":"structure", "members":{ @@ -1709,6 +1768,21 @@ "type":"list", "member":{"shape":"PutTargetsResultEntry"} }, + "QueryStringKey":{ + "type":"string", + "max":512, + "pattern":"[^\\x00-\\x1F\\x7F]+" + }, + "QueryStringParametersMap":{ + "type":"map", + "key":{"shape":"QueryStringKey"}, + "value":{"shape":"QueryStringValue"} + }, + "QueryStringValue":{ + "type":"string", + "max":512, + "pattern":"[^\\x00-\\x09\\x0B\\x0C\\x0E-\\x1F\\x7F]+" + }, "RemovePermissionRequest":{ "type":"structure", "required":["StatementId"], @@ -2059,6 +2133,10 @@ "SqsParameters":{ "shape":"SqsParameters", "documentation":"

Contains the message group ID to use when the target is a FIFO queue.

If you specify an SQS FIFO queue as a target, the queue must have content-based deduplication enabled.

" + }, + "HttpParameters":{ + "shape":"HttpParameters", + "documentation":"

Contains the HTTP parameters to use when the target is a API Gateway REST endpoint.

If you specify an API Gateway REST API as a target, you can use this parameter to specify headers, path parameter, query string keys/values as part of your target invoking request.

" } }, "documentation":"

Targets are the resources to be invoked when a rule is triggered. For a complete list of services and resources that can be set as a target, see PutTargets.

If you are setting the event bus of another account as the target, and that account granted permission to your account through an organization instead of directly by the account ID, then you must specify a RoleArn with proper permissions in the Target structure. For more information, see Sending and Receiving Events Between AWS Accounts in the Amazon EventBridge User Guide.

" diff --git a/botocore/data/forecast/2018-06-26/service-2.json b/botocore/data/forecast/2018-06-26/service-2.json index 0290ea5e..9537a6b4 100644 --- a/botocore/data/forecast/2018-06-26/service-2.json +++ b/botocore/data/forecast/2018-06-26/service-2.json @@ -26,7 +26,7 @@ {"shape":"ResourceAlreadyExistsException"}, {"shape":"LimitExceededException"} ], - "documentation":"

Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:

  • DataFrequency - How frequently your historical time-series data is collected.

  • Domain and DatasetType - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields.

  • Schema - A schema specifies the fields in the dataset, including the field name and data type.

After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see howitworks-datasets-groups.

To get a list of all your datasets, use the ListDatasets operation.

For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.

The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to get the status.

" + "documentation":"

Creates an Amazon Forecast dataset. The information about the dataset that you provide helps Forecast understand how to consume the data for model training. This includes the following:

  • DataFrequency - How frequently your historical time-series data is collected.

  • Domain and DatasetType - Each dataset has an associated dataset domain and a type within the domain. Amazon Forecast provides a list of predefined domains and types within each domain. For each unique dataset domain and type within the domain, Amazon Forecast requires your data to include a minimum set of predefined fields.

  • Schema - A schema specifies the fields in the dataset, including the field name and data type.

After creating a dataset, you import your training data into it and add the dataset to a dataset group. You use the dataset group to create a predictor. For more information, see howitworks-datasets-groups.

To get a list of all your datasets, use the ListDatasets operation.

For example Forecast datasets, see the Amazon Forecast Sample GitHub repository.

The Status of a dataset must be ACTIVE before you can import training data. Use the DescribeDataset operation to get the status.

" }, "CreateDatasetGroup":{ "name":"CreateDatasetGroup", @@ -60,7 +60,7 @@ {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], - "documentation":"

Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.

You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data. For more information, see aws-forecast-iam-roles.

The training data must be in CSV format. The delimiter must be a comma (,).

You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.

To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.

" + "documentation":"

Imports your training data to an Amazon Forecast dataset. You provide the location of your training data in an Amazon Simple Storage Service (Amazon S3) bucket and the Amazon Resource Name (ARN) of the dataset that you want to import the data to.

You must specify a DataSource object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the data, as Amazon Forecast makes a copy of your data and processes it in an internal AWS system. For more information, see aws-forecast-iam-roles.

The training data must be in CSV format. The delimiter must be a comma (,).

You can specify the path to a specific CSV file, the S3 bucket, or to a folder in the S3 bucket. For the latter two cases, Amazon Forecast imports all files up to the limit of 10,000 files.

Because dataset imports are not aggregated, your most recent dataset import is the one that is used when training a predictor or generating a forecast. Make sure that your most recent dataset import contains all of the data you want to model off of, and not just the new data collected since the previous import.

To get a list of all your dataset import jobs, filtered by specified criteria, use the ListDatasetImportJobs operation.

" }, "CreateForecast":{ "name":"CreateForecast", @@ -77,7 +77,7 @@ {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], - "documentation":"

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictor request, multiplied by the DataFrequency value, which you specify in the CreateDataset request. When you query a forecast, you can request a specific date range within the forecast.

To get a list of all your forecasts, use the ListForecasts operation.

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.

For more information, see howitworks-forecast.

The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status.

" + "documentation":"

Creates a forecast for each item in the TARGET_TIME_SERIES dataset that was used to train the predictor. This is known as inference. To retrieve the forecast for a single item at low latency, use the operation. To export the complete forecast into your Amazon Simple Storage Service (Amazon S3) bucket, use the CreateForecastExportJob operation.

The range of the forecast is determined by the ForecastHorizon value, which you specify in the CreatePredictor request. When you query a forecast, you can request a specific date range within the forecast.

To get a list of all your forecasts, use the ListForecasts operation.

The forecasts generated by Amazon Forecast are in the same time zone as the dataset that was used to create the predictor.

For more information, see howitworks-forecast.

The Status of the forecast must be ACTIVE before you can query or export the forecast. Use the DescribeForecast operation to get the status.

" }, "CreateForecastExportJob":{ "name":"CreateForecastExportJob", @@ -94,7 +94,7 @@ {"shape":"ResourceInUseException"}, {"shape":"LimitExceededException"} ], - "documentation":"

Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

<ForecastExportJobName>_<ExportTimestamp>_<PageNumber>

where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

For more information, see howitworks-forecast.

To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.

The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.

" + "documentation":"

Exports a forecast created by the CreateForecast operation to your Amazon Simple Storage Service (Amazon S3) bucket. The forecast file name will match the following conventions:

<ForecastExportJobName>_<ExportTimestamp>_<PartNumber>

where the <ExportTimestamp> component is in Java SimpleDateFormat (yyyy-MM-ddTHH-mm-ssZ).

You must specify a DataDestination object that includes an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the Amazon S3 bucket. For more information, see aws-forecast-iam-roles.

For more information, see howitworks-forecast.

To get a list of all your forecast export jobs, use the ListForecastExportJobs operation.

The Status of the forecast export job must be ACTIVE before you can access the forecast in your Amazon S3 bucket. To get the status, use the DescribeForecastExportJob operation.

" }, "CreatePredictor":{ "name":"CreatePredictor", @@ -125,7 +125,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ResourceInUseException"} ], - "documentation":"

Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset operation.

", + "documentation":"

Deletes an Amazon Forecast dataset that was created using the CreateDataset operation. You can only delete datasets that have a status of ACTIVE or CREATE_FAILED. To get the status use the DescribeDataset operation.

Forecast does not automatically update any dataset groups that contain the deleted dataset. In order to update the dataset group, use the operation, omitting the deleted dataset's ARN.

", "idempotent":true }, "DeleteDatasetGroup":{ @@ -397,6 +397,49 @@ "documentation":"

Returns a list of predictors created using the CreatePredictor operation. For each predictor, this operation returns a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve the complete set of properties by using the ARN with the DescribePredictor operation. You can filter the list using an array of Filter objects.

", "idempotent":true }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Lists the tags for an Amazon Forecast resource.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"LimitExceededException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are also deleted.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidInputException"} + ], + "documentation":"

Deletes the specified tags from a resource.

" + }, "UpdateDatasetGroup":{ "name":"UpdateDatasetGroup", "http":{ @@ -509,6 +552,10 @@ "DatasetArns":{ "shape":"ArnList", "documentation":"

An array of Amazon Resource Names (ARNs) of the datasets that you want to include in the dataset group.

" + }, + "Tags":{ + "shape":"Tags", + "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.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8.

  • Maximum value length - 256 Unicode characters in UTF-8.

  • If 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: + - = . _ : / @.

  • Tag keys and values are case sensitive.

  • Do 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.

" } } }, @@ -544,6 +591,10 @@ "TimestampFormat":{ "shape":"TimestampFormat", "documentation":"

The format of timestamps in the dataset. The format that you specify depends on the DataFrequency specified when the dataset was created. The following formats are supported

  • \"yyyy-MM-dd\"

    For the following data frequencies: Y, M, W, and D

  • \"yyyy-MM-dd HH:mm:ss\"

    For the following data frequencies: H, 30min, 15min, and 1min; and optionally, for: Y, M, W, and D

If the format isn't specified, Amazon Forecast expects the format to be \"yyyy-MM-dd HH:mm:ss\".

" + }, + "Tags":{ + "shape":"Tags", + "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.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8.

  • Maximum value length - 256 Unicode characters in UTF-8.

  • If 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: + - = . _ : / @.

  • Tag keys and values are case sensitive.

  • Do 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.

" } } }, @@ -588,6 +639,10 @@ "EncryptionConfig":{ "shape":"EncryptionConfig", "documentation":"

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

" + }, + "Tags":{ + "shape":"Tags", + "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.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8.

  • Maximum value length - 256 Unicode characters in UTF-8.

  • If 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: + - = . _ : / @.

  • Tag keys and values are case sensitive.

  • Do 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.

" } } }, @@ -619,6 +674,10 @@ "Destination":{ "shape":"DataDestination", "documentation":"

The location where you want to save the forecast and an AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the location. The forecast must be exported to an Amazon S3 bucket.

If encryption is used, Destination must include an AWS Key Management Service (KMS) key. The IAM role must allow Amazon Forecast permission to access the key.

" + }, + "Tags":{ + "shape":"Tags", + "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.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8.

  • Maximum value length - 256 Unicode characters in UTF-8.

  • If 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: + - = . _ : / @.

  • Tag keys and values are case sensitive.

  • Do 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.

" } } }, @@ -648,7 +707,11 @@ }, "ForecastTypes":{ "shape":"ForecastTypes", - "documentation":"

The quantiles at which probabilistic forecasts are generated. You can specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast is different from the median (0.50) when the distribution is not symmetric (e.g. Beta, Negative Binomial). The default value is [\"0.1\", \"0.5\", \"0.9\"].

" + "documentation":"

The quantiles at which probabilistic forecasts are generated. You can currently specify up to 5 quantiles per forecast. Accepted values include 0.01 to 0.99 (increments of .01 only) and mean. The mean forecast is different from the median (0.50) when the distribution is not symmetric (for example, Beta and Negative Binomial). The default value is [\"0.1\", \"0.5\", \"0.9\"].

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The optional metadata that you apply to the forecast to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8.

  • Maximum value length - 256 Unicode characters in UTF-8.

  • If 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: + - = . _ : / @.

  • Tag keys and values are case sensitive.

  • Do 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.

" } } }, @@ -713,6 +776,10 @@ "EncryptionConfig":{ "shape":"EncryptionConfig", "documentation":"

An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

" + }, + "Tags":{ + "shape":"Tags", + "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.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8.

  • Maximum value length - 256 Unicode characters in UTF-8.

  • If 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: + - = . _ : / @.

  • Tag keys and values are case sensitive.

  • Do 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.

" } } }, @@ -1140,7 +1207,7 @@ }, "ForecastTypes":{ "shape":"ForecastTypes", - "documentation":"

The quantiles at which proababilistic forecasts were generated.

" + "documentation":"

The quantiles at which probabilistic forecasts were generated.

" }, "PredictorArn":{ "shape":"Arn", @@ -1332,7 +1399,7 @@ "members":{ "AttributeName":{ "shape":"Name", - "documentation":"

The name of the schema attribute that specifies the data field to be featurized. Only the target field of the TARGET_TIME_SERIES dataset type is supported. For example, for the RETAIL domain, the target is demand, and for the CUSTOM domain, the target is target_value.

" + "documentation":"

The name of the schema attribute that specifies the data field to be featurized. Amazon Forecast supports the target field of the TARGET_TIME_SERIES and the RELATED_TIME_SERIES datasets. For example, for the RETAIL domain, the target is demand, and for the CUSTOM domain, the target is target_value. For more information, see howitworks-missing-values.

" }, "FeaturizationPipeline":{ "shape":"FeaturizationPipeline", @@ -1355,10 +1422,10 @@ }, "Featurizations":{ "shape":"Featurizations", - "documentation":"

An array of featurization (transformation) information for the fields of a dataset. Only a single featurization is supported.

" + "documentation":"

An array of featurization (transformation) information for the fields of a dataset.

" } }, - "documentation":"

In a CreatePredictor operation, the specified algorithm trains a model using the specified dataset group. You can optionally tell the operation to modify data fields prior to training a model. These modifications are referred to as featurization.

You define featurization using the FeaturizationConfig object. You specify an array of transformations, one for each field that you want to featurize. You then include the FeaturizationConfig object in your CreatePredictor request. Amazon Forecast applies the featurization to the TARGET_TIME_SERIES dataset before model training.

You can create multiple featurization configurations. For example, you might call the CreatePredictor operation twice by specifying different featurization configurations.

" + "documentation":"

In a CreatePredictor operation, the specified algorithm trains a model using the specified dataset group. You can optionally tell the operation to modify data fields prior to training a model. These modifications are referred to as featurization.

You define featurization using the FeaturizationConfig object. You specify an array of transformations, one for each field that you want to featurize. You then include the FeaturizationConfig object in your CreatePredictor request. Amazon Forecast applies the featurization to the TARGET_TIME_SERIES and RELATED_TIME_SERIES datasets before model training.

You can create multiple featurization configurations. For example, you might call the CreatePredictor operation twice by specifying different featurization configurations.

" }, "FeaturizationMethod":{ "type":"structure", @@ -1370,10 +1437,10 @@ }, "FeaturizationMethodParameters":{ "shape":"FeaturizationMethodParameters", - "documentation":"

The method parameters (key-value pairs). Specify these parameters to override the default values. The following list shows the parameters and their valid values. Bold signifies the default value.

  • aggregation: sum, avg, first, min, max

  • frontfill: none

  • middlefill: zero, nan (not a number)

  • backfill: zero, nan

" + "documentation":"

The method parameters (key-value pairs), which are a map of override parameters. Specify these parameters to override the default values. Related Time Series attributes do not accept aggregation parameters.

The following list shows the parameters and their valid values for the \"filling\" featurization method for a Target Time Series dataset. Bold signifies the default value.

  • aggregation: sum, avg, first, min, max

  • frontfill: none

  • middlefill: zero, nan (not a number), value, median, mean, min, max

  • backfill: zero, nan, value, median, mean, min, max

The following list shows the parameters and their valid values for a Related Time Series featurization method (there are no defaults):

  • middlefill: zero, value, median, mean, min, max

  • backfill: zero, value, median, mean, min, max

  • futurefill: zero, value, median, mean, min, max

" } }, - "documentation":"

Provides information about the method that featurizes (transforms) a dataset field. The method is part of the FeaturizationPipeline of the Featurization object. If you don't specify FeaturizationMethodParameters, Amazon Forecast uses default parameters.

The following is an example of how you specify a FeaturizationMethod object.

{

\"FeaturizationMethodName\": \"filling\",

\"FeaturizationMethodParameters\": {\"aggregation\": \"avg\", \"backfill\": \"nan\"}

}

" + "documentation":"

Provides information about the method that featurizes (transforms) a dataset field. The method is part of the FeaturizationPipeline of the Featurization object.

The following is an example of how you specify a FeaturizationMethod object.

{

\"FeaturizationMethodName\": \"filling\",

\"FeaturizationMethodParameters\": {\"aggregation\": \"sum\", \"middlefill\": \"zero\", \"backfill\": \"zero\"}

}

" }, "FeaturizationMethodName":{ "type":"string", @@ -1395,7 +1462,7 @@ "Featurizations":{ "type":"list", "member":{"shape":"Featurization"}, - "max":1, + "max":50, "min":1 }, "FieldStatistics":{ @@ -1816,6 +1883,25 @@ } } }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "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.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{ + "shape":"Tags", + "documentation":"

The tags for the resource.

" + } + } + }, "MaxResults":{ "type":"integer", "max":100, @@ -2032,7 +2118,9 @@ }, "SchemaAttributes":{ "type":"list", - "member":{"shape":"SchemaAttribute"} + "member":{"shape":"SchemaAttribute"}, + "max":100, + "min":1 }, "Statistics":{ "type":"structure", @@ -2094,10 +2182,10 @@ }, "Value":{ "shape":"Value", - "documentation":"

One of the following 2 letter country codes:

  • \"AU\" - AUSTRALIA

  • \"DE\" - GERMANY

  • \"JP\" - JAPAN

  • \"US\" - UNITED_STATES

  • \"UK\" - UNITED_KINGDOM

" + "documentation":"

One of the following 2 letter country codes:

  • \"AR\" - ARGENTINA

  • \"AT\" - AUSTRIA

  • \"AU\" - AUSTRALIA

  • \"BE\" - BELGIUM

  • \"BR\" - BRAZIL

  • \"CA\" - CANADA

  • \"CN\" - CHINA

  • \"CZ\" - CZECH REPUBLIC

  • \"DK\" - DENMARK

  • \"EC\" - ECUADOR

  • \"FI\" - FINLAND

  • \"FR\" - FRANCE

  • \"DE\" - GERMANY

  • \"HU\" - HUNGARY

  • \"IE\" - IRELAND

  • \"IN\" - INDIA

  • \"IT\" - ITALY

  • \"JP\" - JAPAN

  • \"KR\" - KOREA

  • \"LU\" - LUXEMBOURG

  • \"MX\" - MEXICO

  • \"NL\" - NETHERLANDS

  • \"NO\" - NORWAY

  • \"PL\" - POLAND

  • \"PT\" - PORTUGAL

  • \"RU\" - RUSSIA

  • \"ZA\" - SOUTH AFRICA

  • \"ES\" - SPAIN

  • \"SE\" - SWEDEN

  • \"CH\" - SWITZERLAND

  • \"US\" - UNITED STATES

  • \"UK\" - UNITED KINGDOM

" } }, - "documentation":"

Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object.

The only supported feature is a holiday calendar. If you use the calendar, all data in the datasets should belong to the same country as the calendar. For the holiday calendar data, see the Jollyday web site.

" + "documentation":"

Describes a supplementary feature of a dataset group. This object is part of the InputDataConfig object.

The only supported feature is a holiday calendar. If you use the calendar, all data in the datasets should belong to the same country as the calendar. For the holiday calendar data, see the Jollyday web site.

India and Korea's holidays are not included in the Jollyday library, but both are supported by Amazon Forecast. Their holidays are:

\"IN\" - INDIA

  • JANUARY 26 - REPUBLIC DAY

  • AUGUST 15 - INDEPENDENCE DAY

  • OCTOBER 2 GANDHI'S BIRTHDAY

\"KR\" - KOREA

  • JANUARY 1 - NEW YEAR

  • MARCH 1 - INDEPENDENCE MOVEMENT DAY

  • MAY 5 - CHILDREN'S DAY

  • JUNE 6 - MEMORIAL DAY

  • AUGUST 15 - LIBERATION DAY

  • OCTOBER 3 - NATIONAL FOUNDATION DAY

  • OCTOBER 9 - HANGEUL DAY

  • DECEMBER 25 - CHRISTMAS DAY

" }, "SupplementaryFeatures":{ "type":"list", @@ -2105,6 +2193,70 @@ "max":1, "min":1 }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{ + "shape":"TagKey", + "documentation":"

One part of a key-value pair that makes up a tag. A key is a general label that acts like a category for more specific tag values.

" + }, + "Value":{ + "shape":"TagValue", + "documentation":"

The optional part of a key-value pair that makes up a tag. A value acts as a descriptor within a tag category (key).

" + } + }, + "documentation":"

The optional metadata that you apply to a resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8.

  • Maximum value length - 256 Unicode characters in UTF-8.

  • If 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: + - = . _ : / @.

  • Tag keys and values are case sensitive.

  • Do 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.

" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "TagKeys":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "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.

" + }, + "Tags":{ + "shape":"Tags", + "documentation":"

The tags to add to the resource. A tag is an array of key-value pairs.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50.

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8.

  • Maximum value length - 256 Unicode characters in UTF-8.

  • If 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: + - = . _ : / @.

  • Tag keys and values are case sensitive.

  • Do 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.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$" + }, + "Tags":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":0 + }, "TestWindowDetails":{ "type":"list", "member":{"shape":"TestWindowSummary"} @@ -2148,6 +2300,28 @@ "max":100, "min":0 }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "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 exports.

" + }, + "TagKeys":{ + "shape":"TagKeys", + "documentation":"

The keys of the tags to be removed.

" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, "UpdateDatasetGroupRequest":{ "type":"structure", "required":[ diff --git a/botocore/data/fsx/2018-03-01/service-2.json b/botocore/data/fsx/2018-03-01/service-2.json index 144bf709..f4713571 100644 --- a/botocore/data/fsx/2018-03-01/service-2.json +++ b/botocore/data/fsx/2018-03-01/service-2.json @@ -48,7 +48,7 @@ {"shape":"ServiceLimitExceeded"}, {"shape":"InternalServerError"} ], - "documentation":"

Creates a backup of an existing Amazon FSx for Windows File Server file system. Creating regular backups for your file system is a best practice that complements the replication that Amazon FSx for Windows File Server performs for your file system. It also enables you to restore from user modification of data.

If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:

  • Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the backup.

By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.

The CreateFileSystem operation returns while the backup's lifecycle state is still CREATING. You can check the file system creation status by calling the DescribeBackups operation, which returns the backup state along with other information.

", + "documentation":"

Creates a backup of an existing Amazon FSx file system. Creating regular backups for your file system is a best practice, enabling you to restore a file system from a backup if an issue arises with the original file system.

For Amazon FSx for Lustre file systems, you can create a backup only for file systems with the following configuration:

  • a Persistent deployment type

  • is not linked to an Amazon S3 data respository.

For more information, see https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-backups.html.

If a backup with the specified client request token exists, and the parameters match, this operation returns the description of the existing backup. If a backup specified client request token exists, and the parameters don't match, this operation returns IncompatibleParameterError. If a backup with the specified client request token doesn't exist, CreateBackup does the following:

  • Creates a new Amazon FSx backup with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the backup.

By using the idempotent operation, you can retry a CreateBackup operation without the risk of creating an extra backup. This approach can be useful when an initial call fails in a way that makes it unclear whether a backup was created. If you use the same client request token and the initial call created a backup, the operation returns a successful result because all the parameters are the same.

The CreateBackup operation returns while the backup's lifecycle state is still CREATING. You can check the backup creation status by calling the DescribeBackups operation, which returns the backup state along with other information.

", "idempotent":true }, "CreateDataRepositoryTask":{ @@ -106,12 +106,13 @@ {"shape":"ActiveDirectoryError"}, {"shape":"IncompatibleParameterError"}, {"shape":"InvalidNetworkSettings"}, + {"shape":"InvalidPerUnitStorageThroughput"}, {"shape":"ServiceLimitExceeded"}, {"shape":"BackupNotFound"}, {"shape":"InternalServerError"}, {"shape":"MissingFileSystemConfiguration"} ], - "documentation":"

Creates a new Amazon FSx file system from an existing Amazon FSx for Windows File Server backup.

If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a client request token specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:

  • Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the file system.

Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.

By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.

" + "documentation":"

Creates a new Amazon FSx file system from an existing Amazon FSx backup.

If a file system with the specified client request token exists and the parameters match, this operation returns the description of the file system. If a client request token specified by the file system exists and the parameters don't match, this call returns IncompatibleParameterError. If a file system with the specified client request token doesn't exist, this operation does the following:

  • Creates a new Amazon FSx file system from backup with an assigned ID, and an initial lifecycle state of CREATING.

  • Returns the description of the file system.

Parameters like Active Directory, default share name, automatic backup, and backup settings default to the parameters of the file system that was backed up, unless overridden. You can explicitly supply other settings.

By using the idempotent operation, you can retry a CreateFileSystemFromBackup call without the risk of creating an extra file system. This approach can be useful when an initial call fails in a way that makes it unclear whether a file system was created. Examples are if a transport level timeout occurred, or your connection was reset. If you use the same client request token and the initial call created a file system, the client receives success as long as the parameters are the same.

The CreateFileSystemFromBackup call returns while the file system's lifecycle state is still CREATING. You can check the file-system creation status by calling the DescribeFileSystems operation, which returns the file system state along with other information.

" }, "DeleteBackup":{ "name":"DeleteBackup", @@ -129,7 +130,7 @@ {"shape":"IncompatibleParameterError"}, {"shape":"InternalServerError"} ], - "documentation":"

Deletes an Amazon FSx for Windows File Server backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.

The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls.

The data in a deleted backup is also deleted and can't be recovered by any means.

", + "documentation":"

Deletes an Amazon FSx backup, deleting its contents. After deletion, the backup no longer exists, and its data is gone.

The DeleteBackup call returns instantly. The backup will not show up in later DescribeBackups calls.

The data in a deleted backup is also deleted and can't be recovered by any means.

", "idempotent":true }, "DeleteFileSystem":{ @@ -164,7 +165,7 @@ {"shape":"BackupNotFound"}, {"shape":"InternalServerError"} ], - "documentation":"

Returns the description of specific Amazon FSx for Windows File Server backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.

" + "documentation":"

Returns the description of specific Amazon FSx backups, if a BackupIds value is provided for that backup. Otherwise, it returns all backups owned by your AWS account in the AWS Region of the endpoint that you're calling.

When retrieving all backups, you can optionally specify the MaxResults parameter to limit the number of backups in a response. If more backups remain, Amazon FSx returns a NextToken value in the response. In this case, send a later request with the NextToken request parameter set to the value of NextToken from the last response.

This action is used in an iterative process to retrieve a list of your backups. DescribeBackups is called first without a NextTokenvalue. Then the action continues to be called with the NextToken parameter set to the value of the last NextToken value until a response has no NextToken.

When using this action, keep the following in mind:

  • The implementation might return fewer than MaxResults file system descriptions while still including a NextToken value.

  • The order of backups returned in the response of one DescribeBackups call and the order of backups returned across the responses of a multi-call iteration is unspecified.

" }, "DescribeDataRepositoryTasks":{ "name":"DescribeDataRepositoryTasks", @@ -323,7 +324,7 @@ "type":"string", "max":255, "min":1, - "pattern":"^.{1,255}$" + "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,255}$" }, "AdministrativeAction":{ "type":"structure", @@ -376,11 +377,11 @@ "type":"string", "max":900, "min":3, - "pattern":"^.{3,900}$" + "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{3,4357}$" }, "AutomaticBackupRetentionDays":{ "type":"integer", - "documentation":"

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days.

", + "documentation":"

The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 35 days. The default is 0.

", "max":35, "min":0 }, @@ -436,7 +437,7 @@ "documentation":"

The configuration of the self-managed Microsoft Active Directory (AD) to which the Windows File Server instance is joined.

" } }, - "documentation":"

A backup of an Amazon FSx for Windows File Server file system. You can create a new file system from a backup to protect against data loss.

" + "documentation":"

A backup of an Amazon FSx for file system.

" }, "BackupFailureDetails":{ "type":"structure", @@ -585,12 +586,12 @@ }, "ClientRequestToken":{ "shape":"ClientRequestToken", - "documentation":"

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

", + "documentation":"

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

", "idempotencyToken":true }, "Tags":{ "shape":"Tags", - "documentation":"

The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name.

" + "documentation":"

The tags to apply to the backup at backup creation. The key value of the Name tag appears in the console as the backup name. If you have set CopyTagsToBackups to true, and you specify one or more tags using the CreateBackup action, no existing tags on the file system are copied from the file system to the backup.

" } }, "documentation":"

The request object for the CreateBackup operation.

" @@ -652,7 +653,7 @@ "BackupId":{"shape":"BackupId"}, "ClientRequestToken":{ "shape":"ClientRequestToken", - "documentation":"

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

", + "documentation":"

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

", "idempotencyToken":true }, "SubnetIds":{ @@ -671,6 +672,7 @@ "shape":"CreateFileSystemWindowsConfiguration", "documentation":"

The configuration for this Microsoft Windows file system.

" }, + "LustreConfiguration":{"shape":"CreateFileSystemLustreConfiguration"}, "StorageType":{ "shape":"StorageType", "documentation":"

Sets the storage type for the Windows file system you're creating from a backup. Valid values are SSD and HDD.

  • Set to SSD to use solid state drive storage. Supported on all Windows deployment types.

  • Set to HDD to use hard disk drive storage. Supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types.

Default value is SSD.

HDD and SSD storage types have different minimum storage capacity requirements. A restored file system's storage capacity is tied to the file system that was backed up. You can create a file system that uses HDD storage from a backup of a file system that used SSD storage only if the original SSD file system had a storage capacity of at least 2000 GiB.

" @@ -709,11 +711,17 @@ }, "DeploymentType":{ "shape":"LustreDeploymentType", - "documentation":"

(Optional) Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

Choose PERSISTENT_1 deployment type for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options.

Encryption of data in-transit is automatically enabled when you access a SCRATCH_2 or PERSISTENT_1 file system from Amazon EC2 instances that support this feature. (Default = SCRATCH_1)

Encryption of data in-transit for SCRATCH_2 and PERSISTENT_1 deployment types is supported when accessed from supported instance types in supported AWS Regions. To learn more, Encrypting Data in Transit.

" + "documentation":"

Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

This option can only be set for for PERSISTENT_1 deployments types.

Choose PERSISTENT_1 deployment type for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options.

Encryption of data in-transit is automatically enabled when you access a SCRATCH_2 or PERSISTENT_1 file system from Amazon EC2 instances that support this feature. (Default = SCRATCH_1)

Encryption of data in-transit for SCRATCH_2 and PERSISTENT_1 deployment types is supported when accessed from supported instance types in supported AWS Regions. To learn more, Encrypting Data in Transit.

" }, "PerUnitStorageThroughput":{ "shape":"PerUnitStorageThroughput", "documentation":"

Required for the PERSISTENT_1 deployment type, describes the amount of read and write throughput for each 1 tebibyte of storage, in MB/s/TiB. File system throughput capacity is calculated by multiplying file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4 TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 117 MB/s of file system throughput. You pay for the amount of throughput that you provision.

Valid values are 50, 100, 200.

" + }, + "DailyAutomaticBackupStartTime":{"shape":"DailyTime"}, + "AutomaticBackupRetentionDays":{"shape":"AutomaticBackupRetentionDays"}, + "CopyTagsToBackups":{ + "shape":"Flag", + "documentation":"

A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it's set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn't specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

" } }, "documentation":"

The Lustre configuration for the file system being created.

" @@ -728,7 +736,7 @@ "members":{ "ClientRequestToken":{ "shape":"ClientRequestToken", - "documentation":"

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

", + "documentation":"

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent creation. This string is automatically filled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

", "idempotencyToken":true }, "FileSystemType":{ @@ -983,7 +991,7 @@ "type":"string", "max":4096, "min":0, - "pattern":"^.{0,4096}$" + "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{0,4096}$" }, "DataRepositoryTaskPaths":{ "type":"list", @@ -1031,7 +1039,7 @@ }, "ClientRequestToken":{ "shape":"ClientRequestToken", - "documentation":"

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.

", + "documentation":"

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.

", "idempotencyToken":true } }, @@ -1051,6 +1059,34 @@ }, "documentation":"

The response object for DeleteBackup operation.

" }, + "DeleteFileSystemLustreConfiguration":{ + "type":"structure", + "members":{ + "SkipFinalBackup":{ + "shape":"Flag", + "documentation":"

Set SkipFinalBackup to false if you want to take a final backup of the file system you are deleting. By default, Amazon FSx will not take a final backup on your behalf when the DeleteFileSystem operation is invoked. (Default = true)

" + }, + "FinalBackupTags":{ + "shape":"Tags", + "documentation":"

Use if SkipFinalBackup is set to false, and you want to apply an array of tags to the final backup. If you have set the file system property CopyTagsToBackups to true, and you specify one or more FinalBackupTags when deleting a file system, Amazon FSx will not copy any existing file system tags to the backup.

" + } + }, + "documentation":"

The configuration object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

" + }, + "DeleteFileSystemLustreResponse":{ + "type":"structure", + "members":{ + "FinalBackupId":{ + "shape":"BackupId", + "documentation":"

The ID of the final backup for this file system.

" + }, + "FinalBackupTags":{ + "shape":"Tags", + "documentation":"

The set of tags applied to the final backup.

" + } + }, + "documentation":"

The response object for the Amazon FSx for Lustre file system being deleted in the DeleteFileSystem operation.

" + }, "DeleteFileSystemRequest":{ "type":"structure", "required":["FileSystemId"], @@ -1061,10 +1097,11 @@ }, "ClientRequestToken":{ "shape":"ClientRequestToken", - "documentation":"

(Optional) A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.

", + "documentation":"

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent deletion. This is automatically filled on your behalf when using the AWS CLI or SDK.

", "idempotencyToken":true }, - "WindowsConfiguration":{"shape":"DeleteFileSystemWindowsConfiguration"} + "WindowsConfiguration":{"shape":"DeleteFileSystemWindowsConfiguration"}, + "LustreConfiguration":{"shape":"DeleteFileSystemLustreConfiguration"} }, "documentation":"

The request object for DeleteFileSystem operation.

" }, @@ -1079,7 +1116,8 @@ "shape":"FileSystemLifecycle", "documentation":"

The file system lifecycle for the deletion request. Should be DELETING.

" }, - "WindowsResponse":{"shape":"DeleteFileSystemWindowsResponse"} + "WindowsResponse":{"shape":"DeleteFileSystemWindowsResponse"}, + "LustreResponse":{"shape":"DeleteFileSystemLustreResponse"} }, "documentation":"

The response object for the DeleteFileSystem operation.

" }, @@ -1116,19 +1154,19 @@ "members":{ "BackupIds":{ "shape":"BackupIds", - "documentation":"

(Optional) IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

" + "documentation":"

IDs of the backups you want to retrieve (String). This overrides any filters. If any IDs are not found, BackupNotFound will be thrown.

" }, "Filters":{ "shape":"Filters", - "documentation":"

(Optional) Filters structure. Supported names are file-system-id and backup-type.

" + "documentation":"

Filters structure. Supported names are file-system-id and backup-type.

" }, "MaxResults":{ "shape":"MaxResults", - "documentation":"

(Optional) Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

" + "documentation":"

Maximum number of backups to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

" }, "NextToken":{ "shape":"NextToken", - "documentation":"

(Optional) Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

" + "documentation":"

Opaque pagination token returned from a previous DescribeBackups operation (String). If a token present, the action continues the list from where the returning call left off.

" } }, "documentation":"

The request object for DescribeBackups operation.

" @@ -1177,15 +1215,15 @@ "members":{ "FileSystemIds":{ "shape":"FileSystemIds", - "documentation":"

(Optional) IDs of the file systems whose descriptions you want to retrieve (String).

" + "documentation":"

IDs of the file systems whose descriptions you want to retrieve (String).

" }, "MaxResults":{ "shape":"MaxResults", - "documentation":"

(Optional) Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

" + "documentation":"

Maximum number of file systems to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

" }, "NextToken":{ "shape":"NextToken", - "documentation":"

(Optional) Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the action continues the list from where the returning call left off.

" + "documentation":"

Opaque pagination token returned from a previous DescribeFileSystems operation (String). If a token present, the action continues the list from where the returning call left off.

" } }, "documentation":"

The request object for DescribeFileSystems operation.

" @@ -1221,7 +1259,7 @@ "type":"string", "max":256, "min":1, - "pattern":"^.{1,256}$" + "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$" }, "DnsIps":{ "type":"list", @@ -1313,7 +1351,7 @@ "type":"string", "max":256, "min":1, - "pattern":"^.{1,256}$" + "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,256}$" }, "FileSystemFailureDetails":{ "type":"structure", @@ -1405,7 +1443,8 @@ "documentation":"

The name for a filter.

", "enum":[ "file-system-id", - "backup-type" + "backup-type", + "file-system-type" ] }, "FilterValue":{ @@ -1508,11 +1547,11 @@ }, "MaxResults":{ "shape":"MaxResults", - "documentation":"

(Optional) Maximum number of tags to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

" + "documentation":"

Maximum number of tags to return in the response (integer). This parameter value must be greater than 0. The number of items that Amazon FSx returns is the minimum of the MaxResults parameter specified in the request and the service's internal maximum number of items per page.

" }, "NextToken":{ "shape":"NextToken", - "documentation":"

(Optional) Opaque pagination token returned from a previous ListTagsForResource operation (String). If a token present, the action continues the list from where the returning call left off.

" + "documentation":"

Opaque pagination token returned from a previous ListTagsForResource operation (String). If a token present, the action continues the list from where the returning call left off.

" } }, "documentation":"

The request object for ListTagsForResource operation.

" @@ -1549,7 +1588,7 @@ "DataRepositoryConfiguration":{"shape":"DataRepositoryConfiguration"}, "DeploymentType":{ "shape":"LustreDeploymentType", - "documentation":"

The deployment type of the FSX for Lustre file system.

" + "documentation":"

The deployment type of the FSX for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data.

SCRATCH_1 and SCRATCH_2 deployment types are best suited for when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1.

The PERSISTENT_1 deployment type is used for longer-term storage and workloads and encryption of data in transit. To learn more about deployment types, see FSx for Lustre Deployment Options. (Default = SCRATCH_1)

" }, "PerUnitStorageThroughput":{ "shape":"PerUnitStorageThroughput", @@ -1558,6 +1597,12 @@ "MountName":{ "shape":"LustreFileSystemMountName", "documentation":"

You use the MountName value when mounting the file system.

For the SCRATCH_1 deployment type, this value is always \"fsx\". For SCRATCH_2 and PERSISTENT_1 deployment types, this value is a string that is unique within an AWS Region.

" + }, + "DailyAutomaticBackupStartTime":{"shape":"DailyTime"}, + "AutomaticBackupRetentionDays":{"shape":"AutomaticBackupRetentionDays"}, + "CopyTagsToBackups":{ + "shape":"Flag", + "documentation":"

A boolean flag indicating whether tags on the file system should be copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false)

" } }, "documentation":"

The configuration for the Amazon FSx for Lustre file system.

" @@ -1630,7 +1675,7 @@ "type":"string", "max":2000, "min":1, - "pattern":"^.{1,2000}$" + "pattern":"^[^\\u0000\\u0085\\u2028\\u2029\\r\\n]{1,2000}$" }, "Parameter":{ "type":"string", @@ -1961,7 +2006,9 @@ "WeeklyMaintenanceStartTime":{ "shape":"WeeklyTime", "documentation":"

The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

" - } + }, + "DailyAutomaticBackupStartTime":{"shape":"DailyTime"}, + "AutomaticBackupRetentionDays":{"shape":"AutomaticBackupRetentionDays"} }, "documentation":"

The configuration object for Amazon FSx for Lustre file systems used in the UpdateFileSystem operation.

" }, diff --git a/botocore/data/glue/2017-03-31/service-2.json b/botocore/data/glue/2017-03-31/service-2.json index 64c02ac9..a1389e06 100644 --- a/botocore/data/glue/2017-03-31/service-2.json +++ b/botocore/data/glue/2017-03-31/service-2.json @@ -481,6 +481,40 @@ ], "documentation":"

Removes a classifier from the Data Catalog.

" }, + "DeleteColumnStatisticsForPartition":{ + "name":"DeleteColumnStatisticsForPartition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteColumnStatisticsForPartitionRequest"}, + "output":{"shape":"DeleteColumnStatisticsForPartitionResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Delete the partition column statistics of a column.

" + }, + "DeleteColumnStatisticsForTable":{ + "name":"DeleteColumnStatisticsForTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteColumnStatisticsForTableRequest"}, + "output":{"shape":"DeleteColumnStatisticsForTableResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves table statistics of columns.

" + }, "DeleteConnection":{ "name":"DeleteConnection", "http":{ @@ -744,6 +778,40 @@ ], "documentation":"

Lists all classifier objects in the Data Catalog.

" }, + "GetColumnStatisticsForPartition":{ + "name":"GetColumnStatisticsForPartition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetColumnStatisticsForPartitionRequest"}, + "output":{"shape":"GetColumnStatisticsForPartitionResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves partition statistics of columns.

" + }, + "GetColumnStatisticsForTable":{ + "name":"GetColumnStatisticsForTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetColumnStatisticsForTableRequest"}, + "output":{"shape":"GetColumnStatisticsForTableResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves table statistics of columns.

" + }, "GetConnection":{ "name":"GetConnection", "http":{ @@ -1121,6 +1189,22 @@ ], "documentation":"

Gets code to perform a specified mapping.

" }, + "GetResourcePolicies":{ + "name":"GetResourcePolicies", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetResourcePoliciesRequest"}, + "output":{"shape":"GetResourcePoliciesResponse"}, + "errors":[ + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"InvalidInputException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Retrieves the security configurations for the resource policies set on individual resources, and also the account-level policy.

" + }, "GetResourcePolicy":{ "name":"GetResourcePolicy", "http":{ @@ -1839,6 +1923,40 @@ ], "documentation":"

Modifies an existing classifier (a GrokClassifier, an XMLClassifier, a JsonClassifier, or a CsvClassifier, depending on which field is present).

" }, + "UpdateColumnStatisticsForPartition":{ + "name":"UpdateColumnStatisticsForPartition", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateColumnStatisticsForPartitionRequest"}, + "output":{"shape":"UpdateColumnStatisticsForPartitionResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Creates or updates partition statistics of columns.

" + }, + "UpdateColumnStatisticsForTable":{ + "name":"UpdateColumnStatisticsForTable", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateColumnStatisticsForTableRequest"}, + "output":{"shape":"UpdateColumnStatisticsForTableResponse"}, + "errors":[ + {"shape":"EntityNotFoundException"}, + {"shape":"InvalidInputException"}, + {"shape":"InternalServiceException"}, + {"shape":"OperationTimeoutException"}, + {"shape":"GlueEncryptionException"} + ], + "documentation":"

Creates or updates table statistics of columns.

" + }, "UpdateConnection":{ "name":"UpdateConnection", "http":{ @@ -2524,7 +2642,54 @@ "type":"list", "member":{"shape":"BatchStopJobRunSuccessfulSubmission"} }, + "BinaryColumnStatisticsData":{ + "type":"structure", + "required":[ + "MaximumLength", + "AverageLength", + "NumberOfNulls" + ], + "members":{ + "MaximumLength":{ + "shape":"NonNegativeLong", + "documentation":"

Maximum length of the column.

" + }, + "AverageLength":{ + "shape":"NonNegativeDouble", + "documentation":"

Average length of the column.

" + }, + "NumberOfNulls":{ + "shape":"NonNegativeLong", + "documentation":"

Number of nulls.

" + } + }, + "documentation":"

Defines a binary column statistics data.

" + }, + "Blob":{"type":"blob"}, "Boolean":{"type":"boolean"}, + "BooleanColumnStatisticsData":{ + "type":"structure", + "required":[ + "NumberOfTrues", + "NumberOfFalses", + "NumberOfNulls" + ], + "members":{ + "NumberOfTrues":{ + "shape":"NonNegativeLong", + "documentation":"

Number of true value.

" + }, + "NumberOfFalses":{ + "shape":"NonNegativeLong", + "documentation":"

Number of false value.

" + }, + "NumberOfNulls":{ + "shape":"NonNegativeLong", + "documentation":"

Number of nulls.

" + } + }, + "documentation":"

Defines a boolean column statistics.

" + }, "BooleanNullable":{"type":"boolean"}, "BooleanValue":{"type":"boolean"}, "BoundedPartitionValueList":{ @@ -2808,6 +2973,24 @@ }, "documentation":"

A column in a Table.

" }, + "ColumnError":{ + "type":"structure", + "members":{ + "ColumnName":{ + "shape":"NameString", + "documentation":"

The name of the column.

" + }, + "Error":{ + "shape":"ErrorDetail", + "documentation":"

The error message occurred during operation.

" + } + }, + "documentation":"

Defines a column containing error.

" + }, + "ColumnErrors":{ + "type":"list", + "member":{"shape":"ColumnError"} + }, "ColumnList":{ "type":"list", "member":{"shape":"Column"} @@ -2818,6 +3001,107 @@ "min":1, "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" }, + "ColumnStatistics":{ + "type":"structure", + "required":[ + "ColumnName", + "ColumnType", + "AnalyzedTime", + "StatisticsData" + ], + "members":{ + "ColumnName":{ + "shape":"NameString", + "documentation":"

The name of the column.

" + }, + "ColumnType":{ + "shape":"TypeString", + "documentation":"

The type of the column.

" + }, + "AnalyzedTime":{ + "shape":"Timestamp", + "documentation":"

The analyzed time of the column statistics.

" + }, + "StatisticsData":{ + "shape":"ColumnStatisticsData", + "documentation":"

The statistics of the column.

" + } + }, + "documentation":"

Defines a column statistics.

" + }, + "ColumnStatisticsData":{ + "type":"structure", + "required":["Type"], + "members":{ + "Type":{ + "shape":"ColumnStatisticsType", + "documentation":"

The name of the column.

" + }, + "BooleanColumnStatisticsData":{ + "shape":"BooleanColumnStatisticsData", + "documentation":"

Boolean Column Statistics Data.

" + }, + "DateColumnStatisticsData":{ + "shape":"DateColumnStatisticsData", + "documentation":"

Date Column Statistics Data.

" + }, + "DecimalColumnStatisticsData":{ + "shape":"DecimalColumnStatisticsData", + "documentation":"

Decimal Column Statistics Data.

" + }, + "DoubleColumnStatisticsData":{ + "shape":"DoubleColumnStatisticsData", + "documentation":"

Double Column Statistics Data.

" + }, + "LongColumnStatisticsData":{ + "shape":"LongColumnStatisticsData", + "documentation":"

Long Column Statistics Data.

" + }, + "StringColumnStatisticsData":{ + "shape":"StringColumnStatisticsData", + "documentation":"

String Column Statistics Data.

" + }, + "BinaryColumnStatisticsData":{ + "shape":"BinaryColumnStatisticsData", + "documentation":"

Binary Column Statistics Data.

" + } + }, + "documentation":"

Defines a column statistics data.

" + }, + "ColumnStatisticsError":{ + "type":"structure", + "members":{ + "ColumnStatistics":{ + "shape":"ColumnStatistics", + "documentation":"

The ColumnStatistics of the column.

" + }, + "Error":{ + "shape":"ErrorDetail", + "documentation":"

The error message occurred during operation.

" + } + }, + "documentation":"

Defines a column containing error.

" + }, + "ColumnStatisticsErrors":{ + "type":"list", + "member":{"shape":"ColumnStatisticsError"} + }, + "ColumnStatisticsList":{ + "type":"list", + "member":{"shape":"ColumnStatistics"} + }, + "ColumnStatisticsType":{ + "type":"string", + "enum":[ + "BOOLEAN", + "DATE", + "DECIMAL", + "DOUBLE", + "LONG", + "STRING", + "BINARY" + ] + }, "ColumnTypeString":{ "type":"string", "max":131072, @@ -2943,7 +3227,7 @@ }, "ConnectionType":{ "shape":"ConnectionType", - "documentation":"

The type of the connection. Currently, only JDBC is supported; SFTP is not supported.

" + "documentation":"

The type of the connection. Currently, SFTP is not supported.

" }, "MatchCriteria":{ "shape":"MatchCriteria", @@ -4240,10 +4524,32 @@ "CreateTableDefaultPermissions":{ "shape":"PrincipalPermissionsList", "documentation":"

Creates a set of default permissions on the table for principals.

" + }, + "TargetDatabase":{ + "shape":"DatabaseIdentifier", + "documentation":"

A DatabaseIdentifier structure that describes a target database for resource linking.

" + }, + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which the database resides.

" } }, "documentation":"

The Database object represents a logical grouping of tables that might reside in a Hive metastore or an RDBMS.

" }, + "DatabaseIdentifier":{ + "type":"structure", + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which the database resides.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database.

" + } + }, + "documentation":"

A structure that describes a target database for resource linking.

" + }, "DatabaseInput":{ "type":"structure", "required":["Name"], @@ -4267,6 +4573,10 @@ "CreateTableDefaultPermissions":{ "shape":"PrincipalPermissionsList", "documentation":"

Creates a set of default permissions on the table for principals.

" + }, + "TargetDatabase":{ + "shape":"DatabaseIdentifier", + "documentation":"

A DatabaseIdentifier structure that describes a target database for resource linking.

" } }, "documentation":"

The structure used to create or update a database.

" @@ -4276,6 +4586,76 @@ "member":{"shape":"Database"} }, "DatabaseName":{"type":"string"}, + "DateColumnStatisticsData":{ + "type":"structure", + "required":[ + "NumberOfNulls", + "NumberOfDistinctValues" + ], + "members":{ + "MinimumValue":{ + "shape":"Timestamp", + "documentation":"

Minimum value of the column.

" + }, + "MaximumValue":{ + "shape":"Timestamp", + "documentation":"

Maximum value of the column.

" + }, + "NumberOfNulls":{ + "shape":"NonNegativeLong", + "documentation":"

Number of nulls.

" + }, + "NumberOfDistinctValues":{ + "shape":"NonNegativeLong", + "documentation":"

Number of distinct values.

" + } + }, + "documentation":"

Defines a date column statistics data.

" + }, + "DecimalColumnStatisticsData":{ + "type":"structure", + "required":[ + "NumberOfNulls", + "NumberOfDistinctValues" + ], + "members":{ + "MinimumValue":{ + "shape":"DecimalNumber", + "documentation":"

Minimum value of the column.

" + }, + "MaximumValue":{ + "shape":"DecimalNumber", + "documentation":"

Maximum value of the column.

" + }, + "NumberOfNulls":{ + "shape":"NonNegativeLong", + "documentation":"

Number of nulls.

" + }, + "NumberOfDistinctValues":{ + "shape":"NonNegativeLong", + "documentation":"

Number of distinct values.

" + } + }, + "documentation":"

Defines a decimal column statistics data.

" + }, + "DecimalNumber":{ + "type":"structure", + "required":[ + "UnscaledValue", + "Scale" + ], + "members":{ + "UnscaledValue":{ + "shape":"Blob", + "documentation":"

The unscaled numeric value.

" + }, + "Scale":{ + "shape":"Integer", + "documentation":"

The scale that determines where the decimal point falls in the unscaled value.

" + } + }, + "documentation":"

Contains a numeric value in decimal format.

" + }, "DeleteBehavior":{ "type":"string", "enum":[ @@ -4299,6 +4679,73 @@ "members":{ } }, + "DeleteColumnStatisticsForPartitionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName", + "PartitionValues", + "ColumnName" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database where the partitions reside.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the partitions' table.

" + }, + "PartitionValues":{ + "shape":"ValueStringList", + "documentation":"

A list of partition values identifying the partition.

" + }, + "ColumnName":{ + "shape":"NameString", + "documentation":"

Name of the column.

" + } + } + }, + "DeleteColumnStatisticsForPartitionResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteColumnStatisticsForTableRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName", + "ColumnName" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database where the partitions reside.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the partitions' table.

" + }, + "ColumnName":{ + "shape":"NameString", + "documentation":"

The name of the column.

" + } + } + }, + "DeleteColumnStatisticsForTableResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteConnectionNameList":{ "type":"list", "member":{"shape":"NameString"}, @@ -4448,6 +4895,10 @@ "PolicyHashCondition":{ "shape":"HashString", "documentation":"

The hash value returned when this policy was set.

" + }, + "ResourceArn":{ + "shape":"GlueResourceArn", + "documentation":"

The ARN of the AWS Glue resource for the resource policy to be deleted.

" } } }, @@ -4738,6 +5189,33 @@ "max":25, "min":1 }, + "Double":{"type":"double"}, + "DoubleColumnStatisticsData":{ + "type":"structure", + "required":[ + "NumberOfNulls", + "NumberOfDistinctValues" + ], + "members":{ + "MinimumValue":{ + "shape":"Double", + "documentation":"

Minimum value of the column.

" + }, + "MaximumValue":{ + "shape":"Double", + "documentation":"

Maximum value of the column.

" + }, + "NumberOfNulls":{ + "shape":"NonNegativeLong", + "documentation":"

Number of nulls.

" + }, + "NumberOfDistinctValues":{ + "shape":"NonNegativeLong", + "documentation":"

Number of distinct values.

" + } + }, + "documentation":"

Defines a double column statistics data.

" + }, "DynamoDBTarget":{ "type":"structure", "members":{ @@ -4778,6 +5256,13 @@ "type":"list", "member":{"shape":"Edge"} }, + "EnableHybridValues":{ + "type":"string", + "enum":[ + "TRUE", + "FALSE" + ] + }, "EncryptionAtRest":{ "type":"structure", "required":["CatalogEncryptionMode"], @@ -5039,6 +5524,95 @@ } } }, + "GetColumnNamesList":{ + "type":"list", + "member":{"shape":"NameString"}, + "max":100, + "min":0 + }, + "GetColumnStatisticsForPartitionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName", + "PartitionValues", + "ColumnNames" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database where the partitions reside.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the partitions' table.

" + }, + "PartitionValues":{ + "shape":"ValueStringList", + "documentation":"

A list of partition values identifying the partition.

" + }, + "ColumnNames":{ + "shape":"GetColumnNamesList", + "documentation":"

A list of the column names.

" + } + } + }, + "GetColumnStatisticsForPartitionResponse":{ + "type":"structure", + "members":{ + "ColumnStatisticsList":{ + "shape":"ColumnStatisticsList", + "documentation":"

List of ColumnStatistics that failed to be retrieved.

" + }, + "Errors":{ + "shape":"ColumnErrors", + "documentation":"

Error occurred during retrieving column statistics data.

" + } + } + }, + "GetColumnStatisticsForTableRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName", + "ColumnNames" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database where the partitions reside.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the partitions' table.

" + }, + "ColumnNames":{ + "shape":"GetColumnNamesList", + "documentation":"

A list of the column names.

" + } + } + }, + "GetColumnStatisticsForTableResponse":{ + "type":"structure", + "members":{ + "ColumnStatisticsList":{ + "shape":"ColumnStatisticsList", + "documentation":"

List of ColumnStatistics that failed to be retrieved.

" + }, + "Errors":{ + "shape":"ColumnErrors", + "documentation":"

List of ColumnStatistics that failed to be retrieved.

" + } + } + }, "GetConnectionRequest":{ "type":"structure", "required":["Name"], @@ -5075,7 +5649,7 @@ }, "ConnectionType":{ "shape":"ConnectionType", - "documentation":"

The type of connections to return. Currently, only JDBC is supported; SFTP is not supported.

" + "documentation":"

The type of connections to return. Currently, SFTP is not supported.

" } }, "documentation":"

Filters the connection definitions that are returned by the GetConnections API operation.

" @@ -5248,6 +5822,10 @@ "MaxResults":{ "shape":"PageSize", "documentation":"

The maximum number of databases to return in one response.

" + }, + "ResourceShareType":{ + "shape":"ResourceShareType", + "documentation":"

Allows you to specify that you want to list the databases shared with your account. The allowable values are FOREIGN or ALL.

  • If set to FOREIGN, will list the databases shared with your account.

  • If set to ALL, will list the databases shared with your account, as well as the databases in yor local account.

" } } }, @@ -5839,9 +6417,43 @@ } } }, + "GetResourcePoliciesRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if this is a continuation request.

" + }, + "MaxResults":{ + "shape":"PageSize", + "documentation":"

The maximum size of a list to return.

" + } + } + }, + "GetResourcePoliciesResponse":{ + "type":"structure", + "members":{ + "GetResourcePoliciesResponseList":{ + "shape":"GetResourcePoliciesResponseList", + "documentation":"

A list of the individual resource policies and the account-level resource policy.

" + }, + "NextToken":{ + "shape":"Token", + "documentation":"

A continuation token, if the returned list does not contain the last resource policy available.

" + } + } + }, + "GetResourcePoliciesResponseList":{ + "type":"list", + "member":{"shape":"GluePolicy"} + }, "GetResourcePolicyRequest":{ "type":"structure", "members":{ + "ResourceArn":{ + "shape":"GlueResourceArn", + "documentation":"

The ARN of the AWS Glue resource for the resource policy to be retrieved. For more information about AWS Glue resource ARNs, see the AWS Glue ARN string pattern

" + } } }, "GetResourcePolicyResponse":{ @@ -6321,6 +6933,28 @@ "documentation":"

An encryption operation failed.

", "exception":true }, + "GluePolicy":{ + "type":"structure", + "members":{ + "PolicyInJson":{ + "shape":"PolicyJsonString", + "documentation":"

Contains the requested policy document, in JSON format.

" + }, + "PolicyHash":{ + "shape":"HashString", + "documentation":"

Contains the hash value associated with this policy.

" + }, + "CreateTime":{ + "shape":"Timestamp", + "documentation":"

The date and time at which the policy was created.

" + }, + "UpdateTime":{ + "shape":"Timestamp", + "documentation":"

The date and time at which the policy was last updated.

" + } + }, + "documentation":"

A structure for returning a resource policy.

" + }, "GlueResourceArn":{ "type":"string", "max":10240, @@ -7230,6 +7864,33 @@ "type":"string", "enum":["EQUALS"] }, + "Long":{"type":"long"}, + "LongColumnStatisticsData":{ + "type":"structure", + "required":[ + "NumberOfNulls", + "NumberOfDistinctValues" + ], + "members":{ + "MinimumValue":{ + "shape":"Long", + "documentation":"

Minimum value of the column.

" + }, + "MaximumValue":{ + "shape":"Long", + "documentation":"

Maximum value of the column.

" + }, + "NumberOfNulls":{ + "shape":"NonNegativeLong", + "documentation":"

Number of nulls.

" + }, + "NumberOfDistinctValues":{ + "shape":"NonNegativeLong", + "documentation":"

Number of distinct values.

" + } + }, + "documentation":"

Defines a long column statistics data.

" + }, "MLTransform":{ "type":"structure", "members":{ @@ -7447,6 +8108,10 @@ "type":"integer", "min":0 }, + "NonNegativeLong":{ + "type":"long", + "min":0 + }, "NotificationProperty":{ "type":"structure", "members":{ @@ -7561,6 +8226,10 @@ "LastAnalyzedTime":{ "shape":"Timestamp", "documentation":"

The last time at which column statistics were computed for this partition.

" + }, + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which the partition resides.

" } }, "documentation":"

Represents a slice of table data.

" @@ -7790,6 +8459,10 @@ "shape":"PolicyJsonString", "documentation":"

Contains the policy document to set, in JSON format.

" }, + "ResourceArn":{ + "shape":"GlueResourceArn", + "documentation":"

The ARN of the AWS Glue resource for the resource policy to be set. For more information about AWS Glue resource ARNs, see the AWS Glue ARN string pattern

" + }, "PolicyHashCondition":{ "shape":"HashString", "documentation":"

The hash value returned when the previous policy was set using PutResourcePolicy. Its purpose is to prevent concurrent modifications of a policy. Do not use this parameter if no previous policy has been set.

" @@ -7797,6 +8470,10 @@ "PolicyExistsCondition":{ "shape":"ExistCondition", "documentation":"

A value of MUST_EXIST is used to update a policy. A value of NOT_EXIST is used to create a new policy. If a value of NONE or a null value is used, the call will not depend on the existence of a policy.

" + }, + "EnableHybrid":{ + "shape":"EnableHybridValues", + "documentation":"

Allows you to specify if you want to use both resource-level and account/catalog-level resource policies. A resource-level policy is a policy attached to an individual resource such as a database or a table.

The default value of NO indicates that resource-level policies cannot co-exist with an account-level policy. A value of YES means the use of both resource-level and account/catalog-level resource policies is allowed.

" } } }, @@ -7880,6 +8557,13 @@ "documentation":"

A resource numerical limit was exceeded.

", "exception":true }, + "ResourceShareType":{ + "type":"string", + "enum":[ + "FOREIGN", + "ALL" + ] + }, "ResourceType":{ "type":"string", "enum":[ @@ -8076,6 +8760,10 @@ "MaxResults":{ "shape":"PageSize", "documentation":"

The maximum number of tables to return in a single response.

" + }, + "ResourceShareType":{ + "shape":"ResourceShareType", + "documentation":"

Allows you to specify that you want to search the tables shared with your account. The allowable values are FOREIGN or ALL.

  • If set to FOREIGN, will search the tables shared with your account.

  • If set to ALL, will search the tables shared with your account, as well as the tables in yor local account.

" } } }, @@ -8559,6 +9247,34 @@ }, "documentation":"

Describes the physical storage of table data.

" }, + "StringColumnStatisticsData":{ + "type":"structure", + "required":[ + "MaximumLength", + "AverageLength", + "NumberOfNulls", + "NumberOfDistinctValues" + ], + "members":{ + "MaximumLength":{ + "shape":"NonNegativeLong", + "documentation":"

Maximum value of the column.

" + }, + "AverageLength":{ + "shape":"NonNegativeDouble", + "documentation":"

Average value of the column.

" + }, + "NumberOfNulls":{ + "shape":"NonNegativeLong", + "documentation":"

Number of nulls.

" + }, + "NumberOfDistinctValues":{ + "shape":"NonNegativeLong", + "documentation":"

Number of distinct values.

" + } + }, + "documentation":"

Defines a string column statistics data.

" + }, "StringList":{ "type":"list", "member":{"shape":"GenericString"} @@ -8634,6 +9350,14 @@ "IsRegisteredWithLakeFormation":{ "shape":"Boolean", "documentation":"

Indicates whether the table has been registered with AWS Lake Formation.

" + }, + "TargetTable":{ + "shape":"TableIdentifier", + "documentation":"

A TableIdentifier structure that describes a target table for resource linking.

" + }, + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which the table resides.

" } }, "documentation":"

Represents a collection of related data organized in columns and rows.

" @@ -8656,6 +9380,24 @@ "type":"list", "member":{"shape":"TableError"} }, + "TableIdentifier":{ + "type":"structure", + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which the table resides.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database that contains the target table.

" + }, + "Name":{ + "shape":"NameString", + "documentation":"

The name of the target table.

" + } + }, + "documentation":"

A structure that describes a target table for resource linking.

" + }, "TableInput":{ "type":"structure", "required":["Name"], @@ -8707,6 +9449,10 @@ "Parameters":{ "shape":"ParametersMap", "documentation":"

These key-value pairs define properties associated with the table.

" + }, + "TargetTable":{ + "shape":"TableIdentifier", + "documentation":"

A TableIdentifier structure that describes a target table for resource linking.

" } }, "documentation":"

A structure used to define a table.

" @@ -9182,6 +9928,12 @@ }, "documentation":"

A structure used to provide information used to update a trigger. This object updates the previous trigger definition by overwriting it completely.

" }, + "TypeString":{ + "type":"string", + "max":20000, + "min":0, + "pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\t]*" + }, "URI":{ "type":"string", "max":1024, @@ -9243,6 +9995,87 @@ "members":{ } }, + "UpdateColumnStatisticsForPartitionRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName", + "PartitionValues", + "ColumnStatisticsList" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database where the partitions reside.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the partitions' table.

" + }, + "PartitionValues":{ + "shape":"ValueStringList", + "documentation":"

A list of partition values identifying the partition.

" + }, + "ColumnStatisticsList":{ + "shape":"UpdateColumnStatisticsList", + "documentation":"

A list of the column statistics.

" + } + } + }, + "UpdateColumnStatisticsForPartitionResponse":{ + "type":"structure", + "members":{ + "Errors":{ + "shape":"ColumnStatisticsErrors", + "documentation":"

Error occurred during updating column statistics data.

" + } + } + }, + "UpdateColumnStatisticsForTableRequest":{ + "type":"structure", + "required":[ + "DatabaseName", + "TableName", + "ColumnStatisticsList" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog where the partitions in question reside. If none is supplied, the AWS account ID is used by default.

" + }, + "DatabaseName":{ + "shape":"NameString", + "documentation":"

The name of the catalog database where the partitions reside.

" + }, + "TableName":{ + "shape":"NameString", + "documentation":"

The name of the partitions' table.

" + }, + "ColumnStatisticsList":{ + "shape":"UpdateColumnStatisticsList", + "documentation":"

A list of the column statistics.

" + } + } + }, + "UpdateColumnStatisticsForTableResponse":{ + "type":"structure", + "members":{ + "Errors":{ + "shape":"ColumnStatisticsErrors", + "documentation":"

List of ColumnStatisticsErrors.

" + } + } + }, + "UpdateColumnStatisticsList":{ + "type":"list", + "member":{"shape":"ColumnStatistics"}, + "max":25, + "min":0 + }, "UpdateConnectionRequest":{ "type":"structure", "required":[ @@ -9749,7 +10582,7 @@ }, "DatabaseName":{ "shape":"NameString", - "documentation":"

The name of the database where the function resides.

" + "documentation":"

The name of the catalog database that contains the function.

" }, "ClassName":{ "shape":"NameString", @@ -9770,6 +10603,10 @@ "ResourceUris":{ "shape":"ResourceUriList", "documentation":"

The resource URIs for the function.

" + }, + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The ID of the Data Catalog in which the function resides.

" } }, "documentation":"

Represents the equivalent of a Hive user-defined function (UDF) definition.

" diff --git a/botocore/data/honeycode/2020-03-01/paginators-1.json b/botocore/data/honeycode/2020-03-01/paginators-1.json new file mode 100644 index 00000000..ea142457 --- /dev/null +++ b/botocore/data/honeycode/2020-03-01/paginators-1.json @@ -0,0 +1,3 @@ +{ + "pagination": {} +} diff --git a/botocore/data/honeycode/2020-03-01/service-2.json b/botocore/data/honeycode/2020-03-01/service-2.json new file mode 100644 index 00000000..4ec967eb --- /dev/null +++ b/botocore/data/honeycode/2020-03-01/service-2.json @@ -0,0 +1,411 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-03-01", + "endpointPrefix":"honeycode", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceAbbreviation":"Honeycode", + "serviceFullName":"Amazon Honeycode", + "serviceId":"Honeycode", + "signatureVersion":"v4", + "signingName":"honeycode", + "uid":"honeycode-2020-03-01" + }, + "operations":{ + "GetScreenData":{ + "name":"GetScreenData", + "http":{ + "method":"POST", + "requestUri":"/screendata" + }, + "input":{"shape":"GetScreenDataRequest"}, + "output":{"shape":"GetScreenDataResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"RequestTimeoutException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"ThrottlingException"}, + {"shape":"ValidationException"} + ], + "documentation":"

The GetScreenData API allows retrieval of data from a screen in a Honeycode app. The API allows setting local variables in the screen to filter, sort or otherwise affect what will be displayed on the screen.

" + }, + "InvokeScreenAutomation":{ + "name":"InvokeScreenAutomation", + "http":{ + "method":"POST", + "requestUri":"/workbooks/{workbookId}/apps/{appId}/screens/{screenId}/automations/{automationId}" + }, + "input":{"shape":"InvokeScreenAutomationRequest"}, + "output":{"shape":"InvokeScreenAutomationResult"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ThrottlingException"}, + {"shape":"ServiceUnavailableException"}, + {"shape":"AutomationExecutionException"}, + {"shape":"AutomationExecutionTimeoutException"}, + {"shape":"RequestTimeoutException"} + ], + "documentation":"

The InvokeScreenAutomation API allows invoking an action defined in a screen in a Honeycode app. The API allows setting local variables, which can then be used in the automation being invoked. This allows automating the Honeycode app interactions to write, update or delete data in the workbook.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

You do not have sufficient access to perform this action. Check that the workbook is owned by you and your IAM policy allows access to the screen/automation in the request.

", + "error":{"httpStatusCode":403}, + "exception":true + }, + "AutomationExecutionException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The automation execution did not end successfully.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "AutomationExecutionTimeoutException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The automation execution timed out.

", + "error":{"httpStatusCode":504}, + "exception":true + }, + "ClientRequestToken":{ + "type":"string", + "max":64, + "min":32 + }, + "ColumnMetadata":{ + "type":"structure", + "required":[ + "name", + "format" + ], + "members":{ + "name":{ + "shape":"Name", + "documentation":"

The name of the column.

" + }, + "format":{ + "shape":"Format", + "documentation":"

The format of the column.

" + } + }, + "documentation":"

Metadata for column in the table.

" + }, + "DataItem":{ + "type":"structure", + "members":{ + "overrideFormat":{ + "shape":"Format", + "documentation":"

The overrideFormat is optional and is specified only if a particular row of data has a different format for the data than the default format defined on the screen or the table.

" + }, + "rawValue":{ + "shape":"RawValue", + "documentation":"

The raw value of the data. e.g. jsmith@example.com

" + }, + "formattedValue":{ + "shape":"FormattedValue", + "documentation":"

The formatted value of the data. e.g. John Smith.

" + } + }, + "documentation":"

The data in a particular data cell defined on the screen.

", + "sensitive":true + }, + "DataItems":{ + "type":"list", + "member":{"shape":"DataItem"} + }, + "ErrorMessage":{"type":"string"}, + "Format":{ + "type":"string", + "enum":[ + "AUTO", + "NUMBER", + "CURRENCY", + "DATE", + "TIME", + "DATE_TIME", + "PERCENTAGE", + "TEXT", + "ACCOUNTING", + "CONTACT", + "ROWLINK" + ] + }, + "FormattedValue":{"type":"string"}, + "GetScreenDataRequest":{ + "type":"structure", + "required":[ + "workbookId", + "appId", + "screenId" + ], + "members":{ + "workbookId":{ + "shape":"ResourceId", + "documentation":"

The ID of the workbook that contains the screen.

" + }, + "appId":{ + "shape":"ResourceId", + "documentation":"

The ID of the app that contains the screem.

" + }, + "screenId":{ + "shape":"ResourceId", + "documentation":"

The ID of the screen.

" + }, + "variables":{ + "shape":"VariableValueMap", + "documentation":"

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

" + }, + "maxResults":{ + "shape":"MaxResults", + "documentation":"

The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.

This parameter is optional. If you don't specify this parameter, the default page size is 100.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

" + } + } + }, + "GetScreenDataResult":{ + "type":"structure", + "required":[ + "results", + "workbookCursor" + ], + "members":{ + "results":{ + "shape":"ResultSetMap", + "documentation":"

A map of all the rows on the screen keyed by block name.

" + }, + "workbookCursor":{ + "shape":"WorkbookCursor", + "documentation":"

Indicates the cursor of the workbook at which the data returned by this workbook is read. Workbook cursor keeps increasing with every update and the increments are not sequential.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

Provides the pagination token to load the next page if there are more results matching the request. If a pagination token is not present in the response, it means that all data matching the query has been loaded.

" + } + } + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

There were unexpected errors from the server.

", + "error":{"httpStatusCode":500}, + "exception":true + }, + "InvokeScreenAutomationRequest":{ + "type":"structure", + "required":[ + "workbookId", + "appId", + "screenId", + "screenAutomationId" + ], + "members":{ + "workbookId":{ + "shape":"ResourceId", + "documentation":"

The ID of the workbook that contains the screen automation.

", + "location":"uri", + "locationName":"workbookId" + }, + "appId":{ + "shape":"ResourceId", + "documentation":"

The ID of the app that contains the screen automation.

", + "location":"uri", + "locationName":"appId" + }, + "screenId":{ + "shape":"ResourceId", + "documentation":"

The ID of the screen that contains the screen automation.

", + "location":"uri", + "locationName":"screenId" + }, + "screenAutomationId":{ + "shape":"ResourceId", + "documentation":"

The ID of the automation action to be performed.

", + "location":"uri", + "locationName":"automationId" + }, + "variables":{ + "shape":"VariableValueMap", + "documentation":"

Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

" + }, + "rowId":{ + "shape":"RowId", + "documentation":"

The row ID for the automation if the automation is defined inside a block with source or list.

" + }, + "clientRequestToken":{ + "shape":"ClientRequestToken", + "documentation":"

The request token for performing the automation action. Request tokens help to identify duplicate requests. If a call times out or fails due to a transient error like a failed network connection, you can retry the call with the same request token. The service ensures that if the first call using that request token is successfully performed, the second call will return the response of the previous call rather than performing the action again.

Note that request tokens are valid only for a few minutes. You cannot use request tokens to dedupe requests spanning hours or days.

" + } + } + }, + "InvokeScreenAutomationResult":{ + "type":"structure", + "required":["workbookCursor"], + "members":{ + "workbookCursor":{ + "shape":"WorkbookCursor", + "documentation":"

The updated workbook cursor after performing the automation action.

" + } + } + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "Name":{ + "type":"string", + "sensitive":true + }, + "PaginationToken":{ + "type":"string", + "max":1024, + "min":1 + }, + "RawValue":{"type":"string"}, + "RequestTimeoutException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

The request timed out.

", + "error":{"httpStatusCode":504}, + "exception":true + }, + "ResourceId":{ + "type":"string", + "pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

A Workbook, App, Screen or Screen Automation was not found with the given ID.

", + "error":{"httpStatusCode":404}, + "exception":true + }, + "ResultHeader":{ + "type":"list", + "member":{"shape":"ColumnMetadata"} + }, + "ResultRow":{ + "type":"structure", + "required":["dataItems"], + "members":{ + "rowId":{ + "shape":"RowId", + "documentation":"

The ID for a particular row.

" + }, + "dataItems":{ + "shape":"DataItems", + "documentation":"

List of all the data cells in a row.

" + } + }, + "documentation":"

A single row in the ResultSet.

" + }, + "ResultRows":{ + "type":"list", + "member":{"shape":"ResultRow"} + }, + "ResultSet":{ + "type":"structure", + "required":[ + "headers", + "rows" + ], + "members":{ + "headers":{ + "shape":"ResultHeader", + "documentation":"

List of headers for all the data cells in the block. The header identifies the name and default format of the data cell. Data cells appear in the same order in all rows as defined in the header. The names and formats are not repeated in the rows. If a particular row does not have a value for a data cell, a blank value is used.

For example, a task list that displays the task name, due date and assigned person might have headers [ { \"name\": \"Task Name\"}, {\"name\": \"Due Date\", \"format\": \"DATE\"}, {\"name\": \"Assigned\", \"format\": \"CONTACT\"} ]. Every row in the result will have the task name as the first item, due date as the second item and assigned person as the third item. If a particular task does not have a due date, that row will still have a blank value in the second element and the assigned person will still be in the third element.

" + }, + "rows":{ + "shape":"ResultRows", + "documentation":"

List of rows returned by the request. Each row has a row Id and a list of data cells in that row. The data cells will be present in the same order as they are defined in the header.

" + } + }, + "documentation":"

ResultSet contains the results of the request for a single block or list defined on the screen.

" + }, + "ResultSetMap":{ + "type":"map", + "key":{"shape":"Name"}, + "value":{"shape":"ResultSet"} + }, + "RowId":{ + "type":"string", + "pattern":"row:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}\\/[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}" + }, + "ServiceUnavailableException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Remote service is unreachable.

", + "error":{"httpStatusCode":503}, + "exception":true + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Tps(transactions per second) rate reached.

", + "error":{"httpStatusCode":429}, + "exception":true + }, + "ValidationException":{ + "type":"structure", + "required":["message"], + "members":{ + "message":{"shape":"ErrorMessage"} + }, + "documentation":"

Request is invalid. The message in the response contains details on why the request is invalid.

", + "error":{"httpStatusCode":400}, + "exception":true + }, + "VariableName":{ + "type":"string", + "sensitive":true + }, + "VariableValue":{ + "type":"structure", + "required":["rawValue"], + "members":{ + "rawValue":{ + "shape":"RawValue", + "documentation":"

Raw value of the variable.

" + } + }, + "documentation":"

The input variables to the app to be used by the InvokeScreenAutomation action request.

", + "sensitive":true + }, + "VariableValueMap":{ + "type":"map", + "key":{"shape":"VariableName"}, + "value":{"shape":"VariableValue"}, + "sensitive":true + }, + "WorkbookCursor":{"type":"long"} + }, + "documentation":"

Amazon Honeycode is a fully managed service that allows you to quickly build mobile and web apps for teams—without programming. Build Honeycode apps for managing almost anything, like projects, customers, operations, approvals, resources, and even your team.

" +} diff --git a/botocore/data/iam/2010-05-08/service-2.json b/botocore/data/iam/2010-05-08/service-2.json index 59704532..97e6e500 100644 --- a/botocore/data/iam/2010-05-08/service-2.json +++ b/botocore/data/iam/2010-05-08/service-2.json @@ -42,7 +42,7 @@ {"shape":"UnmodifiableEntityException"}, {"shape":"ServiceFailureException"} ], - "documentation":"

Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role, and this limit cannot be increased. You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of AWS because of eventual consistency. To force the change, you must disassociate the instance profile and then associate the instance profile, or you can stop your instance and then restart it.

The caller of this API must be granted the PassRole permission on the IAM role by a permissions policy.

For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.

" + "documentation":"

Adds the specified IAM role to the specified instance profile. An instance profile can contain only one role. (The number and size of IAM resources in an AWS account are limited. For more information, see IAM and STS Quotas in the IAM User Guide.) You can remove the existing role and then add a different role to an instance profile. You must then wait for the change to appear across all of AWS because of eventual consistency. To force the change, you must disassociate the instance profile and then associate the instance profile, or you can stop your instance and then restart it.

The caller of this API must be granted the PassRole permission on the IAM role by a permissions policy.

For more information about roles, go to Working with Roles. For more information about instance profiles, go to About Instance Profiles.

" }, "AddUserToGroup":{ "name":"AddUserToGroup", @@ -140,7 +140,7 @@ {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], - "documentation":"

Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is Active.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials. This is true even if the AWS account has no associated users.

For information about limits on the number of keys you can create, see Limitations on IAM Entities in the IAM User Guide.

To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.

" + "documentation":"

Creates a new AWS secret access key and corresponding AWS access key ID for the specified user. The default status for new keys is Active.

If you do not specify a user name, IAM determines the user name implicitly based on the AWS access key ID signing the request. This operation works for access keys under the AWS account. Consequently, you can use this operation to manage AWS account root user credentials. This is true even if the AWS account has no associated users.

The number and size of IAM resources in an AWS account are limited. For more information, see IAM and STS Quotas in the IAM User Guide.

To ensure the security of your AWS account, the secret access key is accessible only during key and user creation. You must save the key (for example, in a text file) if you want to be able to access it again. If a secret key is lost, you can delete the access keys for the associated user and then create new keys.

" }, "CreateAccountAlias":{ "name":"CreateAccountAlias", @@ -173,7 +173,7 @@ {"shape":"NoSuchEntityException"}, {"shape":"ServiceFailureException"} ], - "documentation":"

Creates a new group.

For information about the number of groups you can create, see Limitations on IAM Entities in the IAM User Guide.

" + "documentation":"

Creates a new group.

The number and size of IAM resources in an AWS account are limited. For more information, see IAM and STS Quotas in the IAM User Guide.

" }, "CreateInstanceProfile":{ "name":"CreateInstanceProfile", @@ -191,7 +191,7 @@ {"shape":"LimitExceededException"}, {"shape":"ServiceFailureException"} ], - "documentation":"

Creates a new instance profile. For information about instance profiles, go to About Instance Profiles.

For information about the number of instance profiles you can create, see Limitations on IAM Entities in the IAM User Guide.

" + "documentation":"

Creates a new instance profile. For information about instance profiles, go to About Instance Profiles.

The number and size of IAM resources in an AWS account are limited. For more information, see IAM and STS Quotas in the IAM User Guide.

" }, "CreateLoginProfile":{ "name":"CreateLoginProfile", @@ -291,7 +291,7 @@ {"shape":"ConcurrentModificationException"}, {"shape":"ServiceFailureException"} ], - "documentation":"

Creates a new role for your AWS account. For more information about roles, go to IAM Roles. For information about limitations on role names and the number of roles you can create, go to Limitations on IAM Entities in the IAM User Guide.

" + "documentation":"

Creates a new role for your AWS account. For more information about roles, go to IAM Roles. The number and size of IAM resources in an AWS account are limited. For more information, see IAM and STS Quotas in the IAM User Guide.

" }, "CreateSAMLProvider":{ "name":"CreateSAMLProvider", @@ -368,7 +368,7 @@ {"shape":"ConcurrentModificationException"}, {"shape":"ServiceFailureException"} ], - "documentation":"

Creates a new IAM user for your AWS account.

For information about limitations on the number of IAM users you can create, see Limitations on IAM Entities in the IAM User Guide.

" + "documentation":"

Creates a new IAM user for your AWS account.

The number and size of IAM resources in an AWS account are limited. For more information, see IAM and STS Quotas in the IAM User Guide.

" }, "CreateVirtualMFADevice":{ "name":"CreateVirtualMFADevice", @@ -386,7 +386,7 @@ {"shape":"EntityAlreadyExistsException"}, {"shape":"ServiceFailureException"} ], - "documentation":"

Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.

For information about limits on the number of MFA devices you can create, see Limitations on Entities in the IAM User Guide.

The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.

" + "documentation":"

Creates a new virtual MFA device for the AWS account. After creating the virtual MFA, use EnableMFADevice to attach the MFA device to an IAM user. For more information about creating and working with virtual MFA devices, go to Using a Virtual MFA Device in the IAM User Guide.

The number and size of IAM resources in an AWS account are limited. For more information, see IAM and STS Quotas in the IAM User Guide.

The seed information contained in the QR code and the Base32 string should be treated like any other secret access information. In other words, protect the seed information as you would your AWS access keys or your passwords. After you provision your virtual device, you should ensure that the information is destroyed following secure procedures.

" }, "DeactivateMFADevice":{ "name":"DeactivateMFADevice", @@ -909,7 +909,7 @@ "errors":[ {"shape":"ServiceFailureException"} ], - "documentation":"

Retrieves information about IAM entity usage and IAM quotas in the AWS account.

For information about limitations on IAM entities, see Limitations on IAM Entities in the IAM User Guide.

" + "documentation":"

Retrieves information about IAM entity usage and IAM quotas in the AWS account.

The number and size of IAM resources in an AWS account are limited. For more information, see IAM and STS Quotas in the IAM User Guide.

" }, "GetContextKeysForCustomPolicy":{ "name":"GetContextKeysForCustomPolicy", @@ -4681,7 +4681,7 @@ "members":{ "message":{"shape":"limitExceededMessage"} }, - "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.

", + "documentation":"

The request was rejected because it attempted to create resources beyond the current AWS account limitations. The error message describes the limit exceeded.

", "error":{ "code":"LimitExceeded", "httpStatusCode":409, diff --git a/botocore/data/imagebuilder/2019-12-02/service-2.json b/botocore/data/imagebuilder/2019-12-02/service-2.json index d22ee968..1a8848de 100644 --- a/botocore/data/imagebuilder/2019-12-02/service-2.json +++ b/botocore/data/imagebuilder/2019-12-02/service-2.json @@ -868,6 +868,10 @@ "shape":"TagMap", "documentation":"

The tags to apply to AMIs distributed to this Region.

" }, + "kmsKeyId":{ + "shape":"NonEmptyString", + "documentation":"

The KMS key identifier used to encrypt the distributed image.

" + }, "launchPermission":{ "shape":"LaunchPermissionConfiguration", "documentation":"

Launch permissions can be used to configure which AWS accounts can use the AMI to launch instances.

" @@ -2827,7 +2831,7 @@ "documentation":"

The name of the group.

" } }, - "documentation":"

Describes the configuration for a launch permission. The launch permission modification request is sent to the EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI.

" + "documentation":"

Describes the configuration for a launch permission. The launch permission modification request is sent to the EC2 ModifyImageAttribute API on behalf of the user for each Region they have selected to distribute the AMI. To make an AMI public, set the launch permission authorized accounts to all. See the examples for making an AMI public at EC2 ModifyImageAttribute.

" }, "ListComponentBuildVersionsRequest":{ "type":"structure", diff --git a/botocore/data/iotsitewise/2019-12-02/service-2.json b/botocore/data/iotsitewise/2019-12-02/service-2.json index 0e98ce91..b7eaf33a 100644 --- a/botocore/data/iotsitewise/2019-12-02/service-2.json +++ b/botocore/data/iotsitewise/2019-12-02/service-2.json @@ -3164,10 +3164,6 @@ }, "GetAssetPropertyValueHistoryRequest":{ "type":"structure", - "required":[ - "startDate", - "endDate" - ], "members":{ "assetId":{ "shape":"ID", diff --git a/botocore/data/ivs/2020-07-14/paginators-1.json b/botocore/data/ivs/2020-07-14/paginators-1.json new file mode 100644 index 00000000..37ae105e --- /dev/null +++ b/botocore/data/ivs/2020-07-14/paginators-1.json @@ -0,0 +1,22 @@ +{ + "pagination": { + "ListChannels": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "channels" + }, + "ListStreamKeys": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "streamKeys" + }, + "ListStreams": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults", + "result_key": "streams" + } + } +} diff --git a/botocore/data/ivs/2020-07-14/service-2.json b/botocore/data/ivs/2020-07-14/service-2.json new file mode 100644 index 00000000..18aa30d0 --- /dev/null +++ b/botocore/data/ivs/2020-07-14/service-2.json @@ -0,0 +1,1082 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-07-14", + "endpointPrefix":"ivs", + "protocol":"rest-json", + "serviceAbbreviation":"Amazon IVS", + "serviceFullName":"Amazon Interactive Video Service", + "serviceId":"ivs", + "signatureVersion":"v4", + "signingName":"ivs", + "uid":"ivs-2020-07-14" + }, + "operations":{ + "BatchGetChannel":{ + "name":"BatchGetChannel", + "http":{ + "method":"POST", + "requestUri":"/BatchGetChannel" + }, + "input":{"shape":"BatchGetChannelRequest"}, + "output":{"shape":"BatchGetChannelResponse"}, + "documentation":"

Performs GetChannel on multiple ARNs simultaneously.

" + }, + "BatchGetStreamKey":{ + "name":"BatchGetStreamKey", + "http":{ + "method":"POST", + "requestUri":"/BatchGetStreamKey" + }, + "input":{"shape":"BatchGetStreamKeyRequest"}, + "output":{"shape":"BatchGetStreamKeyResponse"}, + "documentation":"

Performs GetStreamKey on multiple ARNs simultaneously.

" + }, + "CreateChannel":{ + "name":"CreateChannel", + "http":{ + "method":"POST", + "requestUri":"/CreateChannel" + }, + "input":{"shape":"CreateChannelRequest"}, + "output":{"shape":"CreateChannelResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Creates a new channel and an associated stream key to start streaming.

" + }, + "CreateStreamKey":{ + "name":"CreateStreamKey", + "http":{ + "method":"POST", + "requestUri":"/CreateStreamKey" + }, + "input":{"shape":"CreateStreamKeyRequest"}, + "output":{"shape":"CreateStreamKeyResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ServiceQuotaExceededException"} + ], + "documentation":"

Creates a stream key, used to initiate a stream, for a specified channel ARN.

Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.

" + }, + "DeleteChannel":{ + "name":"DeleteChannel", + "http":{ + "method":"POST", + "requestUri":"/DeleteChannel" + }, + "input":{"shape":"DeleteChannelRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Deletes a specified channel and its associated stream keys.

" + }, + "DeleteStreamKey":{ + "name":"DeleteStreamKey", + "http":{ + "method":"POST", + "requestUri":"/DeleteStreamKey" + }, + "input":{"shape":"DeleteStreamKeyRequest"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Deletes the stream key for a specified ARN, so it can no longer be used to stream.

" + }, + "GetChannel":{ + "name":"GetChannel", + "http":{ + "method":"POST", + "requestUri":"/GetChannel" + }, + "input":{"shape":"GetChannelRequest"}, + "output":{"shape":"GetChannelResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets the channel configuration for a specified channel ARN. See also BatchGetChannel.

" + }, + "GetStream":{ + "name":"GetStream", + "http":{ + "method":"POST", + "requestUri":"/GetStream" + }, + "input":{"shape":"GetStreamRequest"}, + "output":{"shape":"GetStreamResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ChannelNotBroadcasting"} + ], + "documentation":"

Gets information about the active (live) stream on a specified channel.

" + }, + "GetStreamKey":{ + "name":"GetStreamKey", + "http":{ + "method":"POST", + "requestUri":"/GetStreamKey" + }, + "input":{"shape":"GetStreamKeyRequest"}, + "output":{"shape":"GetStreamKeyResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets stream-key information for a specified ARN.

" + }, + "ListChannels":{ + "name":"ListChannels", + "http":{ + "method":"POST", + "requestUri":"/ListChannels" + }, + "input":{"shape":"ListChannelsRequest"}, + "output":{"shape":"ListChannelsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Gets summary information about channels. This list can be filtered to match a specified string.

" + }, + "ListStreamKeys":{ + "name":"ListStreamKeys", + "http":{ + "method":"POST", + "requestUri":"/ListStreamKeys" + }, + "input":{"shape":"ListStreamKeysRequest"}, + "output":{"shape":"ListStreamKeysResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets summary information about stream keys. The list can be filtered to a particular channel.

" + }, + "ListStreams":{ + "name":"ListStreams", + "http":{ + "method":"POST", + "requestUri":"/ListStreams" + }, + "input":{"shape":"ListStreamsRequest"}, + "output":{"shape":"ListStreamsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"} + ], + "documentation":"

Gets summary information about live streams.

" + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Gets information about the tags for a specified ARN.

" + }, + "PutMetadata":{ + "name":"PutMetadata", + "http":{ + "method":"POST", + "requestUri":"/PutMetadata" + }, + "input":{"shape":"PutMetadataRequest"}, + "errors":[ + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ChannelNotBroadcasting"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ], + "documentation":"

Inserts metadata into an RTMP stream for a specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.

" + }, + "StopStream":{ + "name":"StopStream", + "http":{ + "method":"POST", + "requestUri":"/StopStream" + }, + "input":{"shape":"StopStreamRequest"}, + "output":{"shape":"StopStreamResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ChannelNotBroadcasting"}, + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"StreamUnavailable"} + ], + "documentation":"

Disconnects the stream for the specified channel. This disconnects the incoming RTMP stream from the client. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.

Many streaming client-software libraries automatically reconnect a dropped RTMP session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.

" + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Adds or updates tags for a resource with a specified ARN.

" + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"InternalServerException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"

Removes tags for a resource with a specified ARN.

" + }, + "UpdateChannel":{ + "name":"UpdateChannel", + "http":{ + "method":"POST", + "requestUri":"/UpdateChannel" + }, + "input":{"shape":"UpdateChannelRequest"}, + "output":{"shape":"UpdateChannelResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"} + ], + "documentation":"

Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.

" + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"

User does not have sufficient access to perform this action.

" + } + }, + "error":{"httpStatusCode":403}, + "exception":true + }, + "BatchError":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"ResourceArn", + "documentation":"

Channel ARN.

" + }, + "code":{ + "shape":"errorCode", + "documentation":"

Error code.

" + }, + "message":{ + "shape":"errorMessage", + "documentation":"

Error message, determined by the application.

" + } + }, + "documentation":"

Error related to a specific channel, specified by its ARN.

" + }, + "BatchErrors":{ + "type":"list", + "member":{"shape":"BatchError"} + }, + "BatchGetChannelRequest":{ + "type":"structure", + "required":["arns"], + "members":{ + "arns":{ + "shape":"ChannelArnList", + "documentation":"

Array of ARNs, one per channel.

" + } + } + }, + "BatchGetChannelResponse":{ + "type":"structure", + "members":{ + "channels":{"shape":"Channels"}, + "errors":{ + "shape":"BatchErrors", + "documentation":"

Each error object is related to a specific ARN in the request.

" + } + } + }, + "BatchGetStreamKeyRequest":{ + "type":"structure", + "required":["arns"], + "members":{ + "arns":{ + "shape":"StreamKeyArnList", + "documentation":"

Array of ARNs, one per channel.

" + } + } + }, + "BatchGetStreamKeyResponse":{ + "type":"structure", + "members":{ + "streamKeys":{"shape":"StreamKeys"}, + "errors":{"shape":"BatchErrors"} + } + }, + "Channel":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"ChannelArn", + "documentation":"

Channel ARN.

" + }, + "name":{ + "shape":"ChannelName", + "documentation":"

Channel name.

" + }, + "latencyMode":{ + "shape":"ChannelLatencyMode", + "documentation":"

Channel latency mode. Default: LOW.

" + }, + "type":{ + "shape":"ChannelType", + "documentation":"

Channel type, which determines the allowable resolution and bitrate. STANDARD: The stream is transcoded; resolution (width, in landscape orientation) can be up to 1080p or the input source resolution, whichever is lower; and bitrate can be up to 8.5 Mbps. BASIC: The stream is transfixed; resolution can be up to 480p; and bitrate can be up to 1.5 Mbps. Default STANDARD.

" + }, + "ingestEndpoint":{ + "shape":"IngestEndpoint", + "documentation":"

Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.

" + }, + "playbackUrl":{ + "shape":"PlaybackURL", + "documentation":"

Channel playback URL.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

Array of 1-50 maps, each of the form string:string (key:value).

" + } + }, + "documentation":"

Object specifying a channel.

" + }, + "ChannelArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:channel/[a-zA-Z0-9-]+$" + }, + "ChannelArnList":{ + "type":"list", + "member":{"shape":"ChannelArn"}, + "max":50, + "min":1 + }, + "ChannelLatencyMode":{ + "type":"string", + "enum":[ + "NORMAL", + "LOW" + ] + }, + "ChannelList":{ + "type":"list", + "member":{"shape":"ChannelSummary"} + }, + "ChannelName":{ + "type":"string", + "max":128, + "min":0, + "pattern":"^[a-zA-Z0-9-_]*$" + }, + "ChannelNotBroadcasting":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"

The stream is offline for the given channel ARN.

" + } + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "ChannelSummary":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"ChannelArn", + "documentation":"

Channel ARN.

" + }, + "name":{ + "shape":"ChannelName", + "documentation":"

Channel name.

" + }, + "latencyMode":{ + "shape":"ChannelLatencyMode", + "documentation":"

Channel latency mode. Default: LOW.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

Array of 1-50 maps, each of the form string:string (key:value).

" + } + }, + "documentation":"

Summary information about a channel.

" + }, + "ChannelType":{ + "type":"string", + "enum":[ + "BASIC", + "STANDARD" + ] + }, + "Channels":{ + "type":"list", + "member":{"shape":"Channel"} + }, + "ConflictException":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"

Updating or deleting a resource can cause an inconsistent state.

" + } + }, + "error":{"httpStatusCode":409}, + "exception":true + }, + "CreateChannelRequest":{ + "type":"structure", + "members":{ + "name":{ + "shape":"ChannelName", + "documentation":"

Channel name.

" + }, + "latencyMode":{ + "shape":"ChannelLatencyMode", + "documentation":"

Channel latency mode. Default: LOW.

" + }, + "type":{ + "shape":"ChannelType", + "documentation":"

Channel type, which determines the allowable resolution and bitrate. STANDARD: The stream is transcoded; resolution (width, in landscape orientation) can be up to 1080p or the input source resolution, whichever is lower; and bitrate can be up to 8.5 Mbps. BASIC: The stream is transfixed; resolution can be up to 480p; and bitrate can be up to 1.5 Mbps. Default: STANDARD.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

See Channel$tags.

" + } + } + }, + "CreateChannelResponse":{ + "type":"structure", + "members":{ + "channel":{"shape":"Channel"}, + "streamKey":{"shape":"StreamKey"} + } + }, + "CreateStreamKeyRequest":{ + "type":"structure", + "required":["channelArn"], + "members":{ + "channelArn":{ + "shape":"ChannelArn", + "documentation":"

ARN of the channel for which to create the stream key.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

See Channel$tags.

" + } + } + }, + "CreateStreamKeyResponse":{ + "type":"structure", + "members":{ + "streamKey":{ + "shape":"StreamKey", + "documentation":"

Stream key used to authenticate an RTMP stream for ingestion.

" + } + } + }, + "DeleteChannelRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"ChannelArn", + "documentation":"

ARN of the channel to be deleted.

" + } + } + }, + "DeleteStreamKeyRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"StreamKeyArn", + "documentation":"

ARN of the stream key to be deleted.

" + } + } + }, + "GetChannelRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"ChannelArn", + "documentation":"

ARN of the channel for which the configuration is to be retrieved.

" + } + } + }, + "GetChannelResponse":{ + "type":"structure", + "members":{ + "channel":{"shape":"Channel"} + } + }, + "GetStreamKeyRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"StreamKeyArn", + "documentation":"

ARN for the stream key to be retrieved.

" + } + } + }, + "GetStreamKeyResponse":{ + "type":"structure", + "members":{ + "streamKey":{"shape":"StreamKey"} + } + }, + "GetStreamRequest":{ + "type":"structure", + "required":["channelArn"], + "members":{ + "channelArn":{ + "shape":"ChannelArn", + "documentation":"

Channel ARN for stream to be accessed.

" + } + } + }, + "GetStreamResponse":{ + "type":"structure", + "members":{ + "stream":{"shape":"Stream"} + } + }, + "IngestEndpoint":{"type":"string"}, + "InternalServerException":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"

Unexpected error during processing of request.

" + } + }, + "error":{"httpStatusCode":500}, + "exception":true + }, + "ListChannelsRequest":{ + "type":"structure", + "members":{ + "filterByName":{ + "shape":"ChannelName", + "documentation":"

Filters the channel list to match the specified name.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The first channel to retrieve. This is used for pagination; see the nextToken response field.

" + }, + "maxResults":{ + "shape":"MaxChannelResults", + "documentation":"

Maximum number of channels to return.

" + } + } + }, + "ListChannelsResponse":{ + "type":"structure", + "required":["channels"], + "members":{ + "channels":{ + "shape":"ChannelList", + "documentation":"

List of the matching channels.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

If there are more channels than maxResults, use nextToken in the request to get the next set.

" + } + } + }, + "ListStreamKeysRequest":{ + "type":"structure", + "required":["channelArn"], + "members":{ + "channelArn":{ + "shape":"ChannelArn", + "documentation":"

Channel ARN used to filter the list.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The first stream key to retrieve. This is used for pagination; see the nextToken response field.

" + }, + "maxResults":{ + "shape":"MaxStreamKeyResults", + "documentation":"

Maximum number of streamKeys to return.

" + } + } + }, + "ListStreamKeysResponse":{ + "type":"structure", + "required":["streamKeys"], + "members":{ + "streamKeys":{ + "shape":"StreamKeyList", + "documentation":"

List of stream keys.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

If there are more stream keys than maxResults, use nextToken in the request to get the next set.

" + } + } + }, + "ListStreamsRequest":{ + "type":"structure", + "members":{ + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

The first stream to retrieve. This is used for pagination; see the nextToken response field.

" + }, + "maxResults":{ + "shape":"MaxStreamResults", + "documentation":"

Maximum number of streams to return.

" + } + } + }, + "ListStreamsResponse":{ + "type":"structure", + "required":["streams"], + "members":{ + "streams":{ + "shape":"StreamList", + "documentation":"

List of streams.

" + }, + "nextToken":{ + "shape":"PaginationToken", + "documentation":"

If there are more streams than maxResults, use nextToken in the request to get the next set.

" + } + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

The ARN of the resource to be retrieved.

", + "location":"uri", + "locationName":"resourceArn" + }, + "nextToken":{ + "shape":"String", + "documentation":"

The first tag to retrieve. This is used for pagination; see the nextToken response field.

" + }, + "maxResults":{ + "shape":"MaxTagResults", + "documentation":"

Maximum number of tags to return.

" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "required":["tags"], + "members":{ + "tags":{"shape":"Tags"}, + "nextToken":{ + "shape":"String", + "documentation":"

If there are more tags than maxResults, use nextToken in the request to get the next set.

" + } + } + }, + "MaxChannelResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "MaxStreamKeyResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "MaxStreamResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "MaxTagResults":{ + "type":"integer", + "max":50, + "min":1 + }, + "PaginationToken":{ + "type":"string", + "max":500, + "min":0 + }, + "PlaybackURL":{"type":"string"}, + "PutMetadataRequest":{ + "type":"structure", + "required":[ + "channelArn", + "metadata" + ], + "members":{ + "channelArn":{ + "shape":"ChannelArn", + "documentation":"

ARN of the channel into which metadata is inserted. This channel must have an active stream.

" + }, + "metadata":{ + "shape":"StreamMetadata", + "documentation":"

Metadata to insert into the stream. Maximum: 1 KB per request.

" + } + } + }, + "ResourceArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:[a-z-]/[a-zA-Z0-9-]+$" + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"

Request references a resource which does not exist.

" + } + }, + "error":{"httpStatusCode":404}, + "exception":true + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"

Request would cause a service quota to be exceeded.

" + } + }, + "error":{"httpStatusCode":402}, + "exception":true + }, + "StopStreamRequest":{ + "type":"structure", + "required":["channelArn"], + "members":{ + "channelArn":{ + "shape":"ChannelArn", + "documentation":"

ARN of the channel for which the stream is to be stopped.

" + } + } + }, + "StopStreamResponse":{ + "type":"structure", + "members":{ + } + }, + "Stream":{ + "type":"structure", + "members":{ + "channelArn":{ + "shape":"ChannelArn", + "documentation":"

Channel ARN for the stream.

" + }, + "playbackUrl":{ + "shape":"PlaybackURL", + "documentation":"

URL of the video master manifest, required by the video player to play the HLS stream.

" + }, + "startTime":{ + "shape":"StreamStartTime", + "documentation":"

ISO-8601 formatted timestamp of the stream’s start.

" + }, + "state":{ + "shape":"StreamState", + "documentation":"

The stream’s state.

" + }, + "health":{ + "shape":"StreamHealth", + "documentation":"

The stream’s health.

" + }, + "viewerCount":{ + "shape":"StreamViewerCount", + "documentation":"

Number of current viewers of the stream.

" + } + }, + "documentation":"

Specifies a live video stream that has been ingested and distributed.

" + }, + "StreamHealth":{ + "type":"string", + "enum":[ + "HEALTHY", + "STARVING", + "UNKNOWN" + ] + }, + "StreamKey":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"StreamKeyArn", + "documentation":"

Stream-key ARN.

" + }, + "value":{ + "shape":"StreamKeyValue", + "documentation":"

Stream-key value.

" + }, + "channelArn":{ + "shape":"ChannelArn", + "documentation":"

Channel ARN for the stream.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

Array of 1-50 maps, each of the form string:string (key:value)

" + } + }, + "documentation":"

Object specifying a stream key.

" + }, + "StreamKeyArn":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^arn:aws:[is]vs:[a-z0-9-]+:[0-9]+:stream-key/[a-zA-Z0-9-]+$" + }, + "StreamKeyArnList":{ + "type":"list", + "member":{"shape":"StreamKeyArn"}, + "max":50, + "min":1 + }, + "StreamKeyList":{ + "type":"list", + "member":{"shape":"StreamKeySummary"} + }, + "StreamKeySummary":{ + "type":"structure", + "members":{ + "arn":{ + "shape":"StreamKeyArn", + "documentation":"

Stream-key ARN.

" + }, + "channelArn":{ + "shape":"ChannelArn", + "documentation":"

Channel ARN for the stream.

" + }, + "tags":{ + "shape":"Tags", + "documentation":"

Array of 1-50 maps, each of the form string:string (key:value)

" + } + }, + "documentation":"

Summary information about a stream key.

" + }, + "StreamKeyValue":{"type":"string"}, + "StreamKeys":{ + "type":"list", + "member":{"shape":"StreamKey"} + }, + "StreamList":{ + "type":"list", + "member":{"shape":"StreamSummary"} + }, + "StreamMetadata":{"type":"string"}, + "StreamStartTime":{"type":"timestamp"}, + "StreamState":{ + "type":"string", + "enum":[ + "LIVE", + "OFFLINE" + ] + }, + "StreamSummary":{ + "type":"structure", + "members":{ + "channelArn":{ + "shape":"ChannelArn", + "documentation":"

Channel ARN for the stream.

" + }, + "state":{ + "shape":"StreamState", + "documentation":"

The stream’s state.

" + }, + "health":{ + "shape":"StreamHealth", + "documentation":"

The stream’s health.

" + }, + "viewerCount":{ + "shape":"StreamViewerCount", + "documentation":"

Number of current viewers of the stream.

" + }, + "startTime":{ + "shape":"StreamStartTime", + "documentation":"

ISO-8601 formatted timestamp of the stream’s start.

" + } + }, + "documentation":"

Summary information about a stream.

" + }, + "StreamUnavailable":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"

The stream is temporarily unavailable.

" + } + }, + "error":{"httpStatusCode":503}, + "exception":true + }, + "StreamViewerCount":{"type":"long"}, + "String":{"type":"string"}, + "TagKey":{ + "type":"string", + "max":128, + "min":1 + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

ARN of the resource for which tags are to be added or updated.

", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{ + "shape":"Tags", + "documentation":"

Array of tags to be added or updated.

" + } + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256 + }, + "Tags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"}, + "max":50, + "min":0 + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"

Request was denied due to request throttling.

" + } + }, + "error":{"httpStatusCode":429}, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"ResourceArn", + "documentation":"

ARN of the resource for which tags are to be removed.

", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "documentation":"

Array of tags to be removed.

", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateChannelRequest":{ + "type":"structure", + "required":["arn"], + "members":{ + "arn":{ + "shape":"ChannelArn", + "documentation":"

ARN of the channel to be updated.

" + }, + "name":{ + "shape":"ChannelName", + "documentation":"

Channel name.

" + }, + "latencyMode":{ + "shape":"ChannelLatencyMode", + "documentation":"

Channel latency mode. Default: LOW.

" + }, + "type":{ + "shape":"ChannelType", + "documentation":"

Channel type, which determines the allowable resolution and bitrate. STANDARD: The stream is transcoded; resolution (width, in landscape orientation) can be up to 1080p or the input source resolution, whichever is lower; and bitrate can be up to 8.5 Mbps. BASIC: The stream is transfixed; resolution can be up to 480p; and bitrate can be up to 1.5 Mbps. Default STANDARD.

" + } + } + }, + "UpdateChannelResponse":{ + "type":"structure", + "members":{ + "channel":{"shape":"Channel"} + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "exceptionMessage":{ + "shape":"errorMessage", + "documentation":"

The input fails to satisfy the constraints specified by an AWS service.

" + } + }, + "error":{"httpStatusCode":400}, + "exception":true + }, + "errorCode":{"type":"string"}, + "errorMessage":{"type":"string"} + }, + "documentation":"

Introduction

The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP API and an AWS SNS event stream for responses. JSON is used for both requests and responses, including errors.

The API is an AWS regional service, currently in these regions: us-west-2, us-east-2, and eu-west-1.

All API request parameters and URLs are case sensitive.

For a summary of notable documentation changes in each release, see Document History.

Allowed Header Values

  • Accept: application/json

  • Accept-Encoding: gzip, deflate

  • Content-Type: application/json

Resources

The following resources contain information about your IVS live stream (see Getting Started with Amazon IVS):

  • Channel — Stores configuration data related to your live stream. You first create a channel and then use the channel’s stream key to start your live stream. See the Channel endpoints for more information.

  • Stream key — An identifier assigned by Amazon IVS when you create a channel, which is then used to authorize streaming. See the StreamKey endpoints for more information. Treat the stream key like a secret, since it allows anyone to stream to the channel.

Tagging

A tag is a metadata label that you assign to an AWS resource. A tag comprises a key and a value, both set by you. For example, you might set a tag as topic:nature to label a particular video category. See Tagging AWS Resources for more information, including restrictions that apply to tags.

Tags can help you identify and organize your AWS resources. For example, you can use the same tag for different resources to indicate that they are related. You can also use tags to manage access (see Access Tags).

The Amazon IVS API has these tag-related endpoints: TagResource, UntagResource, and ListTagsForResource. The following resources support tagging: Channels and Stream Keys.

API Endpoints

Channel:

  • CreateChannel — Creates a new channel and an associated stream key to start streaming.

  • GetChannel — Gets the channel configuration for a specified channel ARN (Amazon Resource Name).

  • BatchGetChannel — Performs GetChannel on multiple ARNs simultaneously.

  • ListChannels — Gets summary information about channels. This list can be filtered to match a specified string.

  • UpdateChannel — Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.

  • DeleteChannel — Deletes a specified channel.

StreamKey:

  • CreateStreamKey — Creates a stream key, used to initiate a stream, for a specified channel ARN.

  • GetStreamKey — Gets stream key information for the specified ARN.

  • BatchGetStreamKey — Performs GetStreamKey on multiple ARNs simultaneously.

  • ListStreamKeys — Gets a list of stream keys. The list can be filtered to a particular channel.

  • DeleteStreamKey — Deletes the stream key for a specified ARN, so it can no longer be used to stream.

Stream:

  • GetStream — Gets information about the active (live) stream on a specified channel.

  • ListStreams — Gets summary information about live streams.

  • StopStream — Disconnects a streamer on a specified channel. This disconnects the incoming RTMP stream from the client. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel.

  • PutMetadata Inserts metadata into an RTMP stream for a specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.

AWS Tags:

  • TagResource — Adds or updates tags for an AWS resource with a specified ARN.

  • UntagResource — Removes tags from a resource with a specified ARN.

  • ListTagsForResource — Gets information about AWS tags for a specified ARN.

" +} diff --git a/botocore/data/lakeformation/2017-03-31/service-2.json b/botocore/data/lakeformation/2017-03-31/service-2.json index 428af939..1d12ef79 100644 --- a/botocore/data/lakeformation/2017-03-31/service-2.json +++ b/botocore/data/lakeformation/2017-03-31/service-2.json @@ -86,7 +86,7 @@ {"shape":"InvalidInputException"}, {"shape":"EntityNotFoundException"} ], - "documentation":"

The AWS Lake Formation principal.

" + "documentation":"

Retrieves the list of the data lake administrators of a Lake Formation-managed data lake.

" }, "GetEffectivePermissionsForPath":{ "name":"GetEffectivePermissionsForPath", @@ -102,7 +102,7 @@ {"shape":"OperationTimeoutException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Returns the permissions for a specified table or database resource located at a path in Amazon S3.

" + "documentation":"

Returns the Lake Formation permissions for a specified table or database resource located at a path in Amazon S3. GetEffectivePermissionsForPath will not return databases and tables if the catalog is encrypted.

" }, "GrantPermissions":{ "name":"GrantPermissions", @@ -117,7 +117,7 @@ {"shape":"EntityNotFoundException"}, {"shape":"InvalidInputException"} ], - "documentation":"

Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

For information about permissions, see Security and Access Control to Metadata and Data.

" + "documentation":"

Grants permissions to the principal to access metadata in the Data Catalog and data organized in underlying data storage such as Amazon S3.

For information about permissions, see Security and Access Control to Metadata and Data.

" }, "ListPermissions":{ "name":"ListPermissions", @@ -132,7 +132,7 @@ {"shape":"OperationTimeoutException"}, {"shape":"InternalServiceException"} ], - "documentation":"

Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.

This operation returns only those permissions that have been explicitly granted.

For information about permissions, see Security and Access Control to Metadata and Data.

" + "documentation":"

Returns a list of the principal permissions on the resource, filtered by the permissions of the caller. For example, if you are granted an ALTER permission, you are able to see only the principal permissions for ALTER.

This operation returns only those permissions that have been explicitly granted.

For information about permissions, see Security and Access Control to Metadata and Data.

" }, "ListResources":{ "name":"ListResources", @@ -161,7 +161,7 @@ {"shape":"InternalServiceException"}, {"shape":"InvalidInputException"} ], - "documentation":"

The AWS Lake Formation principal.

" + "documentation":"

Sets the list of data lake administrators who have admin privileges on all resources managed by Lake Formation. For more information on admin privileges, see Granting Lake Formation Permissions.

This API replaces the current list of data lake admins with the new list being passed. To add an admin, fetch the current list and add the new admin to that list and pass that list in this API.

" }, "RegisterResource":{ "name":"RegisterResource", @@ -177,7 +177,7 @@ {"shape":"OperationTimeoutException"}, {"shape":"AlreadyExistsException"} ], - "documentation":"

Registers the resource as managed by the Data Catalog.

To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.

" + "documentation":"

Registers the resource as managed by the Data Catalog.

To add or update data, Lake Formation needs read/write access to the chosen Amazon S3 path. Choose a role that you know has permission to do this, or choose the AWSServiceRoleForLakeFormationDataAccess service-linked role. When you register the first Amazon S3 path, the service-linked role and a new inline policy are created on your behalf. Lake Formation adds the first path to the inline policy and attaches it to the service-linked role. When you register subsequent paths, Lake Formation adds the path to the existing policy.

The following request registers a new location and gives AWS Lake Formation permission to use the service-linked role to access that location.

ResourceArn = arn:aws:s3:::my-bucket UseServiceLinkedRole = true

If UseServiceLinkedRole is not set to true, you must provide or set the RoleArn:

arn:aws:iam::12345:role/my-data-access-role

" }, "RevokePermissions":{ "name":"RevokePermissions", @@ -379,7 +379,7 @@ "documentation":"

An identifier for the AWS Lake Formation principal.

" } }, - "documentation":"

The AWS Lake Formation principal.

" + "documentation":"

The AWS Lake Formation principal. Supported principals are IAM users or IAM roles.

" }, "DataLakePrincipalList":{ "type":"list", @@ -406,23 +406,31 @@ "members":{ "DataLakeAdmins":{ "shape":"DataLakePrincipalList", - "documentation":"

A list of AWS Lake Formation principals.

" + "documentation":"

A list of AWS Lake Formation principals. Supported principals are IAM users or IAM roles.

" }, "CreateDatabaseDefaultPermissions":{ "shape":"PrincipalPermissionsList", - "documentation":"

A list of up to three principal permissions entries for default create database permissions.

" + "documentation":"

A structure representing a list of up to three principal permissions entries for default create database permissions.

" }, "CreateTableDefaultPermissions":{ "shape":"PrincipalPermissionsList", - "documentation":"

A list of up to three principal permissions entries for default create table permissions.

" + "documentation":"

A structure representing a list of up to three principal permissions entries for default create table permissions.

" + }, + "TrustedResourceOwners":{ + "shape":"TrustedResourceOwners", + "documentation":"

A list of the resource-owning account IDs that the caller's account can use to share their user access details (user ARNs). The user ARNs can be logged in the resource owner's AWS CloudTrail log.

You may want to specify this property when you are in a high-trust boundary, such as the same team or company.

" } }, - "documentation":"

The AWS Lake Formation principal.

" + "documentation":"

A structure representing a list of AWS Lake Formation principals designated as data lake administrators and lists of principal permission entries for default create database and default create table permissions.

" }, "DataLocationResource":{ "type":"structure", "required":["ResourceArn"], "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The identifier for the Data Catalog where the location is registered with AWS Lake Formation. By default, it is the account ID of the caller.

" + }, "ResourceArn":{ "shape":"ResourceArnString", "documentation":"

The Amazon Resource Name (ARN) that uniquely identifies the data location resource.

" @@ -434,6 +442,10 @@ "type":"structure", "required":["Name"], "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The identifier for the Data Catalog. By default, it is the account ID of the caller.

" + }, "Name":{ "shape":"NameString", "documentation":"

The name of the database resource. Unique to the Data Catalog.

" @@ -552,7 +564,7 @@ "members":{ "DataLakeSettings":{ "shape":"DataLakeSettings", - "documentation":"

A list of AWS Lake Formation principals.

" + "documentation":"

A structure representing a list of AWS Lake Formation principals designated as data lake administrators.

" } } }, @@ -768,6 +780,7 @@ "DROP", "DELETE", "INSERT", + "DESCRIBE", "CREATE_DATABASE", "CREATE_TABLE", "DATA_LOCATION_ACCESS" @@ -831,7 +844,7 @@ }, "DataLakeSettings":{ "shape":"DataLakeSettings", - "documentation":"

A list of AWS Lake Formation principals.

" + "documentation":"

A structure representing a list of AWS Lake Formation principals designated as data lake administrators.

" } } }, @@ -850,11 +863,11 @@ }, "UseServiceLinkedRole":{ "shape":"NullableBoolean", - "documentation":"

Designates a trusted caller, an IAM principal, by registering this caller with the Data Catalog.

" + "documentation":"

Designates an AWS Identity and Access Management (IAM) service-linked role by registering this role with the Data Catalog. A service-linked role is a unique type of IAM role that is linked directly to Lake Formation.

For more information, see Using Service-Linked Roles for Lake Formation.

" }, "RoleArn":{ "shape":"IAMRoleArn", - "documentation":"

The identifier for the role.

" + "documentation":"

The identifier for the role that registers the resource.

" } } }, @@ -934,7 +947,7 @@ }, "Permissions":{ "shape":"PermissionList", - "documentation":"

The permissions revoked to the principal on the resource. For information about permissions, see Security and Access Control to Metadata and Data.

" + "documentation":"

The permissions revoked to the principal on the resource. For information about permissions, see Security and Access Control to Metadata and Data.

" }, "PermissionsWithGrantOption":{ "shape":"PermissionList", @@ -954,11 +967,12 @@ }, "TableResource":{ "type":"structure", - "required":[ - "DatabaseName", - "Name" - ], + "required":["DatabaseName"], "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The identifier for the Data Catalog. By default, it is the account ID of the caller.

" + }, "DatabaseName":{ "shape":"NameString", "documentation":"

The name of the database for the table. Unique to a Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.

" @@ -966,13 +980,31 @@ "Name":{ "shape":"NameString", "documentation":"

The name of the table.

" + }, + "TableWildcard":{ + "shape":"TableWildcard", + "documentation":"

A wildcard object representing every table under a database.

At least one of TableResource$Name or TableResource$TableWildcard is required.

" } }, "documentation":"

A structure for the table object. A table is a metadata definition that represents your data. You can Grant and Revoke table privileges to a principal.

" }, - "TableWithColumnsResource":{ + "TableWildcard":{ "type":"structure", "members":{ + }, + "documentation":"

A wildcard object representing every table under a database.

" + }, + "TableWithColumnsResource":{ + "type":"structure", + "required":[ + "DatabaseName", + "Name" + ], + "members":{ + "CatalogId":{ + "shape":"CatalogIdString", + "documentation":"

The identifier for the Data Catalog. By default, it is the account ID of the caller.

" + }, "DatabaseName":{ "shape":"NameString", "documentation":"

The name of the database for the table with columns resource. Unique to the Data Catalog. A database is a set of associated table definitions organized into a logical group. You can Grant and Revoke database privileges to a principal.

" @@ -993,6 +1025,10 @@ "documentation":"

A structure for a table with columns object. This object is only used when granting a SELECT permission.

This object must take a value for at least one of ColumnsNames, ColumnsIndexes, or ColumnsWildcard.

" }, "Token":{"type":"string"}, + "TrustedResourceOwners":{ + "type":"list", + "member":{"shape":"CatalogIdString"} + }, "UpdateResourceRequest":{ "type":"structure", "required":[ diff --git a/botocore/data/organizations/2016-11-28/service-2.json b/botocore/data/organizations/2016-11-28/service-2.json index 4411af09..e25a8c57 100644 --- a/botocore/data/organizations/2016-11-28/service-2.json +++ b/botocore/data/organizations/2016-11-28/service-2.json @@ -58,7 +58,7 @@ {"shape":"UnsupportedAPIEndpointException"}, {"shape":"PolicyChangesInProgressException"} ], - "documentation":"

Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy:

  • Service control policy (SCP) - An SCP specifies what permissions can be delegated to users in affected member accounts. The scope of influence for a policy depends on what you attach the policy to:

    • If you attach an SCP to a root, it affects all accounts in the organization.

    • If you attach an SCP to an OU, it affects all accounts in that OU and in any child OUs.

    • If you attach the policy directly to an account, it affects only that account.

    SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU). You can attach one SCP to a higher level root or OU, and a different SCP to a child OU or to an account. The child policy can further restrict only the permissions that pass through the parent filter and are available to the child. An SCP that is attached to a child can't grant a permission that the parent hasn't already granted. For example, imagine that the parent SCP allows permissions A, B, C, D, and E. The child SCP allows C, D, E, F, and G. The result is that the accounts affected by the child SCP are allowed to use only C, D, and E. They can't use A or B because the child OU filtered them out. They also can't use F and G because the parent OU filtered them out. They can't be granted back by the child SCP; child SCPs can only filter the permissions they receive from the parent SCP.

    AWS Organizations attaches a default SCP named \"FullAWSAccess to every root, OU, and account. This default SCP allows all services and actions, enabling any new child OU or account to inherit the permissions of the parent root or OU. If you detach the default policy, you must replace it with a policy that specifies the permissions that you want to allow in that OU or account.

    For more information about how AWS Organizations policies permissions work, see Using Service Control Policies in the AWS Organizations User Guide.

This operation can be called only from the organization's master account.

" + "documentation":"

Attaches a policy to a root, an organizational unit (OU), or an individual account. How the policy affects accounts depends on the type of policy. Refer to the AWS Organizations User Guide for information about each policy type:

This operation can be called only from the organization's master account.

" }, "CancelHandshake":{ "name":"CancelHandshake", @@ -120,7 +120,7 @@ {"shape":"TooManyRequestsException"}, {"shape":"UnsupportedAPIEndpointException"} ], - "documentation":"

This action is available if all of the following are true:

  • You're authorized to create accounts in the AWS GovCloud (US) Region. For more information on the AWS GovCloud (US) Region, see the AWS GovCloud User Guide.

  • You already have an account in the AWS GovCloud (US) Region that is associated with your master account in the commercial Region.

  • You call this action from the master account of your organization in the commercial Region.

  • You have the organizations:CreateGovCloudAccount permission. AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.

AWS automatically enables AWS CloudTrail for AWS GovCloud (US) accounts, but you should also do the following:

  • Verify that AWS CloudTrail is enabled to store logs.

  • Create an S3 bucket for AWS CloudTrail log storage.

    For more information, see Verifying AWS CloudTrail Is Enabled in the AWS GovCloud User Guide.

You call this action from the master account of your organization in the commercial Region to create a standalone AWS account in the AWS GovCloud (US) Region. After the account is created, the master account of an organization in the AWS GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the AWS GovCloud (US) to join an organization, see AWS Organizations in the AWS GovCloud User Guide.

Calling CreateGovCloudAccount is an asynchronous request that AWS performs in the background. Because CreateGovCloudAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:

When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the AWS GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address.

A role is created in the new account in the commercial Region that allows the master account in the organization in the commercial Region to assume it. An AWS GovCloud (US) account is then created and associated with the commercial account that you just created. A role is created in the new AWS GovCloud (US) account that can be assumed by the AWS GovCloud (US) account that is associated with the master account of the commercial organization. For more information and to view a diagram that explains how account access works, see AWS Organizations in the AWS GovCloud User Guide.

For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.

  • When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account, such as a payment method and signing the end user license agreement (EULA) is not automatically collected. If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the AWS Organizations User Guide.

  • If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS Support.

  • If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact AWS Support.

  • Using CreateGovCloudAccount to create multiple temporary accounts isn't recommended. You can only close an account from the AWS Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an AWS Account in the AWS Organizations User Guide.

When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools.

" + "documentation":"

This action is available if all of the following are true:

  • You're authorized to create accounts in the AWS GovCloud (US) Region. For more information on the AWS GovCloud (US) Region, see the AWS GovCloud User Guide.

  • You already have an account in the AWS GovCloud (US) Region that is associated with your master account in the commercial Region.

  • You call this action from the master account of your organization in the commercial Region.

  • You have the organizations:CreateGovCloudAccount permission. AWS Organizations creates the required service-linked role named AWSServiceRoleForOrganizations. For more information, see AWS Organizations and Service-Linked Roles in the AWS Organizations User Guide.

AWS automatically enables AWS CloudTrail for AWS GovCloud (US) accounts, but you should also do the following:

  • Verify that AWS CloudTrail is enabled to store logs.

  • Create an S3 bucket for AWS CloudTrail log storage.

    For more information, see Verifying AWS CloudTrail Is Enabled in the AWS GovCloud User Guide.

You call this action from the master account of your organization in the commercial Region to create a standalone AWS account in the AWS GovCloud (US) Region. After the account is created, the master account of an organization in the AWS GovCloud (US) Region can invite it to that organization. For more information on inviting standalone accounts in the AWS GovCloud (US) to join an organization, see AWS Organizations in the AWS GovCloud User Guide.

Calling CreateGovCloudAccount is an asynchronous request that AWS performs in the background. Because CreateGovCloudAccount operates asynchronously, it can return a successful completion message even though account initialization might still be in progress. You might need to wait a few minutes before you can successfully access the account. To check the status of the request, do one of the following:

When you call the CreateGovCloudAccount action, you create two accounts: a standalone account in the AWS GovCloud (US) Region and an associated account in the commercial Region for billing and support purposes. The account in the commercial Region is automatically a member of the organization whose credentials made the request. Both accounts are associated with the same email address.

A role is created in the new account in the commercial Region that allows the master account in the organization in the commercial Region to assume it. An AWS GovCloud (US) account is then created and associated with the commercial account that you just created. A role is created in the new AWS GovCloud (US) account that can be assumed by the AWS GovCloud (US) account that is associated with the master account of the commercial organization. For more information and to view a diagram that explains how account access works, see AWS Organizations in the AWS GovCloud User Guide.

For more information about creating accounts, see Creating an AWS Account in Your Organization in the AWS Organizations User Guide.

  • When you create an account in an organization using the AWS Organizations console, API, or CLI commands, the information required for the account to operate as a standalone account is not automatically collected. This includes a payment method and signing the end user license agreement (EULA). If you must remove an account from your organization later, you can do so only after you provide the missing information. Follow the steps at To leave an organization as a member account in the AWS Organizations User Guide.

  • If you get an exception that indicates that you exceeded your account limits for the organization, contact AWS Support.

  • If you get an exception that indicates that the operation failed because your organization is still initializing, wait one hour and then try again. If the error persists, contact AWS Support.

  • Using CreateGovCloudAccount to create multiple temporary accounts isn't recommended. You can only close an account from the AWS Billing and Cost Management console, and you must be signed in as the root user. For information on the requirements and process for closing an account, see Closing an AWS Account in the AWS Organizations User Guide.

When you create a member account with this operation, you can choose whether to create the account with the IAM User and Role Access to Billing Information switch enabled. If you enable it, IAM users and roles that have appropriate permissions can view billing information for the account. If you disable it, only the account root user can access billing information. For information about how to disable this switch for an account, see Granting Access to Your Billing Information and Tools.

" }, "CreateOrganization":{ "name":"CreateOrganization", @@ -339,7 +339,7 @@ {"shape":"InvalidInputException"}, {"shape":"UnsupportedAPIEndpointException"} ], - "documentation":"

Returns the contents of the effective tag policy for the account. The effective tag policy is the aggregation of any tag policies the account inherits, plus any policy directly that is attached to the account.

This action returns information on tag policies only.

For more information on policy inheritance, see How Policy Inheritance Works in the AWS Organizations User Guide.

This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.

" + "documentation":"

Returns the contents of the effective policy for specified policy type and account. The effective policy is the aggregation of any policies of the specified type that the account inherits, plus any policy of that type that is directly attached to the account.

This operation applies only to policy types other than service control policies (SCPs).

For more information about policy inheritance, see How Policy Inheritance Works in the AWS Organizations User Guide.

This operation can be called only from the organization's master account or by a member account that is a delegated administrator for an AWS service.

" }, "DescribeHandshake":{ "name":"DescribeHandshake", @@ -433,7 +433,7 @@ {"shape":"UnsupportedAPIEndpointException"}, {"shape":"PolicyChangesInProgressException"} ], - "documentation":"

Detaches a policy from a target root, organizational unit (OU), or account. If the policy being detached is a service control policy (SCP), the changes to permissions for IAM users and roles in affected accounts are immediate.

Note: Every root, OU, and account must have at least one SCP attached. If you want to replace the default FullAWSAccess policy with one that limits the permissions that can be delegated, you must attach the replacement policy before you can remove the default one. This is the authorization strategy of an \"allow list\". If you instead attach a second SCP and leave the FullAWSAccess SCP still attached, and specify \"Effect\": \"Deny\" in the second SCP to override the \"Effect\": \"Allow\" in the FullAWSAccess policy (or any other attached SCP), you're using the authorization strategy of a \"deny list\".

This operation can be called only from the organization's master account.

" + "documentation":"

Detaches a policy from a target root, organizational unit (OU), or account.

If the policy being detached is a service control policy (SCP), the changes to permissions for AWS Identity and Access Management (IAM) users and roles in affected accounts are immediate.

Every root, OU, and account must have at least one SCP attached. If you want to replace the default FullAWSAccess policy with an SCP that limits the permissions that can be delegated, you must attach the replacement SCP before you can remove the default SCP. This is the authorization strategy of an \"allow list\". If you instead attach a second SCP and leave the FullAWSAccess SCP still attached, and specify \"Effect\": \"Deny\" in the second SCP to override the \"Effect\": \"Allow\" in the FullAWSAccess policy (or any other attached SCP), you're using the authorization strategy of a \"deny list\".

This operation can be called only from the organization's master account.

" }, "DisableAWSServiceAccess":{ "name":"DisableAWSServiceAccess", @@ -475,7 +475,7 @@ {"shape":"UnsupportedAPIEndpointException"}, {"shape":"PolicyChangesInProgressException"} ], - "documentation":"

Disables an organizational control policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation.

This is an asynchronous request that AWS performs in the background. If you disable a policy for a root, it still appears enabled for the organization if all features are enabled for the organization. AWS recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.

This operation can be called only from the organization's master account.

To view the status of available policy types in the organization, use DescribeOrganization.

" + "documentation":"

Disables an organizational policy type in a root. A policy of a certain type can be attached to entities in a root only if that type is enabled in the root. After you perform this operation, you no longer can attach policies of the specified type to that root or to any organizational unit (OU) or account in that root. You can undo this by using the EnablePolicyType operation.

This is an asynchronous request that AWS performs in the background. If you disable a policy type for a root, it still appears enabled for the organization if all features are enabled for the organization. AWS recommends that you first use ListRoots to see the status of policy types for a specified root, and then use this operation.

This operation can be called only from the organization's master account.

To view the status of available policy types in the organization, use DescribeOrganization.

" }, "EnableAWSServiceAccess":{ "name":"EnableAWSServiceAccess", @@ -1114,6 +1114,7 @@ }, "AccountId":{ "type":"string", + "max":12, "pattern":"^\\d{12}$" }, "AccountJoinedMethod":{ @@ -1235,6 +1236,7 @@ }, "ChildId":{ "type":"string", + "max":100, "pattern":"^(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$" }, "ChildNotFoundException":{ @@ -1270,7 +1272,7 @@ "Message":{"shape":"ExceptionMessage"}, "Reason":{"shape":"ConstraintViolationExceptionReason"} }, - "documentation":"

Performing this operation violates a minimum or maximum value limit. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit.

Some of the reasons in the following list might not be applicable to this specific API or operation:

  • ACCOUNT_CANNOT_LEAVE_ORGANIZAION: You attempted to remove the master account from the organization. You can't remove the master account. Instead, after you remove all member accounts, delete the organization itself.

  • ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

  • ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first complete phone verification. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

  • ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

  • ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.

    Or the number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations or contact AWS Support to request an increase in the number of accounts.

    Deleted and closed accounts still count toward your limit.

    If you get receive this exception when running a command immediately after creating the organization, wait one hour and try again. If after an hour it continues to fail with this error, contact AWS Support.

  • CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the master account of the organization as a delegated administrator for an AWS service integrated with Organizations. You can designate only a member account as a delegated administrator.

  • CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

  • CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

  • DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an AWS account as a delegated administrator for an AWS service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

  • EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

  • HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.

  • MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.

  • MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the AWS Regions in China. To create an organization, the master must have an valid business license. For more information, contact customer support.

  • MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide contact a valid address and phone number for the master account. Then try the operation again.

  • MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

  • MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

  • MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

  • MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.

  • MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

  • MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

  • MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.

  • ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

  • OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

  • OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

  • POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

  • POLICY_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of policies that you can have in an organization.

  • TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

", + "documentation":"

Performing this operation violates a minimum or maximum value limit. For example, attempting to remove the last service control policy (SCP) from an OU or root, inviting or creating too many accounts to the organization, or attaching too many policies to an account, OU, or root. This exception includes a reason that contains additional information about the violated limit:

Some of the reasons in the following list might not be applicable to this specific API or operation.

  • ACCOUNT_CANNOT_LEAVE_ORGANIZAION: You attempted to remove the master account from the organization. You can't remove the master account. Instead, after you remove all member accounts, delete the organization itself.

  • ACCOUNT_CANNOT_LEAVE_WITHOUT_EULA: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first agree to the AWS Customer Agreement. Follow the steps at Removing a member account from your organizationin the AWS Organizations User Guide.

  • ACCOUNT_CANNOT_LEAVE_WITHOUT_PHONE_VERIFICATION: You attempted to remove an account from the organization that doesn't yet have enough information to exist as a standalone account. This account requires you to first complete phone verification. Follow the steps at Removing a member account from your organization in the AWS Organizations User Guide.

  • ACCOUNT_CREATION_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of accounts that you can create in one day.

  • ACCOUNT_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the limit on the number of accounts in an organization. If you need more accounts, contact AWS Support to request an increase in your limit.

    Or the number of invitations that you tried to send would cause you to exceed the limit of accounts in your organization. Send fewer invitations or contact AWS Support to request an increase in the number of accounts.

    Deleted and closed accounts still count toward your limit.

    If you get this exception when running a command immediately after creating the organization, wait one hour and try again. After an hour, if the command continues to fail with this error, contact AWS Support.

  • CANNOT_REGISTER_MASTER_AS_DELEGATED_ADMINISTRATOR: You attempted to register the master account of the organization as a delegated administrator for an AWS service integrated with Organizations. You can designate only a member account as a delegated administrator.

  • CANNOT_REMOVE_DELEGATED_ADMINISTRATOR_FROM_ORG: You attempted to remove an account that is registered as a delegated administrator for a service integrated with your organization. To complete this operation, you must first deregister this account as a delegated administrator.

  • CREATE_ORGANIZATION_IN_BILLING_MODE_UNSUPPORTED_REGION: To create an organization in the specified region, you must enable all features mode.

  • DELEGATED_ADMINISTRATOR_EXISTS_FOR_THIS_SERVICE: You attempted to register an AWS account as a delegated administrator for an AWS service that already has a delegated administrator. To complete this operation, you must first deregister any existing delegated administrators for this service.

  • EMAIL_VERIFICATION_CODE_EXPIRED: The email verification code is only valid for a limited period of time. You must resubmit the request and generate a new verfication code.

  • HANDSHAKE_RATE_LIMIT_EXCEEDED: You attempted to exceed the number of handshakes that you can send in one day.

  • MASTER_ACCOUNT_ADDRESS_DOES_NOT_MATCH_MARKETPLACE: To create an account in this organization, you first must migrate the organization's master account to the marketplace that corresponds to the master account's address. For example, accounts with India addresses must be associated with the AISPL marketplace. All accounts in an organization must be associated with the same marketplace.

  • MASTER_ACCOUNT_MISSING_BUSINESS_LICENSE: Applies only to the AWS Regions in China. To create an organization, the master must have an valid business license. For more information, contact customer support.

  • MASTER_ACCOUNT_MISSING_CONTACT_INFO: To complete this operation, you must first provide a valid contact address and phone number for the master account. Then try the operation again.

  • MASTER_ACCOUNT_NOT_GOVCLOUD_ENABLED: To complete this operation, the master account must have an associated account in the AWS GovCloud (US-West) Region. For more information, see AWS Organizations in the AWS GovCloud User Guide.

  • MASTER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To create an organization with this master account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

  • MAX_DELEGATED_ADMINISTRATORS_FOR_SERVICE_LIMIT_EXCEEDED: You attempted to register more delegated administrators than allowed for the service principal.

  • MAX_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to exceed the number of policies of a certain type that can be attached to an entity at one time.

  • MAX_TAG_LIMIT_EXCEEDED: You have exceeded the number of tags allowed on this resource.

  • MEMBER_ACCOUNT_PAYMENT_INSTRUMENT_REQUIRED: To complete this operation with this member account, you first must associate a valid payment instrument, such as a credit card, with the account. Follow the steps at To leave an organization when all required account information has not yet been provided in the AWS Organizations User Guide.

  • MIN_POLICY_TYPE_ATTACHMENT_LIMIT_EXCEEDED: You attempted to detach a policy from an entity that would cause the entity to have fewer than the minimum number of policies of a certain type required.

  • ORGANIZATION_NOT_IN_ALL_FEATURES_MODE: You attempted to perform an operation that requires the organization to be configured to support all features. An organization that supports only consolidated billing features can't perform this operation.

  • OU_DEPTH_LIMIT_EXCEEDED: You attempted to create an OU tree that is too many levels deep.

  • OU_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of OUs that you can have in an organization.

  • POLICY_CONTENT_LIMIT_EXCEEDED: You attempted to create a policy that is larger than the maximum size.

  • POLICY_NUMBER_LIMIT_EXCEEDED: You attempted to exceed the number of policies that you can have in an organization.

  • TAG_POLICY_VIOLATION: You attempted to create or update a resource with tags that are not compliant with the tag policy requirements for this account.

", "exception":true }, "ConstraintViolationExceptionReason":{ @@ -1345,6 +1347,7 @@ }, "CreateAccountRequestId":{ "type":"string", + "max":36, "pattern":"^car-[a-z0-9]{8,32}$" }, "CreateAccountResponse":{ @@ -1504,7 +1507,7 @@ "members":{ "Content":{ "shape":"PolicyContent", - "documentation":"

The policy content to add to the new policy. For example, if you create a service control policy (SCP), this string must be JSON text that specifies the permissions that admins in attached accounts can delegate to their users, groups, and roles. For more information about the SCP syntax, see Service Control Policy Syntax in the AWS Organizations User Guide.

" + "documentation":"

The policy text content to add to the new policy. The text that you supply must adhere to the rules of the policy type you specify in the Type parameter.

" }, "Description":{ "shape":"PolicyDescription", @@ -1516,7 +1519,7 @@ }, "Type":{ "shape":"PolicyType", - "documentation":"

The type of policy to create.

In the current release, the only type of policy that you can create is a service control policy (SCP).

" + "documentation":"

The type of policy to create. You can specify one of the following values:

" } } }, @@ -1689,11 +1692,11 @@ "members":{ "PolicyType":{ "shape":"EffectivePolicyType", - "documentation":"

The type of policy that you want information about.

" + "documentation":"

The type of policy that you want information about. You can specify one of the following values:

" }, "TargetId":{ "shape":"PolicyTargetId", - "documentation":"

When you're signed in as the master account, specify the ID of the account that you want details about. Specifying an organization root or OU as the target is not supported.

" + "documentation":"

When you're signed in as the master account, specify the ID of the account that you want details about. Specifying an organization root or organizational unit (OU) as the target is not supported.

" } } }, @@ -1730,7 +1733,7 @@ "members":{ "Organization":{ "shape":"Organization", - "documentation":"

A structure that contains information about the organization.

" + "documentation":"

A structure that contains information about the organization.

The AvailablePolicyTypes part of the response is deprecated, and you shouldn't use it in your apps. It doesn't include any policy type supported by Organizations other than SCPs. To determine which policy types are enabled in your organization, use the ListRoots operation.

" } } }, @@ -1820,7 +1823,7 @@ }, "PolicyType":{ "shape":"PolicyType", - "documentation":"

The policy type that you want to disable in this root.

" + "documentation":"

The policy type that you want to disable in this root. You can specify one of the following values:

" } } }, @@ -1905,7 +1908,11 @@ }, "EffectivePolicyType":{ "type":"string", - "enum":["TAG_POLICY"] + "enum":[ + "TAG_POLICY", + "BACKUP_POLICY", + "AISERVICES_OPT_OUT_POLICY" + ] }, "Email":{ "type":"string", @@ -1951,7 +1958,7 @@ }, "PolicyType":{ "shape":"PolicyType", - "documentation":"

The policy type that you want to enable.

" + "documentation":"

The policy type that you want to enable. You can specify one of the following values:

" } } }, @@ -2084,6 +2091,7 @@ }, "HandshakeId":{ "type":"string", + "max":34, "pattern":"^h-[0-9a-z]{8,32}$" }, "HandshakeNotFoundException":{ @@ -2097,6 +2105,7 @@ "HandshakeNotes":{ "type":"string", "max":1024, + "pattern":"[\\s\\S]*", "sensitive":true }, "HandshakeParties":{ @@ -2125,6 +2134,7 @@ "type":"string", "max":64, "min":1, + "pattern":"[\\s\\S]*", "sensitive":true }, "HandshakePartyType":{ @@ -2210,7 +2220,7 @@ "Message":{"shape":"ExceptionMessage"}, "Reason":{"shape":"InvalidInputExceptionReason"} }, - "documentation":"

The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit:

Some of the reasons in the following list might not be applicable to this specific API or operation:

  • IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

  • INPUT_REQUIRED: You must include a value for all required parameters.

  • INVALID_ENUM: You specified an invalid value.

  • INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.

  • INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.

  • INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

  • INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

  • INVALID_PATTERN: You provided a value that doesn't match the required pattern.

  • INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.

  • INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

  • INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

  • INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

  • INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

  • MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

  • MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.

  • MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.

  • MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.

  • MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.

  • MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

", + "documentation":"

The requested operation failed because you provided invalid values for one or more of the request parameters. This exception includes a reason that contains additional information about the violated limit:

Some of the reasons in the following list might not be applicable to this specific API or operation.

  • IMMUTABLE_POLICY: You specified a policy that is managed by AWS and can't be modified.

  • INPUT_REQUIRED: You must include a value for all required parameters.

  • INVALID_ENUM: You specified an invalid value.

  • INVALID_FULL_NAME_TARGET: You specified a full name that contains invalid characters.

  • INVALID_LIST_MEMBER: You provided a list to a parameter that contains at least one invalid value.

  • INVALID_PAGINATION_TOKEN: Get the value for the NextToken parameter from the response to a previous call of the operation.

  • INVALID_PARTY_TYPE_TARGET: You specified the wrong type of entity (account, organization, or email) as a party.

  • INVALID_PATTERN: You provided a value that doesn't match the required pattern.

  • INVALID_PATTERN_TARGET_ID: You specified a policy target ID that doesn't match the required pattern.

  • INVALID_ROLE_NAME: You provided a role name that isn't valid. A role name can't begin with the reserved prefix AWSServiceRoleFor.

  • INVALID_SYNTAX_ORGANIZATION_ARN: You specified an invalid Amazon Resource Name (ARN) for the organization.

  • INVALID_SYNTAX_POLICY_ID: You specified an invalid policy ID.

  • INVALID_SYSTEM_TAGS_PARAMETER: You specified a tag key that is a system tag. You can’t add, edit, or delete system tag keys because they're reserved for AWS use. System tags don’t count against your tags per resource limit.

  • MAX_FILTER_LIMIT_EXCEEDED: You can specify only one filter parameter for the operation.

  • MAX_LENGTH_EXCEEDED: You provided a string parameter that is longer than allowed.

  • MAX_VALUE_EXCEEDED: You provided a numeric parameter that has a larger value than allowed.

  • MIN_LENGTH_EXCEEDED: You provided a string parameter that is shorter than allowed.

  • MIN_VALUE_EXCEEDED: You provided a numeric parameter that has a smaller value than allowed.

  • MOVING_ACCOUNT_BETWEEN_DIFFERENT_ROOTS: You can move an account only between entities in the same root.

", "exception":true }, "InvalidInputExceptionReason":{ @@ -2610,7 +2620,7 @@ }, "Filter":{ "shape":"PolicyType", - "documentation":"

The type of policy that you want to include in the returned list.

" + "documentation":"

The type of policy that you want to include in the returned list. You must specify one of the following values:

" }, "NextToken":{ "shape":"NextToken", @@ -2641,7 +2651,7 @@ "members":{ "Filter":{ "shape":"PolicyType", - "documentation":"

Specifies the type of policy that you want to include in the response.

" + "documentation":"

Specifies the type of policy that you want to include in the response. You must specify one of the following values:

" }, "NextToken":{ "shape":"NextToken", @@ -2794,7 +2804,11 @@ } } }, - "NextToken":{"type":"string"}, + "NextToken":{ + "type":"string", + "max":100000, + "pattern":"[\\s\\S]*" + }, "Organization":{ "type":"structure", "members":{ @@ -2824,7 +2838,7 @@ }, "AvailablePolicyTypes":{ "shape":"PolicyTypes", - "documentation":"

A list of policy types that are enabled for this organization. For example, if your organization has all features enabled, then service control policies (SCPs) are included in the list.

Even if a policy type is shown as available in the organization, you can separately enable and disable them at the root level by using EnablePolicyType and DisablePolicyType. Use ListRoots to see the status of a policy type in that root.

" + "documentation":"

Do not use. This field is deprecated and doesn't provide complete information about the policies in your organization.

To determine the policies that are enabled and available for use in your organization, use the ListRoots operation instead.

" } }, "documentation":"

Contains details about an organization. An organization is a collection of accounts that are centrally managed together using consolidated billing, organized hierarchically with organizational units (OUs), and controlled with policies .

" @@ -2876,12 +2890,14 @@ }, "OrganizationalUnitId":{ "type":"string", + "max":68, "pattern":"^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$" }, "OrganizationalUnitName":{ "type":"string", "max":128, - "min":1 + "min":1, + "pattern":"[\\s\\S]*" }, "OrganizationalUnitNotEmptyException":{ "type":"structure", @@ -2919,6 +2935,7 @@ }, "ParentId":{ "type":"string", + "max":100, "pattern":"^(r-[0-9a-z]{4,32})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$" }, "ParentNotFoundException":{ @@ -2973,14 +2990,17 @@ "PolicyContent":{ "type":"string", "max":1000000, - "min":1 + "min":1, + "pattern":"[\\s\\S]*" }, "PolicyDescription":{ "type":"string", - "max":512 + "max":512, + "pattern":"[\\s\\S]*" }, "PolicyId":{ "type":"string", + "max":130, "pattern":"^p-[0-9a-zA-Z_]{8,128}$" }, "PolicyInUseException":{ @@ -2994,7 +3014,8 @@ "PolicyName":{ "type":"string", "max":128, - "min":1 + "min":1, + "pattern":"[\\s\\S]*" }, "PolicyNotAttachedException":{ "type":"structure", @@ -3044,6 +3065,7 @@ }, "PolicyTargetId":{ "type":"string", + "max":100, "pattern":"^(r-[0-9a-z]{4,32})|(\\d{12})|(ou-[0-9a-z]{4,32}-[a-z0-9]{8,32})$" }, "PolicyTargetSummary":{ @@ -3076,7 +3098,9 @@ "type":"string", "enum":[ "SERVICE_CONTROL_POLICY", - "TAG_POLICY" + "TAG_POLICY", + "BACKUP_POLICY", + "AISERVICES_OPT_OUT_POLICY" ] }, "PolicyTypeAlreadyEnabledException":{ @@ -3092,7 +3116,7 @@ "members":{ "Message":{"shape":"ExceptionMessage"} }, - "documentation":"

You can't use the specified policy type with the feature set currently enabled for this organization. For example, you can enable SCPs only after you enable all features in the organization. For more information, see Enabling and Disabling a Policy Type on a Root in the AWS Organizations User Guide.

", + "documentation":"

You can't use the specified policy type with the feature set currently enabled for this organization. For example, you can enable SCPs only after you enable all features in the organization. For more information, see Managing AWS Organizations Policiesin the AWS Organizations User Guide.

", "exception":true }, "PolicyTypeNotEnabledException":{ @@ -3158,6 +3182,7 @@ }, "RoleName":{ "type":"string", + "max":64, "pattern":"[\\w+=,.@-]{1,64}" }, "Root":{ @@ -3188,6 +3213,7 @@ }, "RootId":{ "type":"string", + "max":34, "pattern":"^r-[0-9a-z]{4,32}$" }, "RootName":{ @@ -3270,7 +3296,7 @@ }, "Tags":{ "shape":"Tags", - "documentation":"

The tag to add to the specified resource. Specifying the tag key is required. You can set the value of a tag to an empty string, but you can't set the value of a tag to null.

" + "documentation":"

The tag to add to the specified resource. You must specify both a tag key and value. You can set the value of a tag to an empty string, but you can't set it to null.

" } } }, @@ -3282,6 +3308,7 @@ }, "TaggableResourceId":{ "type":"string", + "max":12, "pattern":"^\\d{12}$" }, "Tags":{ @@ -3316,7 +3343,7 @@ "Type":{"shape":"ExceptionType"}, "Message":{"shape":"ExceptionMessage"} }, - "documentation":"

You have sent too many requests in too short a period of time. The limit helps protect against denial-of-service attacks. Try again later.

For information on limits that affect AWS Organizations, see Limits of AWS Organizations in the AWS Organizations User Guide.

", + "documentation":"

You have sent too many requests in too short a period of time. The quota helps protect against denial-of-service attacks. Try again later.

For information about quotas that affect AWS Organizations, see Quotas for AWS Organizationsin the AWS Organizations User Guide.

", "exception":true }, "UnsupportedAPIEndpointException":{ @@ -3324,7 +3351,7 @@ "members":{ "Message":{"shape":"ExceptionMessage"} }, - "documentation":"

This action isn't available in the current Region.

", + "documentation":"

This action isn't available in the current AWS Region.

", "exception":true }, "UntagResourceRequest":{ diff --git a/botocore/data/quicksight/2018-04-01/service-2.json b/botocore/data/quicksight/2018-04-01/service-2.json index ffbea462..58f35b52 100644 --- a/botocore/data/quicksight/2018-04-01/service-2.json +++ b/botocore/data/quicksight/2018-04-01/service-2.json @@ -46,7 +46,7 @@ {"shape":"UnsupportedUserEditionException"}, {"shape":"InternalFailureException"} ], - "documentation":"

Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.

A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. The CreateDashboard, DescribeDashboard, and ListDashboardsByUser API operations act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.

" + "documentation":"

Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.

A dashboard is an entity in QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. The CreateDashboard, DescribeDashboard, and ListDashboardsByUser API operations act on the dashboard entity. If you have the correct permissions, you can create a dashboard from a template that exists in a different AWS account.

" }, "CreateDataSet":{ "name":"CreateDataSet", @@ -183,6 +183,7 @@ {"shape":"ThrottlingException"}, {"shape":"LimitExceededException"}, {"shape":"UnsupportedUserEditionException"}, + {"shape":"ConflictException"}, {"shape":"InternalFailureException"} ], "documentation":"

Creates a template from an existing QuickSight analysis or template. You can use the resulting template to create a dashboard.

A template is an entity in QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.

" @@ -202,10 +203,51 @@ {"shape":"ResourceExistsException"}, {"shape":"LimitExceededException"}, {"shape":"UnsupportedUserEditionException"}, + {"shape":"ConflictException"}, {"shape":"InternalFailureException"} ], "documentation":"

Creates a template alias for a template.

" }, + "CreateTheme":{ + "name":"CreateTheme", + "http":{ + "method":"POST", + "requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}" + }, + "input":{"shape":"CreateThemeRequest"}, + "output":{"shape":"CreateThemeResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"LimitExceededException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a theme.

A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

" + }, + "CreateThemeAlias":{ + "name":"CreateThemeAlias", + "http":{ + "method":"POST", + "requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}" + }, + "input":{"shape":"CreateThemeAliasRequest"}, + "output":{"shape":"CreateThemeAliasResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Creates a theme alias for a theme.

" + }, "DeleteDashboard":{ "name":"DeleteDashboard", "http":{ @@ -346,10 +388,48 @@ {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"UnsupportedUserEditionException"}, + {"shape":"ConflictException"}, {"shape":"InternalFailureException"} ], "documentation":"

Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.

" }, + "DeleteTheme":{ + "name":"DeleteTheme", + "http":{ + "method":"DELETE", + "requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}" + }, + "input":{"shape":"DeleteThemeRequest"}, + "output":{"shape":"DeleteThemeResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"ConflictException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes a theme.

" + }, + "DeleteThemeAlias":{ + "name":"DeleteThemeAlias", + "http":{ + "method":"DELETE", + "requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}" + }, + "input":{"shape":"DeleteThemeAliasRequest"}, + "output":{"shape":"DeleteThemeAliasResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.

" + }, "DeleteUser":{ "name":"DeleteUser", "http":{ @@ -598,6 +678,61 @@ ], "documentation":"

Describes read and write permissions on a template.

" }, + "DescribeTheme":{ + "name":"DescribeTheme", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}" + }, + "input":{"shape":"DescribeThemeRequest"}, + "output":{"shape":"DescribeThemeResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Describes a theme.

" + }, + "DescribeThemeAlias":{ + "name":"DescribeThemeAlias", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}" + }, + "input":{"shape":"DescribeThemeAliasRequest"}, + "output":{"shape":"DescribeThemeAliasResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Describes the alias for a theme.

" + }, + "DescribeThemePermissions":{ + "name":"DescribeThemePermissions", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/permissions" + }, + "input":{"shape":"DescribeThemePermissionsRequest"}, + "output":{"shape":"DescribeThemePermissionsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Describes the read and write permissions for a theme.

" + }, "DescribeUser":{ "name":"DescribeUser", "http":{ @@ -637,7 +772,7 @@ {"shape":"UnsupportedUserEditionException"}, {"shape":"InternalFailureException"} ], - "documentation":"

Generates a server-side embeddable URL and authorization code. For this process to work properly, first configure the dashboards and user permissions. For more information, see Embedding Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference.

Currently, you can use GetDashboardEmbedURL only from the server, not from the user’s browser.

" + "documentation":"

Generates a URL and authorization code that you can embed in your web server code. Before you use this command, make sure that you have configured the dashboards and permissions.

Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the combination of URL and authorization code:

  • They must be used together.

  • They can be used one time only.

  • They are valid for 5 minutes after you run this command.

  • The resulting user session is valid for 10 hours.

For more information, see Embedding Amazon QuickSight Dashboards in the Amazon QuickSight User Guide or Embedding Amazon QuickSight Dashboards in the Amazon QuickSight API Reference.

" }, "ListDashboardVersions":{ "name":"ListDashboardVersions", @@ -829,6 +964,7 @@ "input":{"shape":"ListTemplateAliasesRequest"}, "output":{"shape":"ListTemplateAliasesResponse"}, "errors":[ + {"shape":"InvalidNextTokenException"}, {"shape":"ThrottlingException"}, {"shape":"ResourceNotFoundException"}, {"shape":"UnsupportedUserEditionException"}, @@ -872,6 +1008,63 @@ ], "documentation":"

Lists all the templates in the current Amazon QuickSight account.

" }, + "ListThemeAliases":{ + "name":"ListThemeAliases", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/aliases" + }, + "input":{"shape":"ListThemeAliasesRequest"}, + "output":{"shape":"ListThemeAliasesResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists all the aliases of a theme.

" + }, + "ListThemeVersions":{ + "name":"ListThemeVersions", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/versions" + }, + "input":{"shape":"ListThemeVersionsRequest"}, + "output":{"shape":"ListThemeVersionsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists all the versions of the themes in the current AWS account.

" + }, + "ListThemes":{ + "name":"ListThemes", + "http":{ + "method":"GET", + "requestUri":"/accounts/{AwsAccountId}/themes" + }, + "input":{"shape":"ListThemesRequest"}, + "output":{"shape":"ListThemesResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"InvalidNextTokenException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Lists all the themes in the current AWS account.

" + }, "ListUserGroups":{ "name":"ListUserGroups", "http":{ @@ -1183,6 +1376,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"}, {"shape":"UnsupportedUserEditionException"}, + {"shape":"ConflictException"}, {"shape":"InternalFailureException"} ], "documentation":"

Updates the template alias of a template.

" @@ -1205,6 +1399,63 @@ ], "documentation":"

Updates the resource permissions for a template.

" }, + "UpdateTheme":{ + "name":"UpdateTheme", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}" + }, + "input":{"shape":"UpdateThemeRequest"}, + "output":{"shape":"UpdateThemeResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates a theme.

" + }, + "UpdateThemeAlias":{ + "name":"UpdateThemeAlias", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/aliases/{AliasName}" + }, + "input":{"shape":"UpdateThemeAliasRequest"}, + "output":{"shape":"UpdateThemeAliasResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceExistsException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates an alias of a theme.

" + }, + "UpdateThemePermissions":{ + "name":"UpdateThemePermissions", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{AwsAccountId}/themes/{ThemeId}/permissions" + }, + "input":{"shape":"UpdateThemePermissionsRequest"}, + "output":{"shape":"UpdateThemePermissionsResponse"}, + "errors":[ + {"shape":"AccessDeniedException"}, + {"shape":"InvalidParameterValueException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"UnsupportedUserEditionException"}, + {"shape":"InternalFailureException"} + ], + "documentation":"

Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example \"quicksight:DescribeTheme\".

Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions:

  • User

    • \"quicksight:DescribeTheme\"

    • \"quicksight:DescribeThemeAlias\"

    • \"quicksight:ListThemeAliases\"

    • \"quicksight:ListThemeVersions\"

  • Owner

    • \"quicksight:DescribeTheme\"

    • \"quicksight:DescribeThemeAlias\"

    • \"quicksight:ListThemeAliases\"

    • \"quicksight:ListThemeVersions\"

    • \"quicksight:DeleteTheme\"

    • \"quicksight:UpdateTheme\"

    • \"quicksight:CreateThemeAlias\"

    • \"quicksight:DeleteThemeAlias\"

    • \"quicksight:UpdateThemeAlias\"

    • \"quicksight:UpdateThemePermissions\"

    • \"quicksight:DescribeThemePermissions\"

  • To specify no permissions, omit the permissions list.

" + }, "UpdateUser":{ "name":"UpdateUser", "http":{ @@ -1360,6 +1611,10 @@ "min":12, "pattern":"^[0-9]{12}$" }, + "AwsAndAccountId":{ + "type":"string", + "pattern":"^(aws|[0-9]{12})$" + }, "AwsIotAnalyticsParameters":{ "type":"structure", "required":["DataSetName"], @@ -1372,6 +1627,17 @@ "documentation":"

AWS IoT Analytics parameters.

" }, "Boolean":{"type":"boolean"}, + "BorderStyle":{ + "type":"structure", + "members":{ + "Show":{ + "shape":"boolean", + "documentation":"

The option to enable display of borders for visuals.

", + "box":true + } + }, + "documentation":"

The display options for tile borders for visuals.

" + }, "CalculatedColumn":{ "type":"structure", "required":[ @@ -1482,6 +1748,11 @@ "max":64, "min":1 }, + "ColorList":{ + "type":"list", + "member":{"shape":"HexColor"}, + "max":100 + }, "ColumnDataType":{ "type":"string", "enum":[ @@ -1593,7 +1864,7 @@ "documentation":"

A geospatial role for a column.

" } }, - "documentation":"

A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

" + "documentation":"

A tag for a column in a TagColumnOperation structure. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

" }, "ColumnTagList":{ "type":"list", @@ -1624,6 +1895,10 @@ "error":{"httpStatusCode":409}, "exception":true }, + "CopySourceArn":{ + "type":"string", + "pattern":"^arn:[-a-z0-9]*:quicksight:[-a-z0-9]*:[0-9]{12}:datasource/.+" + }, "CreateColumnsOperation":{ "type":"structure", "required":["Columns"], @@ -1662,7 +1937,7 @@ }, "Parameters":{ "shape":"Parameters", - "documentation":"

A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values. You can use the dashboard permissions structure described following to override two string parameters that accept multiple values.

" + "documentation":"

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

" }, "Permissions":{ "shape":"ResourcePermissionList", @@ -1670,7 +1945,7 @@ }, "SourceEntity":{ "shape":"DashboardSourceEntity", - "documentation":"

The source entity from which the dashboard is created. The source entity accepts the Amazon Resource Name (ARN) of the source template or analysis and also references the replacement datasets for the placeholders set when creating the template. The replacement datasets need to follow the same schema as the datasets for which placeholders were created when creating the template.

If you are creating a dashboard from a source entity in a different AWS account, use the ARN of the source template.

" + "documentation":"

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

" }, "Tags":{ "shape":"TagList", @@ -1682,7 +1957,11 @@ }, "DashboardPublishOptions":{ "shape":"DashboardPublishOptions", - "documentation":"

Options for publishing the dashboard when you create it:

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .csv format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

  • VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. The sheet controls pane is collapsed by default when set to true. This option is COLLAPSED by default.

" + "documentation":"

Options for publishing the dashboard when you create it:

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .csv format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

  • VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

" + }, + "ThemeArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.

" } } }, @@ -1691,7 +1970,7 @@ "members":{ "Arn":{ "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of the dashboard.

" + "documentation":"

The ARN of the dashboard.

" }, "VersionArn":{ "shape":"Arn", @@ -2190,7 +2469,7 @@ }, "SourceEntity":{ "shape":"TemplateSourceEntity", - "documentation":"

The Amazon Resource Name (ARN) of the source entity from which this template is being created. Currently, you can create a template from an analysis or another template. If the ARN is for an analysis, include its dataset references.

" + "documentation":"

The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

" }, "Tags":{ "shape":"TagList", @@ -2232,6 +2511,135 @@ } } }, + "CreateThemeAliasRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "ThemeId", + "AliasName", + "ThemeVersionNumber" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

The ID of the AWS account that contains the theme for the new theme alias.

", + "location":"uri", + "locationName":"AwsAccountId" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

An ID for the theme alias.

", + "location":"uri", + "locationName":"ThemeId" + }, + "AliasName":{ + "shape":"AliasName", + "documentation":"

The name that you want to give to the theme alias that you are creating. The alias name can't begin with a $. Alias names that start with $ are reserved by Amazon QuickSight.

", + "location":"uri", + "locationName":"AliasName" + }, + "ThemeVersionNumber":{ + "shape":"VersionNumber", + "documentation":"

The version number of the theme.

" + } + } + }, + "CreateThemeAliasResponse":{ + "type":"structure", + "members":{ + "ThemeAlias":{ + "shape":"ThemeAlias", + "documentation":"

Information about the theme alias.

" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

The HTTP status of the request.

", + "location":"statusCode" + }, + "RequestId":{ + "shape":"String", + "documentation":"

The AWS request ID for this operation.

" + } + } + }, + "CreateThemeRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "ThemeId", + "Name", + "BaseThemeId", + "Configuration" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

The ID of the AWS account where you want to store the new theme.

", + "location":"uri", + "locationName":"AwsAccountId" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

An ID for the theme that you want to create. The theme ID is unique per AWS Region in each AWS account.

", + "location":"uri", + "locationName":"ThemeId" + }, + "Name":{ + "shape":"ThemeName", + "documentation":"

A display name for the theme.

" + }, + "BaseThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within a QuickSight analysis.

" + }, + "VersionDescription":{ + "shape":"VersionDescription", + "documentation":"

A description of the first version of the theme that you're creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.

" + }, + "Configuration":{ + "shape":"ThemeConfiguration", + "documentation":"

The theme configuration, which contains the theme display properties.

" + }, + "Permissions":{ + "shape":"ResourcePermissionList", + "documentation":"

A valid grouping of resource permissions to apply to the new theme.

" + }, + "Tags":{ + "shape":"TagList", + "documentation":"

A map of the key-value pairs for the resource tag or tags that you want to add to the resource.

" + } + } + }, + "CreateThemeResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) for the theme.

" + }, + "VersionArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) for the new theme.

" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The ID of the theme.

" + }, + "CreationStatus":{ + "shape":"ResourceStatus", + "documentation":"

The theme creation status.

" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

The HTTP status of the request.

", + "location":"statusCode" + }, + "RequestId":{ + "shape":"String", + "documentation":"

The AWS request ID for this operation.

" + } + } + }, "CredentialPair":{ "type":"structure", "required":[ @@ -2246,6 +2654,10 @@ "Password":{ "shape":"Password", "documentation":"

Password.

" + }, + "AlternateDataSourceParameters":{ + "shape":"DataSourceParametersList", + "documentation":"

A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.

" } }, "documentation":"

The combination of user name and password that are used as credentials.

" @@ -2391,15 +2803,15 @@ "members":{ "Operator":{ "shape":"FilterOperator", - "documentation":"

The comparison operator that you want to use as a filter. For example, \"Operator\": \"StringEquals\".

" + "documentation":"

The comparison operator that you want to use as a filter, for example, \"Operator\": \"StringEquals\".

" }, "Name":{ "shape":"DashboardFilterAttribute", - "documentation":"

The name of the value that you want to use as a filter. For example, \"Name\": \"QUICKSIGHT_USER\".

" + "documentation":"

The name of the value that you want to use as a filter, for example, \"Name\": \"QUICKSIGHT_USER\".

" }, "Value":{ "shape":"String", - "documentation":"

The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter. For example, \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

" + "documentation":"

The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example, \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\".

" } }, "documentation":"

A filter that you apply when searching for dashboards.

" @@ -2556,6 +2968,24 @@ "member":{"shape":"DashboardVersionSummary"}, "max":100 }, + "DataColorPalette":{ + "type":"structure", + "members":{ + "Colors":{ + "shape":"ColorList", + "documentation":"

The hexadecimal codes for the colors.

" + }, + "MinMaxGradient":{ + "shape":"ColorList", + "documentation":"

The minimum and maximum hexadecimal codes that describe a color gradient.

" + }, + "EmptyFillColor":{ + "shape":"HexColor", + "documentation":"

The hexadecimal code of a color that applies to charts where a lack of data is highlighted.

" + } + }, + "documentation":"

The theme colors that are used for data colors in charts. The colors description is a hexidecimal color code that consists of six alphanumerical characters, prefixed with #, for example #37BFF5.

" + }, "DataSet":{ "type":"structure", "members":{ @@ -2756,6 +3186,10 @@ "shape":"DataSourceParameters", "documentation":"

The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

" }, + "AlternateDataSourceParameters":{ + "shape":"DataSourceParametersList", + "documentation":"

A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allowlist. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.

" + }, "VpcConnectionProperties":{ "shape":"VpcConnectionProperties", "documentation":"

The VPC connection information. You need to use this parameter only when you want QuickSight to use a VPC connection when connecting to your underlying source.

" @@ -2776,10 +3210,14 @@ "members":{ "CredentialPair":{ "shape":"CredentialPair", - "documentation":"

Credential pair.

" + "documentation":"

Credential pair. For more information, see CredentialPair.

" + }, + "CopySourceArn":{ + "shape":"CopySourceArn", + "documentation":"

The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.

" } }, - "documentation":"

Data source credentials.

", + "documentation":"

Data source credentials. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

", "sensitive":true }, "DataSourceErrorInfo":{ @@ -2799,6 +3237,8 @@ "DataSourceErrorInfoType":{ "type":"string", "enum":[ + "ACCESS_DENIED", + "COPY_SOURCE_NOT_FOUND", "TIMEOUT", "ENGINE_VERSION_NOT_SUPPORTED", "UNKNOWN_HOST", @@ -2893,6 +3333,12 @@ }, "documentation":"

The parameters that Amazon QuickSight uses to connect to your underlying data source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.

" }, + "DataSourceParametersList":{ + "type":"list", + "member":{"shape":"DataSourceParameters"}, + "max":50, + "min":1 + }, "DataSourceType":{ "type":"string", "enum":[ @@ -3264,7 +3710,7 @@ }, "AliasName":{ "shape":"AliasName", - "documentation":"

The name for the template alias. If you name a specific alias, you delete the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter.

", + "documentation":"

The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter.

", "location":"uri", "locationName":"AliasName" } @@ -3288,7 +3734,7 @@ }, "Arn":{ "shape":"Arn", - "documentation":"

The Amazon Resource Name (ARN) of the resource.

" + "documentation":"

The Amazon Resource Name (ARN) of the template you want to delete.

" }, "RequestId":{ "shape":"String", @@ -3345,6 +3791,109 @@ } } }, + "DeleteThemeAliasRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "ThemeId", + "AliasName" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

The ID of the AWS account that contains the theme alias to delete.

", + "location":"uri", + "locationName":"AwsAccountId" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The ID for the theme that the specified alias is for.

", + "location":"uri", + "locationName":"ThemeId" + }, + "AliasName":{ + "shape":"AliasName", + "documentation":"

The unique name for the theme alias to delete.

", + "location":"uri", + "locationName":"AliasName" + } + } + }, + "DeleteThemeAliasResponse":{ + "type":"structure", + "members":{ + "AliasName":{ + "shape":"AliasName", + "documentation":"

The name for the theme alias.

" + }, + "Arn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the theme resource using the deleted alias.

" + }, + "RequestId":{ + "shape":"String", + "documentation":"

The AWS request ID for this operation.

" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

The HTTP status of the request.

", + "location":"statusCode" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

An ID for the theme associated with the deletion.

" + } + } + }, + "DeleteThemeRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "ThemeId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

The ID of the AWS account that contains the theme that you're deleting.

", + "location":"uri", + "locationName":"AwsAccountId" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

An ID for the theme that you want to delete.

", + "location":"uri", + "locationName":"ThemeId" + }, + "VersionNumber":{ + "shape":"VersionNumber", + "documentation":"

The version of the theme that you want to delete.

Note: If you don't provide a version number, you're using this call to DeleteTheme to delete all versions of the theme.

", + "location":"querystring", + "locationName":"version-number" + } + } + }, + "DeleteThemeResponse":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

" + }, + "RequestId":{ + "shape":"String", + "documentation":"

The AWS request ID for this operation.

" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

The HTTP status of the request.

", + "location":"statusCode" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

An ID for the theme.

" + } + } + }, "DeleteUserByPrincipalIdRequest":{ "type":"structure", "required":[ @@ -3980,6 +4529,151 @@ "shape":"StatusCode", "documentation":"

The HTTP status of the request.

", "location":"statusCode" + }, + "RequestId":{"shape":"String"} + } + }, + "DescribeThemeAliasRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "ThemeId", + "AliasName" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

The ID of the AWS account that contains the theme alias that you're describing.

", + "location":"uri", + "locationName":"AwsAccountId" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The ID for the theme.

", + "location":"uri", + "locationName":"ThemeId" + }, + "AliasName":{ + "shape":"AliasName", + "documentation":"

The name of the theme alias that you want to describe.

", + "location":"uri", + "locationName":"AliasName" + } + } + }, + "DescribeThemeAliasResponse":{ + "type":"structure", + "members":{ + "ThemeAlias":{ + "shape":"ThemeAlias", + "documentation":"

Information about the theme alias.

" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

The HTTP status of the request.

", + "location":"statusCode" + }, + "RequestId":{ + "shape":"String", + "documentation":"

The AWS request ID for this operation.

" + } + } + }, + "DescribeThemePermissionsRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "ThemeId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

The ID of the AWS account that contains the theme that you're describing.

", + "location":"uri", + "locationName":"AwsAccountId" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The ID for the theme that you want to describe permissions for.

", + "location":"uri", + "locationName":"ThemeId" + } + } + }, + "DescribeThemePermissionsResponse":{ + "type":"structure", + "members":{ + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The ID for the theme.

" + }, + "ThemeArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the theme.

" + }, + "Permissions":{ + "shape":"ResourcePermissionList", + "documentation":"

A list of resource permissions set on the theme.

" + }, + "RequestId":{ + "shape":"String", + "documentation":"

The AWS request ID for this operation.

" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

The HTTP status of the request.

", + "location":"statusCode" + } + } + }, + "DescribeThemeRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "ThemeId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAndAccountId", + "documentation":"

The ID of the AWS account that contains the theme that you're describing.

", + "location":"uri", + "locationName":"AwsAccountId" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The ID for the theme.

", + "location":"uri", + "locationName":"ThemeId" + }, + "VersionNumber":{ + "shape":"VersionNumber", + "documentation":"

The version number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the theme is described.

", + "location":"querystring", + "locationName":"version-number" + }, + "AliasName":{ + "shape":"AliasName", + "documentation":"

The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to themes.

", + "location":"querystring", + "locationName":"alias-name" + } + } + }, + "DescribeThemeResponse":{ + "type":"structure", + "members":{ + "Theme":{ + "shape":"Theme", + "documentation":"

The information about the theme that you are describing.

" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

The HTTP status of the request.

", + "location":"statusCode" + }, + "RequestId":{ + "shape":"String", + "documentation":"

The AWS request ID for this operation.

" } } }, @@ -4221,7 +4915,7 @@ "members":{ "EmbedUrl":{ "shape":"EmbeddingUrl", - "documentation":"

An URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes, and the resulting session is valid for 10 hours. The API provides the URL with an auth_code value that enables a single sign-on session.

" + "documentation":"

A single-use URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes. The API provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.

" }, "Status":{ "shape":"StatusCode", @@ -4294,6 +4988,21 @@ "min":1, "pattern":"[\\u0020-\\u00FF]+" }, + "GutterStyle":{ + "type":"structure", + "members":{ + "Show":{ + "shape":"boolean", + "documentation":"

This Boolean value controls whether to display a gutter space between sheet tiles.

", + "box":true + } + }, + "documentation":"

The display options for gutter spacing between tiles on a sheet.

" + }, + "HexColor":{ + "type":"string", + "pattern":"^#[A-F0-9]{6}$" + }, "Host":{ "type":"string", "max":256, @@ -4327,7 +5036,7 @@ "documentation":"

Assignment status.

" } }, - "documentation":"

An IAM policy assignment.

" + "documentation":"

An AWS Identity and Access Management (IAM) policy assignment.

" }, "IAMPolicyAssignmentName":{ "type":"string", @@ -5377,6 +6086,171 @@ } } }, + "ListThemeAliasesRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "ThemeId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

The ID of the AWS account that contains the theme aliases that you're listing.

", + "location":"uri", + "locationName":"AwsAccountId" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The ID for the theme.

", + "location":"uri", + "locationName":"ThemeId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results, or null if there are no more results.

", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to be returned per request.

", + "box":true, + "location":"querystring", + "locationName":"max-result" + } + } + }, + "ListThemeAliasesResponse":{ + "type":"structure", + "members":{ + "ThemeAliasList":{ + "shape":"ThemeAliasList", + "documentation":"

A structure containing the list of the theme's aliases.

" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

The HTTP status of the request.

", + "location":"statusCode" + }, + "RequestId":{ + "shape":"String", + "documentation":"

The AWS request ID for this operation.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results, or null if there are no more results.

" + } + } + }, + "ListThemeVersionsRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "ThemeId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

The ID of the AWS account that contains the themes that you're listing.

", + "location":"uri", + "locationName":"AwsAccountId" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The ID for the theme.

", + "location":"uri", + "locationName":"ThemeId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results, or null if there are no more results.

", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to be returned per request.

", + "box":true, + "location":"querystring", + "locationName":"max-results" + } + } + }, + "ListThemeVersionsResponse":{ + "type":"structure", + "members":{ + "ThemeVersionSummaryList":{ + "shape":"ThemeVersionSummaryList", + "documentation":"

A structure containing a list of all the versions of the specified theme.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results, or null if there are no more results.

" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

The HTTP status of the request.

", + "location":"statusCode" + }, + "RequestId":{ + "shape":"String", + "documentation":"

The AWS request ID for this operation.

" + } + } + }, + "ListThemesRequest":{ + "type":"structure", + "required":["AwsAccountId"], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

The ID of the AWS account that contains the themes that you're listing.

", + "location":"uri", + "locationName":"AwsAccountId" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results, or null if there are no more results.

", + "location":"querystring", + "locationName":"next-token" + }, + "MaxResults":{ + "shape":"MaxResults", + "documentation":"

The maximum number of results to be returned per request.

", + "box":true, + "location":"querystring", + "locationName":"max-results" + }, + "Type":{ + "shape":"ThemeType", + "documentation":"

The type of themes that you want to list. Valid options include the following:

  • ALL (default)- Display all existing themes.

  • CUSTOM - Display only the themes created by people using Amazon QuickSight.

  • QUICKSIGHT - Display only the starting themes defined by QuickSight.

", + "location":"querystring", + "locationName":"type" + } + } + }, + "ListThemesResponse":{ + "type":"structure", + "members":{ + "ThemeSummaryList":{ + "shape":"ThemeSummaryList", + "documentation":"

Information about the themes in the list.

" + }, + "NextToken":{ + "shape":"String", + "documentation":"

The token for the next set of results, or null if there are no more results.

" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

The HTTP status of the request.

", + "location":"statusCode" + }, + "RequestId":{ + "shape":"String", + "documentation":"

The AWS request ID for this operation.

" + } + } + }, "ListUserGroupsRequest":{ "type":"structure", "required":[ @@ -5573,6 +6447,17 @@ }, "documentation":"

Amazon S3 manifest file location.

" }, + "MarginStyle":{ + "type":"structure", + "members":{ + "Show":{ + "shape":"boolean", + "documentation":"

This Boolean value controls whether to display sheet margins.

", + "box":true + } + }, + "documentation":"

The display options for margins around the outside edge of sheets.

" + }, "MariaDbParameters":{ "type":"structure", "required":[ @@ -6016,7 +6901,7 @@ "Message":{"shape":"String"}, "ResourceType":{ "shape":"ExceptionResourceType", - "documentation":"

The AWS request ID for this request.

" + "documentation":"

The resource type for this request.

" }, "RequestId":{ "shape":"String", @@ -6039,7 +6924,7 @@ "Message":{"shape":"String"}, "ResourceType":{ "shape":"ExceptionResourceType", - "documentation":"

The AWS request ID for this request.

" + "documentation":"

The resource type for this request.

" }, "RequestId":{ "shape":"String", @@ -6059,7 +6944,7 @@ "members":{ "Principal":{ "shape":"Principal", - "documentation":"

The Amazon Resource Name (ARN) of an Amazon QuickSight user or group, or an IAM ARN. If you are using cross-account resource sharing, this is the IAM ARN of an account root. Otherwise, it is the ARN of a QuickSight user or group. .

" + "documentation":"

The Amazon Resource Name (ARN) of the principal. This can be one of the following:

  • The ARN of an Amazon QuickSight user, group, or namespace. (This is most common.)

  • The ARN of an AWS account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across AWS accounts. (This is less common.)

" }, "Actions":{ "shape":"ActionList", @@ -6213,7 +7098,7 @@ }, "Filters":{ "shape":"DashboardSearchFilterList", - "documentation":"

The filters to apply to the search. Currently, you can search only by user name. For example, \"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]

" + "documentation":"

The filters to apply to the search. Currently, you can search only by user name, for example, \"Filters\": [ { \"Name\": \"QUICKSIGHT_USER\", \"Operator\": \"StringEquals\", \"Value\": \"arn:aws:quicksight:us-east-1:1:user/default/UserName1\" } ]

" }, "NextToken":{ "shape":"String", @@ -6286,6 +7171,20 @@ }, "documentation":"

Sheet controls option.

" }, + "SheetStyle":{ + "type":"structure", + "members":{ + "Tile":{ + "shape":"TileStyle", + "documentation":"

The display options for tiles.

" + }, + "TileLayout":{ + "shape":"TileLayoutStyle", + "documentation":"

The layout options for tiles.

" + } + }, + "documentation":"

The theme display options for sheets.

" + }, "SiteBaseUrl":{ "type":"string", "max":1024, @@ -6749,6 +7648,218 @@ "SINGLE_QUOTE" ] }, + "Theme":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the theme.

" + }, + "Name":{ + "shape":"ThemeName", + "documentation":"

The name that the user gives to the theme.

" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The identifier that the user gives to the theme.

" + }, + "Version":{"shape":"ThemeVersion"}, + "CreatedTime":{ + "shape":"Timestamp", + "documentation":"

The date and time that the theme was created.

" + }, + "LastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"

The date and time that the theme was last updated.

" + }, + "Type":{ + "shape":"ThemeType", + "documentation":"

The type of theme, based on how it was created. Valid values include: QUICKSIGHT and CUSTOM.

" + } + }, + "documentation":"

" + }, + "ThemeAlias":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the theme alias.

" + }, + "AliasName":{ + "shape":"AliasName", + "documentation":"

The display name of the theme alias.

" + }, + "ThemeVersionNumber":{ + "shape":"VersionNumber", + "documentation":"

The version number of the theme alias.

" + } + }, + "documentation":"

An alias for a theme.

" + }, + "ThemeAliasList":{ + "type":"list", + "member":{"shape":"ThemeAlias"}, + "max":100 + }, + "ThemeConfiguration":{ + "type":"structure", + "members":{ + "DataColorPalette":{ + "shape":"DataColorPalette", + "documentation":"

Color properties that apply to chart data colors.

" + }, + "UIColorPalette":{ + "shape":"UIColorPalette", + "documentation":"

Color properties that apply to the UI and to charts, excluding the colors that apply to data.

" + }, + "Sheet":{ + "shape":"SheetStyle", + "documentation":"

Display options related to sheets.

" + } + }, + "documentation":"

The theme configuration. This configuration contains all of the display properties for a theme.

" + }, + "ThemeError":{ + "type":"structure", + "members":{ + "Type":{ + "shape":"ThemeErrorType", + "documentation":"

The type of error.

" + }, + "Message":{ + "shape":"NonEmptyString", + "documentation":"

The error message.

" + } + }, + "documentation":"

Theme error.

" + }, + "ThemeErrorList":{ + "type":"list", + "member":{"shape":"ThemeError"}, + "min":1 + }, + "ThemeErrorType":{ + "type":"string", + "enum":["INTERNAL_FAILURE"] + }, + "ThemeName":{ + "type":"string", + "max":2048, + "min":1 + }, + "ThemeSummary":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

" + }, + "Name":{ + "shape":"ThemeName", + "documentation":"

the display name for the theme.

" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The ID of the theme. This ID is unique per AWS Region for each AWS account.

" + }, + "LatestVersionNumber":{ + "shape":"VersionNumber", + "documentation":"

The latest version number for the theme.

" + }, + "CreatedTime":{ + "shape":"Timestamp", + "documentation":"

The date and time that this theme was created.

" + }, + "LastUpdatedTime":{ + "shape":"Timestamp", + "documentation":"

The last date and time that this theme was updated.

" + } + }, + "documentation":"

The theme summary.

" + }, + "ThemeSummaryList":{ + "type":"list", + "member":{"shape":"ThemeSummary"}, + "max":100 + }, + "ThemeType":{ + "type":"string", + "enum":[ + "QUICKSIGHT", + "CUSTOM", + "ALL" + ] + }, + "ThemeVersion":{ + "type":"structure", + "members":{ + "VersionNumber":{ + "shape":"VersionNumber", + "documentation":"

The version number of the theme.

" + }, + "Arn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the resource.

" + }, + "Description":{ + "shape":"VersionDescription", + "documentation":"

The description of the theme.

" + }, + "BaseThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.

" + }, + "CreatedTime":{ + "shape":"Timestamp", + "documentation":"

The date and time that this theme version was created.

" + }, + "Configuration":{ + "shape":"ThemeConfiguration", + "documentation":"

The theme configuration, which contains all the theme display properties.

" + }, + "Errors":{ + "shape":"ThemeErrorList", + "documentation":"

Errors associated with the theme.

" + }, + "Status":{ + "shape":"ResourceStatus", + "documentation":"

The status of the theme version.

" + } + }, + "documentation":"

A version of a theme.

" + }, + "ThemeVersionSummary":{ + "type":"structure", + "members":{ + "VersionNumber":{ + "shape":"VersionNumber", + "documentation":"

The version number of the theme version.

" + }, + "Arn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the theme version.

" + }, + "Description":{ + "shape":"VersionDescription", + "documentation":"

The description of the theme version.

" + }, + "CreatedTime":{ + "shape":"Timestamp", + "documentation":"

The date and time that this theme version was created.

" + }, + "Status":{ + "shape":"ResourceStatus", + "documentation":"

The status of the theme version.

" + } + }, + "documentation":"

The theme version.

" + }, + "ThemeVersionSummaryList":{ + "type":"list", + "member":{"shape":"ThemeVersionSummary"}, + "max":100 + }, "ThrottlingException":{ "type":"structure", "members":{ @@ -6762,6 +7873,30 @@ "error":{"httpStatusCode":429}, "exception":true }, + "TileLayoutStyle":{ + "type":"structure", + "members":{ + "Gutter":{ + "shape":"GutterStyle", + "documentation":"

The gutter settings that apply between tiles.

" + }, + "Margin":{ + "shape":"MarginStyle", + "documentation":"

The margin settings that apply around the outside edge of sheets.

" + } + }, + "documentation":"

The display options for the layout of tiles on a sheet.

" + }, + "TileStyle":{ + "type":"structure", + "members":{ + "Border":{ + "shape":"BorderStyle", + "documentation":"

The border around a tile.

" + } + }, + "documentation":"

Display options related to tiles on a sheet.

" + }, "Timestamp":{"type":"timestamp"}, "TimestampList":{ "type":"list", @@ -6825,6 +7960,76 @@ "type":"string", "max":32 }, + "UIColorPalette":{ + "type":"structure", + "members":{ + "PrimaryForeground":{ + "shape":"HexColor", + "documentation":"

The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.

" + }, + "PrimaryBackground":{ + "shape":"HexColor", + "documentation":"

The background color that applies to visuals and other high emphasis UI.

" + }, + "SecondaryForeground":{ + "shape":"HexColor", + "documentation":"

The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.

" + }, + "SecondaryBackground":{ + "shape":"HexColor", + "documentation":"

The background color that applies to the sheet background and sheet controls.

" + }, + "Accent":{ + "shape":"HexColor", + "documentation":"

This color is that applies to selected states and buttons.

" + }, + "AccentForeground":{ + "shape":"HexColor", + "documentation":"

The foreground color that applies to any text or other elements that appear over the accent color.

" + }, + "Danger":{ + "shape":"HexColor", + "documentation":"

The color that applies to error messages.

" + }, + "DangerForeground":{ + "shape":"HexColor", + "documentation":"

The foreground color that applies to any text or other elements that appear over the error color.

" + }, + "Warning":{ + "shape":"HexColor", + "documentation":"

This color that applies to warning and informational messages.

" + }, + "WarningForeground":{ + "shape":"HexColor", + "documentation":"

The foreground color that applies to any text or other elements that appear over the warning color.

" + }, + "Success":{ + "shape":"HexColor", + "documentation":"

The color that applies to success messages, for example the check mark for a successful download.

" + }, + "SuccessForeground":{ + "shape":"HexColor", + "documentation":"

The foreground color that applies to any text or other elements that appear over the success color.

" + }, + "Dimension":{ + "shape":"HexColor", + "documentation":"

The color that applies to the names of fields that are identified as dimensions.

" + }, + "DimensionForeground":{ + "shape":"HexColor", + "documentation":"

The foreground color that applies to any text or other elements that appear over the dimension color.

" + }, + "Measure":{ + "shape":"HexColor", + "documentation":"

The color that applies to the names of fields that are identified as measures.

" + }, + "MeasureForeground":{ + "shape":"HexColor", + "documentation":"

The foreground color that applies to any text or other elements that appear over the measure color.

" + } + }, + "documentation":"

The theme colors that apply to UI and to charts, excluding data colors. The colors description is a hexidecimal color code that consists of six alphanumerical characters, prefixed with #, for example #37BFF5. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.

" + }, "UnsupportedUserEditionException":{ "type":"structure", "members":{ @@ -7005,11 +8210,11 @@ }, "SourceEntity":{ "shape":"DashboardSourceEntity", - "documentation":"

The template or analysis from which the dashboard is created. The SouceTemplate entity accepts the Amazon Resource Name (ARN) of the template and also references to replacement datasets for the placeholders set when creating the template. The replacement datasets need to follow the same schema as the datasets for which placeholders were created when creating the template.

" + "documentation":"

The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

" }, "Parameters":{ "shape":"Parameters", - "documentation":"

A structure that contains the parameters of the dashboard.

" + "documentation":"

A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.

" }, "VersionDescription":{ "shape":"VersionDescription", @@ -7017,7 +8222,11 @@ }, "DashboardPublishOptions":{ "shape":"DashboardPublishOptions", - "documentation":"

Options for publishing the dashboard when you create it:

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .csv format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

  • VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. The sheet controls pane is collapsed by default when set to true. This option is COLLAPSED by default.

" + "documentation":"

Options for publishing the dashboard when you create it:

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .csv format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

  • VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

" + }, + "ThemeArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same AWS account where you create the dashboard.

" } } }, @@ -7425,8 +8634,7 @@ "UpdateResourcePermissionList":{ "type":"list", "member":{"shape":"ResourcePermission"}, - "max":100, - "min":1 + "max":100 }, "UpdateTemplateAliasRequest":{ "type":"structure", @@ -7556,7 +8764,7 @@ }, "SourceEntity":{ "shape":"TemplateSourceEntity", - "documentation":"

The source QuickSight entity from which this template is being updated. You can currently update templates from an Analysis or another template.

" + "documentation":"

The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any AWS Account and any QuickSight-supported AWS Region.

Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

" }, "VersionDescription":{ "shape":"VersionDescription", @@ -7598,6 +8806,180 @@ } } }, + "UpdateThemeAliasRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "ThemeId", + "AliasName", + "ThemeVersionNumber" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

The ID of the AWS account that contains the theme alias that you're updating.

", + "location":"uri", + "locationName":"AwsAccountId" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The ID for the theme.

", + "location":"uri", + "locationName":"ThemeId" + }, + "AliasName":{ + "shape":"AliasName", + "documentation":"

The name of the theme alias that you want to update.

", + "location":"uri", + "locationName":"AliasName" + }, + "ThemeVersionNumber":{ + "shape":"VersionNumber", + "documentation":"

The version number of the theme that the alias should reference.

" + } + } + }, + "UpdateThemeAliasResponse":{ + "type":"structure", + "members":{ + "ThemeAlias":{ + "shape":"ThemeAlias", + "documentation":"

Information about the theme alias.

" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

The HTTP status of the request.

", + "location":"statusCode" + }, + "RequestId":{ + "shape":"String", + "documentation":"

The AWS request ID for this operation.

" + } + } + }, + "UpdateThemePermissionsRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "ThemeId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

The ID of the AWS account that contains the theme.

", + "location":"uri", + "locationName":"AwsAccountId" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The ID for the theme.

", + "location":"uri", + "locationName":"ThemeId" + }, + "GrantPermissions":{ + "shape":"UpdateResourcePermissionList", + "documentation":"

A list of resource permissions to be granted for the theme.

" + }, + "RevokePermissions":{ + "shape":"UpdateResourcePermissionList", + "documentation":"

A list of resource permissions to be revoked from the theme.

" + } + } + }, + "UpdateThemePermissionsResponse":{ + "type":"structure", + "members":{ + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The ID for the theme.

" + }, + "ThemeArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) of the theme.

" + }, + "Permissions":{ + "shape":"ResourcePermissionList", + "documentation":"

The resulting list of resource permissions for the theme.

" + }, + "RequestId":{ + "shape":"String", + "documentation":"

The AWS request ID for this operation.

" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

The HTTP status of the request.

", + "location":"statusCode" + } + } + }, + "UpdateThemeRequest":{ + "type":"structure", + "required":[ + "AwsAccountId", + "ThemeId", + "BaseThemeId" + ], + "members":{ + "AwsAccountId":{ + "shape":"AwsAccountId", + "documentation":"

The ID of the AWS account that contains the theme that you're updating.

", + "location":"uri", + "locationName":"AwsAccountId" + }, + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The ID for the theme.

", + "location":"uri", + "locationName":"ThemeId" + }, + "Name":{ + "shape":"ThemeName", + "documentation":"

The name for the theme.

" + }, + "BaseThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default QuickSight theme.

" + }, + "VersionDescription":{ + "shape":"VersionDescription", + "documentation":"

A description of the theme version that you're updating Every time that you call UpdateTheme, you create a new version of the theme. Each version of the theme maintains a description of the version in VersionDescription.

" + }, + "Configuration":{ + "shape":"ThemeConfiguration", + "documentation":"

The theme configuration, which contains the theme display properties.

" + } + } + }, + "UpdateThemeResponse":{ + "type":"structure", + "members":{ + "ThemeId":{ + "shape":"RestrictiveResourceId", + "documentation":"

The ID for the theme.

" + }, + "Arn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) for the theme.

" + }, + "VersionArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) for the new version of the theme.

" + }, + "CreationStatus":{ + "shape":"ResourceStatus", + "documentation":"

The creation status of the theme.

" + }, + "Status":{ + "shape":"StatusCode", + "documentation":"

The HTTP status of the request.

", + "location":"statusCode" + }, + "RequestId":{ + "shape":"String", + "documentation":"

The AWS request ID for this operation.

" + } + } + }, "UpdateUserRequest":{ "type":"structure", "required":[ diff --git a/botocore/data/rds/2014-10-31/service-2.json b/botocore/data/rds/2014-10-31/service-2.json index 8eb53707..0feeb54c 100644 --- a/botocore/data/rds/2014-10-31/service-2.json +++ b/botocore/data/rds/2014-10-31/service-2.json @@ -451,7 +451,7 @@ {"shape":"DBProxyAlreadyExistsFault"}, {"shape":"DBProxyQuotaExceededFault"} ], - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Creates a new DB proxy.

" + "documentation":"

Creates a new DB proxy.

" }, "CreateDBSecurityGroup":{ "name":"CreateDBSecurityGroup", @@ -719,7 +719,7 @@ {"shape":"DBProxyNotFoundFault"}, {"shape":"InvalidDBProxyStateFault"} ], - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Deletes an existing proxy.

" + "documentation":"

Deletes an existing proxy.

" }, "DeleteDBSecurityGroup":{ "name":"DeleteDBSecurityGroup", @@ -845,7 +845,7 @@ {"shape":"DBProxyNotFoundFault"}, {"shape":"InvalidDBProxyStateFault"} ], - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

" + "documentation":"

Remove the association between one or more DBProxyTarget data structures and a DBProxyTargetGroup.

" }, "DescribeAccountAttributes":{ "name":"DescribeAccountAttributes", @@ -1112,7 +1112,7 @@ "errors":[ {"shape":"DBProxyNotFoundFault"} ], - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Returns information about DB proxies.

" + "documentation":"

Returns information about DB proxies.

" }, "DescribeDBProxyTargetGroups":{ "name":"DescribeDBProxyTargetGroups", @@ -1130,7 +1130,7 @@ {"shape":"DBProxyTargetGroupNotFoundFault"}, {"shape":"InvalidDBProxyStateFault"} ], - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

" + "documentation":"

Returns information about DB proxy target groups, represented by DBProxyTargetGroup data structures.

" }, "DescribeDBProxyTargets":{ "name":"DescribeDBProxyTargets", @@ -1149,7 +1149,7 @@ {"shape":"DBProxyTargetGroupNotFoundFault"}, {"shape":"InvalidDBProxyStateFault"} ], - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Returns information about DBProxyTarget objects. This API supports pagination.

" + "documentation":"

Returns information about DBProxyTarget objects. This API supports pagination.

" }, "DescribeDBSecurityGroups":{ "name":"DescribeDBSecurityGroups", @@ -1667,7 +1667,9 @@ {"shape":"AuthorizationNotFoundFault"}, {"shape":"CertificateNotFoundFault"}, {"shape":"DomainNotFoundFault"}, - {"shape":"BackupPolicyNotFoundFault"} + {"shape":"BackupPolicyNotFoundFault"}, + {"shape":"KMSKeyNotAccessibleFault"}, + {"shape":"InvalidDBClusterStateFault"} ], "documentation":"

Modifies settings for a DB instance. You can change one or more database configuration parameters by specifying these parameters and the new values in the request. To learn what modifications you can make to your DB instance, call DescribeValidDBInstanceModifications before you call ModifyDBInstance.

" }, @@ -1704,7 +1706,7 @@ {"shape":"DBProxyAlreadyExistsFault"}, {"shape":"InvalidDBProxyStateFault"} ], - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Changes the settings for an existing DB proxy.

" + "documentation":"

Changes the settings for an existing DB proxy.

" }, "ModifyDBProxyTargetGroup":{ "name":"ModifyDBProxyTargetGroup", @@ -1722,7 +1724,7 @@ {"shape":"DBProxyTargetGroupNotFoundFault"}, {"shape":"InvalidDBProxyStateFault"} ], - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Modifies the properties of a DBProxyTargetGroup.

" + "documentation":"

Modifies the properties of a DBProxyTargetGroup.

" }, "ModifyDBSnapshot":{ "name":"ModifyDBSnapshot", @@ -1923,7 +1925,7 @@ {"shape":"InvalidDBClusterStateFault"}, {"shape":"InvalidDBProxyStateFault"} ], - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

" + "documentation":"

Associate one or more DBProxyTarget data structures with a DBProxyTargetGroup.

" }, "RemoveFromGlobalCluster":{ "name":"RemoveFromGlobalCluster", @@ -2880,10 +2882,10 @@ }, "InitQuery":{ "shape":"String", - "documentation":"

One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

InitQuery is not currently supported for PostgreSQL.

Default: no initialization query

" + "documentation":"

One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

Default: no initialization query

" } }, - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.

" + "documentation":"

Specifies the settings that control the size and behavior of the connection pool associated with a DBProxyTargetGroup.

" }, "ConnectionPoolConfigurationInfo":{ "type":"structure", @@ -2906,10 +2908,10 @@ }, "InitQuery":{ "shape":"String", - "documentation":"

One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

InitQuery is not currently supported for PostgreSQL.

" + "documentation":"

One or more SQL statements for the proxy to run when opening each new database connection. Typically used with SET statements to make sure that each connection has identical settings such as time zone and character set. This setting is empty by default. For multiple statements, use semicolons as the separator. You can also include multiple variables in a single SET statement, such as SET x=1, y=2.

" } }, - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

" + "documentation":"

Displays the settings that control the size and behavior of the connection pool associated with a DBProxyTarget.

" }, "CopyDBClusterParameterGroupMessage":{ "type":"structure", @@ -3663,7 +3665,7 @@ }, "Domain":{ "shape":"String", - "documentation":"

The Active Directory directory ID to create the DB instance in.

For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

" + "documentation":"

The Active Directory directory ID to create the DB instance in.

For Oracle DB instances, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

" }, "DomainIAMRoleName":{ "shape":"String", @@ -5689,7 +5691,7 @@ "documentation":"

The date and time when the proxy was last updated.

" } }, - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

The data structure representing a proxy managed by the RDS Proxy.

This data type is used as a response element in the DescribeDBProxies action.

" + "documentation":"

The data structure representing a proxy managed by the RDS Proxy.

This data type is used as a response element in the DescribeDBProxies action.

" }, "DBProxyAlreadyExistsFault":{ "type":"structure", @@ -5777,7 +5779,7 @@ "documentation":"

Information about the connection health of the RDS Proxy target.

" } }, - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

This data type is used as a response element in the DescribeDBProxyTargets action.

" + "documentation":"

Contains the details for an RDS Proxy target. It represents an RDS DB instance or Aurora DB cluster that the proxy can connect to. One or more targets are associated with an RDS Proxy target group.

This data type is used as a response element in the DescribeDBProxyTargets action.

" }, "DBProxyTargetAlreadyRegisteredFault":{ "type":"structure", @@ -5827,7 +5829,7 @@ "documentation":"

The date and time when the target group was last updated.

" } }, - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.

This data type is used as a response element in the DescribeDBProxyTargetGroups action.

" + "documentation":"

Represents a set of RDS DB instances, Aurora DB clusters, or both that a proxy can connect to. Currently, each target group is associated with exactly one RDS DB instance or Aurora DB cluster.

This data type is used as a response element in the DescribeDBProxyTargetGroups action.

" }, "DBProxyTargetGroupNotFoundFault":{ "type":"structure", @@ -9259,7 +9261,7 @@ }, "Domain":{ "shape":"String", - "documentation":"

The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.

For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

" + "documentation":"

The Active Directory directory ID to move the DB instance to. Specify none to remove the instance from its current domain. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.

For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

For Oracle DB instances, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

" }, "CopyTagsToSnapshot":{ "shape":"BooleanOptional", @@ -10141,6 +10143,10 @@ "SupportsKerberosAuthentication":{ "shape":"BooleanOptional", "documentation":"

Whether a DB instance supports Kerberos Authentication.

" + }, + "OutpostCapable":{ + "shape":"Boolean", + "documentation":"

Whether a DB instance supports RDS on Outposts.

For more information about RDS on Outposts, see Amazon RDS on AWS Outposts in the Amazon RDS User Guide.

" } }, "documentation":"

Contains a list of available options for a DB instance.

This data type is used as a response element in the DescribeOrderableDBInstanceOptions action.

", @@ -10167,6 +10173,16 @@ }, "documentation":"

Contains the result of a successful invocation of the DescribeOrderableDBInstanceOptions action.

" }, + "Outpost":{ + "type":"structure", + "members":{ + "Arn":{ + "shape":"String", + "documentation":"

The Amazon Resource Name (ARN) of the Outpost.

" + } + }, + "documentation":"

A data type that represents an Outpost.

For more information about RDS on Outposts, see Amazon RDS on AWS Outposts in the Amazon RDS User Guide.

" + }, "Parameter":{ "type":"structure", "members":{ @@ -11391,7 +11407,7 @@ }, "Domain":{ "shape":"String", - "documentation":"

Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.

For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

" + "documentation":"

Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.

For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

For Oracle DB instances, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

" }, "CopyTagsToSnapshot":{ "shape":"BooleanOptional", @@ -11717,7 +11733,7 @@ }, "Domain":{ "shape":"String", - "documentation":"

Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.

For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

For Oracle DB instances, Amazon RDS can use Kerberos Authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

" + "documentation":"

Specify the Active Directory directory ID to restore the DB instance in. The domain must be created prior to this operation. Currently, only Microsoft SQL Server and Oracle DB instances can be created in an Active Directory Domain.

For Microsoft SQL Server DB instances, Amazon RDS can use Windows Authentication to authenticate users that connect to the DB instance. For more information, see Using Windows Authentication with an Amazon RDS DB Instance Running Microsoft SQL Server in the Amazon RDS User Guide.

For Oracle DB instances, Amazon RDS can use Kerberos authentication to authenticate users that connect to the DB instance. For more information, see Using Kerberos Authentication with Amazon RDS for Oracle in the Amazon RDS User Guide.

" }, "DomainIAMRoleName":{ "shape":"String", @@ -12216,15 +12232,19 @@ "members":{ "SubnetIdentifier":{ "shape":"String", - "documentation":"

Specifies the identifier of the subnet.

" + "documentation":"

The identifier of the subnet.

" }, "SubnetAvailabilityZone":{"shape":"AvailabilityZone"}, + "SubnetOutpost":{ + "shape":"Outpost", + "documentation":"

If the subnet is associated with an Outpost, this value specifies the Outpost.

For more information about RDS on Outposts, see Amazon RDS on AWS Outposts in the Amazon RDS User Guide.

" + }, "SubnetStatus":{ "shape":"String", - "documentation":"

Specifies the status of the subnet.

" + "documentation":"

The status of the subnet.

" } }, - "documentation":"

This data type is used as a response element in the DescribeDBSubnetGroups action.

" + "documentation":"

This data type is used as a response element for the DescribeDBSubnetGroups operation.

" }, "SubnetAlreadyInUse":{ "type":"structure", @@ -12355,7 +12375,7 @@ "documentation":"

A description of the health of the RDS Proxy target. If the State is AVAILABLE, a description is not included.

" } }, - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Information about the connection health of an RDS Proxy target.

" + "documentation":"

Information about the connection health of an RDS Proxy target.

" }, "TargetHealthReason":{ "type":"string", @@ -12446,7 +12466,7 @@ "documentation":"

Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

" } }, - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Specifies the details of authentication used by a proxy to log in as a specific database user.

" + "documentation":"

Specifies the details of authentication used by a proxy to log in as a specific database user.

" }, "UserAuthConfigInfo":{ "type":"structure", @@ -12472,7 +12492,7 @@ "documentation":"

Whether to require or disallow AWS Identity and Access Management (IAM) authentication for connections to the proxy.

" } }, - "documentation":"

This is prerelease documentation for the RDS Database Proxy feature in preview release. It is subject to change.

Returns the details of authentication used by a proxy to log in as a specific database user.

" + "documentation":"

Returns the details of authentication used by a proxy to log in as a specific database user.

" }, "UserAuthConfigInfoList":{ "type":"list", diff --git a/botocore/data/sagemaker/2017-07-24/service-2.json b/botocore/data/sagemaker/2017-07-24/service-2.json index c8e59e22..7388ca20 100644 --- a/botocore/data/sagemaker/2017-07-24/service-2.json +++ b/botocore/data/sagemaker/2017-07-24/service-2.json @@ -60,7 +60,7 @@ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceInUse"} ], - "documentation":"

Creates a running App for the specified UserProfile. Supported Apps are JupyterServer, KernelGateway, and TensorBoard. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously. UserProfiles are limited to 5 concurrently running Apps at a time.

" + "documentation":"

Creates a running App for the specified UserProfile. Supported Apps are JupyterServer and KernelGateway. This operation is automatically invoked by Amazon SageMaker Studio upon access to the associated Domain, and when new kernel configurations are selected by the user. A user may have multiple Apps active simultaneously.

" }, "CreateAutoMLJob":{ "name":"CreateAutoMLJob", @@ -483,6 +483,19 @@ ], "documentation":"

Deletes the specified flow definition.

" }, + "DeleteHumanTaskUi":{ + "name":"DeleteHumanTaskUi", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteHumanTaskUiRequest"}, + "output":{"shape":"DeleteHumanTaskUiResponse"}, + "errors":[ + {"shape":"ResourceNotFound"} + ], + "documentation":"

Use this operation to delete a worker task template (HumanTaskUi).

To see a list of human task user interfaces (work task templates) in your account, use . When you delete a worker task template, it no longer appears when you call ListHumanTaskUis.

" + }, "DeleteModel":{ "name":"DeleteModel", "http":{ @@ -722,7 +735,7 @@ "errors":[ {"shape":"ResourceNotFound"} ], - "documentation":"

Returns information about the requested human task user interface.

" + "documentation":"

Returns information about the requested human task user interface (worker task template).

" }, "DescribeHyperParameterTuningJob":{ "name":"DescribeHyperParameterTuningJob", @@ -1564,7 +1577,7 @@ }, "input":{"shape":"UpdateWorkforceRequest"}, "output":{"shape":"UpdateWorkforceResponse"}, - "documentation":"

Restricts access to tasks assigned to workers in the specified workforce to those within specific ranges of IP addresses. You specify allowed IP addresses by creating a list of up to four CIDRs.

By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied access and get a Not Found error message on the worker portal. After restricting access with this operation, you can see the allowed IP values for a private workforce with the operation.

This operation applies only to private workforces.

" + "documentation":"

Restricts access to tasks assigned to workers in the specified workforce to those within specific ranges of IP addresses. You specify allowed IP addresses by creating a list of up to ten CIDRs.

By default, a workforce isn't restricted to specific IP addresses. If you specify a range of IP addresses, workers who attempt to access tasks using any IP address outside the specified range are denied access and get a Not Found error message on the worker portal. After restricting access with this operation, you can see the allowed IP values for a private workforce with the operation.

This operation applies only to private workforces.

" }, "UpdateWorkteam":{ "name":"UpdateWorkteam", @@ -1804,10 +1817,10 @@ "members":{ "AnnotationConsolidationLambdaArn":{ "shape":"LambdaFunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation.

For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox

    arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox

    arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass

    arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass

    arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation

    arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation

    arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass

    arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass

    arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition

    arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition

    arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition

Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox

    arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox

    arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox

Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation

Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox

Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation

For more information, see Annotation Consolidation.

" + "documentation":"

The Amazon Resource Name (ARN) of a Lambda function implements the logic for annotation consolidation and to process output data.

This parameter is required for all labeling jobs. For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for AnnotationConsolidationLambdaArn. For custom labeling workflows, see Post-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-BoundingBox

    arn:aws:lambda:us-east-2:266458841044:function:ACS-BoundingBox

    arn:aws:lambda:us-west-2:081040173940:function:ACS-BoundingBox

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-BoundingBox

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-BoundingBox

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-BoundingBox

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-BoundingBox

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-BoundingBox

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-BoundingBox

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-BoundingBox

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-BoundingBox

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClass

    arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClass

    arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClass

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClass

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClass

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClass

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClass

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClass

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClass

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClass

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClass

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:us-east-2:266458841044:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:us-west-2:081040173940:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-ImageMultiClassMultiLabel

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-SemanticSegmentation

    arn:aws:lambda:us-east-2:266458841044:function:ACS-SemanticSegmentation

    arn:aws:lambda:us-west-2:081040173940:function:ACS-SemanticSegmentation

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-SemanticSegmentation

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-SemanticSegmentation

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-SemanticSegmentation

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-SemanticSegmentation

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-SemanticSegmentation

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-SemanticSegmentation

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-SemanticSegmentation

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-SemanticSegmentation

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClass

    arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClass

    arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClass

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClass

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClass

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClass

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClass

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClass

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClass

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClass

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClass

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:us-east-2:266458841044:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:us-west-2:081040173940:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-TextMultiClassMultiLabel

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-NamedEntityRecognition

    arn:aws:lambda:us-east-2:266458841044:function:ACS-NamedEntityRecognition

    arn:aws:lambda:us-west-2:081040173940:function:ACS-NamedEntityRecognition

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-NamedEntityRecognition

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-NamedEntityRecognition

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-NamedEntityRecognition

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-NamedEntityRecognition

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-NamedEntityRecognition

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-NamedEntityRecognition

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-NamedEntityRecognition

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-NamedEntityRecognition

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-NamedEntityRecognition

3D point cloud object detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectDetection

    arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectDetection

    arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectDetection

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectDetection

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectDetection

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectDetection

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectDetection

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectDetection

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectDetection

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectDetection

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectDetection

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectDetection

3D point cloud object tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudObjectTracking

    arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudObjectTracking

    arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudObjectTracking

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudObjectTracking

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudObjectTracking

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudObjectTracking

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudObjectTracking

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudObjectTracking

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudObjectTracking

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudObjectTracking

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudObjectTracking

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudObjectTracking

3D point cloud semantic segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-3DPointCloudSemanticSegmentation

    arn:aws:lambda:us-east-2:266458841044:function:ACS-3DPointCloudSemanticSegmentation

    arn:aws:lambda:us-west-2:081040173940:function:ACS-3DPointCloudSemanticSegmentation

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-3DPointCloudSemanticSegmentation

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-3DPointCloudSemanticSegmentation

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-3DPointCloudSemanticSegmentation

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-3DPointCloudSemanticSegmentation

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-3DPointCloudSemanticSegmentation

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-3DPointCloudSemanticSegmentation

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-3DPointCloudSemanticSegmentation

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-3DPointCloudSemanticSegmentation

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentSemanticSegmentation

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentSemanticSegmentation

Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationSemanticSegmentation

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationSemanticSegmentation

Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-VerificationBoundingBox

    arn:aws:lambda:us-east-2:266458841044:function:ACS-VerificationBoundingBox

    arn:aws:lambda:us-west-2:081040173940:function:ACS-VerificationBoundingBox

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-VerificationBoundingBox

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-VerificationBoundingBox

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-VerificationBoundingBox

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-VerificationBoundingBox

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-VerificationBoundingBox

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-VerificationBoundingBox

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-VerificationBoundingBox

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-VerificationBoundingBox

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-VerificationBoundingBox

Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:us-east-2:266458841044:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:us-west-2:081040173940:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-AdjustmentBoundingBox

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-AdjustmentBoundingBox

3D point cloud object detection adjustment - Use this task type when you want workers to adjust 3D cuboids around objects in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectDetection

    arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectDetection

    arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectDetection

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectDetection

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectDetection

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectDetection

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectDetection

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectDetection

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectDetection

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectDetection

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectDetection

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectDetection

3D point cloud object tracking adjustment - Use this task type when you want workers to adjust 3D cuboids around objects that appear in a sequence of 3D point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudObjectTracking

    arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudObjectTracking

    arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudObjectTracking

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudObjectTracking

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudObjectTracking

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudObjectTracking

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudObjectTracking

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudObjectTracking

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudObjectTracking

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudObjectTracking

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudObjectTracking

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudObjectTracking

3D point cloud semantic segmentation adjustment - Use this task type when you want workers to adjust a point-level semantic segmentation masks using a paint tool.

  • arn:aws:lambda:us-east-1:432418664414:function:ACS-Adjustment3DPointCloudSemanticSegmentation

    arn:aws:lambda:us-east-2:266458841044:function:ACS-Adjustment3DPointCloudSemanticSegmentation

    arn:aws:lambda:us-west-2:081040173940:function:ACS-Adjustment3DPointCloudSemanticSegmentation

    arn:aws:lambda:eu-west-1:568282634449:function:ACS-Adjustment3DPointCloudSemanticSegmentation

    arn:aws:lambda:ap-northeast-1:477331159723:function:ACS-Adjustment3DPointCloudSemanticSegmentation

    arn:aws:lambda:ap-southeast-2:454466003867:function:ACS-Adjustment3DPointCloudSemanticSegmentation

    arn:aws:lambda:ap-south-1:565803892007:function:ACS-Adjustment3DPointCloudSemanticSegmentation

    arn:aws:lambda:eu-central-1:203001061592:function:ACS-Adjustment3DPointCloudSemanticSegmentation

    arn:aws:lambda:ap-northeast-2:845288260483:function:ACS-Adjustment3DPointCloudSemanticSegmentation

    arn:aws:lambda:eu-west-2:487402164563:function:ACS-Adjustment3DPointCloudSemanticSegmentation

    arn:aws:lambda:ap-southeast-1:377565633583:function:ACS-Adjustment3DPointCloudSemanticSegmentation

    arn:aws:lambda:ca-central-1:918755190332:function:ACS-Adjustment3DPointCloudSemanticSegmentation

" } }, - "documentation":"

Configures how labels are consolidated across human workers.

" + "documentation":"

Configures how labels are consolidated across human workers and processes output data.

" }, "AppArn":{ "type":"string", @@ -3561,7 +3574,7 @@ }, "LabelCategoryConfigS3Uri":{ "shape":"S3Uri", - "documentation":"

The S3 URL of the file that defines the categories used to label the data objects.

The file is a JSON structure in the following format:

{

\"document-version\": \"2018-11-28\"

\"labels\": [

{

\"label\": \"label 1\"

},

{

\"label\": \"label 2\"

},

...

{

\"label\": \"label n\"

}

]

}

" + "documentation":"

The S3 URL of the file that defines the categories used to label the data objects.

For 3D point cloud task types, see Create a Labeling Category Configuration File for 3D Point Cloud Labeling Jobs.

For all other built-in task types and custom tasks, your label category configuration file must be a JSON file in the following format. Identify the labels you want to use by replacing label_1, label_2,...,label_n with your label categories.

{

\"document-version\": \"2018-11-28\"

\"labels\": [

{

\"label\": \"label_1\"

},

{

\"label\": \"label_2\"

},

...

{

\"label\": \"label_n\"

}

]

}

" }, "StoppingConditions":{ "shape":"LabelingJobStoppingConditions", @@ -4034,6 +4047,10 @@ "shape":"MaxConcurrentTransforms", "documentation":"

The maximum number of parallel requests that can be sent to each instance in a transform job. If MaxConcurrentTransforms is set to 0 or left unset, Amazon SageMaker checks the optional execution-parameters to determine the settings for your chosen algorithm. If the execution-parameters endpoint is not enabled, the default value is 1. For more information on execution-parameters, see How Containers Serve Requests. For built-in algorithms, you don't need to set a value for MaxConcurrentTransforms.

" }, + "ModelClientConfig":{ + "shape":"ModelClientConfig", + "documentation":"

Configures the timeout and maximum number of retries for processing a transform job invocation.

" + }, "MaxPayloadInMB":{ "shape":"MaxPayloadInMB", "documentation":"

The maximum allowed size of the payload, in MB. A payload is the data portion of a record (without metadata). The value in MaxPayloadInMB must be greater than, or equal to, the size of a single record. To estimate the size of a record in MB, divide the size of your dataset by the number of records. To ensure that the records fit within the maximum payload size, we recommend using a slightly larger value. The default value is 6 MB.

For cases where the payload might be arbitrarily large and is transmitted using HTTP chunked encoding, set the value to 0. This feature works only in supported algorithms. Currently, Amazon SageMaker built-in algorithms do not support HTTP chunked encoding.

" @@ -4582,6 +4599,21 @@ "members":{ } }, + "DeleteHumanTaskUiRequest":{ + "type":"structure", + "required":["HumanTaskUiName"], + "members":{ + "HumanTaskUiName":{ + "shape":"HumanTaskUiName", + "documentation":"

The name of the human task user interface (work task template) you want to delete.

" + } + } + }, + "DeleteHumanTaskUiResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteModelInput":{ "type":"structure", "required":["ModelName"], @@ -5397,7 +5429,7 @@ }, "FailureReason":{ "shape":"FailureReason", - "documentation":"

" + "documentation":"

The reason your flow definition failed.

" } } }, @@ -5407,7 +5439,7 @@ "members":{ "HumanTaskUiName":{ "shape":"HumanTaskUiName", - "documentation":"

The name of the human task user interface you want information about.

" + "documentation":"

The name of the human task user interface (worker task template) you want information about.

" } } }, @@ -5422,11 +5454,15 @@ "members":{ "HumanTaskUiArn":{ "shape":"HumanTaskUiArn", - "documentation":"

The Amazon Resource Name (ARN) of the human task user interface.

" + "documentation":"

The Amazon Resource Name (ARN) of the human task user interface (worker task template).

" }, "HumanTaskUiName":{ "shape":"HumanTaskUiName", - "documentation":"

The name of the human task user interface.

" + "documentation":"

The name of the human task user interface (worker task template).

" + }, + "HumanTaskUiStatus":{ + "shape":"HumanTaskUiStatus", + "documentation":"

The status of the human task user interface (worker task template). Valid values are listed below.

" }, "CreationTime":{ "shape":"Timestamp", @@ -5441,7 +5477,7 @@ "members":{ "HyperParameterTuningJobName":{ "shape":"HyperParameterTuningJobName", - "documentation":"

The name of the tuning job to describe.

" + "documentation":"

The name of the tuning job.

" } } }, @@ -6096,7 +6132,7 @@ }, "AutoMLJobArn":{ "shape":"AutoMLJobArn", - "documentation":"

" + "documentation":"

The Amazon Resource Name (ARN) of an AutoML job.

" }, "ModelArtifacts":{ "shape":"ModelArtifacts", @@ -6250,6 +6286,10 @@ "shape":"MaxConcurrentTransforms", "documentation":"

The maximum number of parallel requests on each instance node that can be launched in a transform job. The default value is 1.

" }, + "ModelClientConfig":{ + "shape":"ModelClientConfig", + "documentation":"

The timeout and maximum number of retries for processing a transform job invocation.

" + }, "MaxPayloadInMB":{ "shape":"MaxPayloadInMB", "documentation":"

The maximum payload size, in MB, used in the transform job.

" @@ -6292,7 +6332,7 @@ }, "AutoMLJobArn":{ "shape":"AutoMLJobArn", - "documentation":"

" + "documentation":"

The Amazon Resource Name (ARN) of the AutoML transform job.

" }, "DataProcessing":{"shape":"DataProcessing"}, "ExperimentConfig":{"shape":"ExperimentConfig"} @@ -7073,7 +7113,7 @@ }, "Operator":{ "shape":"Operator", - "documentation":"

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals

The value of Name equals Value.

NotEquals

The value of Name doesn't equal Value.

GreaterThan

The value of Name is greater than Value. Not supported for text properties.

GreaterThanOrEqualTo

The value of Name is greater than or equal to Value. Not supported for text properties.

LessThan

The value of Name is less than Value. Not supported for text properties.

LessThanOrEqualTo

The value of Name is less than or equal to Value. Not supported for text properties.

Contains

The value of Name contains the string Value. A SearchExpression can include only one Contains operator. Only supported for text properties.

Exists

The Name property exists.

NotExists

The Name property does not exist.

In

The value of Name is one of the comma delimited strings in Value. Only supported for text properties.

" + "documentation":"

A Boolean binary operator that is used to evaluate the filter. The operator field contains one of the following values:

Equals

The value of Name equals Value.

NotEquals

The value of Name doesn't equal Value.

Exists

The Name property exists.

NotExists

The Name property does not exist.

GreaterThan

The value of Name is greater than Value. Not supported for text properties.

GreaterThanOrEqualTo

The value of Name is greater than or equal to Value. Not supported for text properties.

LessThan

The value of Name is less than Value. Not supported for text properties.

LessThanOrEqualTo

The value of Name is less than or equal to Value. Not supported for text properties.

In

The value of Name is one of the comma delimited strings in Value. Only supported for text properties.

Contains

The value of Name contains the string Value. Only supported for text properties.

A SearchExpression can include the Contains operator multiple times when the value of Name is one of the following:

  • Experiment.DisplayName

  • Experiment.ExperimentName

  • Experiment.Tags

  • Trial.DisplayName

  • Trial.TrialName

  • Trial.Tags

  • TrialComponent.DisplayName

  • TrialComponent.TrialComponentName

  • TrialComponent.Tags

  • TrialComponent.InputArtifacts

  • TrialComponent.OutputArtifacts

A SearchExpression can include only one Contains operator for all other values of Name. In these cases, if you include multiple Contains operators in the SearchExpression, the result is the following error message: \"'CONTAINS' operator usage limit of 1 exceeded.\"

" }, "Value":{ "shape":"FilterValue", @@ -7438,7 +7478,7 @@ }, "PreHumanTaskLambdaArn":{ "shape":"LambdaFunctionArn", - "documentation":"

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

For the built-in bounding box, image classification, semantic segmentation, and text classification task types, Amazon SageMaker Ground Truth provides the following Lambda functions:

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationBoundingBox

Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox

Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation

Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation

" + "documentation":"

The Amazon Resource Name (ARN) of a Lambda function that is run before a data object is sent to a human worker. Use this function to provide input to a custom labeling job.

For built-in task types, use one of the following Amazon SageMaker Ground Truth Lambda function ARNs for PreHumanTaskLambdaArn. For custom labeling workflows, see Pre-annotation Lambda.

Bounding box - Finds the most similar boxes from different workers based on the Jaccard index of the boxes.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-BoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-BoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-BoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-BoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-BoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-BoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-BoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-BoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-BoundingBox

Image classification - Uses a variant of the Expectation Maximization approach to estimate the true class of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClass

Multi-label image classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of an image based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-ImageMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-ImageMultiClassMultiLabel

Semantic segmentation - Treats each pixel in an image as a multi-class classification and treats pixel annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-SemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-SemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-SemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-SemanticSegmentation

Text classification - Uses a variant of the Expectation Maximization approach to estimate the true class of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClass

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClass

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClass

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClass

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClass

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClass

Multi-label text classification - Uses a variant of the Expectation Maximization approach to estimate the true classes of text based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-TextMultiClassMultiLabel

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-TextMultiClassMultiLabel

Named entity recognition - Groups similar selections and calculates aggregate boundaries, resolving to most-assigned label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-NamedEntityRecognition

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-NamedEntityRecognition

3D Point Cloud Modalities

Use the following pre-annotation lambdas for 3D point cloud labeling modality tasks. See 3D Point Cloud Task types to learn more.

3D Point Cloud Object Detection - Use this task type when you want workers to classify objects in a 3D point cloud by drawing 3D cuboids around objects. For example, you can use this task type to ask workers to identify different types of objects in a point cloud, such as cars, bikes, and pedestrians.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectDetection

3D Point Cloud Object Tracking - Use this task type when you want workers to draw 3D cuboids around objects that appear in a sequence of 3D point cloud frames. For example, you can use this task type to ask workers to track the movement of vehicles across multiple point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudObjectTracking

3D Point Cloud Semantic Segmentation - Use this task type when you want workers to create a point-level semantic segmentation masks by painting objects in a 3D point cloud using different colors where each color is assigned to one of the classes you specify.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-3DPointCloudSemanticSegmentation

Use the following ARNs for Label Verification and Adjustment Jobs

Use label verification and adjustment jobs to review and adjust labels. To learn more, see Verify and Adjust Labels .

Bounding box verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgement for bounding box labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking

Bounding box adjustment - Finds the most similar boxes from different workers based on the Jaccard index of the adjusted annotations.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentBoundingBox

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentBoundingBox

Semantic segmentation verification - Uses a variant of the Expectation Maximization approach to estimate the true class of verification judgment for semantic segmentation labels based on annotations from individual workers.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-VerificationSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-VerificationSemanticSegmentation

Semantic segmentation adjustment - Treats each pixel in an image as a multi-class classification and treats pixel adjusted annotations from workers as \"votes\" for the correct label.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-AdjustmentSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-AdjustmentSemanticSegmentation

3D point cloud object detection adjustment - Adjust 3D cuboids in a point cloud frame.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectDetection

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectDetection

3D point cloud object tracking adjustment - Adjust 3D cuboids across a sequence of point cloud frames.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudObjectTracking

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudObjectTracking

3D point cloud semantic segmentation adjustment - Adjust semantic segmentation masks in a 3D point cloud.

  • arn:aws:lambda:us-east-1:432418664414:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-east-2:266458841044:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:us-west-2:081040173940:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-1:568282634449:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-1:477331159723:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-2:454466003867:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-south-1:565803892007:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-central-1:203001061592:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-northeast-2:845288260483:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:eu-west-2:487402164563:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ap-southeast-1:377565633583:function:PRE-Adjustment3DPointCloudSemanticSegmentation

  • arn:aws:lambda:ca-central-1:918755190332:function:PRE-Adjustment3DPointCloudSemanticSegmentation

" }, "TaskKeywords":{ "shape":"TaskKeywords", @@ -7490,6 +7530,13 @@ "min":1, "pattern":"^[a-z0-9](-*[a-z0-9])*" }, + "HumanTaskUiStatus":{ + "type":"string", + "enum":[ + "Active", + "Deleting" + ] + }, "HumanTaskUiSummaries":{ "type":"list", "member":{"shape":"HumanTaskUiSummary"} @@ -8101,6 +8148,16 @@ "max":20, "min":0 }, + "InvocationsMaxRetries":{ + "type":"integer", + "max":3, + "min":0 + }, + "InvocationsTimeoutInSeconds":{ + "type":"integer", + "max":3600, + "min":1 + }, "JobReferenceCode":{ "type":"string", "min":1, @@ -10211,6 +10268,20 @@ }, "documentation":"

Provides information about the location that is configured for storing model artifacts.

Model artifacts are the output that results from training a model, and typically consist of trained parameters, a model defintion that desribes how to compute inferences, and other metadata.

" }, + "ModelClientConfig":{ + "type":"structure", + "members":{ + "InvocationsTimeoutInSeconds":{ + "shape":"InvocationsTimeoutInSeconds", + "documentation":"

The timeout value in seconds for an invocation request.

" + }, + "InvocationsMaxRetries":{ + "shape":"InvocationsMaxRetries", + "documentation":"

The maximum number of retries when invocation requests are failing.

" + } + }, + "documentation":"

Configures the timeout and maximum number of retries for processing a transform job invocation.

" + }, "ModelName":{ "type":"string", "max":63, @@ -11963,7 +12034,7 @@ }, "HumanTaskUiArn":{ "shape":"HumanTaskUiArn", - "documentation":"

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

" + "documentation":"

The HumanTaskUiArn of the worker UI that you want to render. Do not provide a HumanTaskUiArn if you use the UiTemplate parameter.

See a list of available Human Ui Amazon Resource Names (ARNs) in UiConfig.

" } } }, @@ -12219,7 +12290,7 @@ }, "S3Uri":{ "shape":"S3Uri", - "documentation":"

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix.

  • A manifest might look like this: s3://bucketname/example.manifest

    The manifest is an S3 object which is a JSON file with the following format:

    The preceding JSON matches the following s3Uris:

    [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},

    \"relative/path/to/custdata-1\",

    \"relative/path/custdata-2\",

    ...

    \"relative/path/custdata-N\"

    ]

    The preceding JSON matches the following s3Uris:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

    s3://customer_bucket/some/prefix/relative/path/custdata-2

    ...

    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of s3uris in this manifest is the input data for the channel for this datasource. The object that each s3uris points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

" + "documentation":"

Depending on the value specified for the S3DataType, identifies either a key name prefix or a manifest. For example:

  • A key name prefix might look like this: s3://bucketname/exampleprefix

  • A manifest might look like this: s3://bucketname/example.manifest

    A manifest is an S3 object which is a JSON file consisting of an array of elements. The first element is a prefix which is followed by one or more suffixes. SageMaker appends the suffix elements to the prefix to get a full set of S3Uri. Note that the prefix must be a valid non-empty S3Uri that precludes users from specifying a manifest whose individual S3Uri is sourced from different S3 buckets.

    The following code example shows a valid manifest format:

    [ {\"prefix\": \"s3://customer_bucket/some/prefix/\"},

    \"relative/path/to/custdata-1\",

    \"relative/path/custdata-2\",

    ...

    \"relative/path/custdata-N\"

    ]

    This JSON is equivalent to the following S3Uri list:

    s3://customer_bucket/some/prefix/relative/path/to/custdata-1

    s3://customer_bucket/some/prefix/relative/path/custdata-2

    ...

    s3://customer_bucket/some/prefix/relative/path/custdata-N

    The complete set of S3Uri in this manifest is the input data for the channel for this data source. The object that each S3Uri points to must be readable by the IAM role that Amazon SageMaker uses to perform tasks on your behalf.

" }, "S3DataDistributionType":{ "shape":"S3DataDistribution", @@ -12300,7 +12371,7 @@ "documentation":"

A Boolean operator used to evaluate the search expression. If you want every conditional statement in all lists to be satisfied for the entire search expression to be true, specify And. If only a single conditional statement needs to be true for the entire search expression to be true, specify Or. The default value is And.

" } }, - "documentation":"

A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.

A SearchExpression contains the following components:

  • A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value. A SearchExpression can include only one Contains operator.

  • A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.

  • A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.

  • A Boolean operator: And or Or.

" + "documentation":"

A multi-expression that searches for the specified resource or resources in a search. All resource objects that satisfy the expression's condition are included in the search results. You must specify at least one subexpression, filter, or nested filter. A SearchExpression can contain up to twenty elements.

A SearchExpression contains the following components:

  • A list of Filter objects. Each filter defines a simple Boolean expression comprised of a resource property name, Boolean operator, and value.

  • A list of NestedFilter objects. Each nested filter defines a list of Boolean expressions using a list of resource properties. A nested filter is satisfied if a single object in the list satisfies all Boolean expressions.

  • A list of SearchExpression objects. A search expression object can be nested in a list of search expression objects.

  • A Boolean operator: And or Or.

" }, "SearchExpressionList":{ "type":"list", @@ -12563,7 +12634,7 @@ "members":{ "Cidrs":{ "shape":"Cidrs", - "documentation":"

A list of one to four Classless Inter-Domain Routing (CIDR) values.

Maximum: Four CIDR values

The following Length Constraints apply to individual CIDR values in the CIDR value list.

" + "documentation":"

A list of one to ten Classless Inter-Domain Routing (CIDR) values.

Maximum: Ten CIDR values

The following Length Constraints apply to individual CIDR values in the CIDR value list.

" } }, "documentation":"

A list of IP address ranges (CIDRs). Used to create an allow list of IP addresses for a private workforce. For more information, see .

" @@ -12764,7 +12835,7 @@ }, "ListingId":{ "shape":"String", - "documentation":"

" + "documentation":"

Marketplace product listing ID.

" } }, "documentation":"

Describes a work team of a vendor that does the a labelling job.

" @@ -14043,7 +14114,7 @@ }, "HumanTaskUiArn":{ "shape":"HumanTaskUiArn", - "documentation":"

The ARN of the worker task template used to render the worker UI and tools for labeling job tasks. Do not use this parameter if you use UiTemplateS3Uri.

" + "documentation":"

The ARN of the worker task template used to render the worker UI and tools for labeling job tasks.

Use this parameter when you are creating a labeling job for 3D point cloud labeling modalities. Use your labeling job task type to select one of the following ARN's and use it with this parameter when you create a labeling job. Replace aws-region with the AWS region you are creating your labeling job in.

Use this HumanTaskUiArn for 3D point cloud object detection and 3D point cloud object detection adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectDetection

Use this HumanTaskUiArn for 3D point cloud object tracking and 3D point cloud object tracking adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudObjectTracking

Use this HumanTaskUiArn for 3D point cloud semantic segmentation and 3D point cloud semantic segmentation adjustment labeling jobs.

  • arn:aws:sagemaker:aws-region:394669845002:human-task-ui/PointCloudSemanticSegmentation

" } }, "documentation":"

Provided configuration information for the worker UI for a labeling job.

" @@ -14444,7 +14515,7 @@ }, "SourceIpConfig":{ "shape":"SourceIpConfig", - "documentation":"

A list of one to four worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.

Maximum: Four CIDR values

" + "documentation":"

A list of one to ten worker IP address ranges (CIDRs) that can be used to access tasks assigned to this workforce.

Maximum: Ten CIDR values

" } } }, @@ -14687,7 +14758,7 @@ }, "SourceIpConfig":{ "shape":"SourceIpConfig", - "documentation":"

A list of one to four IP address ranges (CIDRs) to be added to the workforce allow list.

" + "documentation":"

A list of one to ten IP address ranges (CIDRs) to be added to the workforce allow list.

" } }, "documentation":"

A single private workforce, which is automatically created when you create your first private work team. You can create one private work force in each AWS Region. By default, any workforce-related API operation used in a specific region will apply to the workforce created in that region. To learn how to create a private workforce, see Create a Private Workforce.

" diff --git a/botocore/data/secretsmanager/2017-10-17/service-2.json b/botocore/data/secretsmanager/2017-10-17/service-2.json index b39a8876..62311e41 100644 --- a/botocore/data/secretsmanager/2017-10-17/service-2.json +++ b/botocore/data/secretsmanager/2017-10-17/service-2.json @@ -27,7 +27,7 @@ {"shape":"InternalServiceError"}, {"shape":"InvalidRequestException"} ], - "documentation":"

Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress.

To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. This will immediately rotate your secret and then enable the automatic schedule.

If you cancel a rotation that is in progress, it can leave the VersionStage labels in an unexpected state. Depending on what step of the rotation was in progress, you might need to remove the staging label AWSPENDING from the partially created version, specified by the VersionId response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version's VersionStage field.

To successfully start a rotation, the staging label AWSPENDING must be in one of the following states:

  • Not be attached to any version at all

  • Attached to the same version as the staging label AWSCURRENT

If the staging label AWSPENDING is attached to a different version than the version with AWSCURRENT then the attempt to rotate fails.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:CancelRotateSecret

Related operations

  • To configure rotation for a secret or to manually trigger a rotation, use RotateSecret.

  • To get the rotation configuration details for a secret, use DescribeSecret.

  • To list all of the currently available secrets, use ListSecrets.

  • To list all of the versions currently associated with a secret, use ListSecretVersionIds.

" + "documentation":"

Disables automatic scheduled rotation and cancels the rotation of a secret if currently in progress.

To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. This immediately rotates your secret and then enables the automatic schedule.

If you cancel a rotation while in progress, it can leave the VersionStage labels in an unexpected state. Depending on the step of the rotation in progress, you might need to remove the staging label AWSPENDING from the partially created version, specified by the VersionId response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version VersionStage field.

To successfully start a rotation, the staging label AWSPENDING must be in one of the following states:

  • Not attached to any version at all

  • Attached to the same version as the staging label AWSCURRENT

If the staging label AWSPENDING attached to a different version than the version with AWSCURRENT then the attempt to rotate fails.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:CancelRotateSecret

Related operations

  • To configure rotation for a secret or to manually trigger a rotation, use RotateSecret.

  • To get the rotation configuration details for a secret, use DescribeSecret.

  • To list all of the currently available secrets, use ListSecrets.

  • To list all of the versions currently associated with a secret, use ListSecretVersionIds.

" }, "CreateSecret":{ "name":"CreateSecret", @@ -48,7 +48,7 @@ {"shape":"InternalServiceError"}, {"shape":"PreconditionNotMetException"} ], - "documentation":"

Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.

Secrets Manager stores the encrypted secret data in one of a collection of \"versions\" associated with the secret. Each version contains a copy of the encrypted secret data. Each version is associated with one or more \"staging labels\" that identify where the version is in the rotation cycle. The SecretVersionsToStages field of the secret contains the mapping of staging labels to the active versions of the secret. Versions without a staging label are considered deprecated and are not included in the list.

You provide the secret data to be encrypted by putting text in either the SecretString parameter or binary data in the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager also creates an initial secret version and automatically attaches the staging label AWSCURRENT to the new version.

  • If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.

  • If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:CreateSecret

  • kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

  • kms:Decrypt - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

  • secretsmanager:TagResource - needed only if you include the Tags parameter.

Related operations

  • To delete a secret, use DeleteSecret.

  • To modify an existing secret, use UpdateSecret.

  • To create a new version of a secret, use PutSecretValue.

  • To retrieve the encrypted secure string and secure binary values, use GetSecretValue.

  • To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure string and secure binary values.

  • To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine the SecretVersionsToStages response value.

" + "documentation":"

Creates a new secret. A secret in Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.

Secrets Manager stores the encrypted secret data in one of a collection of \"versions\" associated with the secret. Each version contains a copy of the encrypted secret data. Each version is associated with one or more \"staging labels\" that identify where the version is in the rotation cycle. The SecretVersionsToStages field of the secret contains the mapping of staging labels to the active versions of the secret. Versions without a staging label are considered deprecated and not included in the list.

You provide the secret data to be encrypted by putting text in either the SecretString parameter or binary data in the SecretBinary parameter, but not both. If you include SecretString or SecretBinary then Secrets Manager also creates an initial secret version and automatically attaches the staging label AWSCURRENT to the new version.

  • If you call an operation to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS creating the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.

  • If the secret resides in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:CreateSecret

  • kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account default AWS managed CMK for Secrets Manager.

  • kms:Decrypt - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account default AWS managed CMK for Secrets Manager.

  • secretsmanager:TagResource - needed only if you include the Tags parameter.

Related operations

  • To delete a secret, use DeleteSecret.

  • To modify an existing secret, use UpdateSecret.

  • To create a new version of a secret, use PutSecretValue.

  • To retrieve the encrypted secure string and secure binary values, use GetSecretValue.

  • To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure string and secure binary values.

  • To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine the SecretVersionsToStages response value.

" }, "DeleteResourcePolicy":{ "name":"DeleteResourcePolicy", @@ -63,7 +63,7 @@ {"shape":"InternalServiceError"}, {"shape":"InvalidRequestException"} ], - "documentation":"

Deletes the resource-based permission policy that's attached to the secret.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:DeleteResourcePolicy

Related operations

  • To attach a resource policy to a secret, use PutResourcePolicy.

  • To retrieve the current resource-based policy that's attached to a secret, use GetResourcePolicy.

  • To list all of the currently available secrets, use ListSecrets.

" + "documentation":"

Deletes the resource-based permission policy attached to the secret.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:DeleteResourcePolicy

Related operations

  • To attach a resource policy to a secret, use PutResourcePolicy.

  • To retrieve the current resource-based policy that's attached to a secret, use GetResourcePolicy.

  • To list all of the currently available secrets, use ListSecrets.

" }, "DeleteSecret":{ "name":"DeleteSecret", @@ -93,7 +93,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceError"} ], - "documentation":"

Retrieves the details of a secret. It does not include the encrypted fields. Only those fields that are populated with a value are returned in the response.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:DescribeSecret

Related operations

" + "documentation":"

Retrieves the details of a secret. It does not include the encrypted fields. Secrets Manager only returns fields populated with a value in the response.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:DescribeSecret

Related operations

" }, "GetRandomPassword":{ "name":"GetRandomPassword", @@ -123,7 +123,7 @@ {"shape":"InternalServiceError"}, {"shape":"InvalidRequestException"} ], - "documentation":"

Retrieves the JSON text of the resource-based policy document that's attached to the specified secret. The JSON request string input and response output are shown formatted with white space and line breaks for better readability. Submit your input as a single line JSON string.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:GetResourcePolicy

Related operations

" + "documentation":"

Retrieves the JSON text of the resource-based policy document attached to the specified secret. The JSON request string input and response output displays formatted code with white space and line breaks for better readability. Submit your input as a single line JSON string.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:GetResourcePolicy

Related operations

" }, "GetSecretValue":{ "name":"GetSecretValue", @@ -155,7 +155,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceError"} ], - "documentation":"

Lists all of the versions attached to the specified secret. The output does not include the SecretString or SecretBinary fields. By default, the list includes only versions that have at least one staging label in VersionStage attached.

Always check the NextToken response parameter when calling any of the List* operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the NextToken response parameter contains a value to pass to the next call to the same API to request the next part of the list.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:ListSecretVersionIds

Related operations

" + "documentation":"

Lists all of the versions attached to the specified secret. The output does not include the SecretString or SecretBinary fields. By default, the list includes only versions that have at least one staging label in VersionStage attached.

Always check the NextToken response parameter when calling any of the List* operations. These operations can occasionally return an empty or shorter than expected list of results even when there more results become available. When this happens, the NextToken response parameter contains a value to pass to the next call to the same API to request the next part of the list.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:ListSecretVersionIds

Related operations

" }, "ListSecrets":{ "name":"ListSecrets", @@ -170,7 +170,7 @@ {"shape":"InvalidNextTokenException"}, {"shape":"InternalServiceError"} ], - "documentation":"

Lists all of the secrets that are stored by Secrets Manager in the AWS account. To list the versions currently stored for a specific secret, use ListSecretVersionIds. The encrypted fields SecretString and SecretBinary are not included in the output. To get that information, call the GetSecretValue operation.

Always check the NextToken response parameter when calling any of the List* operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the NextToken response parameter contains a value to pass to the next call to the same API to request the next part of the list.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:ListSecrets

Related operations

" + "documentation":"

Lists all of the secrets that are stored by Secrets Manager in the AWS account. To list the versions currently stored for a specific secret, use ListSecretVersionIds. The encrypted fields SecretString and SecretBinary are not included in the output. To get that information, call the GetSecretValue operation.

Always check the NextToken response parameter when calling any of the List* operations. These operations can occasionally return an empty or shorter than expected list of results even when there more results become available. When this happens, the NextToken response parameter contains a value to pass to the next call to the same API to request the next part of the list.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:ListSecrets

Related operations

" }, "PutResourcePolicy":{ "name":"PutResourcePolicy", @@ -185,9 +185,10 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InvalidParameterException"}, {"shape":"InternalServiceError"}, - {"shape":"InvalidRequestException"} + {"shape":"InvalidRequestException"}, + {"shape":"PublicPolicyException"} ], - "documentation":"

Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN) in the policy statement's Resources element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all of the relevant policies. For more information, see Using Resource-Based Policies for AWS Secrets Manager. For the complete description of the AWS policy syntax and grammar, see IAM JSON Policy Reference in the IAM User Guide.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:PutResourcePolicy

Related operations

  • To retrieve the resource policy that's attached to a secret, use GetResourcePolicy.

  • To delete the resource-based policy that's attached to a secret, use DeleteResourcePolicy.

  • To list all of the currently available secrets, use ListSecrets.

" + "documentation":"

Attaches the contents of the specified resource-based permission policy to a secret. A resource-based policy is optional. Alternatively, you can use IAM identity-based policies that specify the secret's Amazon Resource Name (ARN) in the policy statement's Resources element. You can also use a combination of both identity-based and resource-based policies. The affected users and roles receive the permissions that are permitted by all of the relevant policies. For more information, see Using Resource-Based Policies for AWS Secrets Manager. For the complete description of the AWS policy syntax and grammar, see IAM JSON Policy Reference in the IAM User Guide.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:PutResourcePolicy

Related operations

" }, "PutSecretValue":{ "name":"PutSecretValue", @@ -206,7 +207,7 @@ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServiceError"} ], - "documentation":"

Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value. You can also specify the staging labels that are initially attached to the new version.

The Secrets Manager console uses only the SecretString field. To add binary data to a secret with the SecretBinary field you must use the AWS CLI or one of the AWS SDKs.

  • If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label AWSCURRENT to the new version.

  • If another version of this secret already exists, then this operation does not automatically move any staging labels other than those that you explicitly specify in the VersionStages parameter.

  • If this operation moves the staging label AWSCURRENT from another version to this version (because you included it in the StagingLabels parameter) then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

  • This operation is idempotent. If a version with a VersionId with the same value as the ClientRequestToken parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones.

  • If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.

  • If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:PutSecretValue

  • kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

Related operations

" + "documentation":"

Stores a new encrypted secret value in the specified secret. To do this, the operation creates a new version and attaches it to the secret. The version can contain a new SecretString value or a new SecretBinary value. You can also specify the staging labels that are initially attached to the new version.

The Secrets Manager console uses only the SecretString field. To add binary data to a secret with the SecretBinary field you must use the AWS CLI or one of the AWS SDKs.

  • If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label AWSCURRENT to the new version.

  • If another version of this secret already exists, then this operation does not automatically move any staging labels other than those that you explicitly specify in the VersionStages parameter.

  • If this operation moves the staging label AWSCURRENT from another version to this version (because you included it in the StagingLabels parameter) then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.

  • This operation is idempotent. If a version with a VersionId with the same value as the ClientRequestToken parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones.

  • If you call an operation to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS creating the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.

  • If the secret resides in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:PutSecretValue

  • kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.

Related operations

" }, "RestoreSecret":{ "name":"RestoreSecret", @@ -238,7 +239,7 @@ {"shape":"InternalServiceError"}, {"shape":"InvalidRequestException"} ], - "documentation":"

Configures and starts the asynchronous process of rotating this secret. If you include the configuration parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not include the configuration parameters, the operation starts a rotation with the values already stored in the secret. After the rotation completes, the protected service and its clients all use the new version of the secret.

This required configuration information includes the ARN of an AWS Lambda function and the time between scheduled rotations. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the protected service to match. After testing the new credentials, the function marks the new secret with the staging label AWSCURRENT so that your clients all immediately begin to use the new version. For more information about rotating secrets and how to configure a Lambda function to rotate the secrets for your protected service, see Rotating Secrets in AWS Secrets Manager in the AWS Secrets Manager User Guide.

Secrets Manager schedules the next rotation when the previous one is complete. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.

The rotation function must end with the versions of the secret in one of two states:

  • The AWSPENDING and AWSCURRENT staging labels are attached to the same version of the secret, or

  • The AWSPENDING staging label is not attached to any version of the secret.

If instead the AWSPENDING staging label is present but is not attached to the same version as AWSCURRENT then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:RotateSecret

  • lambda:InvokeFunction (on the function specified in the secret's metadata)

Related operations

" + "documentation":"

Configures and starts the asynchronous process of rotating this secret. If you include the configuration parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not include the configuration parameters, the operation starts a rotation with the values already stored in the secret. After the rotation completes, the protected service and its clients all use the new version of the secret.

This required configuration information includes the ARN of an AWS Lambda function and the time between scheduled rotations. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the protected service to match. After testing the new credentials, the function marks the new secret with the staging label AWSCURRENT so that your clients all immediately begin to use the new version. For more information about rotating secrets and how to configure a Lambda function to rotate the secrets for your protected service, see Rotating Secrets in AWS Secrets Manager in the AWS Secrets Manager User Guide.

Secrets Manager schedules the next rotation when the previous one completes. Secrets Manager schedules the date by adding the rotation interval (number of days) to the actual date of the last rotation. The service chooses the hour within that 24-hour date window randomly. The minute is also chosen somewhat randomly, but weighted towards the top of the hour and influenced by a variety of factors that help distribute load.

The rotation function must end with the versions of the secret in one of two states:

  • The AWSPENDING and AWSCURRENT staging labels are attached to the same version of the secret, or

  • The AWSPENDING staging label is not attached to any version of the secret.

If the AWSPENDING staging label is present but not attached to the same version as AWSCURRENT then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:RotateSecret

  • lambda:InvokeFunction (on the function specified in the secret's metadata)

Related operations

" }, "TagResource":{ "name":"TagResource", @@ -253,7 +254,7 @@ {"shape":"InvalidParameterException"}, {"shape":"InternalServiceError"} ], - "documentation":"

Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

The following basic restrictions apply to tags:

  • Maximum number of tags per secret—50

  • Maximum key length—127 Unicode characters in UTF-8

  • Maximum value length—255 Unicode characters in UTF-8

  • Tag keys and values are case sensitive.

  • Do not use the aws: prefix in your tag names or values because it is reserved for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.

  • If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:TagResource

Related operations

  • To remove one or more tags from the collection attached to a secret, use UntagResource.

  • To view the list of tags attached to a secret, use DescribeSecret.

" + "documentation":"

Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

The following basic restrictions apply to tags:

  • Maximum number of tags per secret—50

  • Maximum key length—127 Unicode characters in UTF-8

  • Maximum value length—255 Unicode characters in UTF-8

  • Tag keys and values are case sensitive.

  • Do not use the aws: prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.

  • If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied error.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:TagResource

Related operations

  • To remove one or more tags from the collection attached to a secret, use UntagResource.

  • To view the list of tags attached to a secret, use DescribeSecret.

" }, "UntagResource":{ "name":"UntagResource", @@ -289,7 +290,7 @@ {"shape":"InternalServiceError"}, {"shape":"PreconditionNotMetException"} ], - "documentation":"

Modifies many of the details of the specified secret. If you include a ClientRequestToken and either SecretString or SecretBinary then it also creates a new version attached to the secret.

To modify the rotation configuration of a secret, use RotateSecret instead.

The Secrets Manager console uses only the SecretString parameter and therefore limits you to encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret, you must use either the AWS CLI or one of the AWS SDKs.

  • If a version with a VersionId with the same value as the ClientRequestToken parameter already exists, the operation results in an error. You cannot modify an existing version, you can only create a new version.

  • If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new version.

  • If you call an operation that needs to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.

  • If the secret is in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:UpdateSecret

  • kms:GenerateDataKey - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.

  • kms:Decrypt - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.

Related operations

" + "documentation":"

Modifies many of the details of the specified secret. If you include a ClientRequestToken and either SecretString or SecretBinary then it also creates a new version attached to the secret.

To modify the rotation configuration of a secret, use RotateSecret instead.

The Secrets Manager console uses only the SecretString parameter and therefore limits you to encrypting and storing only a text string. To encrypt and store binary data as part of the version of a secret, you must use either the AWS CLI or one of the AWS SDKs.

  • If a version with a VersionId with the same value as the ClientRequestToken parameter already exists, the operation results in an error. You cannot modify an existing version, you can only create a new version.

  • If you include SecretString or SecretBinary to create a new secret version, Secrets Manager automatically attaches the staging label AWSCURRENT to the new version.

  • If you call an operation to encrypt or decrypt the SecretString or SecretBinary for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias aws/secretsmanager. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS creating the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result.

  • If the secret resides in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the KMSKeyId. If you call an API that must encrypt or decrypt SecretString or SecretBinary using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:UpdateSecret

  • kms:GenerateDataKey - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.

  • kms:Decrypt - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.

Related operations

" }, "UpdateSecretVersionStage":{ "name":"UpdateSecretVersionStage", @@ -307,6 +308,23 @@ {"shape":"InternalServiceError"} ], "documentation":"

Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it progresses through the secret rotation process. You can attach a staging label to only one version of a secret at a time. If a staging label to be added is already attached to another version, then it is moved--removed from the other version first and then attached to this one. For more information about staging labels, see Staging Labels in the AWS Secrets Manager User Guide.

The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels--they don't replace it.

You can move the AWSCURRENT staging label to this version by including it in this call.

Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from.

If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.

Minimum permissions

To run this command, you must have the following permissions:

  • secretsmanager:UpdateSecretVersionStage

Related operations

  • To get the list of staging labels that are currently associated with a version of a secret, use DescribeSecret and examine the SecretVersionsToStages response value.

" + }, + "ValidateResourcePolicy":{ + "name":"ValidateResourcePolicy", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ValidateResourcePolicyRequest"}, + "output":{"shape":"ValidateResourcePolicyResponse"}, + "errors":[ + {"shape":"MalformedPolicyDocumentException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidParameterException"}, + {"shape":"InternalServiceError"}, + {"shape":"InvalidRequestException"} + ], + "documentation":"

Validates the JSON text of the resource-based policy document attached to the specified secret. The JSON request string input and response output displays formatted code with white space and line breaks for better readability. Submit your input as a single line JSON string. A resource-based policy is optional.

" } }, "shapes":{ @@ -322,7 +340,7 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"

Specifies the secret for which you want to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

" + "documentation":"

Specifies the secret to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" } } }, @@ -339,7 +357,7 @@ }, "VersionId":{ "shape":"SecretVersionIdType", - "documentation":"

The unique identifier of the version of the secret that was created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage value AWSPENDING to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.

" + "documentation":"

The unique identifier of the version of the secret created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage value AWSPENDING to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.

" } } }, @@ -354,11 +372,11 @@ "members":{ "Name":{ "shape":"NameType", - "documentation":"

Specifies the friendly name of the new secret.

The secret name must be ASCII letters, digits, or the following characters : /_+=.@-

Don't end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. This is because Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.

" + "documentation":"

Specifies the friendly name of the new secret.

The secret name must be ASCII letters, digits, or the following characters : /_+=.@-

Do not end your secret name with a hyphen followed by six characters. If you do so, you risk confusion and unexpected results when searching for a secret by partial ARN. Secrets Manager automatically adds a hyphen and six random characters at the end of the ARN.

" }, "ClientRequestToken":{ "shape":"ClientRequestTokenType", - "documentation":"

(Optional) If you include SecretString or SecretBinary, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.

If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for the new version and include that value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.

  • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

  • If a version with this value already exists and that version's SecretString and SecretBinary values are the same as those in the request, then the request is ignored (the operation is idempotent).

  • If a version with this value already exists and that version's SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.

This value becomes the VersionId of the new version.

", + "documentation":"

(Optional) If you include SecretString or SecretBinary, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.

If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for the new version and include the value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.

  • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

  • If a version with this value already exists and the version SecretString and SecretBinary values are the same as those in the request, then the request is ignored.

  • If a version with this value already exists and that version's SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.

This value becomes the VersionId of the new version.

", "idempotencyToken":true }, "Description":{ @@ -367,7 +385,7 @@ }, "KmsKeyId":{ "shape":"KmsKeyIdType", - "documentation":"

(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret.

You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.

If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields.

You can use the account's default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and specify the ARN in this field.

" + "documentation":"

(Optional) Specifies the ARN, Key ID, or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString or SecretBinary values in the versions stored in this secret.

You can specify any of the supported ways to identify a AWS KMS key ID. If you need to reference a CMK in a different account, you can use only the key ARN or the alias ARN.

If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager). If a AWS KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields.

You can use the account default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret resides in a different account, then you must create a custom CMK and specify the ARN in this field.

" }, "SecretBinary":{ "shape":"SecretBinaryType", @@ -375,11 +393,11 @@ }, "SecretString":{ "shape":"SecretStringType", - "documentation":"

(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

[{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}]

If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.

" + "documentation":"

(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.

Either SecretString or SecretBinary must have a value, but not both. They cannot both be empty.

If you create a secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the SecretString parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.

For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

{\"username\":\"bob\",\"password\":\"abc123xyz456\"}

If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.

" }, "Tags":{ "shape":"TagListType", - "documentation":"

(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

  • Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".

  • If you check tags in IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error.

This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]

If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.

The following basic restrictions apply to tags:

  • Maximum number of tags per secret—50

  • Maximum key length—127 Unicode characters in UTF-8

  • Maximum value length—255 Unicode characters in UTF-8

  • Tag keys and values are case sensitive.

  • Do not use the aws: prefix in your tag names or values because it is reserved for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.

  • If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

" + "documentation":"

(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a \"Key\" and \"Value\" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.

  • Secrets Manager tag key names are case sensitive. A tag with the key \"ABC\" is a different tag from one with key \"abc\".

  • If you check tags in IAM policy Condition elements as part of your security strategy, then adding or removing a tag can change permissions. If the successful completion of this operation would result in you losing your permissions for this secret, then this operation is blocked and returns an Access Denied error.

This parameter requires a JSON text string argument. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide. For example:

[{\"Key\":\"CostCenter\",\"Value\":\"12345\"},{\"Key\":\"environment\",\"Value\":\"production\"}]

If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.

The following basic restrictions apply to tags:

  • Maximum number of tags per secret—50

  • Maximum key length—127 Unicode characters in UTF-8

  • Maximum value length—255 Unicode characters in UTF-8

  • Tag keys and values are case sensitive.

  • Do not use the aws: prefix in your tag names or values because AWS reserves it for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.

  • If you use your tagging schema across multiple services and resources, remember other services might have restrictions on allowed characters. Generally allowed characters: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.

" } } }, @@ -396,7 +414,7 @@ }, "VersionId":{ "shape":"SecretVersionIdType", - "documentation":"

The unique identifier that's associated with the version of the secret you just created.

" + "documentation":"

The unique identifier associated with the version of the secret you just created.

" } } }, @@ -415,7 +433,7 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"

Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

" + "documentation":"

Specifies the secret that you want to delete the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" } } }, @@ -438,7 +456,7 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"

Specifies the secret that you want to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

" + "documentation":"

Specifies the secret that you want to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" }, "RecoveryWindowInDays":{ "shape":"RecoveryWindowInDaysType", @@ -478,7 +496,7 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"

The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

" + "documentation":"

The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" } } }, @@ -545,6 +563,11 @@ "OwningService":{ "shape":"OwningServiceType", "documentation":"

Returns the name of the service that created this secret.

" + }, + "CreatedDate":{ + "shape":"TimestampType", + "documentation":"

The date that the secret was created.

", + "box":true } } }, @@ -570,6 +593,47 @@ "ExcludeNumbersType":{"type":"boolean"}, "ExcludePunctuationType":{"type":"boolean"}, "ExcludeUppercaseType":{"type":"boolean"}, + "Filter":{ + "type":"structure", + "members":{ + "Key":{ + "shape":"FilterNameStringType", + "documentation":"

Filters your list of secrets by a specific key.

" + }, + "Values":{ + "shape":"FilterValuesStringList", + "documentation":"

Filters your list of secrets by a specific value.

" + } + }, + "documentation":"

Allows you to filter your list of secrets.

" + }, + "FilterNameStringType":{ + "type":"string", + "enum":[ + "description", + "name", + "tag-key", + "tag-value", + "all" + ] + }, + "FilterValueStringType":{ + "type":"string", + "max":512, + "min":1, + "pattern":"[a-zA-Z0-9 :_@\\/\\+\\=\\.\\-]+" + }, + "FilterValuesStringList":{ + "type":"list", + "member":{"shape":"FilterValueStringType"}, + "max":10, + "min":1 + }, + "FiltersListType":{ + "type":"list", + "member":{"shape":"Filter"}, + "max":10 + }, "GetRandomPasswordRequest":{ "type":"structure", "members":{ @@ -629,7 +693,7 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"

Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

" + "documentation":"

Specifies the secret that you want to retrieve the attached resource-based policy for. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" } } }, @@ -656,7 +720,7 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"

Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

" + "documentation":"

Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" }, "VersionId":{ "shape":"SecretVersionIdType", @@ -758,16 +822,16 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"

The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

" + "documentation":"

The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" }, "MaxResults":{ "shape":"MaxResultsType", - "documentation":"

(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

", + "documentation":"

(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

", "box":true }, "NextToken":{ "shape":"NextTokenType", - "documentation":"

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + "documentation":"

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

" }, "IncludeDeprecated":{ "shape":"BooleanType", @@ -785,7 +849,7 @@ }, "NextToken":{ "shape":"NextTokenType", - "documentation":"

If present in the response, this value indicates that there's more output available than what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

" + "documentation":"

If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

" }, "ARN":{ "shape":"SecretARNType", @@ -802,12 +866,20 @@ "members":{ "MaxResults":{ "shape":"MaxResultsType", - "documentation":"

(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

", + "documentation":"

(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

", "box":true }, "NextToken":{ "shape":"NextTokenType", - "documentation":"

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.

" + "documentation":"

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

" + }, + "Filters":{ + "shape":"FiltersListType", + "documentation":"

Lists the secret request filters.

" + }, + "SortOrder":{ + "shape":"SortOrderType", + "documentation":"

Lists secrets in the requested order.

" } } }, @@ -820,7 +892,7 @@ }, "NextToken":{ "shape":"NextTokenType", - "documentation":"

If present in the response, this value indicates that there's more output available than what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

" + "documentation":"

If present in the response, this value indicates that there's more output available than included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).

" } } }, @@ -870,6 +942,14 @@ "documentation":"

The request failed because you did not complete all the prerequisite steps.

", "exception":true }, + "PublicPolicyException":{ + "type":"structure", + "members":{ + "Message":{"shape":"ErrorMessage"} + }, + "documentation":"

The resource policy did not prevent broad access to the secret.

", + "exception":true + }, "PutResourcePolicyRequest":{ "type":"structure", "required":[ @@ -879,11 +959,16 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"

Specifies the secret that you want to attach the resource-based policy to. You can specify either the ARN or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

" + "documentation":"

Specifies the secret that you want to attach the resource-based policy to. You can specify either the ARN or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" }, "ResourcePolicy":{ "shape":"NonEmptyResourcePolicyType", "documentation":"

A JSON-formatted string that's constructed according to the grammar and syntax for an AWS resource-based policy. The policy in the string identifies who can access or manage this secret and its versions. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.

" + }, + "BlockPublicPolicy":{ + "shape":"BooleanType", + "documentation":"

Makes an optional API call to Zelkova to validate the Resource Policy to prevent broad access to your secret.

", + "box":true } } }, @@ -892,11 +977,11 @@ "members":{ "ARN":{ "shape":"SecretARNType", - "documentation":"

The ARN of the secret that the resource-based policy was retrieved for.

" + "documentation":"

The ARN of the secret retrieved by the resource-based policy.

" }, "Name":{ "shape":"NameType", - "documentation":"

The friendly name of the secret that the resource-based policy was retrieved for.

" + "documentation":"

The friendly name of the secret that the retrieved by the resource-based policy.

" } } }, @@ -906,11 +991,11 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"

Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

" + "documentation":"

Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" }, "ClientRequestToken":{ "shape":"ClientRequestTokenType", - "documentation":"

(Optional) Specifies a unique identifier for the new version of the secret.

If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

  • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

  • If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).

  • If a version with this value already exists and that version's SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

", + "documentation":"

(Optional) Specifies a unique identifier for the new version of the secret.

If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

  • If the ClientRequestToken value isn't already associated with a version of the secret then a new version of the secret is created.

  • If a version with this value already exists and that version's SecretString or SecretBinary values are the same as those in the request then the request is ignored (the operation is idempotent).

  • If a version with this value already exists and the version of the SecretString and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.

This value becomes the VersionId of the new version.

", "idempotencyToken":true }, "SecretBinary":{ @@ -978,7 +1063,7 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"

Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

" + "documentation":"

Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" } } }, @@ -1001,11 +1086,11 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"

Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

" + "documentation":"

Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" }, "ClientRequestToken":{ "shape":"ClientRequestTokenType", - "documentation":"

(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

You only need to specify your own value if you are implementing your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId of the new version.

", + "documentation":"

(Optional) Specifies a unique identifier for the new version of the secret that helps ensure idempotency.

If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.

You only need to specify your own value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified secret.

Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the function's processing. This value becomes the VersionId of the new version.

", "idempotencyToken":true }, "RotationLambdaARN":{ @@ -1086,7 +1171,7 @@ }, "KmsKeyId":{ "shape":"KmsKeyIdType", - "documentation":"

The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the SecretString and SecretBinary fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK (the one named awssecretsmanager) for this account.

" + "documentation":"

The ARN or alias of the AWS KMS customer master key (CMK) used to encrypt the SecretString and SecretBinary fields in each version of the secret. If you don't provide a key, then Secrets Manager defaults to encrypting the secret fields with the default KMS CMK, the key named awssecretsmanager, for this account.

" }, "RotationEnabled":{ "shape":"RotationEnabledType", @@ -1095,7 +1180,7 @@ }, "RotationLambdaARN":{ "shape":"RotationLambdaARNType", - "documentation":"

The ARN of an AWS Lambda function that's invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret.

" + "documentation":"

The ARN of an AWS Lambda function invoked by Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret.

" }, "RotationRules":{ "shape":"RotationRulesType", @@ -1118,19 +1203,24 @@ }, "DeletedDate":{ "shape":"DeletedDateType", - "documentation":"

The date and time on which this secret was deleted. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.

" + "documentation":"

The date and time the deletion of the secret occurred. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.

" }, "Tags":{ "shape":"TagListType", - "documentation":"

The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

" + "documentation":"

The list of user-defined tags associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.

" }, "SecretVersionsToStages":{ "shape":"SecretVersionsToStagesMapType", - "documentation":"

A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.

A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.

" + "documentation":"

A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId attached to each one. Staging labels are used to keep track of the different versions during the rotation process.

A version that does not have any SecretVersionStage is considered deprecated and subject to deletion. Such versions are not included in this list.

" }, "OwningService":{ "shape":"OwningServiceType", "documentation":"

Returns the name of the service that created the secret.

" + }, + "CreatedDate":{ + "shape":"TimestampType", + "documentation":"

The date and time when a secret was created.

", + "box":true } }, "documentation":"

A structure that contains the details about a secret. It does not include the encrypted SecretString and SecretBinary values. To get those values, use the GetSecretValue operation.

" @@ -1199,6 +1289,13 @@ "key":{"shape":"SecretVersionIdType"}, "value":{"shape":"SecretVersionStagesType"} }, + "SortOrderType":{ + "type":"string", + "enum":[ + "asc", + "desc" + ] + }, "Tag":{ "type":"structure", "members":{ @@ -1208,7 +1305,7 @@ }, "Value":{ "shape":"TagValueType", - "documentation":"

The string value that's associated with the key of the tag.

" + "documentation":"

The string value associated with the key of the tag.

" } }, "documentation":"

A structure that contains information about a tag.

" @@ -1235,7 +1332,7 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"

The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

" + "documentation":"

The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" }, "Tags":{ "shape":"TagListType", @@ -1248,6 +1345,7 @@ "max":256, "min":0 }, + "TimestampType":{"type":"timestamp"}, "UntagResourceRequest":{ "type":"structure", "required":[ @@ -1257,7 +1355,7 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"

The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

" + "documentation":"

The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" }, "TagKeys":{ "shape":"TagKeyListType", @@ -1271,7 +1369,7 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"

Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

" + "documentation":"

Specifies the secret that you want to modify or to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" }, "ClientRequestToken":{ "shape":"ClientRequestTokenType", @@ -1322,7 +1420,7 @@ "members":{ "SecretId":{ "shape":"SecretIdType", - "documentation":"

Specifies the secret with the version whose list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names that end with a hyphen followed by six characters.

" + "documentation":"

Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" }, "VersionStage":{ "shape":"SecretVersionStageType", @@ -1335,7 +1433,7 @@ }, "MoveToVersionId":{ "shape":"SecretVersionIdType", - "documentation":"

(Optional) The secret version ID that you want to add the staging label to. If you want to remove a label from a version, then do not specify this parameter.

If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.

", + "documentation":"

(Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.

If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.

", "box":true } } @@ -1345,14 +1443,59 @@ "members":{ "ARN":{ "shape":"SecretARNType", - "documentation":"

The ARN of the secret with the staging label that was modified.

" + "documentation":"

The ARN of the secret with the modified staging label.

" }, "Name":{ "shape":"SecretNameType", - "documentation":"

The friendly name of the secret with the staging label that was modified.

" + "documentation":"

The friendly name of the secret with the modified staging label.

" } } + }, + "ValidateResourcePolicyRequest":{ + "type":"structure", + "required":["ResourcePolicy"], + "members":{ + "SecretId":{ + "shape":"SecretIdType", + "documentation":"

The identifier for the secret that you want to validate a resource policy. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

" + }, + "ResourcePolicy":{ + "shape":"NonEmptyResourcePolicyType", + "documentation":"

Identifies the Resource Policy attached to the secret.

" + } + } + }, + "ValidateResourcePolicyResponse":{ + "type":"structure", + "members":{ + "PolicyValidationPassed":{ + "shape":"BooleanType", + "documentation":"

Returns a message stating that your Reource Policy passed validation.

" + }, + "ValidationErrors":{ + "shape":"ValidationErrorsType", + "documentation":"

Returns an error message if your policy doesn't pass validatation.

" + } + } + }, + "ValidationErrorsEntry":{ + "type":"structure", + "members":{ + "CheckName":{ + "shape":"NameType", + "documentation":"

Checks the name of the policy.

" + }, + "ErrorMessage":{ + "shape":"ErrorMessage", + "documentation":"

Displays error messages if validation encounters problems during validation of the resource policy.

" + } + }, + "documentation":"

Displays errors that occurred during validation of the resource policy.

" + }, + "ValidationErrorsType":{ + "type":"list", + "member":{"shape":"ValidationErrorsEntry"} } }, - "documentation":"AWS Secrets Manager API Reference

AWS Secrets Manager is a web service that enables you to store, manage, and retrieve, secrets.

This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the AWS Secrets Manager User Guide.

API Version

This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.

As an alternative to using the API directly, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms (such as Java, Ruby, .NET, iOS, and Android). The SDKs provide a convenient way to create programmatic access to AWS Secrets Manager. For example, the SDKs take care of cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

We recommend that you use the AWS SDKs to make programmatic API calls to Secrets Manager. However, you also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn more about the Secrets Manager HTTP Query API, see Making Query Requests in the AWS Secrets Manager User Guide.

Secrets Manager supports GET and POST requests for all actions. That is, the API doesn't require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.

Support and Feedback for AWS Secrets Manager

We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the AWS Secrets Manager Discussion Forum. For more information about the AWS Discussion Forums, see Forums Help.

How examples are presented

The JSON that AWS Secrets Manager expects as your request parameters and that the service returns as a response to HTTP query requests are single, long strings without line breaks or white space formatting. The JSON shown in the examples is formatted with both line breaks and white space to improve readability. When example input parameters would also result in long strings that extend beyond the screen, we insert line breaks to enhance readability. You should always submit the input as a single JSON text string.

Logging API Requests

AWS Secrets Manager supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information that's collected by AWS CloudTrail, you can determine which requests were successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about AWS Secrets Manager and its support for AWS CloudTrail, see Logging AWS Secrets Manager Events with AWS CloudTrail in the AWS Secrets Manager User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.

" + "documentation":"AWS Secrets Manager API Reference

AWS Secrets Manager provides a service to enable you to store, manage, and retrieve, secrets.

This guide provides descriptions of the Secrets Manager API. For more information about using this service, see the AWS Secrets Manager User Guide.

API Version

This version of the Secrets Manager API Reference documents the Secrets Manager API version 2017-10-17.

As an alternative to using the API, you can use one of the AWS SDKs, which consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .NET, iOS, and Android. The SDKs provide a convenient way to create programmatic access to AWS Secrets Manager. For example, the SDKs provide cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the AWS SDKs, including downloading and installing them, see Tools for Amazon Web Services.

We recommend you use the AWS SDKs to make programmatic API calls to Secrets Manager. However, you also can use the Secrets Manager HTTP Query API to make direct calls to the Secrets Manager web service. To learn more about the Secrets Manager HTTP Query API, see Making Query Requests in the AWS Secrets Manager User Guide.

Secrets Manager API supports GET and POST requests for all actions, and doesn't require you to use GET for some actions and POST for others. However, GET requests are subject to the limitation size of a URL. Therefore, for operations that require larger sizes, use a POST request.

Support and Feedback for AWS Secrets Manager

We welcome your feedback. Send your comments to awssecretsmanager-feedback@amazon.com, or post your feedback and questions in the AWS Secrets Manager Discussion Forum. For more information about the AWS Discussion Forums, see Forums Help.

How examples are presented

The JSON that AWS Secrets Manager expects as your request parameters and the service returns as a response to HTTP query requests contain single, long strings without line breaks or white space formatting. The JSON shown in the examples displays the code formatted with both line breaks and white space to improve readability. When example input parameters can also cause long strings extending beyond the screen, you can insert line breaks to enhance readability. You should always submit the input as a single JSON text string.

Logging API Requests

AWS Secrets Manager supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information that's collected by AWS CloudTrail, you can determine the requests successfully made to Secrets Manager, who made the request, when it was made, and so on. For more about AWS Secrets Manager and support for AWS CloudTrail, see Logging AWS Secrets Manager Events with AWS CloudTrail in the AWS Secrets Manager User Guide. To learn more about CloudTrail, including enabling it and find your log files, see the AWS CloudTrail User Guide.

" } diff --git a/botocore/data/securityhub/2018-10-26/service-2.json b/botocore/data/securityhub/2018-10-26/service-2.json index 232851bf..73a22d75 100644 --- a/botocore/data/securityhub/2018-10-26/service-2.json +++ b/botocore/data/securityhub/2018-10-26/service-2.json @@ -806,6 +806,32 @@ "type":"list", "member":{"shape":"AvailabilityZone"} }, + "AwsAutoScalingAutoScalingGroupDetails":{ + "type":"structure", + "members":{ + "LaunchConfigurationName":{ + "shape":"NonEmptyString", + "documentation":"

The name of the launch configuration.

" + }, + "LoadBalancerNames":{ + "shape":"StringList", + "documentation":"

The list of load balancers associated with the group.

" + }, + "HealthCheckType":{ + "shape":"NonEmptyString", + "documentation":"

The service to use for the health checks.

" + }, + "HealthCheckGracePeriod":{ + "shape":"Integer", + "documentation":"

The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before it checks the health status of an EC2 instance that has come into service.

" + }, + "CreatedTime":{ + "shape":"NonEmptyString", + "documentation":"

The datetime when the auto scaling group was created.

" + } + }, + "documentation":"

Provides details about an auto scaling group.

" + }, "AwsCloudFrontDistributionDetails":{ "type":"structure", "members":{ @@ -1260,6 +1286,88 @@ "type":"list", "member":{"shape":"AwsEc2SecurityGroupUserIdGroupPair"} }, + "AwsEc2VolumeAttachment":{ + "type":"structure", + "members":{ + "AttachTime":{ + "shape":"NonEmptyString", + "documentation":"

The datetime when the attachment initiated.

" + }, + "DeleteOnTermination":{ + "shape":"Boolean", + "documentation":"

Whether the EBS volume is deleted when the EC2 instance is terminated.

" + }, + "InstanceId":{ + "shape":"NonEmptyString", + "documentation":"

The identifier of the EC2 instance.

" + }, + "Status":{ + "shape":"NonEmptyString", + "documentation":"

The attachment state of the volume.

" + } + }, + "documentation":"

An attachment to an AWS EC2 volume.

" + }, + "AwsEc2VolumeAttachmentList":{ + "type":"list", + "member":{"shape":"AwsEc2VolumeAttachment"} + }, + "AwsEc2VolumeDetails":{ + "type":"structure", + "members":{ + "CreateTime":{ + "shape":"NonEmptyString", + "documentation":"

The datetime when the volume was created.

" + }, + "Encrypted":{ + "shape":"Boolean", + "documentation":"

Whether the volume is encrypted.

" + }, + "Size":{ + "shape":"Integer", + "documentation":"

The size of the volume, in GiBs.

" + }, + "SnapshotId":{ + "shape":"NonEmptyString", + "documentation":"

The snapshot from which the volume was created.

" + }, + "Status":{ + "shape":"NonEmptyString", + "documentation":"

The volume state.

" + }, + "KmsKeyId":{ + "shape":"NonEmptyString", + "documentation":"

The ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.

" + }, + "Attachments":{ + "shape":"AwsEc2VolumeAttachmentList", + "documentation":"

The volume attachments.

" + } + }, + "documentation":"

Details about an EC2 volume.

" + }, + "AwsEc2VpcDetails":{ + "type":"structure", + "members":{ + "CidrBlockAssociationSet":{ + "shape":"CidrBlockAssociationList", + "documentation":"

Information about the IPv4 CIDR blocks associated with the VPC.

" + }, + "Ipv6CidrBlockAssociationSet":{ + "shape":"Ipv6CidrBlockAssociationList", + "documentation":"

Information about the IPv6 CIDR blocks associated with the VPC.

" + }, + "DhcpOptionsId":{ + "shape":"NonEmptyString", + "documentation":"

The identifier of the set of Dynamic Host Configuration Protocol (DHCP) options that are associated with the VPC. If the default options are associated with the VPC, then this is default.

" + }, + "State":{ + "shape":"NonEmptyString", + "documentation":"

The current state of the VPC.

" + } + }, + "documentation":"

Details about an EC2 VPC.

" + }, "AwsElasticsearchDomainDetails":{ "type":"structure", "members":{ @@ -2051,6 +2159,10 @@ "shape":"Network", "documentation":"

The details of network-related information about a finding.

" }, + "NetworkPath":{ + "shape":"NetworkPathList", + "documentation":"

Provides information about a network path that is relevant to a finding. Each entry under NetworkPath represents a component of that path.

" + }, "Process":{ "shape":"ProcessDetails", "documentation":"

The details of process-related information about a finding.

" @@ -2090,6 +2202,10 @@ "Note":{ "shape":"Note", "documentation":"

A user-defined note added to a finding.

" + }, + "Vulnerabilities":{ + "shape":"VulnerabilityList", + "documentation":"

Provides a list of vulnerabilities associated with the findings.

" } }, "documentation":"

Provides consistent format for the contents of the Security Hub-aggregated findings. AwsSecurityFinding format enables you to share findings between AWS security services and third-party solutions, and security standards checks.

A finding is a potential security issue generated either by AWS services (Amazon GuardDuty, Amazon Inspector, and Amazon Macie) or by the integrated third-party solutions and standards checks.

" @@ -2741,6 +2857,28 @@ "type":"list", "member":{"shape":"NonEmptyString"} }, + "CidrBlockAssociation":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"NonEmptyString", + "documentation":"

The association ID for the IPv4 CIDR block.

" + }, + "CidrBlock":{ + "shape":"NonEmptyString", + "documentation":"

The IPv4 CIDR block.

" + }, + "CidrBlockState":{ + "shape":"NonEmptyString", + "documentation":"

Information about the state of the IPv4 CIDR block.

" + } + }, + "documentation":"

An IPv4 CIDR block association.

" + }, + "CidrBlockAssociationList":{ + "type":"list", + "member":{"shape":"CidrBlockAssociation"} + }, "Compliance":{ "type":"structure", "members":{ @@ -2879,6 +3017,28 @@ } } }, + "Cvss":{ + "type":"structure", + "members":{ + "Version":{ + "shape":"NonEmptyString", + "documentation":"

The version of CVSS for the CVSS score.

" + }, + "BaseScore":{ + "shape":"Double", + "documentation":"

The base CVSS score.

" + }, + "BaseVector":{ + "shape":"NonEmptyString", + "documentation":"

The base scoring vector for the CVSS score.

" + } + }, + "documentation":"

CVSS scores from the advisory related to the vulnerability.

" + }, + "CvssList":{ + "type":"list", + "member":{"shape":"Cvss"} + }, "DateFilter":{ "type":"structure", "members":{ @@ -3639,6 +3799,28 @@ "type":"list", "member":{"shape":"IpFilter"} }, + "Ipv6CidrBlockAssociation":{ + "type":"structure", + "members":{ + "AssociationId":{ + "shape":"NonEmptyString", + "documentation":"

The association ID for the IPv6 CIDR block.

" + }, + "Ipv6CidrBlock":{ + "shape":"NonEmptyString", + "documentation":"

The IPv6 CIDR block.

" + }, + "CidrBlockState":{ + "shape":"NonEmptyString", + "documentation":"

Information about the state of the CIDR block.

" + } + }, + "documentation":"

An IPV6 CIDR block association.

" + }, + "Ipv6CidrBlockAssociationList":{ + "type":"list", + "member":{"shape":"Ipv6CidrBlockAssociation"} + }, "KeywordFilter":{ "type":"structure", "members":{ @@ -3925,6 +4107,10 @@ "shape":"NonEmptyString", "documentation":"

The protocol of network-related information about a finding.

" }, + "OpenPortRange":{ + "shape":"PortRange", + "documentation":"

The range of open ports that is present on the network.

" + }, "SourceIpV4":{ "shape":"NonEmptyString", "documentation":"

The source IPv4 address of network-related information about a finding.

" @@ -3971,6 +4157,64 @@ "OUT" ] }, + "NetworkHeader":{ + "type":"structure", + "members":{ + "Protocol":{ + "shape":"NonEmptyString", + "documentation":"

The protocol used for the component.

" + }, + "Destination":{ + "shape":"NetworkPathComponentDetails", + "documentation":"

Information about the destination of the component.

" + }, + "Source":{ + "shape":"NetworkPathComponentDetails", + "documentation":"

Information about the origin of the component.

" + } + }, + "documentation":"

Details about a network path component that occurs before or after the current component.

" + }, + "NetworkPathComponent":{ + "type":"structure", + "members":{ + "ComponentId":{ + "shape":"NonEmptyString", + "documentation":"

The identifier of a component in the network path.

" + }, + "ComponentType":{ + "shape":"NonEmptyString", + "documentation":"

The type of component.

" + }, + "Egress":{ + "shape":"NetworkHeader", + "documentation":"

Information about the component that comes after the current component in the network path.

" + }, + "Ingress":{ + "shape":"NetworkHeader", + "documentation":"

Information about the component that comes before the current node in the network path.

" + } + }, + "documentation":"

Information about a network path component.

" + }, + "NetworkPathComponentDetails":{ + "type":"structure", + "members":{ + "Address":{ + "shape":"StringList", + "documentation":"

The IP addresses of the destination.

" + }, + "PortRanges":{ + "shape":"PortRangeList", + "documentation":"

A list of port ranges for the destination.

" + } + }, + "documentation":"

Information about the destination of the next component in the network path.

" + }, + "NetworkPathList":{ + "type":"list", + "member":{"shape":"NetworkPathComponent"} + }, "NextToken":{"type":"string"}, "NonEmptyString":{ "type":"string", @@ -4051,6 +4295,24 @@ "aws-us-gov" ] }, + "PortRange":{ + "type":"structure", + "members":{ + "Begin":{ + "shape":"Integer", + "documentation":"

The first port in the port range.

" + }, + "End":{ + "shape":"Integer", + "documentation":"

The last port in the port range.

" + } + }, + "documentation":"

A range of ports.

" + }, + "PortRangeList":{ + "type":"list", + "member":{"shape":"PortRange"} + }, "ProcessDetails":{ "type":"structure", "members":{ @@ -4245,6 +4507,10 @@ "ResourceDetails":{ "type":"structure", "members":{ + "AwsAutoScalingAutoScalingGroup":{ + "shape":"AwsAutoScalingAutoScalingGroupDetails", + "documentation":"

Details for an autoscaling group.

" + }, "AwsCodeBuildProject":{ "shape":"AwsCodeBuildProjectDetails", "documentation":"

Details for an AWS CodeBuild project.

" @@ -4265,6 +4531,14 @@ "shape":"AwsEc2SecurityGroupDetails", "documentation":"

Details for an EC2 security group.

" }, + "AwsEc2Volume":{ + "shape":"AwsEc2VolumeDetails", + "documentation":"

Details for an EC2 volume.

" + }, + "AwsEc2Vpc":{ + "shape":"AwsEc2VpcDetails", + "documentation":"

Details for an EC2 VPC.

" + }, "AwsElbv2LoadBalancer":{ "shape":"AwsElbv2LoadBalancerDetails", "documentation":"

Details about a load balancer.

" @@ -4423,6 +4697,36 @@ }, "documentation":"

Updates to the severity information for a finding.

" }, + "SoftwarePackage":{ + "type":"structure", + "members":{ + "Name":{ + "shape":"NonEmptyString", + "documentation":"

The name of the software package.

" + }, + "Version":{ + "shape":"NonEmptyString", + "documentation":"

The version of the software package.

" + }, + "Epoch":{ + "shape":"NonEmptyString", + "documentation":"

The epoch of the software package.

" + }, + "Release":{ + "shape":"NonEmptyString", + "documentation":"

The release of the software package.

" + }, + "Architecture":{ + "shape":"NonEmptyString", + "documentation":"

The architecture used for the software package.

" + } + }, + "documentation":"

Information about a software package.

" + }, + "SoftwarePackageList":{ + "type":"list", + "member":{"shape":"SoftwarePackage"} + }, "SortCriteria":{ "type":"list", "member":{"shape":"SortCriterion"} @@ -4881,7 +5185,7 @@ }, "DisabledReason":{ "shape":"NonEmptyString", - "documentation":"

A description of the reason why you are disabling a security standard control.

" + "documentation":"

A description of the reason why you are disabling a security standard control. If you are disabling a control, then this is required.

" } } }, @@ -4899,6 +5203,68 @@ "BENIGN_POSITIVE" ] }, + "Vulnerability":{ + "type":"structure", + "required":["Id"], + "members":{ + "Id":{ + "shape":"NonEmptyString", + "documentation":"

The identifier of the vulnerability.

" + }, + "VulnerablePackages":{ + "shape":"SoftwarePackageList", + "documentation":"

List of software packages that have the vulnerability.

" + }, + "Cvss":{ + "shape":"CvssList", + "documentation":"

CVSS scores from the advisory related to the vulnerability.

" + }, + "RelatedVulnerabilities":{ + "shape":"StringList", + "documentation":"

List of vulnerabilities that are related to this vulnerability.

" + }, + "Vendor":{ + "shape":"VulnerabilityVendor", + "documentation":"

Information about the vendor that generates the vulnerability report.

" + }, + "ReferenceUrls":{ + "shape":"StringList", + "documentation":"

A list of URLs that provide additional information about the vulnerability.

" + } + }, + "documentation":"

A vulnerability associated with a finding.

" + }, + "VulnerabilityList":{ + "type":"list", + "member":{"shape":"Vulnerability"} + }, + "VulnerabilityVendor":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{ + "shape":"NonEmptyString", + "documentation":"

The name of the vendor.

" + }, + "Url":{ + "shape":"NonEmptyString", + "documentation":"

The URL of the vulnerability advisory.

" + }, + "VendorSeverity":{ + "shape":"NonEmptyString", + "documentation":"

The severity that the vendor assigned to the vulnerability.

" + }, + "VendorCreatedAt":{ + "shape":"NonEmptyString", + "documentation":"

The datetime when the vulnerability advisory was created.

" + }, + "VendorUpdatedAt":{ + "shape":"NonEmptyString", + "documentation":"

The datetime when the vulnerability advisory was last updated.

" + } + }, + "documentation":"

A vendor that generates a vulnerability report.

" + }, "WafAction":{ "type":"structure", "members":{ diff --git a/botocore/data/sns/2010-03-31/service-2.json b/botocore/data/sns/2010-03-31/service-2.json index e470c03f..53276fa7 100644 --- a/botocore/data/sns/2010-03-31/service-2.json +++ b/botocore/data/sns/2010-03-31/service-2.json @@ -83,7 +83,7 @@ {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], - "documentation":"

Creates a platform application object for one of the supported push notification services, such as APNS and FCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is \"SSL certificate\". For FCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\". The PlatformCredential is also received from the notification service. For WNS, PlatformPrincipal is \"Package Security Identifier\". For MPNS, PlatformPrincipal is \"TLS certificate\". For Baidu, PlatformPrincipal is \"API key\".

For APNS/APNS_SANDBOX, PlatformCredential is \"private key\". For FCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\". For WNS, PlatformCredential is \"secret key\". For MPNS, PlatformCredential is \"private key\". For Baidu, PlatformCredential is \"secret key\". The PlatformApplicationArn that is returned when using CreatePlatformApplication is then used as an attribute for the CreatePlatformEndpoint action.

" + "documentation":"

Creates a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging), to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using the CreatePlatformApplication action.

PlatformPrincipal and PlatformCredential are received from the notification service.

  • For ADM, PlatformPrincipal is client id and PlatformCredential is client secret.

  • For Baidu, PlatformPrincipal is API key and PlatformCredential is secret key.

  • For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate and PlatformCredential is private key.

  • For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal and the PlatformCredential is API key.

  • For MPNS, PlatformPrincipal is TLS certificate and PlatformCredential is private key.

  • For WNS, PlatformPrincipal is Package Security Identifier and PlatformCredential is secret key.

You can use the returned PlatformApplicationArn as an attribute for the CreatePlatformEndpoint action.

" }, "CreatePlatformEndpoint":{ "name":"CreatePlatformEndpoint", @@ -102,7 +102,7 @@ {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], - "documentation":"

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as FCM and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. The EndpointArn that is returned when using CreatePlatformEndpoint can then be used by the Publish action to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.

When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.

" + "documentation":"

Creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. CreatePlatformEndpoint requires the PlatformApplicationArn that is returned from CreatePlatformApplication. You can use the returned EndpointArn to send a message to a mobile app or by the Subscribe action for subscription to a topic. The CreatePlatformEndpoint action is idempotent, so if the requester already owns an endpoint with the same device token and attributes, that endpoint's ARN is returned without creating a new endpoint. For more information, see Using Amazon SNS Mobile Push Notifications.

When using CreatePlatformEndpoint with Baidu, two attributes must be provided: ChannelId and UserId. The token field must also contain the ChannelId. For more information, see Creating an Amazon SNS Endpoint for Baidu.

" }, "CreateTopic":{ "name":"CreateTopic", @@ -126,7 +126,7 @@ {"shape":"TagPolicyException"}, {"shape":"ConcurrentAccessException"} ], - "documentation":"

Creates a topic to which notifications can be published. Users can create at most 100,000 topics. For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.

" + "documentation":"

Creates a topic to which notifications can be published. Users can create at most 100,000 standard topics (at most 1,000 FIFO topics). For more information, see https://aws.amazon.com/sns. This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is returned without creating a new topic.

" }, "DeleteEndpoint":{ "name":"DeleteEndpoint", @@ -154,7 +154,7 @@ {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], - "documentation":"

Deletes a platform application object for one of the supported push notification services, such as APNS and FCM. For more information, see Using Amazon SNS Mobile Push Notifications.

" + "documentation":"

Deletes a platform application object for one of the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "DeleteTopic":{ "name":"DeleteTopic", @@ -191,7 +191,7 @@ {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], - "documentation":"

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as FCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

" + "documentation":"

Retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "GetPlatformApplicationAttributes":{ "name":"GetPlatformApplicationAttributes", @@ -210,7 +210,7 @@ {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], - "documentation":"

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and FCM. For more information, see Using Amazon SNS Mobile Push Notifications.

" + "documentation":"

Retrieves the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "GetSMSAttributes":{ "name":"GetSMSAttributes", @@ -287,7 +287,7 @@ {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], - "documentation":"

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as FCM and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

This action is throttled at 30 transactions per second (TPS).

" + "documentation":"

Lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM (Firebase Cloud Messaging) and APNS. The results for ListEndpointsByPlatformApplication are paginated and return a limited list of endpoints, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListEndpointsByPlatformApplication again using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

This action is throttled at 30 transactions per second (TPS).

" }, "ListPhoneNumbersOptedOut":{ "name":"ListPhoneNumbersOptedOut", @@ -324,7 +324,7 @@ {"shape":"InternalErrorException"}, {"shape":"AuthorizationErrorException"} ], - "documentation":"

Lists the platform application objects for the supported push notification services, such as APNS and FCM. The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

This action is throttled at 15 transactions per second (TPS).

" + "documentation":"

Lists the platform application objects for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). The results for ListPlatformApplications are paginated and return a limited list of applications, up to 100. If additional records are available after the first page results, then a NextToken string will be returned. To receive the next page, you call ListPlatformApplications using the NextToken string received from the previous call. When there are no more records to return, NextToken will be null. For more information, see Using Amazon SNS Mobile Push Notifications.

This action is throttled at 15 transactions per second (TPS).

" }, "ListSubscriptions":{ "name":"ListSubscriptions", @@ -447,7 +447,7 @@ {"shape":"KMSAccessDeniedException"}, {"shape":"InvalidSecurityException"} ], - "documentation":"

Sends a message to an Amazon SNS topic or sends a text message (SMS message) directly to a phone number.

If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.

When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.

To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.

" + "documentation":"

Sends a message to an Amazon SNS topic, a text message (SMS message) directly to a phone number, or a message to a mobile platform endpoint (when you specify the TargetArn).

If you send a message to a topic, Amazon SNS delivers the message to each endpoint that is subscribed to the topic. The format of the message depends on the notification protocol for each subscribed endpoint.

When a messageId is returned, the message has been saved and Amazon SNS will attempt to deliver it shortly.

To use the Publish action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, you must specify the EndpointArn for the TargetArn parameter. The EndpointArn is returned when making a call with the CreatePlatformEndpoint action.

For more information about formatting messages, see Send Custom Platform-Specific Payloads in Messages to Mobile Devices.

You can publish messages only to topics and endpoints in the same AWS Region.

" }, "RemovePermission":{ "name":"RemovePermission", @@ -477,7 +477,7 @@ {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], - "documentation":"

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as FCM and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

" + "documentation":"

Sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM (Firebase Cloud Messaging) and APNS. For more information, see Using Amazon SNS Mobile Push Notifications.

" }, "SetPlatformApplicationAttributes":{ "name":"SetPlatformApplicationAttributes", @@ -492,7 +492,7 @@ {"shape":"AuthorizationErrorException"}, {"shape":"NotFoundException"} ], - "documentation":"

Sets the attributes of the platform application object for the supported push notification services, such as APNS and FCM. For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.

" + "documentation":"

Sets the attributes of the platform application object for the supported push notification services, such as APNS and GCM (Firebase Cloud Messaging). For more information, see Using Amazon SNS Mobile Push Notifications. For information on configuring attributes for message delivery status, see Using Amazon SNS Application Attributes for Message Delivery Status.

" }, "SetSMSAttributes":{ "name":"SetSMSAttributes", @@ -565,7 +565,7 @@ {"shape":"AuthorizationErrorException"}, {"shape":"InvalidSecurityException"} ], - "documentation":"

Prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a subscription, the endpoint owner must call the ConfirmSubscription action with the token from the confirmation message. Confirmation tokens are valid for three days.

This action is throttled at 100 transactions per second (TPS).

" + "documentation":"

Subscribes an endpoint to an Amazon SNS topic. If the endpoint type is HTTP/S or email, or if the endpoint and the topic are not in the same AWS account, the endpoint owner must the ConfirmSubscription action to confirm the subscription.

You call the ConfirmSubscription action with the token from the subscription response. Confirmation tokens are valid for three days.

This action is throttled at 100 transactions per second (TPS).

" }, "TagResource":{ "name":"TagResource", @@ -769,7 +769,7 @@ }, "Platform":{ "shape":"String", - "documentation":"

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and FCM (Firebase Cloud Messaging).

" + "documentation":"

The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Firebase Cloud Messaging).

" }, "Attributes":{ "shape":"MapStringToString", @@ -801,7 +801,7 @@ }, "Token":{ "shape":"String", - "documentation":"

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using FCM or ADM, the device token equivalent is called the registration ID.

" + "documentation":"

Unique identifier created by the notification service for an app on a device. The specific name for Token will vary, depending on which notification service is being used. For example, when using APNS as the notification service, you need the device token. Alternatively, when using GCM (Firebase Cloud Messaging) or ADM, the device token equivalent is called the registration ID.

" }, "CustomUserData":{ "shape":"String", @@ -820,11 +820,11 @@ "members":{ "Name":{ "shape":"topicName", - "documentation":"

The name of the topic you want to create.

Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

" + "documentation":"

The name of the topic you want to create.

Constraints: Topic names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be between 1 and 256 characters long.

For a FIFO (first-in-first-out) topic, the name must end with the .fifo suffix.

" }, "Attributes":{ "shape":"TopicAttributesMap", - "documentation":"

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • DisplayName – The display name to use for a topic with SMS subscriptions.

  • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

The following attribute applies only to server-side-encryption:

  • KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

" + "documentation":"

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the CreateTopic action uses:

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • DisplayName – The display name to use for a topic with SMS subscriptions.

  • FifoTopic – Set to true to create a FIFO topic.

  • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

The following attribute applies only to server-side-encryption:

  • KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

The following attribute applies only to FIFO topics:

  • ContentBasedDeduplication – Enables content-based deduplication. Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

  • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

  • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

" }, "Tags":{ "shape":"TagList", @@ -1000,7 +1000,7 @@ "members":{ "Attributes":{ "shape":"SubscriptionAttributesMap", - "documentation":"

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.

  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • FilterPolicy – The filter policy JSON that is assigned to the subscription.

  • Owner – The AWS account ID of the subscription's owner.

  • PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

  • SubscriptionArn – The subscription's ARN.

  • TopicArn – The topic ARN that the subscription is associated with.

" + "documentation":"

A map of the subscription's attributes. Attributes in this map include the following:

  • ConfirmationWasAuthenticated – true if the subscription confirmation request was authenticated.

  • DeliveryPolicy – The JSON serialization of the subscription's delivery policy.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy that takes into account the topic delivery policy and account system defaults.

  • FilterPolicy – The filter policy JSON that is assigned to the subscription. For more information, see Amazon SNS Message Filtering in the Amazon SNS Developer Guide.

  • Owner – The AWS account ID of the subscription's owner.

  • PendingConfirmation – true if the subscription hasn't been confirmed. To confirm a pending subscription, call the ConfirmSubscription action with a confirmation token.

  • RawMessageDelivery – true if raw message delivery is enabled for the subscription. Raw messages are free of JSON formatting and can be sent to HTTP/S and Amazon SQS endpoints.

  • RedrivePolicy – When specified, sends undeliverable messages to the specified Amazon SQS dead-letter queue. Messages that can't be delivered due to client errors (for example, when the subscribed endpoint is unreachable) or server errors (for example, when the service that powers the subscribed endpoint becomes unavailable) are held in the dead-letter queue for further analysis or reprocessing.

  • SubscriptionArn – The subscription's ARN.

  • TopicArn – The topic ARN that the subscription is associated with.

" } }, "documentation":"

Response for GetSubscriptionAttributes action.

" @@ -1021,7 +1021,7 @@ "members":{ "Attributes":{ "shape":"TopicAttributesMap", - "documentation":"

A map of the topic's attributes. Attributes in this map include the following:

  • DeliveryPolicy – The JSON serialization of the topic's delivery policy.

  • DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.

  • Owner – The AWS account ID of the topic's owner.

  • Policy – The JSON serialization of the topic's access control policy.

  • SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.

  • SubscriptionsDeleted – The number of deleted subscriptions for the topic.

  • SubscriptionsPending – The number of subscriptions pending confirmation for the topic.

  • TopicArn – The topic's ARN.

  • EffectiveDeliveryPolicy – Yhe JSON serialization of the effective delivery policy, taking system defaults into account.

The following attribute applies only to server-side-encryption:

  • KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

" + "documentation":"

A map of the topic's attributes. Attributes in this map include the following:

  • DeliveryPolicy – The JSON serialization of the topic's delivery policy.

  • DisplayName – The human-readable name used in the From field for notifications to email and email-json endpoints.

  • Owner – The AWS account ID of the topic's owner.

  • Policy – The JSON serialization of the topic's access control policy.

  • SubscriptionsConfirmed – The number of confirmed subscriptions for the topic.

  • SubscriptionsDeleted – The number of deleted subscriptions for the topic.

  • SubscriptionsPending – The number of subscriptions pending confirmation for the topic.

  • TopicArn – The topic's ARN.

  • EffectiveDeliveryPolicy – The JSON serialization of the effective delivery policy, taking system defaults into account.

The following attribute applies only to server-side-encryption:

  • KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

" } }, "documentation":"

Response for GetTopicAttributes action.

" @@ -1550,7 +1550,7 @@ }, "Attributes":{ "shape":"MapStringToString", - "documentation":"

A map of the platform application attributes. Attributes in this map include the following:

  • PlatformCredential – The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is private key. For FCM, PlatformCredential is \"API key\". For ADM, PlatformCredential is \"client secret\".

  • PlatformPrincipal – The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is SSL certificate. For FCM, PlatformPrincipal is not applicable. For ADM, PlatformPrincipal is \"client id\".

  • EventEndpointCreated – Topic ARN to which EndpointCreated event notifications should be sent.

  • EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications should be sent.

  • EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications should be sent.

  • EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

  • SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

  • FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

  • SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.

" + "documentation":"

A map of the platform application attributes. Attributes in this map include the following:

  • PlatformCredential – The credential received from the notification service. For APNS and APNS_SANDBOX, PlatformCredential is private key. For GCM (Firebase Cloud Messaging), PlatformCredential is API key. For ADM, PlatformCredential is client secret.

  • PlatformPrincipal – The principal received from the notification service. For APNS and APNS_SANDBOX, PlatformPrincipal is SSL certificate. For GCM (Firebase Cloud Messaging), there is no PlatformPrincipal. For ADM, PlatformPrincipal is client id.

  • EventEndpointCreated – Topic ARN to which EndpointCreated event notifications are sent.

  • EventEndpointDeleted – Topic ARN to which EndpointDeleted event notifications are sent.

  • EventEndpointUpdated – Topic ARN to which EndpointUpdate event notifications are sent.

  • EventDeliveryFailure – Topic ARN to which DeliveryFailure event notifications are sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.

  • SuccessFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

  • FailureFeedbackRoleArn – IAM role ARN used to give Amazon SNS write access to use CloudWatch Logs on your behalf.

  • SuccessFeedbackSampleRate – Sample rate percentage (0-100) of successfully delivered messages.

" } }, "documentation":"

Input for SetPlatformApplicationAttributes action.

" @@ -1607,7 +1607,7 @@ }, "AttributeName":{ "shape":"attributeName", - "documentation":"

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • DisplayName – The display name to use for a topic with SMS subscriptions.

  • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

The following attribute applies only to server-side-encryption:

  • KmsMasterKeyId - The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

" + "documentation":"

A map of attributes with their corresponding values.

The following lists the names, descriptions, and values of the special request parameters that the SetTopicAttributes action uses:

  • DeliveryPolicy – The policy that defines how Amazon SNS retries failed deliveries to HTTP/S endpoints.

  • DisplayName – The display name to use for a topic with SMS subscriptions.

  • Policy – The policy that defines who can access your topic. By default, only the topic owner can publish or subscribe to the topic.

The following attribute applies only to server-side-encryption:

  • KmsMasterKeyId – The ID of an AWS-managed customer master key (CMK) for Amazon SNS or a custom CMK. For more information, see Key Terms. For more examples, see KeyId in the AWS Key Management Service API Reference.

The following attribute applies only to FIFO topics:

  • ContentBasedDeduplication – Enables content-based deduplication. Amazon SNS uses a SHA-256 hash to generate the MessageDeduplicationId using the body of the message (but not the attributes of the message).

  • When ContentBasedDeduplication is in effect, messages with identical content sent within the deduplication interval are treated as duplicates and only one copy of the message is delivered.

  • If the queue has ContentBasedDeduplication set, your MessageDeduplicationId overrides the generated one.

" }, "AttributeValue":{ "shape":"attributeValue", @@ -1647,7 +1647,7 @@ }, "Endpoint":{ "shape":"endpoint", - "documentation":"

The endpoint that you want to receive notifications. Endpoints vary by protocol:

  • For the http protocol, the endpoint is an URL beginning with http://

  • For the https protocol, the endpoint is a URL beginning with https://

  • For the email protocol, the endpoint is an email address

  • For the email-json protocol, the endpoint is an email address

  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device

  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue

  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

  • For the lambda protocol, the endpoint is the ARN of an Amazon Lambda function.

" + "documentation":"

The endpoint that you want to receive notifications. Endpoints vary by protocol:

  • For the http protocol, the (public) endpoint is a URL beginning with http://

  • For the https protocol, the (public) endpoint is a URL beginning with https://

  • For the email protocol, the endpoint is an email address

  • For the email-json protocol, the endpoint is an email address

  • For the sms protocol, the endpoint is a phone number of an SMS-enabled device

  • For the sqs protocol, the endpoint is the ARN of an Amazon SQS queue

  • For the application protocol, the endpoint is the EndpointArn of a mobile app and device.

  • For the lambda protocol, the endpoint is the ARN of an Amazon Lambda function.

" }, "Attributes":{ "shape":"SubscriptionAttributesMap", @@ -1655,7 +1655,7 @@ }, "ReturnSubscriptionArn":{ "shape":"boolean", - "documentation":"

Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.

  • If you have the subscription ARN returned, the response includes the ARN in all cases, even if the subscription is not yet confirmed.

  • If you don't have the subscription ARN returned, in addition to the ARN for confirmed subscriptions, the response also includes the pending subscription ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.

If you set this parameter to true, .

The default value is false.

" + "documentation":"

Sets whether the response from the Subscribe request includes the subscription ARN, even if the subscription is not yet confirmed.

  • If you set this parameter to true, the response includes the ARN in all cases, even if the subscription is not yet confirmed. In addition to the ARN for confirmed subscriptions, the response also includes the pending subscription ARN value for subscriptions that aren't yet confirmed. A subscription becomes confirmed when the subscriber calls the ConfirmSubscription action with a confirmation token.

The default value is false.

" } }, "documentation":"

Input for Subscribe action.

" diff --git a/botocore/data/storagegateway/2013-06-30/service-2.json b/botocore/data/storagegateway/2013-06-30/service-2.json index 47386377..2bb4f9ff 100644 --- a/botocore/data/storagegateway/2013-06-30/service-2.json +++ b/botocore/data/storagegateway/2013-06-30/service-2.json @@ -824,7 +824,7 @@ {"shape":"InvalidGatewayRequestException"}, {"shape":"InternalServerError"} ], - "documentation":"

Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations in the AWS Storage Gateway User Guide.

When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through an CloudWatch event when your RefreshCache operation completes.

Throttle limit: This API is asynchronous so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the AWS Storage Gateway User Guide.

If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server.

For more information, see Getting notified about file operations in the AWS Storage Gateway User Guide.

" + "documentation":"

Refreshes the cache for the specified file share. This operation finds objects in the Amazon S3 bucket that were added, removed, or replaced since the gateway last listed the bucket's contents and cached the results. This operation is only supported in the file gateway type. You can subscribe to be notified through an Amazon CloudWatch event when your RefreshCache operation completes. For more information, see Getting notified about file operations in the AWS Storage Gateway User Guide.

When this API is called, it only initiates the refresh operation. When the API call completes and returns a success code, it doesn't necessarily mean that the file refresh has completed. You should use the refresh-complete notification to determine that the operation has completed before you check for new files on the gateway file share. You can subscribe to be notified through an CloudWatch event when your RefreshCache operation completes.

Throttle limit: This API is asynchronous so the gateway will accept no more than two refreshes at any time. We recommend using the refresh-complete CloudWatch event notification before issuing additional requests. For more information, see Getting notified about file operations in the AWS Storage Gateway User Guide.

If you invoke the RefreshCache API when two requests are already being processed, any new request will cause an InvalidGatewayRequestException error because too many requests were sent to the server.

For more information, see Getting notified about file operations in the AWS Storage Gateway User Guide.

" }, "RemoveTagsFromResource":{ "name":"RemoveTagsFromResource", @@ -1418,6 +1418,17 @@ "min":51200 }, "Boolean":{"type":"boolean"}, + "CacheAttributes":{ + "type":"structure", + "members":{ + "CacheStaleTimeoutInSeconds":{ + "shape":"CacheStaleTimeoutInSeconds", + "documentation":"

Refreshes a file share's cache by using Time To Live (TTL). TTL is the length of time since the last refresh after which access to the directory would cause the file gateway to first refresh that directory's contents from the Amazon S3 bucket. The TTL duration is in seconds.

Valid Values: 300 to 2,592,000 seconds (5 minutes to 30 days)

" + } + }, + "documentation":"

Lists refresh cache information.

" + }, + "CacheStaleTimeoutInSeconds":{"type":"integer"}, "CachediSCSIVolume":{ "type":"structure", "members":{ @@ -1527,6 +1538,13 @@ }, "documentation":"

CancelRetrievalOutput

" }, + "CaseSensitivity":{ + "type":"string", + "enum":[ + "ClientSpecified", + "CaseSensitive" + ] + }, "ChapCredentials":{ "type":"list", "member":{"shape":"ChapInfo"} @@ -1665,7 +1683,7 @@ }, "LocationARN":{ "shape":"LocationARN", - "documentation":"

The ARN of the backed storage used for storing file data.

" + "documentation":"

The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a \"/\".

" }, "DefaultStorageClass":{ "shape":"StorageClass", @@ -1698,6 +1716,14 @@ "Tags":{ "shape":"Tags", "documentation":"

A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

" + }, + "FileShareName":{ + "shape":"FileShareName", + "documentation":"

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN.

" + }, + "CacheAttributes":{ + "shape":"CacheAttributes", + "documentation":"

Refresh cache information.

" } }, "documentation":"

CreateNFSFileShareInput

" @@ -1743,7 +1769,7 @@ }, "LocationARN":{ "shape":"LocationARN", - "documentation":"

The ARN of the backed storage used for storing file data.

" + "documentation":"

The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a \"/\".

" }, "DefaultStorageClass":{ "shape":"StorageClass", @@ -1771,15 +1797,15 @@ }, "AdminUserList":{ "shape":"FileShareUserList", - "documentation":"

A list of users in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user.

Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

" + "documentation":"

A list of users or groups in the Active Directory that will be granted administrator privileges on the file share. These users can do all file operations as the super-user. Acceptable formats include: DOMAIN\\User1, user1, @group1, and @DOMAIN\\group1.

Use this option very carefully, because any user in this list can do anything they like on the file share, regardless of file permissions.

" }, "ValidUserList":{ "shape":"FileShareUserList", - "documentation":"

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example, @group1. Can only be set if Authentication is set to ActiveDirectory.

" + "documentation":"

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\\User1, user1, @group1, and @DOMAIN\\group1. Can only be set if Authentication is set to ActiveDirectory.

" }, "InvalidUserList":{ "shape":"FileShareUserList", - "documentation":"

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example, @group1. Can only be set if Authentication is set to ActiveDirectory.

" + "documentation":"

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\\User1, user1, @group1, and @DOMAIN\\group1. Can only be set if Authentication is set to ActiveDirectory.

" }, "AuditDestinationARN":{ "shape":"AuditDestinationARN", @@ -1789,9 +1815,21 @@ "shape":"Authentication", "documentation":"

The authentication method that users use to access the file share. The default is ActiveDirectory.

Valid Values: ActiveDirectory | GuestAccess

" }, + "CaseSensitivity":{ + "shape":"CaseSensitivity", + "documentation":"

The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.

" + }, "Tags":{ "shape":"Tags", "documentation":"

A list of up to 50 tags that can be assigned to the NFS file share. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.

" + }, + "FileShareName":{ + "shape":"FileShareName", + "documentation":"

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN.

" + }, + "CacheAttributes":{ + "shape":"CacheAttributes", + "documentation":"

Refresh cache information.

" } }, "documentation":"

CreateSMBFileShareInput

" @@ -3078,6 +3116,11 @@ "type":"list", "member":{"shape":"FileShareInfo"} }, + "FileShareName":{ + "type":"string", + "max":255, + "min":1 + }, "FileShareStatus":{ "type":"string", "documentation":"

The status of the file share.

Valid Values: CREATING | UPDATING | AVAILABLE | DELETING

", @@ -3196,6 +3239,8 @@ }, "Host":{ "type":"string", + "max":1024, + "min":6, "pattern":"^(([a-zA-Z0-9\\-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9\\-]*[A-Za-z0-9])(:(\\d+))?$" }, "HostEnvironment":{ @@ -3324,7 +3369,8 @@ "type":"string", "documentation":"

The Amazon Resource Name (ARN) of a symmetric customer master key (CMK) used for Amazon S3 server-side encryption. Storage Gateway does not support asymmetric CMKs. This value can only be set when KMSEncrypted is true. Optional.

", "max":2048, - "min":7 + "min":7, + "pattern":"(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\\S+)$)|(^alias/(\\S+)$)" }, "LastSoftwareUpdate":{ "type":"string", @@ -3567,8 +3613,8 @@ }, "LocationARN":{ "type":"string", - "documentation":"

The ARN of the backend storage used for storing file data.

", - "max":310, + "documentation":"

The ARN of the backend storage used for storing file data. A prefix name can be added to the S3 bucket name. It must end with a \"/\".

", + "max":1400, "min":16 }, "Marker":{ @@ -3651,6 +3697,14 @@ "Tags":{ "shape":"Tags", "documentation":"

A list of up to 50 tags assigned to the NFS file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

" + }, + "FileShareName":{ + "shape":"FileShareName", + "documentation":"

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN.

" + }, + "CacheAttributes":{ + "shape":"CacheAttributes", + "documentation":"

Refresh cache information.

" } }, "documentation":"

The Unix file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported in file gateways.

" @@ -3893,7 +3947,8 @@ "type":"string", "documentation":"

The ARN of the IAM role that file gateway assumes when it accesses the underlying storage.

", "max":2048, - "min":20 + "min":20, + "pattern":"^arn:(aws|aws-cn|aws-us-gov):iam::([0-9]+):role/(\\S+)$" }, "SMBFileShareInfo":{ "type":"structure", @@ -3936,24 +3991,36 @@ }, "AdminUserList":{ "shape":"FileShareUserList", - "documentation":"

A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

" + "documentation":"

A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\\User1, user1, @group1, and @DOMAIN\\group1. Can only be set if Authentication is set to ActiveDirectory.

" }, "ValidUserList":{ "shape":"FileShareUserList", - "documentation":"

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example, @group1. Can only be set if Authentication is set to ActiveDirectory.

" + "documentation":"

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\\User1, user1, @group1, and @DOMAIN\\group1. Can only be set if Authentication is set to ActiveDirectory.

" }, "InvalidUserList":{ "shape":"FileShareUserList", - "documentation":"

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

" + "documentation":"

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\\User1, user1, @group1, and @DOMAIN\\group1. Can only be set if Authentication is set to ActiveDirectory.

" }, "AuditDestinationARN":{ "shape":"AuditDestinationARN", "documentation":"

The Amazon Resource Name (ARN) of the storage used for the audit logs.

" }, "Authentication":{"shape":"Authentication"}, + "CaseSensitivity":{ + "shape":"CaseSensitivity", + "documentation":"

The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.

" + }, "Tags":{ "shape":"Tags", "documentation":"

A list of up to 50 tags assigned to the SMB file share, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation.

" + }, + "FileShareName":{ + "shape":"FileShareName", + "documentation":"

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN.

" + }, + "CacheAttributes":{ + "shape":"CacheAttributes", + "documentation":"

Refresh cache information.

" } }, "documentation":"

The Windows file permissions and ownership information assigned, by default, to native S3 objects when file gateway discovers them in S3 buckets. This operation is only supported for file gateways.

" @@ -4631,6 +4698,14 @@ "RequesterPays":{ "shape":"Boolean", "documentation":"

A value that sets who pays the cost of the request and the cost associated with data download from the S3 bucket. If this value is set to true, the requester pays the costs; otherwise, the S3 bucket owner pays. However, the S3 bucket owner always pays the cost of storing data.

RequesterPays is a configuration for the S3 bucket that backs the file share, so make sure that the configuration on the file share is the same as the S3 bucket configuration.

Valid Values: true | false

" + }, + "FileShareName":{ + "shape":"FileShareName", + "documentation":"

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN.

" + }, + "CacheAttributes":{ + "shape":"CacheAttributes", + "documentation":"

Refresh cache information.

" } }, "documentation":"

UpdateNFSFileShareInput

" @@ -4687,19 +4762,31 @@ }, "AdminUserList":{ "shape":"FileShareUserList", - "documentation":"

A list of users in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. For example, @group1. Can only be set if Authentication is set to ActiveDirectory.

" + "documentation":"

A list of users or groups in the Active Directory that have administrator rights to the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\\User1, user1, @group1, and @DOMAIN\\group1. Can only be set if Authentication is set to ActiveDirectory.

" }, "ValidUserList":{ "shape":"FileShareUserList", - "documentation":"

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. For example, @group1. Can only be set if Authentication is set to ActiveDirectory.

" + "documentation":"

A list of users or groups in the Active Directory that are allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\\User1, user1, @group1, and @DOMAIN\\group1. Can only be set if Authentication is set to ActiveDirectory.

" }, "InvalidUserList":{ "shape":"FileShareUserList", - "documentation":"

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. For example @group1. Can only be set if Authentication is set to ActiveDirectory.

" + "documentation":"

A list of users or groups in the Active Directory that are not allowed to access the file share. A group must be prefixed with the @ character. Acceptable formats include: DOMAIN\\User1, user1, @group1, and @DOMAIN\\group1. Can only be set if Authentication is set to ActiveDirectory.

" }, "AuditDestinationARN":{ "shape":"AuditDestinationARN", "documentation":"

The Amazon Resource Name (ARN) of the storage used for the audit logs.

" + }, + "CaseSensitivity":{ + "shape":"CaseSensitivity", + "documentation":"

The case of an object name in an Amazon S3 bucket. For ClientSpecified, the client determines the case sensitivity. For CaseSensitive, the gateway determines the case sensitivity. The default value is ClientSpecified.

" + }, + "FileShareName":{ + "shape":"FileShareName", + "documentation":"

The name of the file share. Optional.

FileShareName must be set if an S3 prefix name is set in LocationARN.

" + }, + "CacheAttributes":{ + "shape":"CacheAttributes", + "documentation":"

Refresh cache information.

" } }, "documentation":"

UpdateSMBFileShareInput

" diff --git a/botocore/data/wafv2/2019-07-29/service-2.json b/botocore/data/wafv2/2019-07-29/service-2.json index 6b2dbf9d..24907c7a 100644 --- a/botocore/data/wafv2/2019-07-29/service-2.json +++ b/botocore/data/wafv2/2019-07-29/service-2.json @@ -548,7 +548,7 @@ {"shape":"WAFTagOperationInternalErrorException"}, {"shape":"WAFInvalidOperationException"} ], - "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves the TagInfoForResource for the specified resource.

" + "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.

" }, "ListWebACLs":{ "name":"ListWebACLs", @@ -579,9 +579,10 @@ {"shape":"WAFOptimisticLockException"}, {"shape":"WAFServiceLinkedRoleErrorException"}, {"shape":"WAFInvalidParameterException"}, - {"shape":"WAFInvalidOperationException"} + {"shape":"WAFInvalidOperationException"}, + {"shape":"WAFLimitsExceededException"} ], - "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.

You can access information about all traffic that AWS WAF inspects using the following steps:

  1. Create an Amazon Kinesis Data Firehose.

    Create the data firehose with a PUT source and in the Region that you are operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

    Do not create the data firehose using a Kinesis stream as your source.

  2. Associate that firehose to your web ACL using a PutLoggingConfiguration request.

When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.

" + "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.

You can access information about all traffic that AWS WAF inspects using the following steps:

  1. Create an Amazon Kinesis Data Firehose.

    Create the data firehose with a PUT source and in the Region that you are operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

    Give the data firehose a name that starts with the prefix aws-waf-logs-. For example, aws-waf-logs-us-east-2-analytics.

    Do not create the data firehose using a Kinesis stream as your source.

  2. Associate that firehose to your web ACL using a PutLoggingConfiguration request.

When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.

" }, "PutPermissionPolicy":{ "name":"PutPermissionPolicy", @@ -616,7 +617,7 @@ {"shape":"WAFTagOperationInternalErrorException"}, {"shape":"WAFInvalidOperationException"} ], - "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Associates tags with the specified AWS resource. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be \"customer\" and the tag value might be \"companyA.\" You can specify one or more tags to add to each container. You can add up to 50 tags to each AWS resource.

" + "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.

" }, "UntagResource":{ "name":"UntagResource", @@ -1579,6 +1580,13 @@ "type":"list", "member":{"shape":"ExcludedRule"} }, + "FallbackBehavior":{ + "type":"string", + "enum":[ + "MATCH", + "NO_MATCH" + ] + }, "FieldToMatch":{ "type":"structure", "members":{ @@ -1658,12 +1666,48 @@ }, "documentation":"

The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

" }, + "ForwardedIPConfig":{ + "type":"structure", + "required":[ + "HeaderName", + "FallbackBehavior" + ], + "members":{ + "HeaderName":{ + "shape":"ForwardedIPHeaderName", + "documentation":"

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

" + }, + "FallbackBehavior":{ + "shape":"FallbackBehavior", + "documentation":"

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

You can specify the following fallback behaviors:

  • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.

  • NO_MATCH - Treat the web request as not matching the rule statement.

" + } + }, + "documentation":"

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.

AWS WAF only evaluates the first IP address found in the specified HTTP header.

" + }, + "ForwardedIPHeaderName":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9-]+$" + }, + "ForwardedIPPosition":{ + "type":"string", + "enum":[ + "FIRST", + "LAST", + "ANY" + ] + }, "GeoMatchStatement":{ "type":"structure", "members":{ "CountryCodes":{ "shape":"CountryCodes", "documentation":"

An array of two-character country codes, for example, [ \"US\", \"CN\" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.

" + }, + "ForwardedIPConfig":{ + "shape":"ForwardedIPConfig", + "documentation":"

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

" } }, "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

A rule statement used to identify web requests based on country of origin.

" @@ -1875,7 +1919,7 @@ }, "TimeWindow":{ "shape":"TimeWindow", - "documentation":"

The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. Specify the date and time in the following format: \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

" + "documentation":"

The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

" }, "MaxItems":{ "shape":"ListMaxItems", @@ -1896,7 +1940,7 @@ }, "TimeWindow":{ "shape":"TimeWindow", - "documentation":"

Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests.

" + "documentation":"

Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.

" } } }, @@ -2060,6 +2104,29 @@ }, "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Contains one or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports any CIDR range. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

AWS WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.

" }, + "IPSetForwardedIPConfig":{ + "type":"structure", + "required":[ + "HeaderName", + "FallbackBehavior", + "Position" + ], + "members":{ + "HeaderName":{ + "shape":"ForwardedIPHeaderName", + "documentation":"

The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

" + }, + "FallbackBehavior":{ + "shape":"FallbackBehavior", + "documentation":"

The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

You can specify the following fallback behaviors:

  • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.

  • NO_MATCH - Treat the web request as not matching the rule statement.

" + }, + "Position":{ + "shape":"ForwardedIPPosition", + "documentation":"

The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

The options for this setting are the following:

  • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

  • LAST - Inspect the last IP address in the list of IP addresses in the header.

  • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.

" + } + }, + "documentation":"

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.

" + }, "IPSetReferenceStatement":{ "type":"structure", "required":["ARN"], @@ -2067,6 +2134,10 @@ "ARN":{ "shape":"ResourceArn", "documentation":"

The Amazon Resource Name (ARN) of the IPSet that this statement references.

" + }, + "IPSetForwardedIPConfig":{ + "shape":"IPSetForwardedIPConfig", + "documentation":"

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

" } }, "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

" @@ -2533,7 +2604,12 @@ "TAGS", "TAG_KEYS", "METRIC_NAME", - "FIREWALL_MANAGER_STATEMENT" + "FIREWALL_MANAGER_STATEMENT", + "FALLBACK_BEHAVIOR", + "POSITION", + "FORWARDED_IP_CONFIG", + "IP_SET_FORWARDED_IP_CONFIG", + "HEADER_NAME" ] }, "ParameterExceptionParameter":{ @@ -2611,22 +2687,29 @@ "members":{ "Limit":{ "shape":"RateLimit", - "documentation":"

The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopDownStatement, this limit is applied only to the requests that match the statement.

" + "documentation":"

The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

" }, "AggregateKeyType":{ "shape":"RateBasedStatementAggregateKeyType", - "documentation":"

Setting that indicates how to aggregate the request counts. Currently, you must set this to IP. The request counts are aggregated on IP addresses.

" + "documentation":"

Setting that indicates how to aggregate the request counts. The options are the following:

  • IP - Aggregate the request counts on the IP address from the web request origin.

  • FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig, to specify the header to use.

" }, "ScopeDownStatement":{ "shape":"Statement", "documentation":"

An optional nested statement that narrows the scope of the rate-based statement to matching web requests. This can be any nestable statement, and you can nest statements at any level below this scope-down statement.

" + }, + "ForwardedIPConfig":{ + "shape":"ForwardedIPConfig", + "documentation":"

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

This is required if AggregateKeyType is set to FORWARDED_IP.

" } }, "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.

You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

  • An IP match statement with an IP set that specified the address 192.0.2.44.

  • A string match statement that searches in the User-Agent header for the string BadBot.

In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

" }, "RateBasedStatementAggregateKeyType":{ "type":"string", - "enum":["IP"] + "enum":[ + "IP", + "FORWARDED_IP" + ] }, "RateBasedStatementManagedKeysIPSet":{ "type":"structure", @@ -3125,7 +3208,7 @@ "documentation":"

Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as \"companyA\" or \"companyB.\" Tag values are case-sensitive.

" } }, - "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as \"environment\") and the tag value represents a specific value within that category (such as \"test,\" \"development,\" or \"production\"). You can add up to 50 tags to each AWS resource.

" + "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.

" }, "TagInfoForResource":{ "type":"structure", @@ -3139,7 +3222,7 @@ "documentation":"

The array of Tag objects defined for the resource.

" } }, - "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

The collection of tagging definitions for an AWS resource.

" + "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

The collection of tagging definitions for an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as \"environment\", and the tag value represents a specific value within that category, such as \"test,\" \"development,\" or \"production\". Or you might set the tag key to \"customer\" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console.

" }, "TagKey":{ "type":"string", @@ -3232,14 +3315,14 @@ "members":{ "StartTime":{ "shape":"Timestamp", - "documentation":"

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

" + "documentation":"

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

" }, "EndTime":{ "shape":"Timestamp", - "documentation":"

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

" + "documentation":"

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

" } }, - "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests.

In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request.

" + "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests.

You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, \"2016-09-27T14:50Z\". You can specify any time range in the previous three hours.

In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request.

" }, "Timestamp":{"type":"timestamp"}, "URIString":{"type":"string"}, @@ -3488,7 +3571,7 @@ }, "MetricName":{ "shape":"MetricName", - "documentation":"

A name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default_Action.\" You can't change a MetricName after you create a VisibilityConfig.

" + "documentation":"

A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example \"All\" and \"Default_Action.\" You can't change a MetricName after you create a VisibilityConfig.

" } }, "documentation":"

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Defines and enables Amazon CloudWatch metrics and web request sample collection.

" diff --git a/botocore/eventstream.py b/botocore/eventstream.py index ddb822dd..91e88b6c 100644 --- a/botocore/eventstream.py +++ b/botocore/eventstream.py @@ -83,6 +83,7 @@ class DecodeUtils(object): UINT8_BYTE_FORMAT = '!B' UINT16_BYTE_FORMAT = '!H' UINT32_BYTE_FORMAT = '!I' + INT8_BYTE_FORMAT = '!b' INT16_BYTE_FORMAT = '!h' INT32_BYTE_FORMAT = '!i' INT64_BYTE_FORMAT = '!q' @@ -147,6 +148,19 @@ class DecodeUtils(object): value = unpack(DecodeUtils.UINT32_BYTE_FORMAT, data[:4])[0] return value, 4 + @staticmethod + def unpack_int8(data): + """Parse a signed 8-bit integer from the bytes. + + :type data: bytes + :param data: The bytes to parse from. + + :rtype: (int, int) + :returns: A tuple containing the (parsed integer value, bytes consumed) + """ + value = unpack(DecodeUtils.INT8_BYTE_FORMAT, data[:1])[0] + return value, 1 + @staticmethod def unpack_int16(data): """Parse a signed 16-bit integer from the bytes. @@ -349,7 +363,7 @@ class EventStreamHeaderParser(object): # boolean_false 1: DecodeUtils.unpack_false, # byte - 2: DecodeUtils.unpack_uint8, + 2: DecodeUtils.unpack_int8, # short 3: DecodeUtils.unpack_int16, # integer diff --git a/botocore/handlers.py b/botocore/handlers.py index bf8cf9f2..2c15e635 100644 --- a/botocore/handlers.py +++ b/botocore/handlers.py @@ -1049,12 +1049,22 @@ BUILTIN_HANDLERS = [ ('before-call.neptune.CreateDBCluster', inject_presigned_url_rds), - # RDS PresignedUrl documentation customizations + # Neptune PresignedUrl documentation customizations ('docs.*.neptune.CopyDBClusterSnapshot.complete-section', AutoPopulatedParam('PreSignedUrl').document_auto_populated_param), ('docs.*.neptune.CreateDBCluster.complete-section', AutoPopulatedParam('PreSignedUrl').document_auto_populated_param), + ############# + # DocDB + ############# + ('before-call.docdb.CopyDBClusterSnapshot', + inject_presigned_url_rds), + + # DocDB PresignedUrl documentation customizations + ('docs.*.docdb.CopyDBClusterSnapshot.complete-section', + AutoPopulatedParam('PreSignedUrl').document_auto_populated_param), + ############# # S3 Control ############# diff --git a/docs/source/conf.py b/docs/source/conf.py index ff082b51..ec79916d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -52,9 +52,9 @@ copyright = u'2013, Mitch Garnaat' # built documents. # # The short X.Y version. -version = '1.17' +version = '1.17.' # The full version, including alpha/beta/rc tags. -release = '1.17.9' +release = '1.17.22' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/tests/functional/test_docdb.py b/tests/functional/test_docdb.py new file mode 100644 index 00000000..55dc2bef --- /dev/null +++ b/tests/functional/test_docdb.py @@ -0,0 +1,49 @@ +# Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"). You +# may not use this file except in compliance with the License. A copy of +# the License is located at +# +# http://aws.amazon.com/apache2.0/ +# +# or in the "license" file accompanying this file. This file is +# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF +# ANY KIND, either express or implied. See the License for the specific +# language governing permissions and limitations under the License. +import mock +from contextlib import contextmanager + +import botocore.session +from tests import BaseSessionTest, ClientHTTPStubber +from botocore.stub import Stubber +from tests import unittest + + +class TestDocDBPresignUrlInjection(BaseSessionTest): + + def setUp(self): + super(TestDocDBPresignUrlInjection, self).setUp() + self.client = self.session.create_client('docdb', 'us-west-2') + self.http_stubber = ClientHTTPStubber(self.client) + + def assert_presigned_url_injected_in_request(self, body): + self.assertIn('PreSignedUrl', body) + self.assertNotIn('SourceRegion', body) + + def test_copy_db_cluster_snapshot(self): + params = { + 'SourceDBClusterSnapshotIdentifier': 'source-db', + 'TargetDBClusterSnapshotIdentifier': 'target-db', + 'SourceRegion': 'us-east-1' + } + response_body = ( + b'' + b'' + b'' + b'' + ) + self.http_stubber.add_response(body=response_body) + with self.http_stubber: + self.client.copy_db_cluster_snapshot(**params) + sent_request = self.http_stubber.requests[0] + self.assert_presigned_url_injected_in_request(sent_request.body) diff --git a/tests/unit/test_eventstream.py b/tests/unit/test_eventstream.py index 595cec96..7b921980 100644 --- a/tests/unit/test_eventstream.py +++ b/tests/unit/test_eventstream.py @@ -38,18 +38,71 @@ EMPTY_MESSAGE = ( ) ) -INT32_HEADER = ( - (b"\x00\x00\x00+\x00\x00\x00\x0e4\x8b\xec{\x08event-id\x04\x00\x00\xa0\x0c" - b"{'foo':'bar'}\xd3\x89\x02\x85"), +INT8_HEADER = ( + ( + b"\x00\x00\x00\x17\x00\x00\x00\x07)\x86\x01X\x04" + b"byte\x02\xff\xc2\xf8i\xdc" + ), EventStreamMessage( prelude=MessagePrelude( - total_length=0x2b, - headers_length=0x0e, - crc=0x348bec7b, + total_length=0x17, + headers_length=0x7, + crc=0x29860158, ), - headers={'event-id': 0x0000a00c}, - payload=b"{'foo':'bar'}", - crc=0xd3890285, + headers={'byte': -1}, + payload=b'', + crc=0xc2f869dc, + ) +) + +INT16_HEADER = ( + ( + b"\x00\x00\x00\x19\x00\x00\x00\tq\x0e\x92>\x05" + b"short\x03\xff\xff\xb2|\xb6\xcc" + ), + EventStreamMessage( + prelude=MessagePrelude( + total_length=0x19, + headers_length=0x9, + crc=0x710e923e, + ), + headers={'short': -1}, + payload=b'', + crc=0xb27cb6cc, + ) +) + +INT32_HEADER = ( + ( + b"\x00\x00\x00\x1d\x00\x00\x00\r\x83\xe3\xf0\xe7\x07" + b"integer\x04\xff\xff\xff\xff\x8b\x8e\x12\xeb" + ), + EventStreamMessage( + prelude=MessagePrelude( + total_length=0x1D, + headers_length=0xD, + crc=0x83e3f0e7, + ), + headers={'integer': -1}, + payload=b'', + crc=0x8b8e12eb, + ) +) + +INT64_HEADER = ( + ( + b"\x00\x00\x00\x1e\x00\x00\x00\x0e]J\xdb\x8d\x04" + b"long\x05\xff\xff\xff\xff\xff\xff\xff\xffK\xc22\xda" + ), + EventStreamMessage( + prelude=MessagePrelude( + total_length=0x1E, + headers_length=0xE, + crc=0x5d4adb8d, + ), + headers={'long': -1}, + payload=b'', + crc=0x4bc232da, ) ) @@ -137,7 +190,10 @@ ERROR_EVENT_MESSAGE = ( # Tuples of encoded messages and their expected decoded output POSITIVE_CASES = [ EMPTY_MESSAGE, + INT8_HEADER, + INT16_HEADER, INT32_HEADER, + INT64_HEADER, PAYLOAD_NO_HEADERS, PAYLOAD_ONE_STR_HEADER, ALL_HEADERS_TYPES, @@ -286,9 +342,10 @@ def test_message_prelude_properties(): def test_message_to_response_dict(): - response_dict = INT32_HEADER[1].to_response_dict() + response_dict = PAYLOAD_ONE_STR_HEADER[1].to_response_dict() assert_equal(response_dict['status_code'], 200) - assert_equal(response_dict['headers'], {'event-id': 0x0000a00c}) + expected_headers = {'content-type': 'application/json'} + assert_equal(response_dict['headers'], expected_headers) assert_equal(response_dict['body'], b"{'foo':'bar'}") @@ -316,6 +373,12 @@ def test_unpack_uint32(): assert_equal(value, 0xDEADBEEF) +def test_unpack_int8(): + (value, bytes_consumed) = DecodeUtils.unpack_int8(b'\xFE') + assert_equal(bytes_consumed, 1) + assert_equal(value, -2) + + def test_unpack_int16(): (value, bytes_consumed) = DecodeUtils.unpack_int16(b'\xFF\xFE') assert_equal(bytes_consumed, 2)