New upstream version 1.5.75
This commit is contained in:
TANIGUCHI Takaki
parent
a73c3c192a
commit
ed839048df
21
PKG-INFO
21
PKG-INFO
|
|
@ -1,6 +1,6 @@
|
|||
Metadata-Version: 1.1
|
||||
Name: botocore
|
||||
Version: 1.5.7
|
||||
Version: 1.5.75
|
||||
Summary: Low-level, data-driven core of boto 3.
|
||||
Home-page: https://github.com/boto/botocore
|
||||
Author: Amazon Web Services
|
||||
|
|
@ -21,7 +21,24 @@ Description: botocore
|
|||
`AWS CLI <https://github.com/aws/aws-cli>`__ as well as
|
||||
`boto3 <https://github.com/boto/boto3>`__.
|
||||
|
||||
`Documentation <https://botocore.readthedocs.io/en/latest/>`__
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
Documentation for ``botocore`` can be found on `Read the Docs <https://botocore.readthedocs.io/en/latest/>`__.
|
||||
|
||||
|
||||
Getting Help
|
||||
------------
|
||||
|
||||
We use GitHub issues for tracking bugs and feature requests and have limited
|
||||
bandwidth to address them. Please use these community resources for getting
|
||||
help. Please note many of the same resources available for ``boto3`` are
|
||||
applicable for ``botocore``:
|
||||
|
||||
* Ask a question on `Stack Overflow <https://stackoverflow.com/>`__ and tag it with `boto3 <https://stackoverflow.com/questions/tagged/boto3>`__
|
||||
* Come join the AWS Python community chat on `gitter <https://gitter.im/boto/boto3>`__
|
||||
* Open a support ticket with `AWS Support <https://console.aws.amazon.com/support/home#/>`__
|
||||
* If it turns out that you may have found a bug, please `open an issue <https://github.com/boto/botocore/issues/new>`__
|
||||
|
||||
Platform: UNKNOWN
|
||||
Classifier: Development Status :: 5 - Production/Stable
|
||||
|
|
|
|||
19
README.rst
19
README.rst
|
|
@ -13,4 +13,21 @@ botocore package is the foundation for the
|
|||
`AWS CLI <https://github.com/aws/aws-cli>`__ as well as
|
||||
`boto3 <https://github.com/boto/boto3>`__.
|
||||
|
||||
`Documentation <https://botocore.readthedocs.io/en/latest/>`__
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
Documentation for ``botocore`` can be found on `Read the Docs <https://botocore.readthedocs.io/en/latest/>`__.
|
||||
|
||||
|
||||
Getting Help
|
||||
------------
|
||||
|
||||
We use GitHub issues for tracking bugs and feature requests and have limited
|
||||
bandwidth to address them. Please use these community resources for getting
|
||||
help. Please note many of the same resources available for ``boto3`` are
|
||||
applicable for ``botocore``:
|
||||
|
||||
* Ask a question on `Stack Overflow <https://stackoverflow.com/>`__ and tag it with `boto3 <https://stackoverflow.com/questions/tagged/boto3>`__
|
||||
* Come join the AWS Python community chat on `gitter <https://gitter.im/boto/boto3>`__
|
||||
* Open a support ticket with `AWS Support <https://console.aws.amazon.com/support/home#/>`__
|
||||
* If it turns out that you may have found a bug, please `open an issue <https://github.com/boto/botocore/issues/new>`__
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
Metadata-Version: 1.1
|
||||
Name: botocore
|
||||
Version: 1.5.7
|
||||
Version: 1.5.75
|
||||
Summary: Low-level, data-driven core of boto 3.
|
||||
Home-page: https://github.com/boto/botocore
|
||||
Author: Amazon Web Services
|
||||
|
|
@ -21,7 +21,24 @@ Description: botocore
|
|||
`AWS CLI <https://github.com/aws/aws-cli>`__ as well as
|
||||
`boto3 <https://github.com/boto/boto3>`__.
|
||||
|
||||
`Documentation <https://botocore.readthedocs.io/en/latest/>`__
|
||||
|
||||
Documentation
|
||||
-------------
|
||||
Documentation for ``botocore`` can be found on `Read the Docs <https://botocore.readthedocs.io/en/latest/>`__.
|
||||
|
||||
|
||||
Getting Help
|
||||
------------
|
||||
|
||||
We use GitHub issues for tracking bugs and feature requests and have limited
|
||||
bandwidth to address them. Please use these community resources for getting
|
||||
help. Please note many of the same resources available for ``boto3`` are
|
||||
applicable for ``botocore``:
|
||||
|
||||
* Ask a question on `Stack Overflow <https://stackoverflow.com/>`__ and tag it with `boto3 <https://stackoverflow.com/questions/tagged/boto3>`__
|
||||
* Come join the AWS Python community chat on `gitter <https://gitter.im/boto/boto3>`__
|
||||
* Open a support ticket with `AWS Support <https://console.aws.amazon.com/support/home#/>`__
|
||||
* If it turns out that you may have found a bug, please `open an issue <https://github.com/boto/botocore/issues/new>`__
|
||||
|
||||
Platform: UNKNOWN
|
||||
Classifier: Development Status :: 5 - Production/Stable
|
||||
|
|
|
|||
|
|
@ -40,18 +40,32 @@ botocore.egg-info/requires.txt
|
|||
botocore.egg-info/top_level.txt
|
||||
botocore/data/_retry.json
|
||||
botocore/data/endpoints.json
|
||||
botocore/data/acm/2015-12-08/examples-1.json
|
||||
botocore/data/acm/2015-12-08/paginators-1.json
|
||||
botocore/data/acm/2015-12-08/service-2.json
|
||||
botocore/data/apigateway/2015-07-09/examples-1.json
|
||||
botocore/data/apigateway/2015-07-09/paginators-1.json
|
||||
botocore/data/apigateway/2015-07-09/service-2.json
|
||||
botocore/data/application-autoscaling/2016-02-06/examples-1.json
|
||||
botocore/data/application-autoscaling/2016-02-06/paginators-1.json
|
||||
botocore/data/application-autoscaling/2016-02-06/service-2.json
|
||||
botocore/data/appstream/2016-12-01/examples-1.json
|
||||
botocore/data/appstream/2016-12-01/paginators-1.json
|
||||
botocore/data/appstream/2016-12-01/service-2.json
|
||||
botocore/data/athena/2017-05-18/paginators-1.json
|
||||
botocore/data/athena/2017-05-18/service-2.json
|
||||
botocore/data/autoscaling/2011-01-01/examples-1.json
|
||||
botocore/data/autoscaling/2011-01-01/paginators-1.json
|
||||
botocore/data/autoscaling/2011-01-01/service-2.json
|
||||
botocore/data/batch/2016-08-10/examples-1.json
|
||||
botocore/data/batch/2016-08-10/paginators-1.json
|
||||
botocore/data/batch/2016-08-10/service-2.json
|
||||
botocore/data/budgets/2016-10-20/examples-1.json
|
||||
botocore/data/budgets/2016-10-20/paginators-1.json
|
||||
botocore/data/budgets/2016-10-20/service-2.json
|
||||
botocore/data/clouddirectory/2016-05-10/paginators-1.json
|
||||
botocore/data/clouddirectory/2016-05-10/service-2.json
|
||||
botocore/data/cloudformation/2010-05-15/examples-1.json
|
||||
botocore/data/cloudformation/2010-05-15/paginators-1.json
|
||||
botocore/data/cloudformation/2010-05-15/service-2.json
|
||||
botocore/data/cloudformation/2010-05-15/waiters-2.json
|
||||
|
|
@ -91,39 +105,80 @@ botocore/data/cloudfront/2016-09-07/waiters-2.json
|
|||
botocore/data/cloudfront/2016-09-29/paginators-1.json
|
||||
botocore/data/cloudfront/2016-09-29/service-2.json
|
||||
botocore/data/cloudfront/2016-09-29/waiters-2.json
|
||||
botocore/data/cloudfront/2016-11-25/examples-1.json
|
||||
botocore/data/cloudfront/2016-11-25/paginators-1.json
|
||||
botocore/data/cloudfront/2016-11-25/service-2.json
|
||||
botocore/data/cloudfront/2016-11-25/waiters-2.json
|
||||
botocore/data/cloudfront/2017-03-25/examples-1.json
|
||||
botocore/data/cloudfront/2017-03-25/paginators-1.json
|
||||
botocore/data/cloudfront/2017-03-25/service-2.json
|
||||
botocore/data/cloudfront/2017-03-25/waiters-2.json
|
||||
botocore/data/cloudhsm/2014-05-30/examples-1.json
|
||||
botocore/data/cloudhsm/2014-05-30/service-2.json
|
||||
botocore/data/cloudsearch/2011-02-01/service-2.json
|
||||
botocore/data/cloudsearch/2013-01-01/paginators-1.json
|
||||
botocore/data/cloudsearch/2013-01-01/service-2.json
|
||||
botocore/data/cloudsearchdomain/2013-01-01/examples-1.json
|
||||
botocore/data/cloudsearchdomain/2013-01-01/service-2.json
|
||||
botocore/data/cloudtrail/2013-11-01/examples-1.json
|
||||
botocore/data/cloudtrail/2013-11-01/paginators-1.json
|
||||
botocore/data/cloudtrail/2013-11-01/service-2.json
|
||||
botocore/data/cloudwatch/2010-08-01/examples-1.json
|
||||
botocore/data/cloudwatch/2010-08-01/paginators-1.json
|
||||
botocore/data/cloudwatch/2010-08-01/service-2.json
|
||||
botocore/data/cloudwatch/2010-08-01/waiters-2.json
|
||||
botocore/data/codebuild/2016-10-06/examples-1.json
|
||||
botocore/data/codebuild/2016-10-06/paginators-1.json
|
||||
botocore/data/codebuild/2016-10-06/service-2.json
|
||||
botocore/data/codecommit/2015-04-13/examples-1.json
|
||||
botocore/data/codecommit/2015-04-13/paginators-1.json
|
||||
botocore/data/codecommit/2015-04-13/service-2.json
|
||||
botocore/data/codedeploy/2014-10-06/examples-1.json
|
||||
botocore/data/codedeploy/2014-10-06/paginators-1.json
|
||||
botocore/data/codedeploy/2014-10-06/service-2.json
|
||||
botocore/data/codedeploy/2014-10-06/waiters-2.json
|
||||
botocore/data/codepipeline/2015-07-09/examples-1.json
|
||||
botocore/data/codepipeline/2015-07-09/paginators-1.json
|
||||
botocore/data/codepipeline/2015-07-09/service-2.json
|
||||
botocore/data/codestar/2017-04-19/paginators-1.json
|
||||
botocore/data/codestar/2017-04-19/service-2.json
|
||||
botocore/data/cognito-identity/2014-06-30/examples-1.json
|
||||
botocore/data/cognito-identity/2014-06-30/paginators-1.json
|
||||
botocore/data/cognito-identity/2014-06-30/service-2.json
|
||||
botocore/data/cognito-idp/2016-04-18/examples-1.json
|
||||
botocore/data/cognito-idp/2016-04-18/paginators-1.json
|
||||
botocore/data/cognito-idp/2016-04-18/service-2.json
|
||||
botocore/data/cognito-sync/2014-06-30/service-2.json
|
||||
botocore/data/config/2014-11-12/examples-1.json
|
||||
botocore/data/config/2014-11-12/paginators-1.json
|
||||
botocore/data/config/2014-11-12/service-2.json
|
||||
botocore/data/cur/2017-01-06/examples-1.json
|
||||
botocore/data/cur/2017-01-06/paginators-1.json
|
||||
botocore/data/cur/2017-01-06/service-2.json
|
||||
botocore/data/datapipeline/2012-10-29/paginators-1.json
|
||||
botocore/data/datapipeline/2012-10-29/service-2.json
|
||||
botocore/data/dax/2017-04-19/paginators-1.json
|
||||
botocore/data/dax/2017-04-19/service-2.json
|
||||
botocore/data/devicefarm/2015-06-23/examples-1.json
|
||||
botocore/data/devicefarm/2015-06-23/paginators-1.json
|
||||
botocore/data/devicefarm/2015-06-23/service-2.json
|
||||
botocore/data/directconnect/2012-10-25/examples-1.json
|
||||
botocore/data/directconnect/2012-10-25/paginators-1.json
|
||||
botocore/data/directconnect/2012-10-25/service-2.json
|
||||
botocore/data/discovery/2015-11-01/examples-1.json
|
||||
botocore/data/discovery/2015-11-01/paginators-1.json
|
||||
botocore/data/discovery/2015-11-01/service-2.json
|
||||
botocore/data/dms/2016-01-01/examples-1.json
|
||||
botocore/data/dms/2016-01-01/paginators-1.json
|
||||
botocore/data/dms/2016-01-01/service-2.json
|
||||
botocore/data/ds/2015-04-16/examples-1.json
|
||||
botocore/data/ds/2015-04-16/service-2.json
|
||||
botocore/data/dynamodb/2012-08-10/examples-1.json
|
||||
botocore/data/dynamodb/2012-08-10/paginators-1.json
|
||||
botocore/data/dynamodb/2012-08-10/service-2.json
|
||||
botocore/data/dynamodb/2012-08-10/waiters-2.json
|
||||
botocore/data/dynamodbstreams/2012-08-10/examples-1.json
|
||||
botocore/data/dynamodbstreams/2012-08-10/paginators-1.json
|
||||
botocore/data/dynamodbstreams/2012-08-10/service-2.json
|
||||
botocore/data/ec2/2014-09-01/paginators-1.json
|
||||
botocore/data/ec2/2014-09-01/service-2.json
|
||||
|
|
@ -151,11 +206,15 @@ botocore/data/ec2/2016-11-15/examples-1.json
|
|||
botocore/data/ec2/2016-11-15/paginators-1.json
|
||||
botocore/data/ec2/2016-11-15/service-2.json
|
||||
botocore/data/ec2/2016-11-15/waiters-2.json
|
||||
botocore/data/ecr/2015-09-21/examples-1.json
|
||||
botocore/data/ecr/2015-09-21/paginators-1.json
|
||||
botocore/data/ecr/2015-09-21/service-2.json
|
||||
botocore/data/ecs/2014-11-13/examples-1.json
|
||||
botocore/data/ecs/2014-11-13/paginators-1.json
|
||||
botocore/data/ecs/2014-11-13/service-2.json
|
||||
botocore/data/ecs/2014-11-13/waiters-2.json
|
||||
botocore/data/efs/2015-02-01/examples-1.json
|
||||
botocore/data/efs/2015-02-01/paginators-1.json
|
||||
botocore/data/efs/2015-02-01/service-2.json
|
||||
botocore/data/elasticache/2014-09-30/paginators-1.json
|
||||
botocore/data/elasticache/2014-09-30/service-2.json
|
||||
|
|
@ -166,104 +225,186 @@ botocore/data/elasticache/2015-02-02/waiters-2.json
|
|||
botocore/data/elasticbeanstalk/2010-12-01/examples-1.json
|
||||
botocore/data/elasticbeanstalk/2010-12-01/paginators-1.json
|
||||
botocore/data/elasticbeanstalk/2010-12-01/service-2.json
|
||||
botocore/data/elastictranscoder/2012-09-25/examples-1.json
|
||||
botocore/data/elastictranscoder/2012-09-25/paginators-1.json
|
||||
botocore/data/elastictranscoder/2012-09-25/service-2.json
|
||||
botocore/data/elastictranscoder/2012-09-25/waiters-2.json
|
||||
botocore/data/elb/2012-06-01/examples-1.json
|
||||
botocore/data/elb/2012-06-01/paginators-1.json
|
||||
botocore/data/elb/2012-06-01/service-2.json
|
||||
botocore/data/elb/2012-06-01/waiters-2.json
|
||||
botocore/data/elbv2/2015-12-01/examples-1.json
|
||||
botocore/data/elbv2/2015-12-01/paginators-1.json
|
||||
botocore/data/elbv2/2015-12-01/service-2.json
|
||||
botocore/data/emr/2009-03-31/examples-1.json
|
||||
botocore/data/emr/2009-03-31/paginators-1.json
|
||||
botocore/data/emr/2009-03-31/service-2.json
|
||||
botocore/data/emr/2009-03-31/waiters-2.json
|
||||
botocore/data/es/2015-01-01/paginators-1.json
|
||||
botocore/data/es/2015-01-01/service-2.json
|
||||
botocore/data/events/2014-02-03/service-2.json
|
||||
botocore/data/events/2015-10-07/examples-1.json
|
||||
botocore/data/events/2015-10-07/paginators-1.json
|
||||
botocore/data/events/2015-10-07/service-2.json
|
||||
botocore/data/firehose/2015-08-04/examples-1.json
|
||||
botocore/data/firehose/2015-08-04/service-2.json
|
||||
botocore/data/gamelift/2015-10-01/examples-1.json
|
||||
botocore/data/gamelift/2015-10-01/paginators-1.json
|
||||
botocore/data/gamelift/2015-10-01/service-2.json
|
||||
botocore/data/glacier/2012-06-01/examples-1.json
|
||||
botocore/data/glacier/2012-06-01/paginators-1.json
|
||||
botocore/data/glacier/2012-06-01/service-2.json
|
||||
botocore/data/glacier/2012-06-01/waiters-2.json
|
||||
botocore/data/greengrass/2017-06-07/service-2.json
|
||||
botocore/data/health/2016-08-04/examples-1.json
|
||||
botocore/data/health/2016-08-04/paginators-1.json
|
||||
botocore/data/health/2016-08-04/service-2.json
|
||||
botocore/data/iam/2010-05-08/examples-1.json
|
||||
botocore/data/iam/2010-05-08/paginators-1.json
|
||||
botocore/data/iam/2010-05-08/service-2.json
|
||||
botocore/data/iam/2010-05-08/waiters-2.json
|
||||
botocore/data/importexport/2010-06-01/paginators-1.json
|
||||
botocore/data/importexport/2010-06-01/service-2.json
|
||||
botocore/data/inspector/2015-08-18/service-2.json
|
||||
botocore/data/inspector/2016-02-16/examples-1.json
|
||||
botocore/data/inspector/2016-02-16/paginators-1.json
|
||||
botocore/data/inspector/2016-02-16/service-2.json
|
||||
botocore/data/iot-data/2015-05-28/service-2.json
|
||||
botocore/data/iot/2015-05-28/examples-1.json
|
||||
botocore/data/iot/2015-05-28/paginators-1.json
|
||||
botocore/data/iot/2015-05-28/service-2.json
|
||||
botocore/data/kinesis/2013-12-02/examples-1.json
|
||||
botocore/data/kinesis/2013-12-02/paginators-1.json
|
||||
botocore/data/kinesis/2013-12-02/service-2.json
|
||||
botocore/data/kinesis/2013-12-02/waiters-2.json
|
||||
botocore/data/kinesisanalytics/2015-08-14/examples-1.json
|
||||
botocore/data/kinesisanalytics/2015-08-14/paginators-1.json
|
||||
botocore/data/kinesisanalytics/2015-08-14/service-2.json
|
||||
botocore/data/kms/2014-11-01/examples-1.json
|
||||
botocore/data/kms/2014-11-01/paginators-1.json
|
||||
botocore/data/kms/2014-11-01/service-2.json
|
||||
botocore/data/lambda/2014-11-11/service-2.json
|
||||
botocore/data/lambda/2015-03-31/examples-1.json
|
||||
botocore/data/lambda/2015-03-31/paginators-1.json
|
||||
botocore/data/lambda/2015-03-31/service-2.json
|
||||
botocore/data/lex-models/2017-04-19/paginators-1.json
|
||||
botocore/data/lex-models/2017-04-19/service-2.json
|
||||
botocore/data/lex-runtime/2016-11-28/paginators-1.json
|
||||
botocore/data/lex-runtime/2016-11-28/service-2.json
|
||||
botocore/data/lightsail/2016-11-28/examples-1.json
|
||||
botocore/data/lightsail/2016-11-28/paginators-1.json
|
||||
botocore/data/lightsail/2016-11-28/service-2.json
|
||||
botocore/data/logs/2014-03-28/examples-1.json
|
||||
botocore/data/logs/2014-03-28/paginators-1.json
|
||||
botocore/data/logs/2014-03-28/service-2.json
|
||||
botocore/data/machinelearning/2014-12-12/examples-1.json
|
||||
botocore/data/machinelearning/2014-12-12/paginators-1.json
|
||||
botocore/data/machinelearning/2014-12-12/service-2.json
|
||||
botocore/data/machinelearning/2014-12-12/waiters-2.json
|
||||
botocore/data/marketplace-entitlement/2017-01-11/paginators-1.json
|
||||
botocore/data/marketplace-entitlement/2017-01-11/service-2.json
|
||||
botocore/data/marketplacecommerceanalytics/2015-07-01/examples-1.json
|
||||
botocore/data/marketplacecommerceanalytics/2015-07-01/paginators-1.json
|
||||
botocore/data/marketplacecommerceanalytics/2015-07-01/service-2.json
|
||||
botocore/data/meteringmarketplace/2016-01-14/examples-1.json
|
||||
botocore/data/meteringmarketplace/2016-01-14/service-2.json
|
||||
botocore/data/mturk/2017-01-17/paginators-1.json
|
||||
botocore/data/mturk/2017-01-17/service-2.json
|
||||
botocore/data/opsworks/2013-02-18/examples-1.json
|
||||
botocore/data/opsworks/2013-02-18/paginators-1.json
|
||||
botocore/data/opsworks/2013-02-18/service-2.json
|
||||
botocore/data/opsworks/2013-02-18/waiters-2.json
|
||||
botocore/data/opsworkscm/2016-11-01/examples-1.json
|
||||
botocore/data/opsworkscm/2016-11-01/paginators-1.json
|
||||
botocore/data/opsworkscm/2016-11-01/service-2.json
|
||||
botocore/data/opsworkscm/2016-11-01/waiters-2.json
|
||||
botocore/data/organizations/2016-11-28/paginators-1.json
|
||||
botocore/data/organizations/2016-11-28/service-2.json
|
||||
botocore/data/pinpoint/2016-12-01/examples-1.json
|
||||
botocore/data/pinpoint/2016-12-01/service-2.json
|
||||
botocore/data/polly/2016-06-10/examples-1.json
|
||||
botocore/data/polly/2016-06-10/paginators-1.json
|
||||
botocore/data/polly/2016-06-10/service-2.json
|
||||
botocore/data/rds/2014-09-01/paginators-1.json
|
||||
botocore/data/rds/2014-09-01/service-2.json
|
||||
botocore/data/rds/2014-09-01/waiters-2.json
|
||||
botocore/data/rds/2014-10-31/examples-1.json
|
||||
botocore/data/rds/2014-10-31/paginators-1.json
|
||||
botocore/data/rds/2014-10-31/service-2.json
|
||||
botocore/data/rds/2014-10-31/service-2.sdk-extras.json
|
||||
botocore/data/rds/2014-10-31/waiters-2.json
|
||||
botocore/data/redshift/2012-12-01/examples-1.json
|
||||
botocore/data/redshift/2012-12-01/paginators-1.json
|
||||
botocore/data/redshift/2012-12-01/service-2.json
|
||||
botocore/data/redshift/2012-12-01/waiters-2.json
|
||||
botocore/data/rekognition/2016-06-27/examples-1.json
|
||||
botocore/data/rekognition/2016-06-27/paginators-1.json
|
||||
botocore/data/rekognition/2016-06-27/service-2.json
|
||||
botocore/data/resourcegroupstaggingapi/2017-01-26/paginators-1.json
|
||||
botocore/data/resourcegroupstaggingapi/2017-01-26/service-2.json
|
||||
botocore/data/route53/2013-04-01/examples-1.json
|
||||
botocore/data/route53/2013-04-01/paginators-1.json
|
||||
botocore/data/route53/2013-04-01/service-2.json
|
||||
botocore/data/route53/2013-04-01/waiters-2.json
|
||||
botocore/data/route53domains/2014-05-15/paginators-1.json
|
||||
botocore/data/route53domains/2014-05-15/service-2.json
|
||||
botocore/data/s3/2006-03-01/examples-1.json
|
||||
botocore/data/s3/2006-03-01/paginators-1.json
|
||||
botocore/data/s3/2006-03-01/service-2.json
|
||||
botocore/data/s3/2006-03-01/waiters-2.json
|
||||
botocore/data/sdb/2009-04-15/paginators-1.json
|
||||
botocore/data/sdb/2009-04-15/service-2.json
|
||||
botocore/data/servicecatalog/2015-12-10/examples-1.json
|
||||
botocore/data/servicecatalog/2015-12-10/paginators-1.json
|
||||
botocore/data/servicecatalog/2015-12-10/service-2.json
|
||||
botocore/data/ses/2010-12-01/examples-1.json
|
||||
botocore/data/ses/2010-12-01/paginators-1.json
|
||||
botocore/data/ses/2010-12-01/service-2.json
|
||||
botocore/data/ses/2010-12-01/waiters-2.json
|
||||
botocore/data/shield/2016-06-02/examples-1.json
|
||||
botocore/data/shield/2016-06-02/service-2.json
|
||||
botocore/data/sms/2016-10-24/examples-1.json
|
||||
botocore/data/sms/2016-10-24/paginators-1.json
|
||||
botocore/data/sms/2016-10-24/service-2.json
|
||||
botocore/data/snowball/2016-06-30/examples-1.json
|
||||
botocore/data/snowball/2016-06-30/paginators-1.json
|
||||
botocore/data/snowball/2016-06-30/service-2.json
|
||||
botocore/data/sns/2010-03-31/examples-1.json
|
||||
botocore/data/sns/2010-03-31/paginators-1.json
|
||||
botocore/data/sns/2010-03-31/service-2.json
|
||||
botocore/data/sqs/2012-11-05/examples-1.json
|
||||
botocore/data/sqs/2012-11-05/paginators-1.json
|
||||
botocore/data/sqs/2012-11-05/service-2.json
|
||||
botocore/data/ssm/2014-11-06/examples-1.json
|
||||
botocore/data/ssm/2014-11-06/paginators-1.json
|
||||
botocore/data/ssm/2014-11-06/service-2.json
|
||||
botocore/data/stepfunctions/2016-11-23/examples-1.json
|
||||
botocore/data/stepfunctions/2016-11-23/paginators-1.json
|
||||
botocore/data/stepfunctions/2016-11-23/service-2.json
|
||||
botocore/data/storagegateway/2013-06-30/examples-1.json
|
||||
botocore/data/storagegateway/2013-06-30/paginators-1.json
|
||||
botocore/data/storagegateway/2013-06-30/service-2.json
|
||||
botocore/data/sts/2011-06-15/examples-1.json
|
||||
botocore/data/sts/2011-06-15/paginators-1.json
|
||||
botocore/data/sts/2011-06-15/service-2.json
|
||||
botocore/data/support/2013-04-15/examples-1.json
|
||||
botocore/data/support/2013-04-15/paginators-1.json
|
||||
botocore/data/support/2013-04-15/service-2.json
|
||||
botocore/data/swf/2012-01-25/paginators-1.json
|
||||
botocore/data/swf/2012-01-25/service-2.json
|
||||
botocore/data/waf-regional/2016-11-28/examples-1.json
|
||||
botocore/data/waf-regional/2016-11-28/paginators-1.json
|
||||
botocore/data/waf-regional/2016-11-28/service-2.json
|
||||
botocore/data/waf/2015-08-24/examples-1.json
|
||||
botocore/data/waf/2015-08-24/paginators-1.json
|
||||
botocore/data/waf/2015-08-24/service-2.json
|
||||
botocore/data/workdocs/2016-05-01/paginators-1.json
|
||||
botocore/data/workdocs/2016-05-01/service-2.json
|
||||
botocore/data/workspaces/2015-04-08/examples-1.json
|
||||
botocore/data/workspaces/2015-04-08/paginators-1.json
|
||||
botocore/data/workspaces/2015-04-08/service-2.json
|
||||
botocore/data/xray/2016-04-12/examples-1.json
|
||||
botocore/data/xray/2016-04-12/paginators-1.json
|
||||
botocore/data/xray/2016-04-12/service-2.json
|
||||
botocore/docs/__init__.py
|
||||
botocore/docs/client.py
|
||||
|
|
@ -445,13 +586,16 @@ tests/functional/test_client_class_names.py
|
|||
tests/functional/test_client_metadata.py
|
||||
tests/functional/test_cloudformation.py
|
||||
tests/functional/test_cloudsearchdomain.py
|
||||
tests/functional/test_cognito_idp.py
|
||||
tests/functional/test_credentials.py
|
||||
tests/functional/test_ec2.py
|
||||
tests/functional/test_endpoints.py
|
||||
tests/functional/test_iot_data.py
|
||||
tests/functional/test_lex.py
|
||||
tests/functional/test_loaders.py
|
||||
tests/functional/test_machinelearning.py
|
||||
tests/functional/test_model_completeness.py
|
||||
tests/functional/test_mturk.py
|
||||
tests/functional/test_paginate.py
|
||||
tests/functional/test_paginator_config.py
|
||||
tests/functional/test_public_apis.py
|
||||
|
|
@ -459,6 +603,7 @@ tests/functional/test_rds.py
|
|||
tests/functional/test_regions.py
|
||||
tests/functional/test_s3.py
|
||||
tests/functional/test_session.py
|
||||
tests/functional/test_six_imports.py
|
||||
tests/functional/test_stub.py
|
||||
tests/functional/test_waiter_config.py
|
||||
tests/functional/docs/__init__.py
|
||||
|
|
@ -466,7 +611,9 @@ tests/functional/docs/test_alias.py
|
|||
tests/functional/docs/test_autoscaling.py
|
||||
tests/functional/docs/test_ec2.py
|
||||
tests/functional/docs/test_glacier.py
|
||||
tests/functional/docs/test_lex.py
|
||||
tests/functional/docs/test_s3.py
|
||||
tests/functional/docs/test_shared_example_config.py
|
||||
tests/functional/docs/test_streaming_body.py
|
||||
tests/functional/leak/__init__.py
|
||||
tests/functional/leak/test_resource_leaks.py
|
||||
|
|
|
|||
|
|
@ -16,7 +16,7 @@ import os
|
|||
import re
|
||||
import logging
|
||||
|
||||
__version__ = '1.5.7'
|
||||
__version__ = '1.5.75'
|
||||
|
||||
|
||||
class NullHandler(logging.Handler):
|
||||
|
|
@ -45,6 +45,8 @@ _xform_cache = {
|
|||
('DescribeStorediSCSIVolumes', '-'): 'describe-stored-iscsi-volumes',
|
||||
('CreateStorediSCSIVolume', '_'): 'create_stored_iscsi_volume',
|
||||
('CreateStorediSCSIVolume', '-'): 'create-stored-iscsi-volume',
|
||||
('ListHITsForQualificationType', '_'): 'list_hits_for_qualification_type',
|
||||
('ListHITsForQualificationType', '-'): 'list-hits-for-qualification-type',
|
||||
}
|
||||
# The items in this dict represent partial renames to apply globally to all
|
||||
# services which might have a matching argument or operation. This way a
|
||||
|
|
|
|||
|
|
@ -52,9 +52,16 @@ class ClientArgsCreator(object):
|
|||
s3_config = final_args['s3_config']
|
||||
partition = endpoint_config['metadata'].get('partition', None)
|
||||
|
||||
signing_region = endpoint_config['signing_region']
|
||||
endpoint_region_name = endpoint_config['region_name']
|
||||
if signing_region is None and endpoint_region_name is None:
|
||||
signing_region, endpoint_region_name = \
|
||||
self._get_default_s3_region(service_name, endpoint_bridge)
|
||||
config_kwargs['region_name'] = endpoint_region_name
|
||||
|
||||
event_emitter = copy.copy(self._event_emitter)
|
||||
signer = RequestSigner(
|
||||
service_name, endpoint_config['signing_region'],
|
||||
service_name, signing_region,
|
||||
endpoint_config['signing_name'],
|
||||
endpoint_config['signature_version'],
|
||||
credentials, event_emitter)
|
||||
|
|
@ -64,7 +71,7 @@ class ClientArgsCreator(object):
|
|||
endpoint_creator = EndpointCreator(event_emitter)
|
||||
|
||||
endpoint = endpoint_creator.create_endpoint(
|
||||
service_model, region_name=endpoint_config['region_name'],
|
||||
service_model, region_name=endpoint_region_name,
|
||||
endpoint_url=endpoint_config['endpoint_url'], verify=verify,
|
||||
response_parser_factory=self._response_parser_factory,
|
||||
max_pool_connections=new_config.max_pool_connections,
|
||||
|
|
@ -187,3 +194,12 @@ class ClientArgsCreator(object):
|
|||
else:
|
||||
config_copy[key] = False
|
||||
return config_copy
|
||||
|
||||
def _get_default_s3_region(self, service_name, endpoint_bridge):
|
||||
# If a user is providing a custom URL, the endpoint resolver will
|
||||
# refuse to infer a signing region. If we want to default to s3v4,
|
||||
# we have to account for this.
|
||||
if service_name == 's3':
|
||||
endpoint = endpoint_bridge.resolve('s3')
|
||||
return endpoint['signing_region'], endpoint['region_name']
|
||||
return None, None
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ from botocore.compat import encodebytes
|
|||
from botocore.compat import six
|
||||
from botocore.compat import json
|
||||
from botocore.compat import MD5_AVAILABLE
|
||||
from botocore.compat import ensure_unicode
|
||||
|
||||
logger = logging.getLogger(__name__)
|
||||
|
||||
|
|
@ -50,6 +51,7 @@ SIGNED_HEADERS_BLACKLIST = [
|
|||
'user-agent',
|
||||
'x-amzn-trace-id',
|
||||
]
|
||||
UNSIGNED_PAYLOAD = 'UNSIGNED-PAYLOAD'
|
||||
|
||||
|
||||
class BaseSigner(object):
|
||||
|
|
@ -227,17 +229,29 @@ class SigV4Auth(BaseSigner):
|
|||
headers = []
|
||||
sorted_header_names = sorted(set(headers_to_sign))
|
||||
for key in sorted_header_names:
|
||||
value = ','.join(v.strip() for v in
|
||||
value = ','.join(self._header_value(v) for v in
|
||||
sorted(headers_to_sign.get_all(key)))
|
||||
headers.append('%s:%s' % (key, value))
|
||||
headers.append('%s:%s' % (key, ensure_unicode(value)))
|
||||
return '\n'.join(headers)
|
||||
|
||||
def _header_value(self, value):
|
||||
# From the sigv4 docs:
|
||||
# Lowercase(HeaderName) + ':' + Trimall(HeaderValue)
|
||||
#
|
||||
# The Trimall function removes excess white space before and after
|
||||
# values, and converts sequential spaces to a single space.
|
||||
return ' '.join(value.split())
|
||||
|
||||
def signed_headers(self, headers_to_sign):
|
||||
l = ['%s' % n.lower().strip() for n in set(headers_to_sign)]
|
||||
l = sorted(l)
|
||||
return ';'.join(l)
|
||||
|
||||
def payload(self, request):
|
||||
if not self._should_sha256_sign_payload(request):
|
||||
# When payload signing is disabled, we use this static string in
|
||||
# place of the payload checksum.
|
||||
return UNSIGNED_PAYLOAD
|
||||
if request.body and hasattr(request.body, 'seek'):
|
||||
position = request.body.tell()
|
||||
read_chunksize = functools.partial(request.body.read,
|
||||
|
|
@ -255,6 +269,16 @@ class SigV4Auth(BaseSigner):
|
|||
else:
|
||||
return EMPTY_SHA256_HASH
|
||||
|
||||
def _should_sha256_sign_payload(self, request):
|
||||
# Payloads will always be signed over insecure connections.
|
||||
if not request.url.startswith('https'):
|
||||
return True
|
||||
|
||||
# Certain operations may have payload signing disabled by default.
|
||||
# Since we don't have access to the operation model, we pass in this
|
||||
# bit of metadata through the request context.
|
||||
return request.context.get('payload_signing_enabled', True)
|
||||
|
||||
def canonical_request(self, request):
|
||||
cr = [request.method.upper()]
|
||||
path = self._normalize_url_path(urlsplit(request.url).path)
|
||||
|
|
@ -346,6 +370,11 @@ class SigV4Auth(BaseSigner):
|
|||
del request.headers['X-Amz-Security-Token']
|
||||
request.headers['X-Amz-Security-Token'] = self.credentials.token
|
||||
|
||||
if not request.context.get('payload_signing_enabled', True):
|
||||
if 'X-Amz-Content-SHA256' in request.headers:
|
||||
del request.headers['X-Amz-Content-SHA256']
|
||||
request.headers['X-Amz-Content-SHA256'] = UNSIGNED_PAYLOAD
|
||||
|
||||
def _set_necessary_date_headers(self, request):
|
||||
# The spec allows for either the Date _or_ the X-Amz-Date value to be
|
||||
# used so we check both. If there's a Date header, we use the date
|
||||
|
|
@ -383,10 +412,7 @@ class S3SigV4Auth(SigV4Auth):
|
|||
if 'X-Amz-Content-SHA256' in request.headers:
|
||||
del request.headers['X-Amz-Content-SHA256']
|
||||
|
||||
if self._should_sha256_sign_payload(request):
|
||||
request.headers['X-Amz-Content-SHA256'] = self.payload(request)
|
||||
else:
|
||||
request.headers['X-Amz-Content-SHA256'] = 'UNSIGNED-PAYLOAD'
|
||||
request.headers['X-Amz-Content-SHA256'] = self.payload(request)
|
||||
|
||||
def _should_sha256_sign_payload(self, request):
|
||||
# S3 allows optional body signing, so to minimize the performance
|
||||
|
|
@ -400,15 +426,27 @@ class S3SigV4Auth(SigV4Auth):
|
|||
if s3_config is None:
|
||||
s3_config = {}
|
||||
|
||||
# The explicit configuration takes precedence over any implicit
|
||||
# configuration.
|
||||
sign_payload = s3_config.get('payload_signing_enabled', None)
|
||||
if sign_payload is not None:
|
||||
return sign_payload
|
||||
|
||||
if 'Content-MD5' in request.headers and 'https' in request.url and \
|
||||
request.context.get('has_streaming_input', False):
|
||||
# We require that both content-md5 be present and https be enabled
|
||||
# to implicitly disable body signing. The combination of TLS and
|
||||
# content-md5 is sufficiently secure and durable for us to be
|
||||
# confident in the request without body signing.
|
||||
if not request.url.startswith('https') or \
|
||||
'Content-MD5' not in request.headers:
|
||||
return True
|
||||
|
||||
# If the input is streaming we disable body signing by default.
|
||||
if request.context.get('has_streaming_input', False):
|
||||
return False
|
||||
|
||||
return True
|
||||
# If the S3-specific checks had no results, delegate to the generic
|
||||
# checks.
|
||||
return super(S3SigV4Auth, self)._should_sha256_sign_payload(request)
|
||||
|
||||
def _normalize_url_path(self, path):
|
||||
# For S3, we do not normalize the path.
|
||||
|
|
@ -514,7 +552,7 @@ class S3SigV4QueryAuth(SigV4QueryAuth):
|
|||
# "You don't include a payload hash in the Canonical Request, because
|
||||
# when you create a presigned URL, you don't know anything about the
|
||||
# payload. Instead, you use a constant string "UNSIGNED-PAYLOAD".
|
||||
return "UNSIGNED-PAYLOAD"
|
||||
return UNSIGNED_PAYLOAD
|
||||
|
||||
|
||||
class S3SigV4PostAuth(SigV4Auth):
|
||||
|
|
|
|||
|
|
@ -19,7 +19,8 @@ import socket
|
|||
import inspect
|
||||
|
||||
from botocore.compat import six
|
||||
from botocore.compat import HTTPHeaders, HTTPResponse, urlunsplit, urlsplit
|
||||
from botocore.compat import HTTPHeaders, HTTPResponse, urlunsplit, urlsplit,\
|
||||
urlparse
|
||||
from botocore.exceptions import UnseekableStreamError
|
||||
from botocore.utils import percent_encode_sequence
|
||||
from botocore.vendored.requests import models
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ from botocore.utils import switch_to_virtual_host_style
|
|||
from botocore.utils import S3_ACCELERATE_WHITELIST
|
||||
from botocore.args import ClientArgsCreator
|
||||
from botocore.compat import urlsplit
|
||||
from botocore import UNSIGNED
|
||||
# Keep this imported. There's pre-existing code that uses
|
||||
# "from botocore.client import Config".
|
||||
from botocore.config import Config
|
||||
|
|
@ -69,7 +70,9 @@ class ClientCreator(object):
|
|||
service_model, region_name, is_secure, endpoint_url,
|
||||
verify, credentials, scoped_config, client_config, endpoint_bridge)
|
||||
service_client = cls(**client_args)
|
||||
self._register_s3_events(service_client, endpoint_bridge, endpoint_url)
|
||||
self._register_s3_events(
|
||||
service_client, endpoint_bridge, endpoint_url, client_config,
|
||||
scoped_config)
|
||||
return service_client
|
||||
|
||||
def create_client_class(self, service_name, api_version=None):
|
||||
|
|
@ -116,7 +119,8 @@ class ClientCreator(object):
|
|||
self._event_emitter.register('needs-retry.%s' % endpoint_prefix,
|
||||
handler, unique_id=unique_id)
|
||||
|
||||
def _register_s3_events(self, client, endpoint_bridge, endpoint_url):
|
||||
def _register_s3_events(self, client, endpoint_bridge, endpoint_url,
|
||||
client_config, scoped_config):
|
||||
if client.meta.service_model.service_name != 's3':
|
||||
return
|
||||
S3RegionRedirector(endpoint_bridge, client).register()
|
||||
|
|
@ -130,6 +134,9 @@ class ClientCreator(object):
|
|||
client.meta.events.register_first(
|
||||
'request-created.s3', switch_host_s3_accelerate)
|
||||
|
||||
self._set_s3_presign_signature_version(
|
||||
client.meta, client_config, scoped_config)
|
||||
|
||||
def _set_s3_addressing_style(self, endpoint_url, s3_config, event_emitter):
|
||||
if s3_config is None:
|
||||
s3_config = {}
|
||||
|
|
@ -212,6 +219,56 @@ class ClientCreator(object):
|
|||
# Remaining parts must all be in the whitelist.
|
||||
return all(p in S3_ACCELERATE_WHITELIST for p in feature_parts)
|
||||
|
||||
def _set_s3_presign_signature_version(self, client_meta,
|
||||
client_config, scoped_config):
|
||||
# This will return the manually configured signature version, or None
|
||||
# if none was manually set. If a customer manually sets the signature
|
||||
# version, we always want to use what they set.
|
||||
provided_signature_version = _get_configured_signature_version(
|
||||
's3', client_config, scoped_config)
|
||||
if provided_signature_version is not None:
|
||||
return
|
||||
|
||||
# Check to see if the region is a region that we know about. If we
|
||||
# don't know about a region, then we can safely assume it's a new
|
||||
# region that is sigv4 only, since all new S3 regions only allow sigv4.
|
||||
regions = self._endpoint_resolver.get_available_endpoints(
|
||||
's3', client_meta.partition)
|
||||
if client_meta.region_name not in regions:
|
||||
return
|
||||
|
||||
# If it is a region we know about, we want to default to sigv2, so here
|
||||
# we check to see if it is available.
|
||||
endpoint = self._endpoint_resolver.construct_endpoint(
|
||||
's3', client_meta.region_name)
|
||||
signature_versions = endpoint['signatureVersions']
|
||||
if 's3' not in signature_versions:
|
||||
return
|
||||
|
||||
# We now know that we're in a known region that supports sigv2 and
|
||||
# the customer hasn't set a signature version so we default the
|
||||
# signature version to sigv2.
|
||||
client_meta.events.register(
|
||||
'choose-signer.s3', self._default_s3_presign_to_sigv2)
|
||||
|
||||
def _default_s3_presign_to_sigv2(self, signature_version, **kwargs):
|
||||
"""
|
||||
Returns the 's3' (sigv2) signer if presigning an s3 request. This is
|
||||
intended to be used to set the default signature version for the signer
|
||||
to sigv2.
|
||||
|
||||
:type signature_version: str
|
||||
:param signature_version: The current client signature version.
|
||||
|
||||
:type signing_name: str
|
||||
:param signing_name: The signing name of the service.
|
||||
|
||||
:return: 's3' if the request is an s3 presign request, None otherwise
|
||||
"""
|
||||
for suffix in ['-query', '-presign-post']:
|
||||
if signature_version.endswith(suffix):
|
||||
return 's3' + suffix
|
||||
|
||||
def _get_client_args(self, service_model, region_name, is_secure,
|
||||
endpoint_url, verify, credentials,
|
||||
scoped_config, client_config, endpoint_bridge):
|
||||
|
|
@ -433,31 +490,16 @@ class ClientEndpointBridge(object):
|
|||
return region_name, signing_region
|
||||
|
||||
def _resolve_signature_version(self, service_name, resolved):
|
||||
# Client config overrides everything.
|
||||
client = self.client_config
|
||||
if client and client.signature_version is not None:
|
||||
return client.signature_version
|
||||
# Scoped config overrides picking from the endpoint metadata.
|
||||
scoped = self.scoped_config
|
||||
if scoped is not None:
|
||||
service_config = scoped.get(service_name)
|
||||
if service_config is not None and isinstance(service_config, dict):
|
||||
version = service_config.get('signature_version')
|
||||
if version:
|
||||
logger.debug(
|
||||
"Switching signature version for service %s "
|
||||
"to version %s based on config file override.",
|
||||
service_name, version)
|
||||
return version
|
||||
configured_version = _get_configured_signature_version(
|
||||
service_name, self.client_config, self.scoped_config)
|
||||
if configured_version is not None:
|
||||
return configured_version
|
||||
|
||||
# Pick a signature version from the endpoint metadata if present.
|
||||
if 'signatureVersions' in resolved:
|
||||
potential_versions = resolved['signatureVersions']
|
||||
if service_name == 's3':
|
||||
# We currently prefer s3 over s3v4.
|
||||
if 's3' in potential_versions:
|
||||
return 's3'
|
||||
elif 's3v4' in potential_versions:
|
||||
return 's3v4'
|
||||
return 's3v4'
|
||||
if 'v4' in potential_versions:
|
||||
return 'v4'
|
||||
# Now just iterate over the signature versions in order until we
|
||||
|
|
@ -496,6 +538,19 @@ class BaseClient(object):
|
|||
self._exceptions = None
|
||||
self._register_handlers()
|
||||
|
||||
def __getattr__(self, item):
|
||||
event_name = 'getattr.%s.%s' % (self._service_model.service_name, item)
|
||||
handler, event_response = self.meta.events.emit_until_response(
|
||||
event_name, client=self)
|
||||
|
||||
if event_response is not None:
|
||||
return event_response
|
||||
|
||||
raise AttributeError(
|
||||
"'%s' object has no attribute '%s'" % (
|
||||
self.__class__.__name__, item)
|
||||
)
|
||||
|
||||
def _register_handlers(self):
|
||||
# Register the handler required to sign requests.
|
||||
self.meta.events.register('request-created.%s' %
|
||||
|
|
@ -511,7 +566,8 @@ class BaseClient(object):
|
|||
request_context = {
|
||||
'client_region': self.meta.region_name,
|
||||
'client_config': self.meta.config,
|
||||
'has_streaming_input': operation_model.has_streaming_input
|
||||
'has_streaming_input': operation_model.has_streaming_input,
|
||||
'auth_type': operation_model.auth_type,
|
||||
}
|
||||
request_dict = self._convert_to_request_dict(
|
||||
api_params, operation_model, context=request_context)
|
||||
|
|
@ -750,3 +806,31 @@ class ClientMeta(object):
|
|||
@property
|
||||
def partition(self):
|
||||
return self._partition
|
||||
|
||||
|
||||
def _get_configured_signature_version(service_name, client_config,
|
||||
scoped_config):
|
||||
"""
|
||||
Gets the manually configured signature version.
|
||||
|
||||
:returns: the customer configured signature version, or None if no
|
||||
signature version was configured.
|
||||
"""
|
||||
# Client config overrides everything.
|
||||
if client_config and client_config.signature_version is not None:
|
||||
return client_config.signature_version
|
||||
|
||||
# Scoped config overrides picking from the endpoint metadata.
|
||||
if scoped_config is not None:
|
||||
# A given service may have service specific configuration in the
|
||||
# config file, so we need to check there as well.
|
||||
service_config = scoped_config.get(service_name)
|
||||
if service_config is not None and isinstance(service_config, dict):
|
||||
version = service_config.get('signature_version')
|
||||
if version:
|
||||
logger.debug(
|
||||
"Switching signature version for service %s "
|
||||
"to version %s based on config file override.",
|
||||
service_name, version)
|
||||
return version
|
||||
return None
|
||||
|
|
|
|||
|
|
@ -27,7 +27,7 @@ logger = logging.getLogger(__name__)
|
|||
|
||||
|
||||
if six.PY3:
|
||||
from six.moves import http_client
|
||||
from botocore.vendored.six.moves import http_client
|
||||
|
||||
class HTTPHeaders(http_client.HTTPMessage):
|
||||
pass
|
||||
|
|
|
|||
|
|
@ -14,8 +14,9 @@
|
|||
import os
|
||||
import shlex
|
||||
import copy
|
||||
import sys
|
||||
|
||||
from six.moves import configparser
|
||||
from botocore.compat import six
|
||||
|
||||
import botocore.exceptions
|
||||
|
||||
|
|
@ -142,12 +143,13 @@ def raw_config_parse(config_filename, parse_subsections=True):
|
|||
path = os.path.expandvars(path)
|
||||
path = os.path.expanduser(path)
|
||||
if not os.path.isfile(path):
|
||||
raise botocore.exceptions.ConfigNotFound(path=path)
|
||||
cp = configparser.RawConfigParser()
|
||||
raise botocore.exceptions.ConfigNotFound(path=_unicode_path(path))
|
||||
cp = six.moves.configparser.RawConfigParser()
|
||||
try:
|
||||
cp.read(path)
|
||||
except configparser.Error:
|
||||
raise botocore.exceptions.ConfigParseError(path=path)
|
||||
cp.read([path])
|
||||
except six.moves.configparser.Error:
|
||||
raise botocore.exceptions.ConfigParseError(
|
||||
path=_unicode_path(path))
|
||||
else:
|
||||
for section in cp.sections():
|
||||
config[section] = {}
|
||||
|
|
@ -161,11 +163,17 @@ def raw_config_parse(config_filename, parse_subsections=True):
|
|||
config_value = _parse_nested(config_value)
|
||||
except ValueError:
|
||||
raise botocore.exceptions.ConfigParseError(
|
||||
path=path)
|
||||
path=_unicode_path(path))
|
||||
config[section][option] = config_value
|
||||
return config
|
||||
|
||||
|
||||
def _unicode_path(path):
|
||||
if isinstance(path, six.text_type):
|
||||
return path
|
||||
return path.decode(sys.getfilesystemencoding(), 'replace')
|
||||
|
||||
|
||||
def _parse_nested(config_value):
|
||||
# Given a value like this:
|
||||
# \n
|
||||
|
|
|
|||
|
|
@ -508,6 +508,7 @@ class EnvProvider(CredentialProvider):
|
|||
# The token can come from either of these env var.
|
||||
# AWS_SESSION_TOKEN is what other AWS SDKs have standardized on.
|
||||
TOKENS = ['AWS_SECURITY_TOKEN', 'AWS_SESSION_TOKEN']
|
||||
EXPIRY_TIME = 'AWS_CREDENTIAL_EXPIRATION'
|
||||
|
||||
def __init__(self, environ=None, mapping=None):
|
||||
"""
|
||||
|
|
@ -533,6 +534,7 @@ class EnvProvider(CredentialProvider):
|
|||
var_mapping['access_key'] = self.ACCESS_KEY
|
||||
var_mapping['secret_key'] = self.SECRET_KEY
|
||||
var_mapping['token'] = self.TOKENS
|
||||
var_mapping['expiry_time'] = self.EXPIRY_TIME
|
||||
else:
|
||||
var_mapping['access_key'] = mapping.get(
|
||||
'access_key', self.ACCESS_KEY)
|
||||
|
|
@ -542,6 +544,8 @@ class EnvProvider(CredentialProvider):
|
|||
'token', self.TOKENS)
|
||||
if not isinstance(var_mapping['token'], list):
|
||||
var_mapping['token'] = [var_mapping['token']]
|
||||
var_mapping['expiry_time'] = mapping.get(
|
||||
'expiry_time', self.EXPIRY_TIME)
|
||||
return var_mapping
|
||||
|
||||
def load(self):
|
||||
|
|
@ -550,19 +554,61 @@ class EnvProvider(CredentialProvider):
|
|||
"""
|
||||
if self._mapping['access_key'] in self.environ:
|
||||
logger.info('Found credentials in environment variables.')
|
||||
access_key, secret_key = self._extract_creds_from_mapping(
|
||||
self.environ, self._mapping['access_key'],
|
||||
self._mapping['secret_key'])
|
||||
token = self._get_session_token()
|
||||
return Credentials(access_key, secret_key, token,
|
||||
method=self.METHOD)
|
||||
fetcher = self._create_credentials_fetcher()
|
||||
credentials = fetcher(require_expiry=False)
|
||||
|
||||
expiry_time = credentials['expiry_time']
|
||||
if expiry_time is not None:
|
||||
expiry_time = parse(expiry_time)
|
||||
return RefreshableCredentials(
|
||||
credentials['access_key'], credentials['secret_key'],
|
||||
credentials['token'], expiry_time,
|
||||
refresh_using=fetcher, method=self.METHOD
|
||||
)
|
||||
|
||||
return Credentials(
|
||||
credentials['access_key'], credentials['secret_key'],
|
||||
credentials['token'], method=self.METHOD
|
||||
)
|
||||
else:
|
||||
return None
|
||||
|
||||
def _get_session_token(self):
|
||||
for token_envvar in self._mapping['token']:
|
||||
if token_envvar in self.environ:
|
||||
return self.environ[token_envvar]
|
||||
def _create_credentials_fetcher(self):
|
||||
mapping = self._mapping
|
||||
method = self.METHOD
|
||||
environ = self.environ
|
||||
|
||||
def fetch_credentials(require_expiry=True):
|
||||
credentials = {}
|
||||
|
||||
access_key = environ.get(mapping['access_key'])
|
||||
if access_key is None:
|
||||
raise PartialCredentialsError(
|
||||
provider=method, cred_var=mapping['access_key'])
|
||||
credentials['access_key'] = access_key
|
||||
|
||||
secret_key = environ.get(mapping['secret_key'])
|
||||
if secret_key is None:
|
||||
raise PartialCredentialsError(
|
||||
provider=method, cred_var=mapping['secret_key'])
|
||||
credentials['secret_key'] = secret_key
|
||||
|
||||
token = None
|
||||
for token_env_var in mapping['token']:
|
||||
if token_env_var in environ:
|
||||
token = environ[token_env_var]
|
||||
break
|
||||
credentials['token'] = token
|
||||
|
||||
expiry_time = environ.get(mapping['expiry_time'])
|
||||
if require_expiry and expiry_time is None:
|
||||
raise PartialCredentialsError(
|
||||
provider=method, cred_var=mapping['expiry_time'])
|
||||
credentials['expiry_time'] = expiry_time
|
||||
|
||||
return credentials
|
||||
|
||||
return fetch_credentials
|
||||
|
||||
|
||||
class OriginalEC2Provider(CredentialProvider):
|
||||
|
|
@ -834,7 +880,7 @@ class AssumeRoleProvider(CredentialProvider):
|
|||
return None
|
||||
|
||||
def _is_expired(self, credentials):
|
||||
end_time = parse(credentials['Credentials']['Expiration'])
|
||||
end_time = _parse_if_needed(credentials['Credentials']['Expiration'])
|
||||
now = datetime.datetime.now(tzlocal())
|
||||
seconds = total_seconds(end_time - now)
|
||||
return seconds < self.EXPIRY_WINDOW_SECONDS
|
||||
|
|
@ -945,6 +991,8 @@ class ContainerProvider(CredentialProvider):
|
|||
|
||||
METHOD = 'container-role'
|
||||
ENV_VAR = 'AWS_CONTAINER_CREDENTIALS_RELATIVE_URI'
|
||||
ENV_VAR_FULL = 'AWS_CONTAINER_CREDENTIALS_FULL_URI'
|
||||
ENV_VAR_AUTH_TOKEN = 'AWS_CONTAINER_AUTHORIZATION_TOKEN'
|
||||
|
||||
def __init__(self, environ=None, fetcher=None):
|
||||
if environ is None:
|
||||
|
|
@ -955,15 +1003,18 @@ class ContainerProvider(CredentialProvider):
|
|||
self._fetcher = fetcher
|
||||
|
||||
def load(self):
|
||||
if self.ENV_VAR not in self._environ:
|
||||
# This cred provider is only triggered if the
|
||||
# self.ENV_VAR is set, which only happens if you opt
|
||||
# into this feature on ECS.
|
||||
return None
|
||||
return self._retrieve_or_fail(self._environ[self.ENV_VAR])
|
||||
# This cred provider is only triggered if the self.ENV_VAR is set,
|
||||
# which only happens if you opt into this feature.
|
||||
if self.ENV_VAR in self._environ or self.ENV_VAR_FULL in self._environ:
|
||||
return self._retrieve_or_fail()
|
||||
|
||||
def _retrieve_or_fail(self, relative_uri):
|
||||
fetcher = self._create_fetcher(relative_uri)
|
||||
def _retrieve_or_fail(self):
|
||||
if self._provided_relative_uri():
|
||||
full_uri = self._fetcher.full_url(self._environ[self.ENV_VAR])
|
||||
else:
|
||||
full_uri = self._environ[self.ENV_VAR_FULL]
|
||||
headers = self._build_headers()
|
||||
fetcher = self._create_fetcher(full_uri, headers)
|
||||
creds = fetcher()
|
||||
return RefreshableCredentials(
|
||||
access_key=creds['access_key'],
|
||||
|
|
@ -974,12 +1025,21 @@ class ContainerProvider(CredentialProvider):
|
|||
refresh_using=fetcher,
|
||||
)
|
||||
|
||||
def _create_fetcher(self, relative_uri):
|
||||
def _build_headers(self):
|
||||
headers = {}
|
||||
auth_token = self._environ.get(self.ENV_VAR_AUTH_TOKEN)
|
||||
if auth_token is not None:
|
||||
return {
|
||||
'Authorization': auth_token
|
||||
}
|
||||
|
||||
def _create_fetcher(self, full_uri, headers):
|
||||
def fetch_creds():
|
||||
try:
|
||||
response = self._fetcher.retrieve_uri(relative_uri)
|
||||
response = self._fetcher.retrieve_full_uri(
|
||||
full_uri, headers=headers)
|
||||
except MetadataRetrievalError as e:
|
||||
logger.debug("Error retrieving ECS metadata: %s", e,
|
||||
logger.debug("Error retrieving container metadata: %s", e,
|
||||
exc_info=True)
|
||||
raise CredentialRetrievalError(provider=self.METHOD,
|
||||
error_msg=str(e))
|
||||
|
|
@ -991,6 +1051,9 @@ class ContainerProvider(CredentialProvider):
|
|||
}
|
||||
return fetch_creds
|
||||
|
||||
def _provided_relative_uri(self):
|
||||
return self.ENV_VAR in self._environ
|
||||
|
||||
|
||||
class CredentialResolver(object):
|
||||
|
||||
|
|
|
|||
|
|
@ -16,6 +16,14 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"throttled_exception": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
"service_error_code": "ThrottledException",
|
||||
"http_status_code": 400
|
||||
}
|
||||
}
|
||||
},
|
||||
"too_many_requests": {
|
||||
"applies_when": {
|
||||
"response": {
|
||||
|
|
@ -80,6 +88,7 @@
|
|||
"gateway_timeout": {"$ref": "gateway_timeout"},
|
||||
"limit_exceeded": {"$ref": "limit_exceeded"},
|
||||
"throttling_exception": {"$ref": "throttling_exception"},
|
||||
"throttled_exception": {"$ref": "throttled_exception"},
|
||||
"throttling": {"$ref": "throttling"},
|
||||
"too_many_requests": {"$ref": "too_many_requests"}
|
||||
}
|
||||
|
|
|
|||
5
botocore/data/acm/2015-12-08/examples-1.json
Normal file
5
botocore/data/acm/2015-12-08/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
|
|
@ -8,4 +8,3 @@
|
|||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -149,7 +149,7 @@
|
|||
{"shape":"InvalidArnException"},
|
||||
{"shape":"InvalidDomainValidationOptionsException"}
|
||||
],
|
||||
"documentation":"<p>Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM Certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking <b>I Approve</b>. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM Certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate.</p>"
|
||||
"documentation":"<p>Resends the email that requests domain ownership validation. The domain owner or an authorized representative must approve the ACM Certificate before it can be issued. The certificate can be approved by clicking a link in the mail to navigate to the Amazon certificate approval website and then clicking <b>I Approve</b>. However, the validation email can be blocked by spam filters. Therefore, if you do not receive the original mail, you can request that the mail be resent within 72 hours of requesting the ACM Certificate. If more than 72 hours have elapsed since your original request or since your last attempt to resend validation mail, you must request a new certificate. For more information about setting up your contact email addresses, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/setup-email.html\">Configure Email for your Domain</a>. </p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -672,11 +672,11 @@
|
|||
"members":{
|
||||
"DomainName":{
|
||||
"shape":"DomainNameString",
|
||||
"documentation":"<p>Fully qualified domain name (FQDN), such as www.example.com, of the site that you want to secure with an ACM Certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com.</p>"
|
||||
"documentation":"<p> Fully qualified domain name (FQDN), such as www.example.com, of the site that you want to secure with an ACM Certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, *.example.com protects www.example.com, site.example.com, and images.example.com. </p> <p> The maximum length of a DNS name is 253 octets. The name is made up of multiple labels separated by periods. No label can be longer than 63 octets. Consider the following examples: </p> <p> <code>(63 octets).(63 octets).(63 octets).(61 octets)</code> is legal because the total length is 253 octets (63+1+63+1+63+1+61) and no label exceeds 63 octets. </p> <p> <code>(64 octets).(63 octets).(63 octets).(61 octets)</code> is not legal because the total length exceeds 253 octets (64+1+63+1+63+1+61) and the first label exceeds 63 octets. </p> <p> <code>(63 octets).(63 octets).(63 octets).(62 octets)</code> is not legal because the total length of the DNS name (63+1+63+1+63+1+62) exceeds 253 octets. </p>"
|
||||
},
|
||||
"SubjectAlternativeNames":{
|
||||
"shape":"DomainList",
|
||||
"documentation":"<p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM Certificate. For example, add the name www.example.net to a certificate for which the <code>DomainName</code> field is www.example.com if users can reach your site by using either name.</p>"
|
||||
"documentation":"<p>Additional FQDNs to be included in the Subject Alternative Name extension of the ACM Certificate. For example, add the name www.example.net to a certificate for which the <code>DomainName</code> field is www.example.com if users can reach your site by using either name. The maximum number of domain names that you can add to an ACM Certificate is 100. However, the initial limit is 10 domain names. If you need more than 10 names, you must request a limit increase. For more information, see <a href=\"http://docs.aws.amazon.com/acm/latest/userguide/acm-limits.html\">Limits</a>.</p>"
|
||||
},
|
||||
"IdempotencyToken":{
|
||||
"shape":"IdempotencyToken",
|
||||
|
|
|
|||
5
botocore/data/apigateway/2015-07-09/examples-1.json
Executable file
5
botocore/data/apigateway/2015-07-09/examples-1.json
Executable file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
|
|
@ -47,6 +47,24 @@
|
|||
"output_token": "position",
|
||||
"limit_key": "limit",
|
||||
"result_key": "items"
|
||||
},
|
||||
"GetUsage": {
|
||||
"input_token": "position",
|
||||
"output_token": "position",
|
||||
"limit_key": "limit",
|
||||
"result_key": "items"
|
||||
},
|
||||
"GetUsagePlans": {
|
||||
"input_token": "position",
|
||||
"output_token": "position",
|
||||
"limit_key": "limit",
|
||||
"result_key": "items"
|
||||
},
|
||||
"GetUsagePlanKeys": {
|
||||
"input_token": "position",
|
||||
"output_token": "position",
|
||||
"limit_key": "limit",
|
||||
"result_key": "items"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
378
botocore/data/apigateway/2015-07-09/service-2.json
Executable file → Normal file
378
botocore/data/apigateway/2015-07-09/service-2.json
Executable file → Normal file
File diff suppressed because one or more lines are too long
257
botocore/data/application-autoscaling/2016-02-06/examples-1.json
Normal file
257
botocore/data/application-autoscaling/2016-02-06/examples-1.json
Normal file
|
|
@ -0,0 +1,257 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
"DeleteScalingPolicy": [
|
||||
{
|
||||
"input": {
|
||||
"PolicyName": "web-app-cpu-lt-25",
|
||||
"ResourceId": "service/default/web-app",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes a scaling policy for the Amazon ECS service called web-app, which is running in the default cluster.",
|
||||
"id": "to-delete-a-scaling-policy-1470863892689",
|
||||
"title": "To delete a scaling policy"
|
||||
}
|
||||
],
|
||||
"DeregisterScalableTarget": [
|
||||
{
|
||||
"input": {
|
||||
"ResourceId": "service/default/web-app",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deregisters a scalable target for an Amazon ECS service called web-app that is running in the default cluster.",
|
||||
"id": "to-deregister-a-scalable-target-1470864164895",
|
||||
"title": "To deregister a scalable target"
|
||||
}
|
||||
],
|
||||
"DescribeScalableTargets": [
|
||||
{
|
||||
"input": {
|
||||
"ServiceNamespace": "ecs"
|
||||
},
|
||||
"output": {
|
||||
"ScalableTargets": [
|
||||
{
|
||||
"CreationTime": "2016-05-06T11:21:46.199Z",
|
||||
"MaxCapacity": 10,
|
||||
"MinCapacity": 1,
|
||||
"ResourceId": "service/default/web-app",
|
||||
"RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the scalable targets for the ecs service namespace.",
|
||||
"id": "to-describe-scalable-targets-1470864286961",
|
||||
"title": "To describe scalable targets"
|
||||
}
|
||||
],
|
||||
"DescribeScalingActivities": [
|
||||
{
|
||||
"input": {
|
||||
"ResourceId": "service/default/web-app",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs"
|
||||
},
|
||||
"output": {
|
||||
"ScalingActivities": [
|
||||
{
|
||||
"ActivityId": "e6c5f7d1-dbbb-4a3f-89b2-51f33e766399",
|
||||
"Cause": "monitor alarm web-app-cpu-lt-25 in state ALARM triggered policy web-app-cpu-lt-25",
|
||||
"Description": "Setting desired count to 1.",
|
||||
"EndTime": "2016-05-06T16:04:32.111Z",
|
||||
"ResourceId": "service/default/web-app",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs",
|
||||
"StartTime": "2016-05-06T16:03:58.171Z",
|
||||
"StatusCode": "Successful",
|
||||
"StatusMessage": "Successfully set desired count to 1. Change successfully fulfilled by ecs."
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the scaling activities for an Amazon ECS service called web-app that is running in the default cluster.",
|
||||
"id": "to-describe-scaling-activities-for-a-scalable-target-1470864398629",
|
||||
"title": "To describe scaling activities for a scalable target"
|
||||
}
|
||||
],
|
||||
"DescribeScalingPolicies": [
|
||||
{
|
||||
"input": {
|
||||
"ServiceNamespace": "ecs"
|
||||
},
|
||||
"output": {
|
||||
"NextToken": "",
|
||||
"ScalingPolicies": [
|
||||
{
|
||||
"Alarms": [
|
||||
{
|
||||
"AlarmARN": "arn:aws:cloudwatch:us-west-2:012345678910:alarm:web-app-cpu-gt-75",
|
||||
"AlarmName": "web-app-cpu-gt-75"
|
||||
}
|
||||
],
|
||||
"CreationTime": "2016-05-06T12:11:39.230Z",
|
||||
"PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75",
|
||||
"PolicyName": "web-app-cpu-gt-75",
|
||||
"PolicyType": "StepScaling",
|
||||
"ResourceId": "service/default/web-app",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs",
|
||||
"StepScalingPolicyConfiguration": {
|
||||
"AdjustmentType": "PercentChangeInCapacity",
|
||||
"Cooldown": 60,
|
||||
"StepAdjustments": [
|
||||
{
|
||||
"MetricIntervalLowerBound": 0,
|
||||
"ScalingAdjustment": 200
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the scaling policies for the ecs service namespace.",
|
||||
"id": "to-describe-scaling-policies-1470864609734",
|
||||
"title": "To describe scaling policies"
|
||||
}
|
||||
],
|
||||
"PutScalingPolicy": [
|
||||
{
|
||||
"input": {
|
||||
"PolicyName": "web-app-cpu-gt-75",
|
||||
"PolicyType": "StepScaling",
|
||||
"ResourceId": "service/default/web-app",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs",
|
||||
"StepScalingPolicyConfiguration": {
|
||||
"AdjustmentType": "PercentChangeInCapacity",
|
||||
"Cooldown": 60,
|
||||
"StepAdjustments": [
|
||||
{
|
||||
"MetricIntervalLowerBound": 0,
|
||||
"ScalingAdjustment": 200
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"PolicyARN": "arn:aws:autoscaling:us-west-2:012345678910:scalingPolicy:6d8972f3-efc8-437c-92d1-6270f29a66e7:resource/ecs/service/default/web-app:policyName/web-app-cpu-gt-75"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example applies a scaling policy to an Amazon ECS service called web-app in the default cluster. The policy increases the desired count of the service by 200%, with a cool down period of 60 seconds.",
|
||||
"id": "to-apply-a-scaling-policy-to-an-amazon-ecs-service-1470864779862",
|
||||
"title": "To apply a scaling policy to an Amazon ECS service"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"PolicyName": "fleet-cpu-gt-75",
|
||||
"PolicyType": "StepScaling",
|
||||
"ResourceId": "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3",
|
||||
"ScalableDimension": "ec2:spot-fleet-request:TargetCapacity",
|
||||
"ServiceNamespace": "ec2",
|
||||
"StepScalingPolicyConfiguration": {
|
||||
"AdjustmentType": "PercentChangeInCapacity",
|
||||
"Cooldown": 180,
|
||||
"StepAdjustments": [
|
||||
{
|
||||
"MetricIntervalLowerBound": 0,
|
||||
"ScalingAdjustment": 200
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"PolicyARN": "arn:aws:autoscaling:us-east-1:012345678910:scalingPolicy:89406401-0cb7-4130-b770-d97cca0e446b:resource/ec2/spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3:policyName/fleet-cpu-gt-75"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example applies a scaling policy to an Amazon EC2 Spot fleet. The policy increases the target capacity of the spot fleet by 200%, with a cool down period of 180 seconds.\",\n ",
|
||||
"id": "to-apply-a-scaling-policy-to-an-amazon-ec2-spot-fleet-1472073278469",
|
||||
"title": "To apply a scaling policy to an Amazon EC2 Spot fleet"
|
||||
}
|
||||
],
|
||||
"RegisterScalableTarget": [
|
||||
{
|
||||
"input": {
|
||||
"MaxCapacity": 10,
|
||||
"MinCapacity": 1,
|
||||
"ResourceId": "service/default/web-app",
|
||||
"RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingECSRole",
|
||||
"ScalableDimension": "ecs:service:DesiredCount",
|
||||
"ServiceNamespace": "ecs"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example registers a scalable target from an Amazon ECS service called web-app that is running on the default cluster, with a minimum desired count of 1 task and a maximum desired count of 10 tasks.",
|
||||
"id": "to-register-a-new-scalable-target-1470864910380",
|
||||
"title": "To register an ECS service as a scalable target"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"MaxCapacity": 10,
|
||||
"MinCapacity": 1,
|
||||
"ResourceId": "spot-fleet-request/sfr-45e69d8a-be48-4539-bbf3-3464e99c50c3",
|
||||
"RoleARN": "arn:aws:iam::012345678910:role/ApplicationAutoscalingSpotRole",
|
||||
"ScalableDimension": "ec2:spot-fleet-request:TargetCapacity",
|
||||
"ServiceNamespace": "ec2"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
},
|
||||
"description": "This example registers a scalable target from an Amazon EC2 Spot fleet with a minimum target capacity of 1 and a maximum of 10.",
|
||||
"id": "to-register-an-ec2-spot-fleet-as-a-scalable-target-1472072899649",
|
||||
"title": "To register an EC2 Spot fleet as a scalable target"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -106,6 +106,7 @@
|
|||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ObjectNotFoundException"},
|
||||
{"shape":"ConcurrentUpdateException"},
|
||||
{"shape":"FailedResourceAccessException"},
|
||||
{"shape":"InternalServiceException"}
|
||||
],
|
||||
"documentation":"<p>Creates or updates a policy for an Application Auto Scaling scalable target.</p> <p>Each scalable target is identified by a service namespace, resource ID, and scalable dimension. A scaling policy applies to the scalable target identified by those three attributes. You cannot create a scaling policy without first registering a scalable target using <a>RegisterScalableTarget</a>.</p> <p>To update a policy, specify its policy name and the parameters that you want to change. Any parameters that you don't specify are not changed by this update request.</p> <p>You can view the scaling policies for a service namespace using <a>DescribeScalingPolicies</a>. If you are no longer using a scaling policy, you can delete it using <a>DeleteScalingPolicy</a>.</p>"
|
||||
|
|
@ -167,6 +168,37 @@
|
|||
"exception":true
|
||||
},
|
||||
"Cooldown":{"type":"integer"},
|
||||
"CustomizedMetricSpecification":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"MetricName",
|
||||
"Namespace",
|
||||
"Statistic"
|
||||
],
|
||||
"members":{
|
||||
"MetricName":{
|
||||
"shape":"MetricName",
|
||||
"documentation":"<p>The name of the metric.</p>"
|
||||
},
|
||||
"Namespace":{
|
||||
"shape":"MetricNamespace",
|
||||
"documentation":"<p>The namespace of the metric.</p>"
|
||||
},
|
||||
"Dimensions":{
|
||||
"shape":"MetricDimensions",
|
||||
"documentation":"<p>The dimensions of the metric.</p>"
|
||||
},
|
||||
"Statistic":{
|
||||
"shape":"MetricStatistic",
|
||||
"documentation":"<p>The statistic of the metric.</p>"
|
||||
},
|
||||
"Unit":{
|
||||
"shape":"MetricUnit",
|
||||
"documentation":"<p>The unit of the metric.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Configures a customized metric for a target tracking policy.</p>"
|
||||
},
|
||||
"DeleteScalingPolicyRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -186,11 +218,11 @@
|
|||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -213,11 +245,11 @@
|
|||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -236,11 +268,11 @@
|
|||
},
|
||||
"ResourceIds":{
|
||||
"shape":"ResourceIdsMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
|
|
@ -275,11 +307,11 @@
|
|||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
|
|
@ -318,11 +350,11 @@
|
|||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property. If you specify a scalable dimension, you must also specify a resource ID.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxResults",
|
||||
|
|
@ -353,7 +385,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>Failed access to resources caused an exception. This exception currently only applies to <a>DescribeScalingPolicies</a>. It is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have the proper permissions to call the CloudWatch <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html\">DescribeAlarms</a> API operation on behalf of your account.</p>",
|
||||
"documentation":"<p>Failed access to resources caused an exception. This exception is thrown when Application Auto Scaling is unable to retrieve the alarms associated with a scaling policy due to a client error, for example, if the role ARN specified for a scalable target does not have permission to call the CloudWatch <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_DescribeAlarms.html\">DescribeAlarms</a> API operation on behalf of your account.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InternalServiceException":{
|
||||
|
|
@ -389,7 +421,51 @@
|
|||
"Maximum"
|
||||
]
|
||||
},
|
||||
"MetricDimension":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Name",
|
||||
"Value"
|
||||
],
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"MetricDimensionName",
|
||||
"documentation":"<p>The name of the dimension.</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"MetricDimensionValue",
|
||||
"documentation":"<p>The value of the dimension.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes the dimension of a metric.</p>"
|
||||
},
|
||||
"MetricDimensionName":{"type":"string"},
|
||||
"MetricDimensionValue":{"type":"string"},
|
||||
"MetricDimensions":{
|
||||
"type":"list",
|
||||
"member":{"shape":"MetricDimension"}
|
||||
},
|
||||
"MetricName":{"type":"string"},
|
||||
"MetricNamespace":{"type":"string"},
|
||||
"MetricScale":{"type":"double"},
|
||||
"MetricStatistic":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"Average",
|
||||
"Minimum",
|
||||
"Maximum",
|
||||
"SampleCount",
|
||||
"Sum"
|
||||
]
|
||||
},
|
||||
"MetricType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"DynamoDBReadCapacityUtilization",
|
||||
"DynamoDBWriteCapacityUtilization"
|
||||
]
|
||||
},
|
||||
"MetricUnit":{"type":"string"},
|
||||
"MinAdjustmentMagnitude":{"type":"integer"},
|
||||
"ObjectNotFoundException":{
|
||||
"type":"structure",
|
||||
|
|
@ -407,7 +483,25 @@
|
|||
},
|
||||
"PolicyType":{
|
||||
"type":"string",
|
||||
"enum":["StepScaling"]
|
||||
"enum":[
|
||||
"StepScaling",
|
||||
"TargetTrackingScaling"
|
||||
]
|
||||
},
|
||||
"PredefinedMetricSpecification":{
|
||||
"type":"structure",
|
||||
"required":["PredefinedMetricType"],
|
||||
"members":{
|
||||
"PredefinedMetricType":{
|
||||
"shape":"MetricType",
|
||||
"documentation":"<p>The metric type.</p>"
|
||||
},
|
||||
"ResourceLabel":{
|
||||
"shape":"ResourceLabel",
|
||||
"documentation":"<p>Reserved for future use.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Configures a predefined metric for a target tracking policy.</p>"
|
||||
},
|
||||
"PutScalingPolicyRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -428,19 +522,23 @@
|
|||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>"
|
||||
},
|
||||
"PolicyType":{
|
||||
"shape":"PolicyType",
|
||||
"documentation":"<p>The policy type. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required.</p>"
|
||||
"documentation":"<p>The policy type. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required.</p> <p>For DynamoDB, only <code>TargetTrackingScaling</code> is supported. For any other service, only <code>StepScaling</code> is supported.</p>"
|
||||
},
|
||||
"StepScalingPolicyConfiguration":{
|
||||
"shape":"StepScalingPolicyConfiguration",
|
||||
"documentation":"<p>The configuration for the step scaling policy. If you are creating a new policy, this parameter is required. If you are updating a policy, this parameter is not required. For more information, see <a>StepScalingPolicyConfiguration</a> and <a>StepAdjustment</a>.</p>"
|
||||
"documentation":"<p>A step scaling policy.</p> <p>This parameter is required if you are creating a policy and the policy type is <code>StepScaling</code>.</p>"
|
||||
},
|
||||
"TargetTrackingScalingPolicyConfiguration":{
|
||||
"shape":"TargetTrackingScalingPolicyConfiguration",
|
||||
"documentation":"<p>A target tracking policy.</p> <p>This parameter is required if you are creating a new policy and the policy type is <code>TargetTrackingScaling</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -451,6 +549,10 @@
|
|||
"PolicyARN":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resulting scaling policy.</p>"
|
||||
},
|
||||
"Alarms":{
|
||||
"shape":"Alarms",
|
||||
"documentation":"<p>The CloudWatch alarms created for the target tracking policy.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -468,11 +570,11 @@
|
|||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>"
|
||||
},
|
||||
"MinCapacity":{
|
||||
"shape":"ResourceCapacity",
|
||||
|
|
@ -508,12 +610,22 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"ResourceIdMaxLen1600"}
|
||||
},
|
||||
"ResourceLabel":{
|
||||
"type":"string",
|
||||
"max":1023,
|
||||
"min":1
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ecs:service:DesiredCount",
|
||||
"ec2:spot-fleet-request:TargetCapacity",
|
||||
"elasticmapreduce:instancegroup:InstanceCount"
|
||||
"elasticmapreduce:instancegroup:InstanceCount",
|
||||
"appstream:fleet:DesiredCapacity",
|
||||
"dynamodb:table:ReadCapacityUnits",
|
||||
"dynamodb:table:WriteCapacityUnits",
|
||||
"dynamodb:index:ReadCapacityUnits",
|
||||
"dynamodb:index:WriteCapacityUnits"
|
||||
]
|
||||
},
|
||||
"ScalableTarget":{
|
||||
|
|
@ -534,11 +646,11 @@
|
|||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scalable target. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension associated with the scalable target. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>"
|
||||
},
|
||||
"MinCapacity":{
|
||||
"shape":"ResourceCapacity",
|
||||
|
|
@ -590,11 +702,11 @@
|
|||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling activity. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"XmlString",
|
||||
|
|
@ -669,11 +781,11 @@
|
|||
},
|
||||
"ResourceId":{
|
||||
"shape":"ResourceIdMaxLen1600",
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>The identifier of the resource associated with the scaling policy. This string consists of the resource type and unique identifier.</p> <ul> <li> <p>ECS service - The resource type is <code>service</code> and the unique identifier is the cluster name and service name. Example: <code>service/default/sample-webapp</code>.</p> </li> <li> <p>Spot fleet request - The resource type is <code>spot-fleet-request</code> and the unique identifier is the Spot fleet request ID. Example: <code>spot-fleet-request/sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE</code>.</p> </li> <li> <p>EMR cluster - The resource type is <code>instancegroup</code> and the unique identifier is the cluster ID and instance group ID. Example: <code>instancegroup/j-2EEZNYKUA1NTV/ig-1791Y4E1L8YI0</code>.</p> </li> <li> <p>AppStream 2.0 fleet - The resource type is <code>fleet</code> and the unique identifier is the fleet name. Example: <code>fleet/sample-fleet</code>.</p> </li> <li> <p>DynamoDB table - The resource type is <code>table</code> and the unique identifier is the resource ID. Example: <code>table/my-table</code>.</p> </li> <li> <p>DynamoDB global secondary index - The resource type is <code>index</code> and the unique identifier is the resource ID. Example: <code>table/my-table/index/my-table-index</code>.</p> </li> </ul>"
|
||||
},
|
||||
"ScalableDimension":{
|
||||
"shape":"ScalableDimension",
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> </ul>"
|
||||
"documentation":"<p>The scalable dimension. This string consists of the service namespace, resource type, and scaling property.</p> <ul> <li> <p> <code>ecs:service:DesiredCount</code> - The desired task count of an ECS service.</p> </li> <li> <p> <code>ec2:spot-fleet-request:TargetCapacity</code> - The target capacity of a Spot fleet request.</p> </li> <li> <p> <code>elasticmapreduce:instancegroup:InstanceCount</code> - The instance count of an EMR Instance Group.</p> </li> <li> <p> <code>appstream:fleet:DesiredCapacity</code> - The desired capacity of an AppStream 2.0 fleet.</p> </li> <li> <p> <code>dynamodb:table:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:table:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB table.</p> </li> <li> <p> <code>dynamodb:index:ReadCapacityUnits</code> - The provisioned read capacity for a DynamoDB global secondary index.</p> </li> <li> <p> <code>dynamodb:index:WriteCapacityUnits</code> - The provisioned write capacity for a DynamoDB global secondary index.</p> </li> </ul>"
|
||||
},
|
||||
"PolicyType":{
|
||||
"shape":"PolicyType",
|
||||
|
|
@ -681,7 +793,11 @@
|
|||
},
|
||||
"StepScalingPolicyConfiguration":{
|
||||
"shape":"StepScalingPolicyConfiguration",
|
||||
"documentation":"<p>The configuration for the step scaling policy.</p>"
|
||||
"documentation":"<p>A step scaling policy.</p>"
|
||||
},
|
||||
"TargetTrackingScalingPolicyConfiguration":{
|
||||
"shape":"TargetTrackingScalingPolicyConfiguration",
|
||||
"documentation":"<p>A target tracking policy.</p>"
|
||||
},
|
||||
"Alarms":{
|
||||
"shape":"Alarms",
|
||||
|
|
@ -699,7 +815,9 @@
|
|||
"enum":[
|
||||
"ecs",
|
||||
"elasticmapreduce",
|
||||
"ec2"
|
||||
"ec2",
|
||||
"appstream",
|
||||
"dynamodb"
|
||||
]
|
||||
},
|
||||
"StepAdjustment":{
|
||||
|
|
@ -742,7 +860,7 @@
|
|||
},
|
||||
"Cooldown":{
|
||||
"shape":"Cooldown",
|
||||
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.</p> <p>For scale out policies, while <code>Cooldown</code> is in effect, the capacity that has been added by the previous scale out event that initiated the <code>Cooldown</code> is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a <code>Cooldown</code> period of 5 minutes starts. During the <code>Cooldown</code> period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.</p> <p>For scale in policies, the <code>Cooldown</code> period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the <code>Cooldown</code> period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p>"
|
||||
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes where previous trigger-related scaling activities can influence future scaling events.</p> <p>For scale out policies, while the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out. For example, an alarm triggers a step scaling policy to scale out an Amazon ECS service by 2 tasks, the scaling activity completes successfully, and a cooldown period of 5 minutes starts. During the Cooldown period, if the alarm triggers the same policy again but at a more aggressive step adjustment to scale out the service by 3 tasks, the 2 tasks that were added in the previous scale out event are considered part of that capacity and only 1 additional task is added to the desired count.</p> <p>For scale in policies, the cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p>"
|
||||
},
|
||||
"MetricAggregationType":{
|
||||
"shape":"MetricAggregationType",
|
||||
|
|
@ -751,6 +869,33 @@
|
|||
},
|
||||
"documentation":"<p>Represents a step scaling policy configuration.</p>"
|
||||
},
|
||||
"TargetTrackingScalingPolicyConfiguration":{
|
||||
"type":"structure",
|
||||
"required":["TargetValue"],
|
||||
"members":{
|
||||
"TargetValue":{
|
||||
"shape":"MetricScale",
|
||||
"documentation":"<p>The target value for the metric. The range is 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2).</p>"
|
||||
},
|
||||
"PredefinedMetricSpecification":{
|
||||
"shape":"PredefinedMetricSpecification",
|
||||
"documentation":"<p>A predefined metric.</p>"
|
||||
},
|
||||
"CustomizedMetricSpecification":{
|
||||
"shape":"CustomizedMetricSpecification",
|
||||
"documentation":"<p>Reserved for future use.</p>"
|
||||
},
|
||||
"ScaleOutCooldown":{
|
||||
"shape":"Cooldown",
|
||||
"documentation":"<p>The amount of time, in seconds, after a scale out activity completes before another scale out activity can start.</p> <p>While the cooldown period is in effect, the capacity that has been added by the previous scale out event that initiated the cooldown is calculated as part of the desired capacity for the next scale out. The intention is to continuously (but not excessively) scale out.</p>"
|
||||
},
|
||||
"ScaleInCooldown":{
|
||||
"shape":"Cooldown",
|
||||
"documentation":"<p>The amount of time, in seconds, after a scale in activity completes before another scale in activity can start.</p> <p>The cooldown period is used to block subsequent scale in requests until it has expired. The intention is to scale in conservatively to protect your application's availability. However, if another alarm triggers a scale out policy during the cooldown period after a scale-in, Application Auto Scaling scales out your scalable target immediately.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents a target tracking scaling policy configuration.</p>"
|
||||
},
|
||||
"TimestampType":{"type":"timestamp"},
|
||||
"ValidationException":{
|
||||
"type":"structure",
|
||||
|
|
@ -765,5 +910,5 @@
|
|||
"pattern":"[\\u0020-\\uD7FF\\uE000-\\uFFFD\\uD800\\uDC00-\\uDBFF\\uDFFF\\r\\n\\t]*"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>With Application Auto Scaling, you can automatically scale your AWS resources. The experience similar to that of <a href=\"https://aws.amazon.com/autoscaling/\">Auto Scaling</a>. You can use Application Auto Scaling to accomplish the following tasks:</p> <ul> <li> <p>Define scaling policies to automatically scale your AWS resources</p> </li> <li> <p>Scale your resources in response to CloudWatch alarms</p> </li> <li> <p>View the history of your scaling events</p> </li> </ul> <p>Application Auto Scaling can scale the following AWS resources:</p> <ul> <li> <p>Amazon ECS services. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html\">Service Auto Scaling</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> </li> <li> <p>Amazon EC2 Spot fleets. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-auto-scaling.html\">Automatic Scaling for Spot Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> <li> <p>Amazon EMR clusters. For more information, see <a href=\"http://docs.aws.amazon.com/ElasticMapReduce/latest/ManagementGuide/emr-automatic-scaling.html\">Using Automatic Scaling in Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p> </li> </ul> <p>For a list of supported regions, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#as-app_region\">AWS Regions and Endpoints: Application Auto Scaling</a> in the <i>AWS General Reference</i>.</p>"
|
||||
"documentation":"<p>With Application Auto Scaling, you can automatically scale your AWS resources. The experience similar to that of <a href=\"https://aws.amazon.com/autoscaling/\">Auto Scaling</a>. You can use Application Auto Scaling to accomplish the following tasks:</p> <ul> <li> <p>Define scaling policies to automatically scale your AWS resources</p> </li> <li> <p>Scale your resources in response to CloudWatch alarms</p> </li> <li> <p>View the history of your scaling events</p> </li> </ul> <p>Application Auto Scaling can scale the following AWS resources:</p> <ul> <li> <p>Amazon ECS services. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-auto-scaling.html\">Service Auto Scaling</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p> </li> <li> <p>Amazon EC2 Spot fleets. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-auto-scaling.html\">Automatic Scaling for Spot Fleet</a> in the <i>Amazon EC2 User Guide</i>.</p> </li> <li> <p>Amazon EMR clusters. For more information, see <a href=\"http://docs.aws.amazon.com/ElasticMapReduce/latest/ManagementGuide/emr-automatic-scaling.html\">Using Automatic Scaling in Amazon EMR</a> in the <i>Amazon EMR Management Guide</i>.</p> </li> <li> <p>AppStream 2.0 fleets. For more information, see <a href=\"http://docs.aws.amazon.com/appstream2/latest/developerguide/autoscaling.html\">Fleet Auto Scaling for Amazon AppStream 2.0</a> in the <i>Amazon AppStream 2.0 Developer Guide</i>.</p> </li> <li> <p>Provisioned read and write capacity for Amazon DynamoDB tables and global secondary indexes. For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TargetTracking.html\">Auto Scaling for DynamoDB</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p> </li> </ul> <p>For a list of supported regions, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/rande.html#as-app_region\">AWS Regions and Endpoints: Application Auto Scaling</a> in the <i>AWS General Reference</i>.</p>"
|
||||
}
|
||||
|
|
|
|||
5
botocore/data/appstream/2016-12-01/examples-1.json
Normal file
5
botocore/data/appstream/2016-12-01/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
3
botocore/data/appstream/2016-12-01/paginators-1.json
Normal file
3
botocore/data/appstream/2016-12-01/paginators-1.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
|
|
@ -22,7 +22,9 @@
|
|||
"output":{"shape":"AssociateFleetResult"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"IncompatibleImageException"}
|
||||
],
|
||||
"documentation":"<p>Associate a fleet to a stack.</p>"
|
||||
},
|
||||
|
|
@ -39,7 +41,8 @@
|
|||
{"shape":"ResourceNotAvailableException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidRoleException"}
|
||||
{"shape":"InvalidRoleException"},
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new fleet.</p>"
|
||||
},
|
||||
|
|
@ -53,7 +56,11 @@
|
|||
"output":{"shape":"CreateStackResult"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ResourceAlreadyExistsException"}
|
||||
{"shape":"ResourceAlreadyExistsException"},
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"InvalidRoleException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Create a new stack.</p>"
|
||||
},
|
||||
|
|
@ -68,7 +75,8 @@
|
|||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ResourceNotAvailableException"},
|
||||
{"shape":"OperationNotPermittedException"}
|
||||
{"shape":"OperationNotPermittedException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Creates a URL to start an AppStream 2.0 streaming session for a user. By default, the URL is valid only for 1 minute from the time that it is generated.</p>"
|
||||
},
|
||||
|
|
@ -82,7 +90,8 @@
|
|||
"output":{"shape":"DeleteFleetResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a fleet.</p>"
|
||||
},
|
||||
|
|
@ -96,7 +105,8 @@
|
|||
"output":{"shape":"DeleteStackResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the stack. After this operation completes, the environment can no longer be activated, and any reservations made for the stack are released.</p>"
|
||||
},
|
||||
|
|
@ -134,7 +144,10 @@
|
|||
},
|
||||
"input":{"shape":"DescribeSessionsRequest"},
|
||||
"output":{"shape":"DescribeSessionsResult"},
|
||||
"documentation":"<p>Describes the streaming sessions for a stack and a fleet. If a user ID is provided, this operation returns streaming sessions for only that user. Pass this value for the <code>nextToken</code> parameter in a subsequent call to this operation to retrieve the next set of items.</p>"
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Describes the streaming sessions for a stack and a fleet. If a user ID is provided, this operation returns streaming sessions for only that user. Pass this value for the <code>nextToken</code> parameter in a subsequent call to this operation to retrieve the next set of items. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.</p>"
|
||||
},
|
||||
"DescribeStacks":{
|
||||
"name":"DescribeStacks",
|
||||
|
|
@ -159,7 +172,8 @@
|
|||
"output":{"shape":"DisassociateFleetResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
],
|
||||
"documentation":"<p>Disassociates a fleet from a stack.</p>"
|
||||
},
|
||||
|
|
@ -203,7 +217,9 @@
|
|||
"output":{"shape":"StartFleetResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
{"shape":"OperationNotPermittedException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
],
|
||||
"documentation":"<p>Starts a fleet.</p>"
|
||||
},
|
||||
|
|
@ -216,7 +232,8 @@
|
|||
"input":{"shape":"StopFleetRequest"},
|
||||
"output":{"shape":"StopFleetResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
],
|
||||
"documentation":"<p>Stops a fleet.</p>"
|
||||
},
|
||||
|
|
@ -232,9 +249,13 @@
|
|||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InvalidRoleException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ResourceNotAvailableException"},
|
||||
{"shape":"InvalidParameterCombinationException"},
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"IncompatibleImageException"}
|
||||
],
|
||||
"documentation":"<p>Updates an existing fleet. All the attributes except the fleet name can be updated in the <b>STOPPED</b> state. Only <b>ComputeCapacity</b> and <b>ImageName</b> can be updated in any other state. </p>"
|
||||
"documentation":"<p>Updates an existing fleet. All the attributes except the fleet name can be updated in the <b>STOPPED</b> state. When a fleet is in the <b>RUNNING</b> state, only <code>DisplayName</code> and <code>ComputeCapacity</code> can be updated. A fleet cannot be updated in a status of <b>STARTING</b> or <b>STOPPING</b>.</p>"
|
||||
},
|
||||
"UpdateStack":{
|
||||
"name":"UpdateStack",
|
||||
|
|
@ -246,7 +267,11 @@
|
|||
"output":{"shape":"UpdateStackResult"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"ResourceInUseException"}
|
||||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"InvalidRoleException"},
|
||||
{"shape":"InvalidParameterCombinationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"IncompatibleImageException"}
|
||||
],
|
||||
"documentation":"<p>Updates the specified fields in the stack with the specified name.</p>"
|
||||
}
|
||||
|
|
@ -281,7 +306,7 @@
|
|||
},
|
||||
"Metadata":{
|
||||
"shape":"Metadata",
|
||||
"documentation":"<p>Additional attributes that describes the application.</p>"
|
||||
"documentation":"<p>Additional attributes that describe the application.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An entry for a single application in the application catalog.</p>"
|
||||
|
|
@ -316,7 +341,16 @@
|
|||
"members":{
|
||||
}
|
||||
},
|
||||
"AuthenticationType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"API",
|
||||
"SAML",
|
||||
"USERPOOL"
|
||||
]
|
||||
},
|
||||
"Boolean":{"type":"boolean"},
|
||||
"BooleanObject":{"type":"boolean"},
|
||||
"ComputeCapacity":{
|
||||
"type":"structure",
|
||||
"required":["DesiredInstances"],
|
||||
|
|
@ -351,6 +385,14 @@
|
|||
},
|
||||
"documentation":"<p>The capacity information for the fleet.</p>"
|
||||
},
|
||||
"ConcurrentModificationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>An API error occurred. Wait a few minutes and try again.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"CreateFleetRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -382,11 +424,11 @@
|
|||
},
|
||||
"MaxUserDurationInSeconds":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The maximum time up to which a streaming session can run.</p>"
|
||||
"documentation":"<p>The maximum time for which a streaming session can run. The input can be any numeric value in seconds between 600 and 57600.</p>"
|
||||
},
|
||||
"DisconnectTimeoutInSeconds":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to his/her previous session. </p>"
|
||||
"documentation":"<p>The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600. </p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"Description",
|
||||
|
|
@ -395,6 +437,10 @@
|
|||
"DisplayName":{
|
||||
"shape":"DisplayName",
|
||||
"documentation":"<p>The display name of the fleet.</p>"
|
||||
},
|
||||
"EnableDefaultInternetAccess":{
|
||||
"shape":"BooleanObject",
|
||||
"documentation":"<p>Enables or disables default Internet access for the fleet.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for the new fleet to create.</p>"
|
||||
|
|
@ -423,6 +469,10 @@
|
|||
"DisplayName":{
|
||||
"shape":"DisplayName",
|
||||
"documentation":"<p>The name displayed to end users on the AppStream 2.0 portal.</p>"
|
||||
},
|
||||
"StorageConnectors":{
|
||||
"shape":"StorageConnectorList",
|
||||
"documentation":"<p>The storage connectors to be enabled for the stack.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -461,7 +511,7 @@
|
|||
},
|
||||
"Validity":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The validity duration of the URL in seconds. After this duration, the URL returned by this operation becomes invalid.</p>"
|
||||
"documentation":"<p>The duration up to which the URL returned by this action is valid. The input can be any numeric value in seconds between 1 and 604800 seconds.</p>"
|
||||
},
|
||||
"SessionContext":{
|
||||
"shape":"String",
|
||||
|
|
@ -582,6 +632,10 @@
|
|||
"Limit":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The size of each page of results. The default value is 20 and the maximum supported value is 50.</p>"
|
||||
},
|
||||
"AuthenticationType":{
|
||||
"shape":"AuthenticationType",
|
||||
"documentation":"<p>The authentication method of the user. It can be <code>API</code> for a user authenticated using a streaming URL, or <code>SAML</code> for a SAML federated user. If an authentication type is not provided, the operation defaults to users authenticated using a streaming URL.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -654,7 +708,10 @@
|
|||
"type":"string",
|
||||
"max":100
|
||||
},
|
||||
"ErrorMessage":{"type":"string"},
|
||||
"ErrorMessage":{
|
||||
"type":"string",
|
||||
"documentation":"<p>The error message in the exception.</p>"
|
||||
},
|
||||
"ExpireSessionRequest":{
|
||||
"type":"structure",
|
||||
"required":["SessionId"],
|
||||
|
|
@ -711,11 +768,11 @@
|
|||
},
|
||||
"MaxUserDurationInSeconds":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The maximum time during which a streaming session can run.</p>"
|
||||
"documentation":"<p>The maximum time for which a streaming session can run. The value can be any numeric value in seconds between 600 and 57600.</p>"
|
||||
},
|
||||
"DisconnectTimeoutInSeconds":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The time after disconnection when a session is considered to have ended. When a user reconnects after a disconnection, the user is connected to the same session and instance within this time interval.</p>"
|
||||
"documentation":"<p>The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600.</p>"
|
||||
},
|
||||
"State":{
|
||||
"shape":"FleetState",
|
||||
|
|
@ -732,10 +789,27 @@
|
|||
"FleetErrors":{
|
||||
"shape":"FleetErrors",
|
||||
"documentation":"<p>The list of fleet errors is appended to this list.</p>"
|
||||
},
|
||||
"EnableDefaultInternetAccess":{
|
||||
"shape":"BooleanObject",
|
||||
"documentation":"<p>Whether default Internet access is enabled for the fleet. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for a fleet.</p>"
|
||||
},
|
||||
"FleetAttribute":{
|
||||
"type":"string",
|
||||
"documentation":"<p>Fleet attribute.</p>",
|
||||
"enum":[
|
||||
"VPC_CONFIGURATION",
|
||||
"VPC_CONFIGURATION_SECURITY_GROUP_IDS"
|
||||
]
|
||||
},
|
||||
"FleetAttributes":{
|
||||
"type":"list",
|
||||
"member":{"shape":"FleetAttribute"},
|
||||
"documentation":"<p>A list of fleet attributes.</p>"
|
||||
},
|
||||
"FleetError":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -812,6 +886,10 @@
|
|||
"shape":"VisibilityType",
|
||||
"documentation":"<p>The visibility of an image to the user; images can be public or private.</p>"
|
||||
},
|
||||
"ImageBuilderSupported":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Whether an image builder can be launched from this image.</p>"
|
||||
},
|
||||
"Platform":{
|
||||
"shape":"PlatformType",
|
||||
"documentation":"<p>The operating system platform of the image.</p>"
|
||||
|
|
@ -831,6 +909,10 @@
|
|||
"CreatedTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The timestamp when the image was created.</p>"
|
||||
},
|
||||
"PublicBaseImageReleasedDate":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The AWS release date of the public base image. For private images, this date is the release date of the base image from which the image was created.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>New streaming instances are booted from images. The image stores the application catalog and is connected to fleets.</p>"
|
||||
|
|
@ -869,7 +951,23 @@
|
|||
"IMAGE_BUILDER_NOT_AVAILABLE"
|
||||
]
|
||||
},
|
||||
"IncompatibleImageException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>The image does not support storage connectors.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"Integer":{"type":"integer"},
|
||||
"InvalidParameterCombinationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>Indicates an incorrect combination of parameters, or a missing parameter.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidRoleException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -972,6 +1070,11 @@
|
|||
"documentation":"<p>The specified resource already exists.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ResourceIdentifier":{
|
||||
"type":"string",
|
||||
"documentation":"<p>The ARN of the resource.</p>",
|
||||
"min":1
|
||||
},
|
||||
"ResourceInUseException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -996,6 +1099,12 @@
|
|||
"documentation":"<p>The specified resource was not found.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"SecurityGroupIdList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"},
|
||||
"documentation":"<p>A list of security groups.</p>",
|
||||
"max":5
|
||||
},
|
||||
"Session":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -1025,6 +1134,10 @@
|
|||
"State":{
|
||||
"shape":"SessionState",
|
||||
"documentation":"<p>The current state of the streaming session.</p>"
|
||||
},
|
||||
"AuthenticationType":{
|
||||
"shape":"AuthenticationType",
|
||||
"documentation":"<p>The authentication method of the user for whom the session was created. It can be <code>API</code> for a user authenticated using a streaming URL or <code>SAML</code> for a SAML federated user.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for a streaming session.</p>"
|
||||
|
|
@ -1066,10 +1179,44 @@
|
|||
"CreatedTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The timestamp when the stack was created.</p>"
|
||||
},
|
||||
"StorageConnectors":{
|
||||
"shape":"StorageConnectorList",
|
||||
"documentation":"<p>The storage connectors to be enabled for the stack.</p>"
|
||||
},
|
||||
"StackErrors":{
|
||||
"shape":"StackErrors",
|
||||
"documentation":"<p>The list of errors associated with the stack.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Details about a stack.</p>"
|
||||
},
|
||||
"StackError":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ErrorCode":{
|
||||
"shape":"StackErrorCode",
|
||||
"documentation":"<p>The error code of a stack error.</p>"
|
||||
},
|
||||
"ErrorMessage":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The error message of a stack error.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for a stack error.</p>"
|
||||
},
|
||||
"StackErrorCode":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"STORAGE_CONNECTOR_ERROR",
|
||||
"INTERNAL_SERVICE_ERROR"
|
||||
]
|
||||
},
|
||||
"StackErrors":{
|
||||
"type":"list",
|
||||
"member":{"shape":"StackError"},
|
||||
"documentation":"<p>A list of stack errors.</p>"
|
||||
},
|
||||
"StackList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Stack"},
|
||||
|
|
@ -1105,6 +1252,31 @@
|
|||
"members":{
|
||||
}
|
||||
},
|
||||
"StorageConnector":{
|
||||
"type":"structure",
|
||||
"required":["ConnectorType"],
|
||||
"members":{
|
||||
"ConnectorType":{
|
||||
"shape":"StorageConnectorType",
|
||||
"documentation":"<p>The type of storage connector. The possible values include: HOMEFOLDERS.</p>"
|
||||
},
|
||||
"ResourceIdentifier":{
|
||||
"shape":"ResourceIdentifier",
|
||||
"documentation":"<p>The ARN associated with the storage connector.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for a storage connector.</p>"
|
||||
},
|
||||
"StorageConnectorList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"StorageConnector"},
|
||||
"documentation":"<p>A list of storage connectors.</p>"
|
||||
},
|
||||
"StorageConnectorType":{
|
||||
"type":"string",
|
||||
"documentation":"<p>The type of storage connector. The possible values include: HOMEFOLDERS.</p>",
|
||||
"enum":["HOMEFOLDERS"]
|
||||
},
|
||||
"String":{
|
||||
"type":"string",
|
||||
"min":1
|
||||
|
|
@ -1116,8 +1288,7 @@
|
|||
"SubnetIdList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"},
|
||||
"documentation":"<p>A list of subnet IDs.</p>",
|
||||
"min":1
|
||||
"documentation":"<p>A list of subnet IDs.</p>"
|
||||
},
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"UpdateFleetRequest":{
|
||||
|
|
@ -1146,15 +1317,16 @@
|
|||
},
|
||||
"MaxUserDurationInSeconds":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The maximum time during which a streaming session can run.</p>"
|
||||
"documentation":"<p>The maximum time for which a streaming session can run. The input can be any numeric value in seconds between 600 and 57600.</p>"
|
||||
},
|
||||
"DisconnectTimeoutInSeconds":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The time after disconnection when a session is considered to have ended. When the user reconnects after a disconnection, the user is connected to the same instance within this time interval.</p>"
|
||||
"documentation":"<p>The time after disconnection when a session is considered to have ended. If a user who got disconnected reconnects within this timeout interval, the user is connected back to their previous session. The input can be any numeric value in seconds between 60 and 57600.</p>"
|
||||
},
|
||||
"DeleteVpcConfig":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Delete the VPC association for the specified fleet.</p>"
|
||||
"documentation":"<p>Delete the VPC association for the specified fleet.</p>",
|
||||
"deprecated":true
|
||||
},
|
||||
"Description":{
|
||||
"shape":"Description",
|
||||
|
|
@ -1163,6 +1335,14 @@
|
|||
"DisplayName":{
|
||||
"shape":"DisplayName",
|
||||
"documentation":"<p>The name displayed to end users on the AppStream 2.0 portal.</p>"
|
||||
},
|
||||
"EnableDefaultInternetAccess":{
|
||||
"shape":"BooleanObject",
|
||||
"documentation":"<p>Enables or disables default Internet access for the fleet.</p>"
|
||||
},
|
||||
"AttributesToDelete":{
|
||||
"shape":"FleetAttributes",
|
||||
"documentation":"<p>Fleet attributes to be deleted.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1190,6 +1370,14 @@
|
|||
"Name":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the stack to update.</p>"
|
||||
},
|
||||
"StorageConnectors":{
|
||||
"shape":"StorageConnectorList",
|
||||
"documentation":"<p>The storage connectors to be enabled for the stack.</p>"
|
||||
},
|
||||
"DeleteStorageConnectors":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Remove all the storage connectors currently enabled for the stack.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1216,14 +1404,17 @@
|
|||
},
|
||||
"VpcConfig":{
|
||||
"type":"structure",
|
||||
"required":["SubnetIds"],
|
||||
"members":{
|
||||
"SubnetIds":{
|
||||
"shape":"SubnetIdList",
|
||||
"documentation":"<p>The list of subnets to which a network interface is established from the fleet instance.</p>"
|
||||
},
|
||||
"SecurityGroupIds":{
|
||||
"shape":"SecurityGroupIdList",
|
||||
"documentation":"<p>Security groups associated with the fleet.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The VPC in which the fleet is launched.</p>"
|
||||
"documentation":"<p>VPC configuration information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<fullname>Amazon AppStream 2.0</fullname> <p>API documentation for Amazon AppStream 2.0.</p>"
|
||||
|
|
|
|||
3
botocore/data/athena/2017-05-18/paginators-1.json
Normal file
3
botocore/data/athena/2017-05-18/paginators-1.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
873
botocore/data/athena/2017-05-18/service-2.json
Normal file
873
botocore/data/athena/2017-05-18/service-2.json
Normal file
|
|
@ -0,0 +1,873 @@
|
|||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2017-05-18",
|
||||
"endpointPrefix":"athena",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceFullName":"Amazon Athena",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"AmazonAthena",
|
||||
"uid":"athena-2017-05-18"
|
||||
},
|
||||
"operations":{
|
||||
"BatchGetNamedQuery":{
|
||||
"name":"BatchGetNamedQuery",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"BatchGetNamedQueryInput"},
|
||||
"output":{"shape":"BatchGetNamedQueryOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Returns the details of a single named query or a list of up to 50 queries, which you provide as an array of query ID strings. Use <a>ListNamedQueries</a> to get the list of named query IDs. If information could not be retrieved for a submitted query ID, information about the query ID submitted is listed under <a>UnprocessedNamedQueryId</a>. Named queries are different from executed queries. Use <a>BatchGetQueryExecution</a> to get details about each unique query execution, and <a>ListQueryExecutions</a> to get a list of query execution IDs.</p>"
|
||||
},
|
||||
"BatchGetQueryExecution":{
|
||||
"name":"BatchGetQueryExecution",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"BatchGetQueryExecutionInput"},
|
||||
"output":{"shape":"BatchGetQueryExecutionOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Returns the details of a single query execution or a list of up to 50 query executions, which you provide as an array of query execution ID strings. To get a list of query execution IDs, use <a>ListQueryExecutions</a>. Query executions are different from named (saved) queries. Use <a>BatchGetNamedQuery</a> to get details about named queries.</p>"
|
||||
},
|
||||
"CreateNamedQuery":{
|
||||
"name":"CreateNamedQuery",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateNamedQueryInput"},
|
||||
"output":{"shape":"CreateNamedQueryOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Creates a named query.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"DeleteNamedQuery":{
|
||||
"name":"DeleteNamedQuery",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteNamedQueryInput"},
|
||||
"output":{"shape":"DeleteNamedQueryOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a named query.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"GetNamedQuery":{
|
||||
"name":"GetNamedQuery",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetNamedQueryInput"},
|
||||
"output":{"shape":"GetNamedQueryOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Returns information about a single query.</p>"
|
||||
},
|
||||
"GetQueryExecution":{
|
||||
"name":"GetQueryExecution",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetQueryExecutionInput"},
|
||||
"output":{"shape":"GetQueryExecutionOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Returns information about a single execution of a query. Each time a query executes, information about the query execution is saved with a unique ID.</p>"
|
||||
},
|
||||
"GetQueryResults":{
|
||||
"name":"GetQueryResults",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetQueryResultsInput"},
|
||||
"output":{"shape":"GetQueryResultsOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Returns the results of a single query execution specified by <code>QueryExecutionId</code>. This request does not execute the query but returns results. Use <a>StartQueryExecution</a> to run a query.</p>"
|
||||
},
|
||||
"ListNamedQueries":{
|
||||
"name":"ListNamedQueries",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListNamedQueriesInput"},
|
||||
"output":{"shape":"ListNamedQueriesOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Provides a list of all available query IDs.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>"
|
||||
},
|
||||
"ListQueryExecutions":{
|
||||
"name":"ListQueryExecutions",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListQueryExecutionsInput"},
|
||||
"output":{"shape":"ListQueryExecutionsOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Provides a list of all available query execution IDs.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>"
|
||||
},
|
||||
"StartQueryExecution":{
|
||||
"name":"StartQueryExecution",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StartQueryExecutionInput"},
|
||||
"output":{"shape":"StartQueryExecutionOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"},
|
||||
{"shape":"TooManyRequestsException"}
|
||||
],
|
||||
"documentation":"<p>Runs (executes) the SQL query statements contained in the <code>Query</code> string.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"StopQueryExecution":{
|
||||
"name":"StopQueryExecution",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StopQueryExecutionInput"},
|
||||
"output":{"shape":"StopQueryExecutionOutput"},
|
||||
"errors":[
|
||||
{"shape":"InternalServerException"},
|
||||
{"shape":"InvalidRequestException"}
|
||||
],
|
||||
"documentation":"<p>Stops a query execution.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>",
|
||||
"idempotent":true
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"BatchGetNamedQueryInput":{
|
||||
"type":"structure",
|
||||
"required":["NamedQueryIds"],
|
||||
"members":{
|
||||
"NamedQueryIds":{
|
||||
"shape":"NamedQueryIdList",
|
||||
"documentation":"<p>An array of query IDs.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"BatchGetNamedQueryOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NamedQueries":{
|
||||
"shape":"NamedQueryList",
|
||||
"documentation":"<p>Information about the named query IDs submitted.</p>"
|
||||
},
|
||||
"UnprocessedNamedQueryIds":{
|
||||
"shape":"UnprocessedNamedQueryIdList",
|
||||
"documentation":"<p>Information about provided query IDs.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"BatchGetQueryExecutionInput":{
|
||||
"type":"structure",
|
||||
"required":["QueryExecutionIds"],
|
||||
"members":{
|
||||
"QueryExecutionIds":{
|
||||
"shape":"QueryExecutionIdList",
|
||||
"documentation":"<p>An array of query execution IDs.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"BatchGetQueryExecutionOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"QueryExecutions":{
|
||||
"shape":"QueryExecutionList",
|
||||
"documentation":"<p>Information about a query execution.</p>"
|
||||
},
|
||||
"UnprocessedQueryExecutionIds":{
|
||||
"shape":"UnprocessedQueryExecutionIdList",
|
||||
"documentation":"<p>Information about the query executions that failed to run.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Boolean":{"type":"boolean"},
|
||||
"ColumnInfo":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Name",
|
||||
"Type"
|
||||
],
|
||||
"members":{
|
||||
"CatalogName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The catalog to which the query results belong.</p>"
|
||||
},
|
||||
"SchemaName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The schema name (database name) to which the query results belong.</p>"
|
||||
},
|
||||
"TableName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The table name for the query results.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the column.</p>"
|
||||
},
|
||||
"Label":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A column label.</p>"
|
||||
},
|
||||
"Type":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The data type of the column.</p>"
|
||||
},
|
||||
"Precision":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>For <code>DECIMAL</code> data types, specifies the total number of digits, up to 38. For performance reasons, we recommend up to 18 digits.</p>"
|
||||
},
|
||||
"Scale":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>For <code>DECIMAL</code> data types, specifies the total number of digits in the fractional part of the value. Defaults to 0.</p>"
|
||||
},
|
||||
"Nullable":{
|
||||
"shape":"ColumnNullable",
|
||||
"documentation":"<p>Indicates the column's nullable status.</p>"
|
||||
},
|
||||
"CaseSensitive":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Indicates whether values in the column are case-sensitive.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about the columns in a query execution result.</p>"
|
||||
},
|
||||
"ColumnInfoList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ColumnInfo"}
|
||||
},
|
||||
"ColumnNullable":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"NOT_NULL",
|
||||
"NULLABLE",
|
||||
"UNKNOWN"
|
||||
]
|
||||
},
|
||||
"CreateNamedQueryInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Name",
|
||||
"Database",
|
||||
"QueryString"
|
||||
],
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The plain language name for the query.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"DescriptionString",
|
||||
"documentation":"<p>A brief explanation of the query.</p>"
|
||||
},
|
||||
"Database":{
|
||||
"shape":"DatabaseString",
|
||||
"documentation":"<p>The database to which the query belongs.</p>"
|
||||
},
|
||||
"QueryString":{
|
||||
"shape":"QueryString",
|
||||
"documentation":"<p>The text of the query itself. In other words, all query statements.</p>"
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"IdempotencyToken",
|
||||
"documentation":"<p>A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another <code>CreateNamedQuery</code> request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the <code>QueryString</code>, an error is returned.</p> <important> <p>This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.</p> </important>",
|
||||
"idempotencyToken":true
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateNamedQueryOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NamedQueryId":{
|
||||
"shape":"NamedQueryId",
|
||||
"documentation":"<p>The unique ID of the query.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DatabaseString":{
|
||||
"type":"string",
|
||||
"max":32,
|
||||
"min":1
|
||||
},
|
||||
"Date":{"type":"timestamp"},
|
||||
"Datum":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"VarCharValue":{
|
||||
"shape":"datumString",
|
||||
"documentation":"<p>The value of the datum.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A piece of data (a field in the table).</p>"
|
||||
},
|
||||
"DeleteNamedQueryInput":{
|
||||
"type":"structure",
|
||||
"required":["NamedQueryId"],
|
||||
"members":{
|
||||
"NamedQueryId":{
|
||||
"shape":"NamedQueryId",
|
||||
"documentation":"<p>The unique ID of the query to delete.</p>",
|
||||
"idempotencyToken":true
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteNamedQueryOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DescriptionString":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
"min":1
|
||||
},
|
||||
"EncryptionConfiguration":{
|
||||
"type":"structure",
|
||||
"required":["EncryptionOption"],
|
||||
"members":{
|
||||
"EncryptionOption":{
|
||||
"shape":"EncryptionOption",
|
||||
"documentation":"<p>Indicates whether Amazon S3 server-side encryption with Amazon S3-managed keys (<code>SSE-S3</code>), server-side encryption with KMS-managed keys (<code>SSE-KMS</code>), or client-side encryption with KMS-managed keys (CSE-KMS) is used.</p>"
|
||||
},
|
||||
"KmsKey":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>For <code>SSE-KMS</code> and <code>CSE-KMS</code>, this is the KMS key ARN or ID.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>If query results are encrypted in Amazon S3, indicates the Amazon S3 encryption option used.</p>"
|
||||
},
|
||||
"EncryptionOption":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"SSE_S3",
|
||||
"SSE_KMS",
|
||||
"CSE_KMS"
|
||||
]
|
||||
},
|
||||
"ErrorCode":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":1
|
||||
},
|
||||
"ErrorMessage":{"type":"string"},
|
||||
"GetNamedQueryInput":{
|
||||
"type":"structure",
|
||||
"required":["NamedQueryId"],
|
||||
"members":{
|
||||
"NamedQueryId":{
|
||||
"shape":"NamedQueryId",
|
||||
"documentation":"<p>The unique ID of the query. Use <a>ListNamedQueries</a> to get query IDs.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetNamedQueryOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NamedQuery":{
|
||||
"shape":"NamedQuery",
|
||||
"documentation":"<p>Information about the query.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetQueryExecutionInput":{
|
||||
"type":"structure",
|
||||
"required":["QueryExecutionId"],
|
||||
"members":{
|
||||
"QueryExecutionId":{
|
||||
"shape":"QueryExecutionId",
|
||||
"documentation":"<p>The unique ID of the query execution.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetQueryExecutionOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"QueryExecution":{
|
||||
"shape":"QueryExecution",
|
||||
"documentation":"<p>Information about the query execution.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetQueryResultsInput":{
|
||||
"type":"structure",
|
||||
"required":["QueryExecutionId"],
|
||||
"members":{
|
||||
"QueryExecutionId":{
|
||||
"shape":"QueryExecutionId",
|
||||
"documentation":"<p>The unique ID of the query execution.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>The token that specifies where to start pagination if a previous request was truncated.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxQueryResults",
|
||||
"documentation":"<p>The maximum number of results (rows) to return in this request.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetQueryResultsOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ResultSet":{
|
||||
"shape":"ResultSet",
|
||||
"documentation":"<p>The results of the query execution.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>A token to be used by the next request if this request is truncated.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"IdempotencyToken":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":32
|
||||
},
|
||||
"Integer":{"type":"integer"},
|
||||
"InternalServerException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>Indicates a platform issue, which may be due to a transient condition or outage.</p>",
|
||||
"exception":true,
|
||||
"fault":true
|
||||
},
|
||||
"InvalidRequestException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AthenaErrorCode":{"shape":"ErrorCode"},
|
||||
"Message":{"shape":"ErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>Indicates that something is wrong with the input to the request. For example, a required parameter may be missing or out of range.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ListNamedQueriesInput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>The token that specifies where to start pagination if a previous request was truncated.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxNamedQueriesCount",
|
||||
"documentation":"<p>The maximum number of queries to return in this request.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListNamedQueriesOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NamedQueryIds":{
|
||||
"shape":"NamedQueryIdList",
|
||||
"documentation":"<p>The list of unique query IDs.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>A token to be used by the next request if this request is truncated.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListQueryExecutionsInput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>The token that specifies where to start pagination if a previous request was truncated.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"MaxQueryExecutionsCount",
|
||||
"documentation":"<p>The maximum number of query executions to return in this request.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListQueryExecutionsOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"QueryExecutionIds":{
|
||||
"shape":"QueryExecutionIdList",
|
||||
"documentation":"<p>The unique IDs of each query execution as an array of strings.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"Token",
|
||||
"documentation":"<p>A token to be used by the next request if this request is truncated.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Long":{"type":"long"},
|
||||
"MaxNamedQueriesCount":{
|
||||
"type":"integer",
|
||||
"box":true,
|
||||
"max":50,
|
||||
"min":0
|
||||
},
|
||||
"MaxQueryExecutionsCount":{
|
||||
"type":"integer",
|
||||
"box":true,
|
||||
"max":50,
|
||||
"min":0
|
||||
},
|
||||
"MaxQueryResults":{
|
||||
"type":"integer",
|
||||
"box":true,
|
||||
"max":1000,
|
||||
"min":0
|
||||
},
|
||||
"NameString":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1
|
||||
},
|
||||
"NamedQuery":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Name",
|
||||
"Database",
|
||||
"QueryString"
|
||||
],
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"NameString",
|
||||
"documentation":"<p>The plain-language name of the query.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"DescriptionString",
|
||||
"documentation":"<p>A brief description of the query.</p>"
|
||||
},
|
||||
"Database":{
|
||||
"shape":"DatabaseString",
|
||||
"documentation":"<p>The database to which the query belongs.</p>"
|
||||
},
|
||||
"QueryString":{
|
||||
"shape":"QueryString",
|
||||
"documentation":"<p>The SQL query statements that comprise the query.</p>"
|
||||
},
|
||||
"NamedQueryId":{
|
||||
"shape":"NamedQueryId",
|
||||
"documentation":"<p>The unique identifier of the query.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A query, where <code>QueryString</code> is the SQL query statements that comprise the query.</p>"
|
||||
},
|
||||
"NamedQueryId":{"type":"string"},
|
||||
"NamedQueryIdList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NamedQueryId"},
|
||||
"max":50,
|
||||
"min":1
|
||||
},
|
||||
"NamedQueryList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NamedQuery"}
|
||||
},
|
||||
"QueryExecution":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"QueryExecutionId":{
|
||||
"shape":"QueryExecutionId",
|
||||
"documentation":"<p>The unique identifier for each query execution.</p>"
|
||||
},
|
||||
"Query":{
|
||||
"shape":"QueryString",
|
||||
"documentation":"<p>The SQL query statements which the query execution ran.</p>"
|
||||
},
|
||||
"ResultConfiguration":{
|
||||
"shape":"ResultConfiguration",
|
||||
"documentation":"<p>The location in Amazon S3 where query results were stored and the encryption option, if any, used for query results.</p>"
|
||||
},
|
||||
"QueryExecutionContext":{
|
||||
"shape":"QueryExecutionContext",
|
||||
"documentation":"<p>The database in which the query execution occurred.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"QueryExecutionStatus",
|
||||
"documentation":"<p>The completion date, current state, submission time, and state change reason (if applicable) for the query execution.</p>"
|
||||
},
|
||||
"Statistics":{
|
||||
"shape":"QueryExecutionStatistics",
|
||||
"documentation":"<p>The amount of data scanned during the query execution and the amount of time that it took to execute.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a single instance of a query execution.</p>"
|
||||
},
|
||||
"QueryExecutionContext":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Database":{
|
||||
"shape":"DatabaseString",
|
||||
"documentation":"<p>The name of the database.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The database in which the query execution occurs.</p>"
|
||||
},
|
||||
"QueryExecutionId":{"type":"string"},
|
||||
"QueryExecutionIdList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"QueryExecutionId"},
|
||||
"max":50,
|
||||
"min":1
|
||||
},
|
||||
"QueryExecutionList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"QueryExecution"}
|
||||
},
|
||||
"QueryExecutionState":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"QUEUED",
|
||||
"RUNNING",
|
||||
"SUCCEEDED",
|
||||
"FAILED",
|
||||
"CANCELLED"
|
||||
]
|
||||
},
|
||||
"QueryExecutionStatistics":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"EngineExecutionTimeInMillis":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The number of milliseconds that the query took to execute.</p>"
|
||||
},
|
||||
"DataScannedInBytes":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The number of bytes in the data that was queried.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The amount of data scanned during the query execution and the amount of time that it took to execute.</p>"
|
||||
},
|
||||
"QueryExecutionStatus":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"State":{
|
||||
"shape":"QueryExecutionState",
|
||||
"documentation":"<p>The state of query execution. <code>SUBMITTED</code> indicates that the query is queued for execution. <code>RUNNING</code> indicates that the query is scanning data and returning results. <code>SUCCEEDED</code> indicates that the query completed without error. <code>FAILED</code> indicates that the query experienced an error and did not complete processing. <code>CANCELLED</code> indicates that user input interrupted query execution.</p>"
|
||||
},
|
||||
"StateChangeReason":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Further detail about the status of the query.</p>"
|
||||
},
|
||||
"SubmissionDateTime":{
|
||||
"shape":"Date",
|
||||
"documentation":"<p>The date and time that the query was submitted.</p>"
|
||||
},
|
||||
"CompletionDateTime":{
|
||||
"shape":"Date",
|
||||
"documentation":"<p>The date and time that the query completed.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The completion date, current state, submission time, and state change reason (if applicable) for the query execution.</p>"
|
||||
},
|
||||
"QueryString":{
|
||||
"type":"string",
|
||||
"max":262144,
|
||||
"min":1
|
||||
},
|
||||
"ResultConfiguration":{
|
||||
"type":"structure",
|
||||
"required":["OutputLocation"],
|
||||
"members":{
|
||||
"OutputLocation":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The location in S3 where query results are stored.</p>"
|
||||
},
|
||||
"EncryptionConfiguration":{
|
||||
"shape":"EncryptionConfiguration",
|
||||
"documentation":"<p>If query results are encrypted in S3, indicates the S3 encryption option used (for example, <code>SSE-KMS</code> or <code>CSE-KMS</code> and key information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The location in Amazon S3 where query results are stored and the encryption option, if any, used for query results.</p>"
|
||||
},
|
||||
"ResultSet":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Rows":{
|
||||
"shape":"RowList",
|
||||
"documentation":"<p>The rows in the table.</p>"
|
||||
},
|
||||
"ResultSetMetadata":{
|
||||
"shape":"ResultSetMetadata",
|
||||
"documentation":"<p>The metadata that describes the column structure and data types of a table of query results.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The metadata and rows that comprise a query result set. The metadata describes the column structure and data types.</p>"
|
||||
},
|
||||
"ResultSetMetadata":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ColumnInfo":{
|
||||
"shape":"ColumnInfoList",
|
||||
"documentation":"<p>Information about the columns in a query execution result.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The metadata that describes the column structure and data types of a table of query results.</p>"
|
||||
},
|
||||
"Row":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Data":{
|
||||
"shape":"datumList",
|
||||
"documentation":"<p>The data that populates a row in a query result table.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The rows that comprise a query result table.</p>"
|
||||
},
|
||||
"RowList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Row"}
|
||||
},
|
||||
"StartQueryExecutionInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"QueryString",
|
||||
"ResultConfiguration"
|
||||
],
|
||||
"members":{
|
||||
"QueryString":{
|
||||
"shape":"QueryString",
|
||||
"documentation":"<p>The SQL query statements to be executed.</p>"
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"IdempotencyToken",
|
||||
"documentation":"<p>A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another <code>StartQueryExecution</code> request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the <code>QueryString</code>, an error is returned.</p> <important> <p>This token is listed as not required because AWS SDKs (for example the AWS SDK for Java) auto-generate the token for users. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the action will fail.</p> </important>",
|
||||
"idempotencyToken":true
|
||||
},
|
||||
"QueryExecutionContext":{
|
||||
"shape":"QueryExecutionContext",
|
||||
"documentation":"<p>The database within which the query executes.</p>"
|
||||
},
|
||||
"ResultConfiguration":{
|
||||
"shape":"ResultConfiguration",
|
||||
"documentation":"<p>Specifies information about where and how to save the results of the query execution.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartQueryExecutionOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"QueryExecutionId":{
|
||||
"shape":"QueryExecutionId",
|
||||
"documentation":"<p>The unique ID of the query that ran as a result of this request.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StopQueryExecutionInput":{
|
||||
"type":"structure",
|
||||
"required":["QueryExecutionId"],
|
||||
"members":{
|
||||
"QueryExecutionId":{
|
||||
"shape":"QueryExecutionId",
|
||||
"documentation":"<p>The unique ID of the query execution to stop.</p>",
|
||||
"idempotencyToken":true
|
||||
}
|
||||
}
|
||||
},
|
||||
"StopQueryExecutionOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"String":{"type":"string"},
|
||||
"ThrottleReason":{
|
||||
"type":"string",
|
||||
"enum":["CONCURRENT_QUERY_LIMIT_EXCEEDED"]
|
||||
},
|
||||
"Token":{"type":"string"},
|
||||
"TooManyRequestsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ErrorMessage"},
|
||||
"Reason":{"shape":"ThrottleReason"}
|
||||
},
|
||||
"documentation":"<p>Indicates that the request was throttled.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"UnprocessedNamedQueryId":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NamedQueryId":{
|
||||
"shape":"NamedQueryId",
|
||||
"documentation":"<p>The unique identifier of the named query.</p>"
|
||||
},
|
||||
"ErrorCode":{
|
||||
"shape":"ErrorCode",
|
||||
"documentation":"<p>The error code returned when the processing request for the named query failed, if applicable.</p>"
|
||||
},
|
||||
"ErrorMessage":{
|
||||
"shape":"ErrorMessage",
|
||||
"documentation":"<p>The error message returned when the processing request for the named query failed, if applicable.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a named query ID that could not be processed.</p>"
|
||||
},
|
||||
"UnprocessedNamedQueryIdList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"UnprocessedNamedQueryId"}
|
||||
},
|
||||
"UnprocessedQueryExecutionId":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"QueryExecutionId":{
|
||||
"shape":"QueryExecutionId",
|
||||
"documentation":"<p>The unique identifier of the query execution.</p>"
|
||||
},
|
||||
"ErrorCode":{
|
||||
"shape":"ErrorCode",
|
||||
"documentation":"<p>The error code returned when the query execution failed to process, if applicable.</p>"
|
||||
},
|
||||
"ErrorMessage":{
|
||||
"shape":"ErrorMessage",
|
||||
"documentation":"<p>The error message returned when the query execution failed to process, if applicable.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes a query execution that failed to process.</p>"
|
||||
},
|
||||
"UnprocessedQueryExecutionIdList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"UnprocessedQueryExecutionId"}
|
||||
},
|
||||
"datumList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Datum"}
|
||||
},
|
||||
"datumString":{"type":"string"}
|
||||
},
|
||||
"documentation":"<p>Amazon Athena is an interactive query service that lets you use standard SQL to analyze data directly in Amazon S3. You can point Athena at your data in Amazon S3 and run ad-hoc queries and get results in seconds. Athena is serverless, so there is no infrastructure to set up or manage. You pay only for the queries you run. Athena scales automatically—executing queries in parallel—so results are fast, even with large datasets and complex queries. For more information, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/what-is.html\">What is Amazon Athena</a> in the <i>Amazon Athena User Guide</i>.</p> <p>For code samples using the AWS SDK for Java, see <a href=\"http://docs.aws.amazon.com/athena/latest/ug/code-samples.html\">Examples and Code Samples</a> in the <i>Amazon Athena User Guide</i>.</p>"
|
||||
}
|
||||
1395
botocore/data/autoscaling/2011-01-01/examples-1.json
Normal file
1395
botocore/data/autoscaling/2011-01-01/examples-1.json
Normal file
|
|
@ -0,0 +1,1395 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
"AttachInstances": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"InstanceIds": [
|
||||
"i-93633f9b"
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example attaches the specified instance to the specified Auto Scaling group.",
|
||||
"id": "autoscaling-attach-instances-1",
|
||||
"title": "To attach an instance to an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"AttachLoadBalancerTargetGroups": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"TargetGroupARNs": [
|
||||
"arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example attaches the specified target group to the specified Auto Scaling group.",
|
||||
"id": "autoscaling-attach-load-balancer-target-groups-1",
|
||||
"title": "To attach a target group to an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"AttachLoadBalancers": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"LoadBalancerNames": [
|
||||
"my-load-balancer"
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example attaches the specified load balancer to the specified Auto Scaling group.",
|
||||
"id": "autoscaling-attach-load-balancers-1",
|
||||
"title": "To attach a load balancer to an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"CompleteLifecycleAction": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"LifecycleActionResult": "CONTINUE",
|
||||
"LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635",
|
||||
"LifecycleHookName": "my-lifecycle-hook"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.",
|
||||
"id": "autoscaling-complete-lifecycle-action-1",
|
||||
"title": "To complete the lifecycle action"
|
||||
}
|
||||
],
|
||||
"CreateAutoScalingGroup": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"LaunchConfigurationName": "my-launch-config",
|
||||
"MaxSize": 3,
|
||||
"MinSize": 1,
|
||||
"VPCZoneIdentifier": "subnet-4176792c"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example creates an Auto Scaling group.",
|
||||
"id": "autoscaling-create-auto-scaling-group-1",
|
||||
"title": "To create an Auto Scaling group"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"AvailabilityZones": [
|
||||
"us-west-2c"
|
||||
],
|
||||
"HealthCheckGracePeriod": 120,
|
||||
"HealthCheckType": "ELB",
|
||||
"LaunchConfigurationName": "my-launch-config",
|
||||
"LoadBalancerNames": [
|
||||
"my-load-balancer"
|
||||
],
|
||||
"MaxSize": 3,
|
||||
"MinSize": 1
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example creates an Auto Scaling group and attaches the specified Classic Load Balancer.",
|
||||
"id": "autoscaling-create-auto-scaling-group-2",
|
||||
"title": "To create an Auto Scaling group with an attached load balancer"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"HealthCheckGracePeriod": 120,
|
||||
"HealthCheckType": "ELB",
|
||||
"LaunchConfigurationName": "my-launch-config",
|
||||
"MaxSize": 3,
|
||||
"MinSize": 1,
|
||||
"TargetGroupARNs": [
|
||||
"arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
|
||||
],
|
||||
"VPCZoneIdentifier": "subnet-4176792c, subnet-65ea5f08"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example creates an Auto Scaling group and attaches the specified target group.",
|
||||
"id": "autoscaling-create-auto-scaling-group-3",
|
||||
"title": "To create an Auto Scaling group with an attached target group"
|
||||
}
|
||||
],
|
||||
"CreateLaunchConfiguration": [
|
||||
{
|
||||
"input": {
|
||||
"IamInstanceProfile": "my-iam-role",
|
||||
"ImageId": "ami-12345678",
|
||||
"InstanceType": "m3.medium",
|
||||
"LaunchConfigurationName": "my-launch-config",
|
||||
"SecurityGroups": [
|
||||
"sg-eb2af88e"
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example creates a launch configuration.",
|
||||
"id": "autoscaling-create-launch-configuration-1",
|
||||
"title": "To create a launch configuration"
|
||||
}
|
||||
],
|
||||
"CreateOrUpdateTags": [
|
||||
{
|
||||
"input": {
|
||||
"Tags": [
|
||||
{
|
||||
"Key": "Role",
|
||||
"PropagateAtLaunch": true,
|
||||
"ResourceId": "my-auto-scaling-group",
|
||||
"ResourceType": "auto-scaling-group",
|
||||
"Value": "WebServer"
|
||||
},
|
||||
{
|
||||
"Key": "Dept",
|
||||
"PropagateAtLaunch": true,
|
||||
"ResourceId": "my-auto-scaling-group",
|
||||
"ResourceType": "auto-scaling-group",
|
||||
"Value": "Research"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example adds two tags to the specified Auto Scaling group.",
|
||||
"id": "autoscaling-create-or-update-tags-1",
|
||||
"title": "To create or update tags for an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"DeleteAutoScalingGroup": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes the specified Auto Scaling group.",
|
||||
"id": "autoscaling-delete-auto-scaling-group-1",
|
||||
"title": "To delete an Auto Scaling group"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"ForceDelete": true
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes the specified Auto Scaling group and all its instances.",
|
||||
"id": "autoscaling-delete-auto-scaling-group-2",
|
||||
"title": "To delete an Auto Scaling group and all its instances"
|
||||
}
|
||||
],
|
||||
"DeleteLaunchConfiguration": [
|
||||
{
|
||||
"input": {
|
||||
"LaunchConfigurationName": "my-launch-config"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes the specified launch configuration.",
|
||||
"id": "autoscaling-delete-launch-configuration-1",
|
||||
"title": "To delete a launch configuration"
|
||||
}
|
||||
],
|
||||
"DeleteLifecycleHook": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"LifecycleHookName": "my-lifecycle-hook"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes the specified lifecycle hook.",
|
||||
"id": "autoscaling-delete-lifecycle-hook-1",
|
||||
"title": "To delete a lifecycle hook"
|
||||
}
|
||||
],
|
||||
"DeleteNotificationConfiguration": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes the specified notification from the specified Auto Scaling group.",
|
||||
"id": "autoscaling-delete-notification-configuration-1",
|
||||
"title": "To delete an Auto Scaling notification"
|
||||
}
|
||||
],
|
||||
"DeletePolicy": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"PolicyName": "ScaleIn"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes the specified Auto Scaling policy.",
|
||||
"id": "autoscaling-delete-policy-1",
|
||||
"title": "To delete an Auto Scaling policy"
|
||||
}
|
||||
],
|
||||
"DeleteScheduledAction": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"ScheduledActionName": "my-scheduled-action"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes the specified scheduled action from the specified Auto Scaling group.",
|
||||
"id": "autoscaling-delete-scheduled-action-1",
|
||||
"title": "To delete a scheduled action from an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"DeleteTags": [
|
||||
{
|
||||
"input": {
|
||||
"Tags": [
|
||||
{
|
||||
"Key": "Dept",
|
||||
"ResourceId": "my-auto-scaling-group",
|
||||
"ResourceType": "auto-scaling-group",
|
||||
"Value": "Research"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes the specified tag from the specified Auto Scaling group.",
|
||||
"id": "autoscaling-delete-tags-1",
|
||||
"title": "To delete a tag from an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"DescribeAccountLimits": [
|
||||
{
|
||||
"output": {
|
||||
"MaxNumberOfAutoScalingGroups": 20,
|
||||
"MaxNumberOfLaunchConfigurations": 100,
|
||||
"NumberOfAutoScalingGroups": 3,
|
||||
"NumberOfLaunchConfigurations": 5
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the Auto Scaling limits for your AWS account.",
|
||||
"id": "autoscaling-describe-account-limits-1",
|
||||
"title": "To describe your Auto Scaling account limits"
|
||||
}
|
||||
],
|
||||
"DescribeAdjustmentTypes": [
|
||||
{
|
||||
"output": {
|
||||
"AdjustmentTypes": [
|
||||
{
|
||||
"AdjustmentType": "ChangeInCapacity"
|
||||
},
|
||||
{
|
||||
"AdjustmentType": "ExactCapcity"
|
||||
},
|
||||
{
|
||||
"AdjustmentType": "PercentChangeInCapacity"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the available adjustment types.",
|
||||
"id": "autoscaling-describe-adjustment-types-1",
|
||||
"title": "To describe the Auto Scaling adjustment types"
|
||||
}
|
||||
],
|
||||
"DescribeAutoScalingGroups": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupNames": [
|
||||
"my-auto-scaling-group"
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"AutoScalingGroups": [
|
||||
{
|
||||
"AutoScalingGroupARN": "arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480f03:autoScalingGroupName/my-auto-scaling-group",
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"AvailabilityZones": [
|
||||
"us-west-2c"
|
||||
],
|
||||
"CreatedTime": "2013-08-19T20:53:25.584Z",
|
||||
"DefaultCooldown": 300,
|
||||
"DesiredCapacity": 1,
|
||||
"EnabledMetrics": [
|
||||
|
||||
],
|
||||
"HealthCheckGracePeriod": 300,
|
||||
"HealthCheckType": "EC2",
|
||||
"Instances": [
|
||||
{
|
||||
"AvailabilityZone": "us-west-2c",
|
||||
"HealthStatus": "Healthy",
|
||||
"InstanceId": "i-4ba0837f",
|
||||
"LaunchConfigurationName": "my-launch-config",
|
||||
"LifecycleState": "InService"
|
||||
}
|
||||
],
|
||||
"LaunchConfigurationName": "my-launch-config",
|
||||
"LoadBalancerNames": [
|
||||
|
||||
],
|
||||
"MaxSize": 1,
|
||||
"MinSize": 0,
|
||||
"NewInstancesProtectedFromScaleIn": false,
|
||||
"SuspendedProcesses": [
|
||||
|
||||
],
|
||||
"Tags": [
|
||||
|
||||
],
|
||||
"TerminationPolicies": [
|
||||
"Default"
|
||||
],
|
||||
"VPCZoneIdentifier": "subnet-12345678"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the specified Auto Scaling group.",
|
||||
"id": "autoscaling-describe-auto-scaling-groups-1",
|
||||
"title": "To describe an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"DescribeAutoScalingInstances": [
|
||||
{
|
||||
"input": {
|
||||
"InstanceIds": [
|
||||
"i-4ba0837f"
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"AutoScalingInstances": [
|
||||
{
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"AvailabilityZone": "us-west-2c",
|
||||
"HealthStatus": "HEALTHY",
|
||||
"InstanceId": "i-4ba0837f",
|
||||
"LaunchConfigurationName": "my-launch-config",
|
||||
"LifecycleState": "InService",
|
||||
"ProtectedFromScaleIn": false
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the specified Auto Scaling instance.",
|
||||
"id": "autoscaling-describe-auto-scaling-instances-1",
|
||||
"title": "To describe one or more Auto Scaling instances"
|
||||
}
|
||||
],
|
||||
"DescribeAutoScalingNotificationTypes": [
|
||||
{
|
||||
"output": {
|
||||
"AutoScalingNotificationTypes": [
|
||||
"autoscaling:EC2_INSTANCE_LAUNCH",
|
||||
"autoscaling:EC2_INSTANCE_LAUNCH_ERROR",
|
||||
"autoscaling:EC2_INSTANCE_TERMINATE",
|
||||
"autoscaling:EC2_INSTANCE_TERMINATE_ERROR",
|
||||
"autoscaling:TEST_NOTIFICATION"
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the available notification types.",
|
||||
"id": "autoscaling-describe-auto-scaling-notification-types-1",
|
||||
"title": "To describe the Auto Scaling notification types"
|
||||
}
|
||||
],
|
||||
"DescribeLaunchConfigurations": [
|
||||
{
|
||||
"input": {
|
||||
"LaunchConfigurationNames": [
|
||||
"my-launch-config"
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"LaunchConfigurations": [
|
||||
{
|
||||
"AssociatePublicIpAddress": true,
|
||||
"BlockDeviceMappings": [
|
||||
|
||||
],
|
||||
"CreatedTime": "2014-05-07T17:39:28.599Z",
|
||||
"EbsOptimized": false,
|
||||
"ImageId": "ami-043a5034",
|
||||
"InstanceMonitoring": {
|
||||
"Enabled": true
|
||||
},
|
||||
"InstanceType": "t1.micro",
|
||||
"LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config",
|
||||
"LaunchConfigurationName": "my-launch-config",
|
||||
"SecurityGroups": [
|
||||
"sg-67ef0308"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the specified launch configuration.",
|
||||
"id": "autoscaling-describe-launch-configurations-1",
|
||||
"title": "To describe Auto Scaling launch configurations"
|
||||
}
|
||||
],
|
||||
"DescribeLifecycleHookTypes": [
|
||||
{
|
||||
"output": {
|
||||
"LifecycleHookTypes": [
|
||||
"autoscaling:EC2_INSTANCE_LAUNCHING",
|
||||
"autoscaling:EC2_INSTANCE_TERMINATING"
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the available lifecycle hook types.",
|
||||
"id": "autoscaling-describe-lifecycle-hook-types-1",
|
||||
"title": "To describe the available types of lifecycle hooks"
|
||||
}
|
||||
],
|
||||
"DescribeLifecycleHooks": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group"
|
||||
},
|
||||
"output": {
|
||||
"LifecycleHooks": [
|
||||
{
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"DefaultResult": "ABANDON",
|
||||
"GlobalTimeout": 172800,
|
||||
"HeartbeatTimeout": 3600,
|
||||
"LifecycleHookName": "my-lifecycle-hook",
|
||||
"LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING",
|
||||
"NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic",
|
||||
"RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the lifecycle hooks for the specified Auto Scaling group.",
|
||||
"id": "autoscaling-describe-lifecycle-hooks-1",
|
||||
"title": "To describe your lifecycle hooks"
|
||||
}
|
||||
],
|
||||
"DescribeLoadBalancerTargetGroups": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group"
|
||||
},
|
||||
"output": {
|
||||
"LoadBalancerTargetGroups": [
|
||||
{
|
||||
"LoadBalancerTargetGroupARN": "arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067",
|
||||
"State": "Added"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the target groups attached to the specified Auto Scaling group.",
|
||||
"id": "autoscaling-describe-load-balancer-target-groups-1",
|
||||
"title": "To describe the target groups for an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"DescribeLoadBalancers": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group"
|
||||
},
|
||||
"output": {
|
||||
"LoadBalancers": [
|
||||
{
|
||||
"LoadBalancerName": "my-load-balancer",
|
||||
"State": "Added"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the load balancers attached to the specified Auto Scaling group.",
|
||||
"id": "autoscaling-describe-load-balancers-1",
|
||||
"title": "To describe the load balancers for an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"DescribeMetricCollectionTypes": [
|
||||
{
|
||||
"output": {
|
||||
"Granularities": [
|
||||
{
|
||||
"Granularity": "1Minute"
|
||||
}
|
||||
],
|
||||
"Metrics": [
|
||||
{
|
||||
"Metric": "GroupMinSize"
|
||||
},
|
||||
{
|
||||
"Metric": "GroupMaxSize"
|
||||
},
|
||||
{
|
||||
"Metric": "GroupDesiredCapacity"
|
||||
},
|
||||
{
|
||||
"Metric": "GroupInServiceInstances"
|
||||
},
|
||||
{
|
||||
"Metric": "GroupPendingInstances"
|
||||
},
|
||||
{
|
||||
"Metric": "GroupTerminatingInstances"
|
||||
},
|
||||
{
|
||||
"Metric": "GroupStandbyInstances"
|
||||
},
|
||||
{
|
||||
"Metric": "GroupTotalInstances"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the available metric collection types.",
|
||||
"id": "autoscaling-describe-metric-collection-types-1",
|
||||
"title": "To describe the Auto Scaling metric collection types"
|
||||
}
|
||||
],
|
||||
"DescribeNotificationConfigurations": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupNames": [
|
||||
"my-auto-scaling-group"
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"NotificationConfigurations": [
|
||||
{
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"NotificationType": "autoscaling:TEST_NOTIFICATION",
|
||||
"TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic-2"
|
||||
},
|
||||
{
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"NotificationType": "autoscaling:TEST_NOTIFICATION",
|
||||
"TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the notification configurations for the specified Auto Scaling group.",
|
||||
"id": "autoscaling-describe-notification-configurations-1",
|
||||
"title": "To describe Auto Scaling notification configurations"
|
||||
}
|
||||
],
|
||||
"DescribePolicies": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group"
|
||||
},
|
||||
"output": {
|
||||
"ScalingPolicies": [
|
||||
{
|
||||
"AdjustmentType": "ChangeInCapacity",
|
||||
"Alarms": [
|
||||
|
||||
],
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn",
|
||||
"PolicyName": "ScaleIn",
|
||||
"ScalingAdjustment": -1
|
||||
},
|
||||
{
|
||||
"AdjustmentType": "PercentChangeInCapacity",
|
||||
"Alarms": [
|
||||
|
||||
],
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"Cooldown": 60,
|
||||
"MinAdjustmentStep": 2,
|
||||
"PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange",
|
||||
"PolicyName": "ScalePercentChange",
|
||||
"ScalingAdjustment": 25
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the policies for the specified Auto Scaling group.",
|
||||
"id": "autoscaling-describe-policies-1",
|
||||
"title": "To describe Auto Scaling policies"
|
||||
}
|
||||
],
|
||||
"DescribeScalingActivities": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group"
|
||||
},
|
||||
"output": {
|
||||
"Activities": [
|
||||
{
|
||||
"ActivityId": "f9f2d65b-f1f2-43e7-b46d-d86756459699",
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"Cause": "At 2013-08-19T20:53:25Z a user request created an AutoScalingGroup changing the desired capacity from 0 to 1. At 2013-08-19T20:53:29Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 1.",
|
||||
"Description": "Launching a new EC2 instance: i-4ba0837f",
|
||||
"Details": "details",
|
||||
"EndTime": "2013-08-19T20:54:02Z",
|
||||
"Progress": 100,
|
||||
"StartTime": "2013-08-19T20:53:29.930Z",
|
||||
"StatusCode": "Successful"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the scaling activities for the specified Auto Scaling group.",
|
||||
"id": "autoscaling-describe-scaling-activities-1",
|
||||
"title": "To describe the scaling activities for an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"DescribeScalingProcessTypes": [
|
||||
{
|
||||
"output": {
|
||||
"Processes": [
|
||||
{
|
||||
"ProcessName": "AZRebalance"
|
||||
},
|
||||
{
|
||||
"ProcessName": "AddToLoadBalancer"
|
||||
},
|
||||
{
|
||||
"ProcessName": "AlarmNotification"
|
||||
},
|
||||
{
|
||||
"ProcessName": "HealthCheck"
|
||||
},
|
||||
{
|
||||
"ProcessName": "Launch"
|
||||
},
|
||||
{
|
||||
"ProcessName": "ReplaceUnhealthy"
|
||||
},
|
||||
{
|
||||
"ProcessName": "ScheduledActions"
|
||||
},
|
||||
{
|
||||
"ProcessName": "Terminate"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the Auto Scaling process types.",
|
||||
"id": "autoscaling-describe-scaling-process-types-1",
|
||||
"title": "To describe the Auto Scaling process types"
|
||||
}
|
||||
],
|
||||
"DescribeScheduledActions": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group"
|
||||
},
|
||||
"output": {
|
||||
"ScheduledUpdateGroupActions": [
|
||||
{
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"DesiredCapacity": 4,
|
||||
"MaxSize": 6,
|
||||
"MinSize": 2,
|
||||
"Recurrence": "30 0 1 12 0",
|
||||
"ScheduledActionARN": "arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action",
|
||||
"ScheduledActionName": "my-scheduled-action",
|
||||
"StartTime": "2016-12-01T00:30:00Z",
|
||||
"Time": "2016-12-01T00:30:00Z"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the scheduled actions for the specified Auto Scaling group.",
|
||||
"id": "autoscaling-describe-scheduled-actions-1",
|
||||
"title": "To describe scheduled actions"
|
||||
}
|
||||
],
|
||||
"DescribeTags": [
|
||||
{
|
||||
"input": {
|
||||
"Filters": [
|
||||
{
|
||||
"Name": "auto-scaling-group",
|
||||
"Values": [
|
||||
"my-auto-scaling-group"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"Tags": [
|
||||
{
|
||||
"Key": "Dept",
|
||||
"PropagateAtLaunch": true,
|
||||
"ResourceId": "my-auto-scaling-group",
|
||||
"ResourceType": "auto-scaling-group",
|
||||
"Value": "Research"
|
||||
},
|
||||
{
|
||||
"Key": "Role",
|
||||
"PropagateAtLaunch": true,
|
||||
"ResourceId": "my-auto-scaling-group",
|
||||
"ResourceType": "auto-scaling-group",
|
||||
"Value": "WebServer"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the tags for the specified Auto Scaling group.",
|
||||
"id": "autoscaling-describe-tags-1",
|
||||
"title": "To describe tags"
|
||||
}
|
||||
],
|
||||
"DescribeTerminationPolicyTypes": [
|
||||
{
|
||||
"output": {
|
||||
"TerminationPolicyTypes": [
|
||||
"ClosestToNextInstanceHour",
|
||||
"Default",
|
||||
"NewestInstance",
|
||||
"OldestInstance",
|
||||
"OldestLaunchConfiguration"
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the available termination policy types.",
|
||||
"id": "autoscaling-describe-termination-policy-types-1",
|
||||
"title": "To describe termination policy types"
|
||||
}
|
||||
],
|
||||
"DetachInstances": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"InstanceIds": [
|
||||
"i-93633f9b"
|
||||
],
|
||||
"ShouldDecrementDesiredCapacity": true
|
||||
},
|
||||
"output": {
|
||||
"Activities": [
|
||||
{
|
||||
"ActivityId": "5091cb52-547a-47ce-a236-c9ccbc2cb2c9",
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"Cause": "At 2015-04-12T15:02:16Z instance i-93633f9b was detached in response to a user request, shrinking the capacity from 2 to 1.",
|
||||
"Description": "Detaching EC2 instance: i-93633f9b",
|
||||
"Details": "details",
|
||||
"Progress": 50,
|
||||
"StartTime": "2015-04-12T15:02:16.179Z",
|
||||
"StatusCode": "InProgress"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example detaches the specified instance from the specified Auto Scaling group.",
|
||||
"id": "autoscaling-detach-instances-1",
|
||||
"title": "To detach an instance from an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"DetachLoadBalancerTargetGroups": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"TargetGroupARNs": [
|
||||
"arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067"
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example detaches the specified target group from the specified Auto Scaling group",
|
||||
"id": "autoscaling-detach-load-balancer-target-groups-1",
|
||||
"title": "To detach a target group from an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"DetachLoadBalancers": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"LoadBalancerNames": [
|
||||
"my-load-balancer"
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example detaches the specified load balancer from the specified Auto Scaling group.",
|
||||
"id": "autoscaling-detach-load-balancers-1",
|
||||
"title": "To detach a load balancer from an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"DisableMetricsCollection": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"Metrics": [
|
||||
"GroupDesiredCapacity"
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.",
|
||||
"id": "autoscaling-disable-metrics-collection-1",
|
||||
"title": "To disable metrics collection for an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"EnableMetricsCollection": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"Granularity": "1Minute"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example enables data collection for the specified Auto Scaling group.",
|
||||
"id": "autoscaling-enable-metrics-collection-1",
|
||||
"title": "To enable metrics collection for an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"EnterStandby": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"InstanceIds": [
|
||||
"i-93633f9b"
|
||||
],
|
||||
"ShouldDecrementDesiredCapacity": true
|
||||
},
|
||||
"output": {
|
||||
"Activities": [
|
||||
{
|
||||
"ActivityId": "ffa056b4-6ed3-41ba-ae7c-249dfae6eba1",
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"Cause": "At 2015-04-12T15:10:23Z instance i-93633f9b was moved to standby in response to a user request, shrinking the capacity from 2 to 1.",
|
||||
"Description": "Moving EC2 instance to Standby: i-93633f9b",
|
||||
"Details": "details",
|
||||
"Progress": 50,
|
||||
"StartTime": "2015-04-12T15:10:23.640Z",
|
||||
"StatusCode": "InProgress"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example puts the specified instance into standby mode.",
|
||||
"id": "autoscaling-enter-standby-1",
|
||||
"title": "To move instances into standby mode"
|
||||
}
|
||||
],
|
||||
"ExecutePolicy": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"HonorCooldown": true,
|
||||
"PolicyName": "ScaleIn"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example executes the specified Auto Scaling policy for the specified Auto Scaling group.",
|
||||
"id": "autoscaling-execute-policy-1",
|
||||
"title": "To execute an Auto Scaling policy"
|
||||
}
|
||||
],
|
||||
"ExitStandby": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"InstanceIds": [
|
||||
"i-93633f9b"
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"Activities": [
|
||||
{
|
||||
"ActivityId": "142928e1-a2dc-453a-9b24-b85ad6735928",
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"Cause": "At 2015-04-12T15:14:29Z instance i-93633f9b was moved out of standby in response to a user request, increasing the capacity from 1 to 2.",
|
||||
"Description": "Moving EC2 instance out of Standby: i-93633f9b",
|
||||
"Details": "details",
|
||||
"Progress": 30,
|
||||
"StartTime": "2015-04-12T15:14:29.886Z",
|
||||
"StatusCode": "PreInService"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example moves the specified instance out of standby mode.",
|
||||
"id": "autoscaling-exit-standby-1",
|
||||
"title": "To move instances out of standby mode"
|
||||
}
|
||||
],
|
||||
"PutLifecycleHook": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"LifecycleHookName": "my-lifecycle-hook",
|
||||
"LifecycleTransition": "autoscaling:EC2_INSTANCE_LAUNCHING",
|
||||
"NotificationTargetARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic --role-arn",
|
||||
"RoleARN": "arn:aws:iam::123456789012:role/my-auto-scaling-role"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example creates a lifecycle hook.",
|
||||
"id": "autoscaling-put-lifecycle-hook-1",
|
||||
"title": "To create a lifecycle hook"
|
||||
}
|
||||
],
|
||||
"PutNotificationConfiguration": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"NotificationTypes": [
|
||||
"autoscaling:TEST_NOTIFICATION"
|
||||
],
|
||||
"TopicARN": "arn:aws:sns:us-west-2:123456789012:my-sns-topic"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example adds the specified notification to the specified Auto Scaling group.",
|
||||
"id": "autoscaling-put-notification-configuration-1",
|
||||
"title": "To add an Auto Scaling notification"
|
||||
}
|
||||
],
|
||||
"PutScalingPolicy": [
|
||||
{
|
||||
"input": {
|
||||
"AdjustmentType": "ChangeInCapacity",
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"PolicyName": "ScaleIn",
|
||||
"ScalingAdjustment": -1
|
||||
},
|
||||
"output": {
|
||||
"PolicyARN": "arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example adds the specified policy to the specified Auto Scaling group.",
|
||||
"id": "autoscaling-put-scaling-policy-1",
|
||||
"title": "To add a scaling policy to an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"PutScheduledUpdateGroupAction": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"DesiredCapacity": 4,
|
||||
"EndTime": "2014-05-12T08:00:00Z",
|
||||
"MaxSize": 6,
|
||||
"MinSize": 2,
|
||||
"ScheduledActionName": "my-scheduled-action",
|
||||
"StartTime": "2014-05-12T08:00:00Z"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example adds the specified scheduled action to the specified Auto Scaling group.",
|
||||
"id": "autoscaling-put-scheduled-update-group-action-1",
|
||||
"title": "To add a scheduled action to an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"RecordLifecycleActionHeartbeat": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"LifecycleActionToken": "bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635",
|
||||
"LifecycleHookName": "my-lifecycle-hook"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example records a lifecycle action heartbeat to keep the instance in a pending state.",
|
||||
"id": "autoscaling-record-lifecycle-action-heartbeat-1",
|
||||
"title": "To record a lifecycle action heartbeat"
|
||||
}
|
||||
],
|
||||
"ResumeProcesses": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"ScalingProcesses": [
|
||||
"AlarmNotification"
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example resumes the specified suspended scaling process for the specified Auto Scaling group.",
|
||||
"id": "autoscaling-resume-processes-1",
|
||||
"title": "To resume Auto Scaling processes"
|
||||
}
|
||||
],
|
||||
"SetDesiredCapacity": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"DesiredCapacity": 2,
|
||||
"HonorCooldown": true
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example sets the desired capacity for the specified Auto Scaling group.",
|
||||
"id": "autoscaling-set-desired-capacity-1",
|
||||
"title": "To set the desired capacity for an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"SetInstanceHealth": [
|
||||
{
|
||||
"input": {
|
||||
"HealthStatus": "Unhealthy",
|
||||
"InstanceId": "i-93633f9b"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example sets the health status of the specified instance to Unhealthy.",
|
||||
"id": "autoscaling-set-instance-health-1",
|
||||
"title": "To set the health status of an instance"
|
||||
}
|
||||
],
|
||||
"SetInstanceProtection": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"InstanceIds": [
|
||||
"i-93633f9b"
|
||||
],
|
||||
"ProtectedFromScaleIn": true
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example enables instance protection for the specified instance.",
|
||||
"id": "autoscaling-set-instance-protection-1",
|
||||
"title": "To enable instance protection for an instance"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"InstanceIds": [
|
||||
"i-93633f9b"
|
||||
],
|
||||
"ProtectedFromScaleIn": false
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example disables instance protection for the specified instance.",
|
||||
"id": "autoscaling-set-instance-protection-2",
|
||||
"title": "To disable instance protection for an instance"
|
||||
}
|
||||
],
|
||||
"SuspendProcesses": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"ScalingProcesses": [
|
||||
"AlarmNotification"
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example suspends the specified scaling process for the specified Auto Scaling group.",
|
||||
"id": "autoscaling-suspend-processes-1",
|
||||
"title": "To suspend Auto Scaling processes"
|
||||
}
|
||||
],
|
||||
"TerminateInstanceInAutoScalingGroup": [
|
||||
{
|
||||
"input": {
|
||||
"InstanceId": "i-93633f9b",
|
||||
"ShouldDecrementDesiredCapacity": false
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example terminates the specified instance from the specified Auto Scaling group without updating the size of the group. Auto Scaling launches a replacement instance after the specified instance terminates.",
|
||||
"id": "autoscaling-terminate-instance-in-auto-scaling-group-1",
|
||||
"title": "To terminate an instance in an Auto Scaling group"
|
||||
}
|
||||
],
|
||||
"UpdateAutoScalingGroup": [
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"LaunchConfigurationName": "new-launch-config"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example updates the launch configuration of the specified Auto Scaling group.",
|
||||
"id": "autoscaling-update-auto-scaling-group-1",
|
||||
"title": "To update the launch configuration"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"MaxSize": 3,
|
||||
"MinSize": 1
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example updates the minimum size and maximum size of the specified Auto Scaling group.",
|
||||
"id": "autoscaling-update-auto-scaling-group-2",
|
||||
"title": "To update the minimum and maximum size"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"AutoScalingGroupName": "my-auto-scaling-group",
|
||||
"NewInstancesProtectedFromScaleIn": true
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example enables instance protection for the specified Auto Scaling group.",
|
||||
"id": "autoscaling-update-auto-scaling-group-3",
|
||||
"title": "To enable instance protection"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -20,7 +20,7 @@
|
|||
"errors":[
|
||||
{"shape":"ResourceContentionFault"}
|
||||
],
|
||||
"documentation":"<p>Attaches one or more EC2 instances to the specified Auto Scaling group.</p> <p>When you attach instances, Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.</p> <p>If there is a Classic load balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-instance-asg.html\">Attach EC2 Instances to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>Attaches one or more EC2 instances to the specified Auto Scaling group.</p> <p>When you attach instances, Auto Scaling increases the desired capacity of the group by the number of instances being attached. If the number of instances being attached plus the desired capacity of the group exceeds the maximum size of the group, the operation fails.</p> <p>If there is a Classic Load Balancer attached to your Auto Scaling group, the instances are also registered with the load balancer. If there are target groups attached to your Auto Scaling group, the instances are also registered with the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-instance-asg.html\">Attach EC2 Instances to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"AttachLoadBalancerTargetGroups":{
|
||||
"name":"AttachLoadBalancerTargetGroups",
|
||||
|
|
@ -52,7 +52,7 @@
|
|||
"errors":[
|
||||
{"shape":"ResourceContentionFault"}
|
||||
],
|
||||
"documentation":"<p>Attaches one or more Classic load balancers to the specified Auto Scaling group.</p> <p>To attach an Application load balancer instead, see <a>AttachLoadBalancerTargetGroups</a>.</p> <p>To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>Attaches one or more Classic Load Balancers to the specified Auto Scaling group.</p> <p>To attach an Application Load Balancer instead, see <a>AttachLoadBalancerTargetGroups</a>.</p> <p>To describe the load balancers for an Auto Scaling group, use <a>DescribeLoadBalancers</a>. To detach the load balancer from the Auto Scaling group, use <a>DetachLoadBalancers</a>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/attach-load-balancer-asg.html\">Attach a Load Balancer to Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"CompleteLifecycleAction":{
|
||||
"name":"CompleteLifecycleAction",
|
||||
|
|
@ -360,7 +360,7 @@
|
|||
"errors":[
|
||||
{"shape":"ResourceContentionFault"}
|
||||
],
|
||||
"documentation":"<p>Describes the load balancers for the specified Auto Scaling group.</p> <p>Note that this operation describes only Classic load balancers. If you have Application load balancers, use <a>DescribeLoadBalancerTargetGroups</a> instead.</p>"
|
||||
"documentation":"<p>Describes the load balancers for the specified Auto Scaling group.</p> <p>Note that this operation describes only Classic Load Balancers. If you have Application Load Balancers, use <a>DescribeLoadBalancerTargetGroups</a> instead.</p>"
|
||||
},
|
||||
"DescribeMetricCollectionTypes":{
|
||||
"name":"DescribeMetricCollectionTypes",
|
||||
|
|
@ -506,7 +506,7 @@
|
|||
"errors":[
|
||||
{"shape":"ResourceContentionFault"}
|
||||
],
|
||||
"documentation":"<p>Removes one or more instances from the specified Auto Scaling group.</p> <p>After the instances are detached, you can manage them independently from the rest of the Auto Scaling group.</p> <p>If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached.</p> <p>If there is a Classic load balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/detach-instance-asg.html\">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>Removes one or more instances from the specified Auto Scaling group.</p> <p>After the instances are detached, you can manage them independent of the Auto Scaling group.</p> <p>If you do not specify the option to decrement the desired capacity, Auto Scaling launches instances to replace the ones that are detached.</p> <p>If there is a Classic Load Balancer attached to the Auto Scaling group, the instances are deregistered from the load balancer. If there are target groups attached to the Auto Scaling group, the instances are deregistered from the target groups.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/detach-instance-asg.html\">Detach EC2 Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"DetachLoadBalancerTargetGroups":{
|
||||
"name":"DetachLoadBalancerTargetGroups",
|
||||
|
|
@ -538,7 +538,7 @@
|
|||
"errors":[
|
||||
{"shape":"ResourceContentionFault"}
|
||||
],
|
||||
"documentation":"<p>Detaches one or more Classic load balancers from the specified Auto Scaling group.</p> <p>Note that this operation detaches only Classic load balancers. If you have Application load balancers, use <a>DetachLoadBalancerTargetGroups</a> instead.</p> <p>When you detach a load balancer, it enters the <code>Removing</code> state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using <a>DescribeLoadBalancers</a>. Note that the instances remain running.</p>"
|
||||
"documentation":"<p>Detaches one or more Classic Load Balancers from the specified Auto Scaling group.</p> <p>Note that this operation detaches only Classic Load Balancers. If you have Application Load Balancers, use <a>DetachLoadBalancerTargetGroups</a> instead.</p> <p>When you detach a load balancer, it enters the <code>Removing</code> state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the load balancer using <a>DescribeLoadBalancers</a>. Note that the instances remain running.</p>"
|
||||
},
|
||||
"DisableMetricsCollection":{
|
||||
"name":"DisableMetricsCollection",
|
||||
|
|
@ -578,7 +578,7 @@
|
|||
"errors":[
|
||||
{"shape":"ResourceContentionFault"}
|
||||
],
|
||||
"documentation":"<p>Moves the specified instances into <code>Standby</code> mode.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>Moves the specified instances into the standby state.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-enter-exit-standby.html\">Temporarily Removing Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"ExecutePolicy":{
|
||||
"name":"ExecutePolicy",
|
||||
|
|
@ -607,7 +607,7 @@
|
|||
"errors":[
|
||||
{"shape":"ResourceContentionFault"}
|
||||
],
|
||||
"documentation":"<p>Moves the specified instances out of <code>Standby</code> mode.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/AutoScalingGroupLifecycle.html\">Auto Scaling Lifecycle</a> in the <i>Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>Moves the specified instances out of the standby state.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/as-enter-exit-standby.html\">Temporarily Removing Instances from Your Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"PutLifecycleHook":{
|
||||
"name":"PutLifecycleHook",
|
||||
|
|
@ -782,7 +782,7 @@
|
|||
{"shape":"ScalingActivityInProgressFault"},
|
||||
{"shape":"ResourceContentionFault"}
|
||||
],
|
||||
"documentation":"<p>Updates the configuration for the specified Auto Scaling group.</p> <p>To update an Auto Scaling group with a launch configuration with <code>InstanceMonitoring</code> set to <code>False</code>, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using <a>DisableMetricsCollection</a>.</p> <p>The new settings are registered upon the completion of this call. Any launch configuration settings take effect on any triggers after this call returns. Scaling activities that are currently in progress aren't affected.</p> <p>Note the following:</p> <ul> <li> <p>If you specify a new value for <code>MinSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MinSize</code> is larger than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MinSize</code>.</p> </li> <li> <p>If you specify a new value for <code>MaxSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MaxSize</code> is smaller than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MaxSize</code>.</p> </li> <li> <p>All other optional parameters are left unchanged if not specified.</p> </li> </ul>"
|
||||
"documentation":"<p>Updates the configuration for the specified Auto Scaling group.</p> <p>The new settings take effect on any scaling activities after this call returns. Scaling activities that are currently in progress aren't affected.</p> <p>To update an Auto Scaling group with a launch configuration with <code>InstanceMonitoring</code> set to <code>false</code>, you must first disable the collection of group metrics. Otherwise, you will get an error. If you have previously enabled the collection of group metrics, you can disable it using <a>DisableMetricsCollection</a>.</p> <p>Note the following:</p> <ul> <li> <p>If you specify a new value for <code>MinSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MinSize</code> is larger than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MinSize</code>.</p> </li> <li> <p>If you specify a new value for <code>MaxSize</code> without specifying a value for <code>DesiredCapacity</code>, and the new <code>MaxSize</code> is smaller than the current size of the group, we implicitly call <a>SetDesiredCapacity</a> to set the size of the group to the new value of <code>MaxSize</code>.</p> </li> <li> <p>All other optional parameters are left unchanged if not specified.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -802,8 +802,7 @@
|
|||
"shape":"XmlString",
|
||||
"documentation":"<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of DescribeScalingActivities.</p>"
|
||||
}
|
||||
},
|
||||
"Activity":{
|
||||
"type":"structure",
|
||||
|
|
@ -869,8 +868,7 @@
|
|||
"shape":"Activity",
|
||||
"documentation":"<p>A scaling activity.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of TerminateInstancesInAutoScalingGroup.</p>"
|
||||
}
|
||||
},
|
||||
"AdjustmentType":{
|
||||
"type":"structure",
|
||||
|
|
@ -939,8 +937,7 @@
|
|||
"shape":"ResourceName",
|
||||
"documentation":"<p>The name of the group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for AttachInstances.</p>"
|
||||
}
|
||||
},
|
||||
"AttachLoadBalancerTargetGroupsResultType":{
|
||||
"type":"structure",
|
||||
|
|
@ -962,14 +959,12 @@
|
|||
"shape":"TargetGroupARNs",
|
||||
"documentation":"<p>The Amazon Resource Names (ARN) of the target groups.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for AttachLoadBalancerTargetGroups.</p>"
|
||||
}
|
||||
},
|
||||
"AttachLoadBalancersResultType":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>Contains the output of AttachLoadBalancers.</p>"
|
||||
}
|
||||
},
|
||||
"AttachLoadBalancersType":{
|
||||
"type":"structure",
|
||||
|
|
@ -986,8 +981,7 @@
|
|||
"shape":"LoadBalancerNames",
|
||||
"documentation":"<p>One or more load balancer names.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for AttachLoadBalancers.</p>"
|
||||
}
|
||||
},
|
||||
"AutoScalingGroup":{
|
||||
"type":"structure",
|
||||
|
|
@ -1113,10 +1107,9 @@
|
|||
},
|
||||
"MaxRecords":{
|
||||
"shape":"MaxRecords",
|
||||
"documentation":"<p>The maximum number of items to return with this call.</p>"
|
||||
"documentation":"<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DescribeAutoScalingGroups.</p>"
|
||||
}
|
||||
},
|
||||
"AutoScalingGroups":{
|
||||
"type":"list",
|
||||
|
|
@ -1134,8 +1127,7 @@
|
|||
"shape":"XmlString",
|
||||
"documentation":"<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output for DescribeAutoScalingGroups.</p>"
|
||||
}
|
||||
},
|
||||
"AutoScalingInstanceDetails":{
|
||||
"type":"structure",
|
||||
|
|
@ -1171,7 +1163,7 @@
|
|||
},
|
||||
"LaunchConfigurationName":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>The launch configuration associated with the instance.</p>"
|
||||
"documentation":"<p>The launch configuration used to launch the instance. This value is not available if you attached the instance to the Auto Scaling group.</p>"
|
||||
},
|
||||
"ProtectedFromScaleIn":{
|
||||
"shape":"InstanceProtected",
|
||||
|
|
@ -1195,8 +1187,7 @@
|
|||
"shape":"XmlString",
|
||||
"documentation":"<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of DescribeAutoScalingInstances.</p>"
|
||||
}
|
||||
},
|
||||
"AutoScalingNotificationTypes":{
|
||||
"type":"list",
|
||||
|
|
@ -1258,8 +1249,7 @@
|
|||
"CompleteLifecycleActionAnswer":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>Contains the output of CompleteLifecycleAction.</p>"
|
||||
}
|
||||
},
|
||||
"CompleteLifecycleActionType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1289,8 +1279,7 @@
|
|||
"shape":"XmlStringMaxLen19",
|
||||
"documentation":"<p>The ID of the instance.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for CompleteLifecycleAction.</p>"
|
||||
}
|
||||
},
|
||||
"Cooldown":{"type":"integer"},
|
||||
"CreateAutoScalingGroupType":{
|
||||
|
|
@ -1323,7 +1312,7 @@
|
|||
},
|
||||
"DesiredCapacity":{
|
||||
"shape":"AutoScalingGroupDesiredCapacity",
|
||||
"documentation":"<p>The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group.</p>"
|
||||
"documentation":"<p>The number of EC2 instances that should be running in the group. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group.</p>"
|
||||
},
|
||||
"DefaultCooldown":{
|
||||
"shape":"Cooldown",
|
||||
|
|
@ -1335,7 +1324,7 @@
|
|||
},
|
||||
"LoadBalancerNames":{
|
||||
"shape":"LoadBalancerNames",
|
||||
"documentation":"<p>One or more Classic load balancers. To specify an Application load balancer, use <code>TargetGroupARNs</code> instead.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-asg-from-instance.html\">Using a Load Balancer With an Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>One or more Classic Load Balancers. To specify an Application Load Balancer, use <code>TargetGroupARNs</code> instead.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-asg-from-instance.html\">Using a Load Balancer With an Auto Scaling Group</a> in the <i>Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"TargetGroupARNs":{
|
||||
"shape":"TargetGroupARNs",
|
||||
|
|
@ -1369,8 +1358,7 @@
|
|||
"shape":"Tags",
|
||||
"documentation":"<p>One or more tags.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/autoscaling-tagging.html\">Tagging Auto Scaling Groups and Instances</a> in the <i>Auto Scaling User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for CreateAutoScalingGroup.</p>"
|
||||
}
|
||||
},
|
||||
"CreateLaunchConfigurationType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1382,7 +1370,7 @@
|
|||
},
|
||||
"ImageId":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html\">Finding an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
|
||||
"documentation":"<p>The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances.</p> <p>If you do not specify <code>InstanceId</code>, you must specify <code>ImageId</code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html\">Finding an AMI</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>"
|
||||
},
|
||||
"KeyName":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
|
|
@ -1406,11 +1394,11 @@
|
|||
},
|
||||
"InstanceId":{
|
||||
"shape":"XmlStringMaxLen19",
|
||||
"documentation":"<p>The ID of the instance to use to create the launch configuration.</p> <p>The new launch configuration derives attributes from the instance, with the exception of the block device mapping.</p> <p>To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-lc-with-instanceID.html\">Create a Launch Configuration Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>"
|
||||
"documentation":"<p>The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, with the exception of the block device mapping.</p> <p>If you do not specify <code>InstanceId</code>, you must specify both <code>ImageId</code> and <code>InstanceType</code>.</p> <p>To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/create-lc-with-instanceID.html\">Create a Launch Configuration Using an EC2 Instance</a> in the <i>Auto Scaling User Guide</i>.</p>"
|
||||
},
|
||||
"InstanceType":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>The instance type of the EC2 instance. For information about available instance types, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes\"> Available Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i> </p>"
|
||||
"documentation":"<p>The instance type of the EC2 instance.</p> <p>If you do not specify <code>InstanceId</code>, you must specify <code>InstanceType</code>.</p> <p>For information about available instance types, see <a href=\"http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes\">Available Instance Types</a> in the <i>Amazon Elastic Compute Cloud User Guide.</i> </p>"
|
||||
},
|
||||
"KernelId":{
|
||||
"shape":"XmlStringMaxLen255",
|
||||
|
|
@ -1426,7 +1414,7 @@
|
|||
},
|
||||
"InstanceMonitoring":{
|
||||
"shape":"InstanceMonitoring",
|
||||
"documentation":"<p>Enables detailed monitoring (<code>true</code>) or basic monitoring (<code>false</code>) for the Auto Scaling instances.</p>"
|
||||
"documentation":"<p>Enables detailed monitoring (<code>true</code>) or basic monitoring (<code>false</code>) for the Auto Scaling instances. The default is <code>true</code>.</p>"
|
||||
},
|
||||
"SpotPrice":{
|
||||
"shape":"SpotPrice",
|
||||
|
|
@ -1448,8 +1436,7 @@
|
|||
"shape":"XmlStringMaxLen64",
|
||||
"documentation":"<p>The tenancy of the instance. An instance with a tenancy of <code>dedicated</code> runs on single-tenant hardware and can only be launched into a VPC.</p> <p>You must set the value of this parameter to <code>dedicated</code> if want to launch Dedicated Instances into a shared tenancy VPC (VPC with instance placement tenancy attribute set to <code>default</code>).</p> <p>If you specify this parameter, be sure to specify at least one subnet when you create your group.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/autoscaling/latest/userguide/asg-in-vpc.html\">Launching Auto Scaling Instances in a VPC</a> in the <i>Auto Scaling User Guide</i>.</p> <p>Valid values: <code>default</code> | <code>dedicated</code> </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for CreateLaunchConfiguration.</p>"
|
||||
}
|
||||
},
|
||||
"CreateOrUpdateTagsType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1459,8 +1446,7 @@
|
|||
"shape":"Tags",
|
||||
"documentation":"<p>One or more tags.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for CreateOrUpdateTags.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteAutoScalingGroupType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1474,14 +1460,12 @@
|
|||
"shape":"ForceDelete",
|
||||
"documentation":"<p>Specifies that the group will be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DeleteAutoScalingGroup.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteLifecycleHookAnswer":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>Contains the output of DeleteLifecycleHook.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteLifecycleHookType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1498,8 +1482,7 @@
|
|||
"shape":"ResourceName",
|
||||
"documentation":"<p>The name of the Auto Scaling group for the lifecycle hook.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DeleteLifecycleHook.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteNotificationConfigurationType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1516,8 +1499,7 @@
|
|||
"shape":"ResourceName",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon Simple Notification Service (SNS) topic.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DeleteNotificationConfiguration.</p>"
|
||||
}
|
||||
},
|
||||
"DeletePolicyType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1531,8 +1513,7 @@
|
|||
"shape":"ResourceName",
|
||||
"documentation":"<p>The name or Amazon Resource Name (ARN) of the policy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DeletePolicy.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteScheduledActionType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1549,8 +1530,7 @@
|
|||
"shape":"ResourceName",
|
||||
"documentation":"<p>The name of the action to delete.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DeleteScheduledAction.</p>"
|
||||
}
|
||||
},
|
||||
"DeleteTagsType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1560,8 +1540,7 @@
|
|||
"shape":"Tags",
|
||||
"documentation":"<p>One or more tags.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DeleteTags.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeAccountLimitsAnswer":{
|
||||
"type":"structure",
|
||||
|
|
@ -1582,8 +1561,7 @@
|
|||
"shape":"NumberOfLaunchConfigurations",
|
||||
"documentation":"<p>The current number of launch configurations for your AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DescribeAccountLimits.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeAdjustmentTypesAnswer":{
|
||||
"type":"structure",
|
||||
|
|
@ -1592,8 +1570,7 @@
|
|||
"shape":"AdjustmentTypes",
|
||||
"documentation":"<p>The policy adjustment types.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DescribeAdjustmentTypes.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeAutoScalingInstancesType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1604,14 +1581,13 @@
|
|||
},
|
||||
"MaxRecords":{
|
||||
"shape":"MaxRecords",
|
||||
"documentation":"<p>The maximum number of items to return with this call.</p>"
|
||||
"documentation":"<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"XmlString",
|
||||
"documentation":"<p>The token for the next set of items to return. (You received this token from a previous call.)</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DescribeAutoScalingInstances.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeAutoScalingNotificationTypesAnswer":{
|
||||
"type":"structure",
|
||||
|
|
@ -1620,8 +1596,7 @@
|
|||
"shape":"AutoScalingNotificationTypes",
|
||||
"documentation":"<p>The notification types.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of DescribeAutoScalingNotificationTypes.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeLifecycleHookTypesAnswer":{
|
||||
"type":"structure",
|
||||
|
|
@ -1630,8 +1605,7 @@
|
|||
"shape":"AutoScalingNotificationTypes",
|
||||
"documentation":"<p>The lifecycle hook types.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of DescribeLifecycleHookTypes.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeLifecycleHooksAnswer":{
|
||||
"type":"structure",
|
||||
|
|
@ -1640,8 +1614,7 @@
|
|||
"shape":"LifecycleHooks",
|
||||
"documentation":"<p>The lifecycle hooks for the specified group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of DescribeLifecycleHooks.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeLifecycleHooksType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1655,8 +1628,7 @@
|
|||
"shape":"LifecycleHookNames",
|
||||
"documentation":"<p>The names of one or more lifecycle hooks. If you omit this parameter, all lifecycle hooks are described.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DescribeLifecycleHooks.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeLoadBalancerTargetGroupsRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1672,10 +1644,9 @@
|
|||
},
|
||||
"MaxRecords":{
|
||||
"shape":"MaxRecords",
|
||||
"documentation":"<p>The maximum number of items to return with this call.</p>"
|
||||
"documentation":"<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DescribeLoadBalancerTargetGroups.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeLoadBalancerTargetGroupsResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -1688,8 +1659,7 @@
|
|||
"shape":"XmlString",
|
||||
"documentation":"<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of DescribeLoadBalancerTargetGroups.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeLoadBalancersRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1705,10 +1675,9 @@
|
|||
},
|
||||
"MaxRecords":{
|
||||
"shape":"MaxRecords",
|
||||
"documentation":"<p>The maximum number of items to return with this call.</p>"
|
||||
"documentation":"<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DescribeLoadBalancers.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeLoadBalancersResponse":{
|
||||
"type":"structure",
|
||||
|
|
@ -1721,8 +1690,7 @@
|
|||
"shape":"XmlString",
|
||||
"documentation":"<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of DescribeLoadBalancers.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeMetricCollectionTypesAnswer":{
|
||||
"type":"structure",
|
||||
|
|
@ -1735,8 +1703,7 @@
|
|||
"shape":"MetricGranularityTypes",
|
||||
"documentation":"<p>The granularities for the metrics.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of DescribeMetricsCollectionTypes.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeNotificationConfigurationsAnswer":{
|
||||
"type":"structure",
|
||||
|
|
@ -1750,8 +1717,7 @@
|
|||
"shape":"XmlString",
|
||||
"documentation":"<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output from DescribeNotificationConfigurations.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeNotificationConfigurationsType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1766,10 +1732,9 @@
|
|||
},
|
||||
"MaxRecords":{
|
||||
"shape":"MaxRecords",
|
||||
"documentation":"<p>The maximum number of items to return with this call.</p>"
|
||||
"documentation":"<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DescribeNotificationConfigurations.</p>"
|
||||
}
|
||||
},
|
||||
"DescribePoliciesType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1792,10 +1757,9 @@
|
|||
},
|
||||
"MaxRecords":{
|
||||
"shape":"MaxRecords",
|
||||
"documentation":"<p>The maximum number of items to be returned with each call.</p>"
|
||||
"documentation":"<p>The maximum number of items to be returned with each call. The default value is 50 and the maximum value is 100.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DescribePolicies.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeScalingActivitiesType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1810,14 +1774,13 @@
|
|||
},
|
||||
"MaxRecords":{
|
||||
"shape":"MaxRecords",
|
||||
"documentation":"<p>The maximum number of items to return with this call.</p>"
|
||||
"documentation":"<p>The maximum number of items to return with this call. The default value is 100.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"XmlString",
|
||||
"documentation":"<p>The token for the next set of items to return. (You received this token from a previous call.)</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DescribeScalingActivities.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeScheduledActionsType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1844,10 +1807,9 @@
|
|||
},
|
||||
"MaxRecords":{
|
||||
"shape":"MaxRecords",
|
||||
"documentation":"<p>The maximum number of items to return with this call.</p>"
|
||||
"documentation":"<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DescribeScheduledActions.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeTagsType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1862,10 +1824,9 @@
|
|||
},
|
||||
"MaxRecords":{
|
||||
"shape":"MaxRecords",
|
||||
"documentation":"<p>The maximum number of items to return with this call.</p>"
|
||||
"documentation":"<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DescribeTags.</p>"
|
||||
}
|
||||
},
|
||||
"DescribeTerminationPolicyTypesAnswer":{
|
||||
"type":"structure",
|
||||
|
|
@ -1874,8 +1835,7 @@
|
|||
"shape":"TerminationPolicies",
|
||||
"documentation":"<p>The termination policies supported by Auto Scaling (<code>OldestInstance</code>, <code>OldestLaunchConfiguration</code>, <code>NewestInstance</code>, <code>ClosestToNextInstanceHour</code>, and <code>Default</code>).</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of DescribeTerminationPolicyTypes.</p>"
|
||||
}
|
||||
},
|
||||
"DetachInstancesAnswer":{
|
||||
"type":"structure",
|
||||
|
|
@ -1884,8 +1844,7 @@
|
|||
"shape":"Activities",
|
||||
"documentation":"<p>The activities related to detaching the instances from the Auto Scaling group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of DetachInstances.</p>"
|
||||
}
|
||||
},
|
||||
"DetachInstancesQuery":{
|
||||
"type":"structure",
|
||||
|
|
@ -1906,8 +1865,7 @@
|
|||
"shape":"ShouldDecrementDesiredCapacity",
|
||||
"documentation":"<p>If <code>True</code>, the Auto Scaling group decrements the desired capacity value by the number of instances detached.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DetachInstances.</p>"
|
||||
}
|
||||
},
|
||||
"DetachLoadBalancerTargetGroupsResultType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1934,8 +1892,7 @@
|
|||
"DetachLoadBalancersResultType":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>Contains the output for DetachLoadBalancers.</p>"
|
||||
}
|
||||
},
|
||||
"DetachLoadBalancersType":{
|
||||
"type":"structure",
|
||||
|
|
@ -1952,8 +1909,7 @@
|
|||
"shape":"LoadBalancerNames",
|
||||
"documentation":"<p>One or more load balancer names.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DetachLoadBalancers.</p>"
|
||||
}
|
||||
},
|
||||
"DisableMetricsCollectionQuery":{
|
||||
"type":"structure",
|
||||
|
|
@ -1967,8 +1923,7 @@
|
|||
"shape":"Metrics",
|
||||
"documentation":"<p>One or more of the following metrics. If you omit this parameter, all metrics are disabled.</p> <ul> <li> <p> <code>GroupMinSize</code> </p> </li> <li> <p> <code>GroupMaxSize</code> </p> </li> <li> <p> <code>GroupDesiredCapacity</code> </p> </li> <li> <p> <code>GroupInServiceInstances</code> </p> </li> <li> <p> <code>GroupPendingInstances</code> </p> </li> <li> <p> <code>GroupStandbyInstances</code> </p> </li> <li> <p> <code>GroupTerminatingInstances</code> </p> </li> <li> <p> <code>GroupTotalInstances</code> </p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DisableMetricsCollection.</p>"
|
||||
}
|
||||
},
|
||||
"Ebs":{
|
||||
"type":"structure",
|
||||
|
|
@ -2020,8 +1975,7 @@
|
|||
"shape":"XmlStringMaxLen255",
|
||||
"documentation":"<p>The granularity to associate with the metrics to collect. The only valid value is <code>1Minute</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for EnableMetricsCollection.</p>"
|
||||
}
|
||||
},
|
||||
"EnabledMetric":{
|
||||
"type":"structure",
|
||||
|
|
@ -2048,8 +2002,7 @@
|
|||
"shape":"Activities",
|
||||
"documentation":"<p>The activities related to moving instances into <code>Standby</code> mode.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of EnterStandby.</p>"
|
||||
}
|
||||
},
|
||||
"EnterStandbyQuery":{
|
||||
"type":"structure",
|
||||
|
|
@ -2070,8 +2023,7 @@
|
|||
"shape":"ShouldDecrementDesiredCapacity",
|
||||
"documentation":"<p>Specifies whether the instances moved to <code>Standby</code> mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to <code>Standby</code> mode.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for EnteStandby.</p>"
|
||||
}
|
||||
},
|
||||
"EstimatedInstanceWarmup":{"type":"integer"},
|
||||
"ExecutePolicyType":{
|
||||
|
|
@ -2098,8 +2050,7 @@
|
|||
"shape":"MetricScale",
|
||||
"documentation":"<p>The breach threshold for the alarm.</p> <p>This parameter is required if the policy type is <code>StepScaling</code> and not supported otherwise.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for ExecutePolicy.</p>"
|
||||
}
|
||||
},
|
||||
"ExitStandbyAnswer":{
|
||||
"type":"structure",
|
||||
|
|
@ -2108,8 +2059,7 @@
|
|||
"shape":"Activities",
|
||||
"documentation":"<p>The activities related to moving instances out of <code>Standby</code> mode.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for ExitStandby.</p>"
|
||||
}
|
||||
},
|
||||
"ExitStandbyQuery":{
|
||||
"type":"structure",
|
||||
|
|
@ -2123,8 +2073,7 @@
|
|||
"shape":"ResourceName",
|
||||
"documentation":"<p>The name of the Auto Scaling group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for ExitStandby.</p>"
|
||||
}
|
||||
},
|
||||
"Filter":{
|
||||
"type":"structure",
|
||||
|
|
@ -2196,10 +2145,10 @@
|
|||
"members":{
|
||||
"Enabled":{
|
||||
"shape":"MonitoringEnabled",
|
||||
"documentation":"<p>If <code>True</code>, instance monitoring is enabled.</p>"
|
||||
"documentation":"<p>If <code>true</code>, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes whether instance monitoring is enabled.</p>"
|
||||
"documentation":"<p>Describes whether detailed monitoring is enabled for the Auto Scaling instances.</p>"
|
||||
},
|
||||
"InstanceProtected":{"type":"boolean"},
|
||||
"Instances":{
|
||||
|
|
@ -2318,8 +2267,7 @@
|
|||
"shape":"ResourceName",
|
||||
"documentation":"<p>The name of the launch configuration.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DeleteLaunchConfiguration.</p>"
|
||||
}
|
||||
},
|
||||
"LaunchConfigurationNames":{
|
||||
"type":"list",
|
||||
|
|
@ -2338,10 +2286,9 @@
|
|||
},
|
||||
"MaxRecords":{
|
||||
"shape":"MaxRecords",
|
||||
"documentation":"<p>The maximum number of items to return with this call. The default is 100.</p>"
|
||||
"documentation":"<p>The maximum number of items to return with this call. The default value is 50 and the maximum value is 100.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for DescribeLaunchConfigurations.</p>"
|
||||
}
|
||||
},
|
||||
"LaunchConfigurations":{
|
||||
"type":"list",
|
||||
|
|
@ -2359,8 +2306,7 @@
|
|||
"shape":"XmlString",
|
||||
"documentation":"<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of DescribeLaunchConfigurations.</p>"
|
||||
}
|
||||
},
|
||||
"LifecycleActionResult":{"type":"string"},
|
||||
"LifecycleActionToken":{
|
||||
|
|
@ -2469,7 +2415,7 @@
|
|||
"documentation":"<p>One of the following load balancer states:</p> <ul> <li> <p> <code>Adding</code> - The instances in the group are being registered with the load balancer.</p> </li> <li> <p> <code>Added</code> - All instances in the group are registered with the load balancer.</p> </li> <li> <p> <code>InService</code> - At least one instance in the group passed an ELB health check.</p> </li> <li> <p> <code>Removing</code> - The instances in the group are being deregistered from the load balancer. If connection draining is enabled, Elastic Load Balancing waits for in-flight requests to complete before deregistering the instances.</p> </li> <li> <p> <code>Removed</code> - All instances in the group are deregistered from the load balancer.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes the state of a Classic load balancer.</p> <p>If you specify a load balancer when creating the Auto Scaling group, the state of the load balancer is <code>InService</code>.</p> <p>If you attach a load balancer to an existing Auto Scaling group, the initial state is <code>Adding</code>. The state transitions to <code>Added</code> after all instances in the group are registered with the load balancer. If ELB health checks are enabled for the load balancer, the state transitions to <code>InService</code> after at least one instance in the group passes the health check. If EC2 health checks are enabled instead, the load balancer remains in the <code>Added</code> state.</p>"
|
||||
"documentation":"<p>Describes the state of a Classic Load Balancer.</p> <p>If you specify a load balancer when creating the Auto Scaling group, the state of the load balancer is <code>InService</code>.</p> <p>If you attach a load balancer to an existing Auto Scaling group, the initial state is <code>Adding</code>. The state transitions to <code>Added</code> after all instances in the group are registered with the load balancer. If ELB health checks are enabled for the load balancer, the state transitions to <code>InService</code> after at least one instance in the group passes the health check. If EC2 health checks are enabled instead, the load balancer remains in the <code>Added</code> state.</p>"
|
||||
},
|
||||
"LoadBalancerStates":{
|
||||
"type":"list",
|
||||
|
|
@ -2577,8 +2523,7 @@
|
|||
"shape":"XmlString",
|
||||
"documentation":"<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of DescribePolicies.</p>"
|
||||
}
|
||||
},
|
||||
"PolicyARNType":{
|
||||
"type":"structure",
|
||||
|
|
@ -2587,8 +2532,7 @@
|
|||
"shape":"ResourceName",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the policy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of PutScalingPolicy.</p>"
|
||||
}
|
||||
},
|
||||
"PolicyIncrement":{"type":"integer"},
|
||||
"PolicyNames":{
|
||||
|
|
@ -2625,8 +2569,7 @@
|
|||
"shape":"Processes",
|
||||
"documentation":"<p>The names of the process types.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of DescribeScalingProcessTypes.</p>"
|
||||
}
|
||||
},
|
||||
"Progress":{"type":"integer"},
|
||||
"PropagateAtLaunch":{"type":"boolean"},
|
||||
|
|
@ -2634,8 +2577,7 @@
|
|||
"PutLifecycleHookAnswer":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>Contains the output of PutLifecycleHook.</p>"
|
||||
}
|
||||
},
|
||||
"PutLifecycleHookType":{
|
||||
"type":"structure",
|
||||
|
|
@ -2676,8 +2618,7 @@
|
|||
"shape":"LifecycleActionResult",
|
||||
"documentation":"<p>Defines the action the Auto Scaling group should take when the lifecycle hook timeout elapses or if an unexpected failure occurs. This parameter can be either <code>CONTINUE</code> or <code>ABANDON</code>. The default value is <code>ABANDON</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for PutLifecycleHook.</p>"
|
||||
}
|
||||
},
|
||||
"PutNotificationConfigurationType":{
|
||||
"type":"structure",
|
||||
|
|
@ -2699,8 +2640,7 @@
|
|||
"shape":"AutoScalingNotificationTypes",
|
||||
"documentation":"<p>The type of event that will cause the notification to be sent. For details about notification types supported by Auto Scaling, see <a>DescribeAutoScalingNotificationTypes</a>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for PutNotificationConfiguration.</p>"
|
||||
}
|
||||
},
|
||||
"PutScalingPolicyType":{
|
||||
"type":"structure",
|
||||
|
|
@ -2754,8 +2694,7 @@
|
|||
"shape":"EstimatedInstanceWarmup",
|
||||
"documentation":"<p>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.</p> <p>This parameter is not supported if the policy type is <code>SimpleScaling</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for PutScalingPolicy.</p>"
|
||||
}
|
||||
},
|
||||
"PutScheduledUpdateGroupActionType":{
|
||||
"type":"structure",
|
||||
|
|
@ -2800,14 +2739,12 @@
|
|||
"shape":"AutoScalingGroupDesiredCapacity",
|
||||
"documentation":"<p>The number of EC2 instances that should be running in the group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for PutScheduledUpdateGroupAction.</p>"
|
||||
}
|
||||
},
|
||||
"RecordLifecycleActionHeartbeatAnswer":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>Contains the output of RecordLifecycleActionHeartBeat.</p>"
|
||||
}
|
||||
},
|
||||
"RecordLifecycleActionHeartbeatType":{
|
||||
"type":"structure",
|
||||
|
|
@ -2832,8 +2769,7 @@
|
|||
"shape":"XmlStringMaxLen19",
|
||||
"documentation":"<p>The ID of the instance.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for RecordLifecycleActionHeartbeat.</p>"
|
||||
}
|
||||
},
|
||||
"ResourceContentionFault":{
|
||||
"type":"structure",
|
||||
|
|
@ -2947,7 +2883,7 @@
|
|||
},
|
||||
"Cooldown":{
|
||||
"shape":"Cooldown",
|
||||
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before any further trigger-related scaling activities can start.</p>"
|
||||
"documentation":"<p>The amount of time, in seconds, after a scaling activity completes before any further dynamic scaling activities can start.</p>"
|
||||
},
|
||||
"StepAdjustments":{
|
||||
"shape":"StepAdjustments",
|
||||
|
|
@ -2980,8 +2916,7 @@
|
|||
"shape":"ProcessNames",
|
||||
"documentation":"<p>One or more of the following processes. If you omit this parameter, all processes are specified.</p> <ul> <li> <p> <code>Launch</code> </p> </li> <li> <p> <code>Terminate</code> </p> </li> <li> <p> <code>HealthCheck</code> </p> </li> <li> <p> <code>ReplaceUnhealthy</code> </p> </li> <li> <p> <code>AZRebalance</code> </p> </li> <li> <p> <code>AlarmNotification</code> </p> </li> <li> <p> <code>ScheduledActions</code> </p> </li> <li> <p> <code>AddToLoadBalancer</code> </p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for SuspendProcesses and ResumeProcesses.</p>"
|
||||
}
|
||||
},
|
||||
"ScheduledActionNames":{
|
||||
"type":"list",
|
||||
|
|
@ -2998,8 +2933,7 @@
|
|||
"shape":"XmlString",
|
||||
"documentation":"<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of DescribeScheduledActions.</p>"
|
||||
}
|
||||
},
|
||||
"ScheduledUpdateGroupAction":{
|
||||
"type":"structure",
|
||||
|
|
@ -3074,8 +3008,7 @@
|
|||
"shape":"HonorCooldown",
|
||||
"documentation":"<p>By default, <code>SetDesiredCapacity</code> overrides any cooldown period associated with the Auto Scaling group. Specify <code>True</code> to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for SetDesiredCapacity.</p>"
|
||||
}
|
||||
},
|
||||
"SetInstanceHealthQuery":{
|
||||
"type":"structure",
|
||||
|
|
@ -3096,14 +3029,12 @@
|
|||
"shape":"ShouldRespectGracePeriod",
|
||||
"documentation":"<p>If the Auto Scaling group of the specified instance has a <code>HealthCheckGracePeriod</code> specified for the group, by default, this call will respect the grace period. Set this to <code>False</code>, if you do not want the call to respect the grace period associated with the group.</p> <p>For more information, see the description of the health check grace period for <a>CreateAutoScalingGroup</a>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for SetInstanceHealth.</p>"
|
||||
}
|
||||
},
|
||||
"SetInstanceProtectionAnswer":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>Contains the output of SetInstanceProtection.</p>"
|
||||
}
|
||||
},
|
||||
"SetInstanceProtectionQuery":{
|
||||
"type":"structure",
|
||||
|
|
@ -3125,8 +3056,7 @@
|
|||
"shape":"ProtectedFromScaleIn",
|
||||
"documentation":"<p>Indicates whether the instance is protected from termination by Auto Scaling when scaling in.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for SetInstanceProtection.</p>"
|
||||
}
|
||||
},
|
||||
"ShouldDecrementDesiredCapacity":{"type":"boolean"},
|
||||
"ShouldRespectGracePeriod":{"type":"boolean"},
|
||||
|
|
@ -3260,8 +3190,7 @@
|
|||
"shape":"XmlString",
|
||||
"documentation":"<p>The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the output of DescribeTags.</p>"
|
||||
}
|
||||
},
|
||||
"TargetGroupARNs":{
|
||||
"type":"list",
|
||||
|
|
@ -3282,8 +3211,7 @@
|
|||
"shape":"ShouldDecrementDesiredCapacity",
|
||||
"documentation":"<p>If <code>true</code>, terminating the instance also decrements the size of the Auto Scaling group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for TerminateInstanceInAutoScalingGroup.</p>"
|
||||
}
|
||||
},
|
||||
"TerminationPolicies":{
|
||||
"type":"list",
|
||||
|
|
@ -3346,8 +3274,7 @@
|
|||
"shape":"InstanceProtected",
|
||||
"documentation":"<p>Indicates whether newly launched instances are protected from termination by Auto Scaling when scaling in.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the parameters for UpdateAutoScalingGroup.</p>"
|
||||
}
|
||||
},
|
||||
"Values":{
|
||||
"type":"list",
|
||||
|
|
|
|||
589
botocore/data/batch/2016-08-10/examples-1.json
Normal file
589
botocore/data/batch/2016-08-10/examples-1.json
Normal file
|
|
@ -0,0 +1,589 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
"CancelJob": [
|
||||
{
|
||||
"input": {
|
||||
"jobId": "1d828f65-7a4d-42e8-996d-3b900ed59dc4",
|
||||
"reason": "Cancelling job."
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example cancels a job with the specified job ID.",
|
||||
"id": "to-cancel-a-job-1481152314733",
|
||||
"title": "To cancel a job"
|
||||
}
|
||||
],
|
||||
"CreateComputeEnvironment": [
|
||||
{
|
||||
"input": {
|
||||
"type": "MANAGED",
|
||||
"computeEnvironmentName": "C4OnDemand",
|
||||
"computeResources": {
|
||||
"type": "EC2",
|
||||
"desiredvCpus": 48,
|
||||
"ec2KeyPair": "id_rsa",
|
||||
"instanceRole": "ecsInstanceRole",
|
||||
"instanceTypes": [
|
||||
"c4.large",
|
||||
"c4.xlarge",
|
||||
"c4.2xlarge",
|
||||
"c4.4xlarge",
|
||||
"c4.8xlarge"
|
||||
],
|
||||
"maxvCpus": 128,
|
||||
"minvCpus": 0,
|
||||
"securityGroupIds": [
|
||||
"sg-cf5093b2"
|
||||
],
|
||||
"subnets": [
|
||||
"subnet-220c0e0a",
|
||||
"subnet-1a95556d",
|
||||
"subnet-978f6dce"
|
||||
],
|
||||
"tags": {
|
||||
"Name": "Batch Instance - C4OnDemand"
|
||||
}
|
||||
},
|
||||
"serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
|
||||
"state": "ENABLED"
|
||||
},
|
||||
"output": {
|
||||
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand",
|
||||
"computeEnvironmentName": "C4OnDemand"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example creates a managed compute environment with specific C4 instance types that are launched on demand. The compute environment is called C4OnDemand.",
|
||||
"id": "to-create-a-managed-ec2-compute-environment-1481152600017",
|
||||
"title": "To create a managed EC2 compute environment"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"type": "MANAGED",
|
||||
"computeEnvironmentName": "M4Spot",
|
||||
"computeResources": {
|
||||
"type": "SPOT",
|
||||
"bidPercentage": 20,
|
||||
"desiredvCpus": 4,
|
||||
"ec2KeyPair": "id_rsa",
|
||||
"instanceRole": "ecsInstanceRole",
|
||||
"instanceTypes": [
|
||||
"m4"
|
||||
],
|
||||
"maxvCpus": 128,
|
||||
"minvCpus": 0,
|
||||
"securityGroupIds": [
|
||||
"sg-cf5093b2"
|
||||
],
|
||||
"spotIamFleetRole": "arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role",
|
||||
"subnets": [
|
||||
"subnet-220c0e0a",
|
||||
"subnet-1a95556d",
|
||||
"subnet-978f6dce"
|
||||
],
|
||||
"tags": {
|
||||
"Name": "Batch Instance - M4Spot"
|
||||
}
|
||||
},
|
||||
"serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
|
||||
"state": "ENABLED"
|
||||
},
|
||||
"output": {
|
||||
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot",
|
||||
"computeEnvironmentName": "M4Spot"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example creates a managed compute environment with the M4 instance type that is launched when the Spot bid price is at or below 20% of the On-Demand price for the instance type. The compute environment is called M4Spot.",
|
||||
"id": "to-create-a-managed-ec2-spot-compute-environment-1481152844190",
|
||||
"title": "To create a managed EC2 Spot compute environment"
|
||||
}
|
||||
],
|
||||
"CreateJobQueue": [
|
||||
{
|
||||
"input": {
|
||||
"computeEnvironmentOrder": [
|
||||
{
|
||||
"computeEnvironment": "M4Spot",
|
||||
"order": 1
|
||||
}
|
||||
],
|
||||
"jobQueueName": "LowPriority",
|
||||
"priority": 10,
|
||||
"state": "ENABLED"
|
||||
},
|
||||
"output": {
|
||||
"jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority",
|
||||
"jobQueueName": "LowPriority"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example creates a job queue called LowPriority that uses the M4Spot compute environment.",
|
||||
"id": "to-create-a-job-queue-with-a-single-compute-environment-1481152967946",
|
||||
"title": "To create a job queue with a single compute environment"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"computeEnvironmentOrder": [
|
||||
{
|
||||
"computeEnvironment": "C4OnDemand",
|
||||
"order": 1
|
||||
},
|
||||
{
|
||||
"computeEnvironment": "M4Spot",
|
||||
"order": 2
|
||||
}
|
||||
],
|
||||
"jobQueueName": "HighPriority",
|
||||
"priority": 1,
|
||||
"state": "ENABLED"
|
||||
},
|
||||
"output": {
|
||||
"jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
|
||||
"jobQueueName": "HighPriority"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example creates a job queue called HighPriority that uses the C4OnDemand compute environment with an order of 1 and the M4Spot compute environment with an order of 2.",
|
||||
"id": "to-create-a-job-queue-with-multiple-compute-environments-1481153027051",
|
||||
"title": "To create a job queue with multiple compute environments"
|
||||
}
|
||||
],
|
||||
"DeleteComputeEnvironment": [
|
||||
{
|
||||
"input": {
|
||||
"computeEnvironment": "P2OnDemand"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes the P2OnDemand compute environment.",
|
||||
"id": "to-delete-a-compute-environment-1481153105644",
|
||||
"title": "To delete a compute environment"
|
||||
}
|
||||
],
|
||||
"DeleteJobQueue": [
|
||||
{
|
||||
"input": {
|
||||
"jobQueue": "GPGPU"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes the GPGPU job queue.",
|
||||
"id": "to-delete-a-job-queue-1481153508134",
|
||||
"title": "To delete a job queue"
|
||||
}
|
||||
],
|
||||
"DeregisterJobDefinition": [
|
||||
{
|
||||
"input": {
|
||||
"jobDefinition": "sleep10"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deregisters a job definition called sleep10.",
|
||||
"id": "to-deregister-a-job-definition-1481153579565",
|
||||
"title": "To deregister a job definition"
|
||||
}
|
||||
],
|
||||
"DescribeComputeEnvironments": [
|
||||
{
|
||||
"input": {
|
||||
"computeEnvironments": [
|
||||
"P2OnDemand"
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"computeEnvironments": [
|
||||
{
|
||||
"type": "MANAGED",
|
||||
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand",
|
||||
"computeEnvironmentName": "P2OnDemand",
|
||||
"computeResources": {
|
||||
"type": "EC2",
|
||||
"desiredvCpus": 48,
|
||||
"ec2KeyPair": "id_rsa",
|
||||
"instanceRole": "ecsInstanceRole",
|
||||
"instanceTypes": [
|
||||
"p2"
|
||||
],
|
||||
"maxvCpus": 128,
|
||||
"minvCpus": 0,
|
||||
"securityGroupIds": [
|
||||
"sg-cf5093b2"
|
||||
],
|
||||
"subnets": [
|
||||
"subnet-220c0e0a",
|
||||
"subnet-1a95556d",
|
||||
"subnet-978f6dce"
|
||||
],
|
||||
"tags": {
|
||||
"Name": "Batch Instance - P2OnDemand"
|
||||
}
|
||||
},
|
||||
"ecsClusterArn": "arn:aws:ecs:us-east-1:012345678910:cluster/P2OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc",
|
||||
"serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole",
|
||||
"state": "ENABLED",
|
||||
"status": "VALID",
|
||||
"statusReason": "ComputeEnvironment Healthy"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the P2OnDemand compute environment.",
|
||||
"id": "to-describe-a-compute-environment-1481153713334",
|
||||
"title": "To describe a compute environment"
|
||||
}
|
||||
],
|
||||
"DescribeJobDefinitions": [
|
||||
{
|
||||
"input": {
|
||||
"status": "ACTIVE"
|
||||
},
|
||||
"output": {
|
||||
"jobDefinitions": [
|
||||
{
|
||||
"type": "container",
|
||||
"containerProperties": {
|
||||
"command": [
|
||||
"sleep",
|
||||
"60"
|
||||
],
|
||||
"environment": [
|
||||
|
||||
],
|
||||
"image": "busybox",
|
||||
"memory": 128,
|
||||
"mountPoints": [
|
||||
|
||||
],
|
||||
"ulimits": [
|
||||
|
||||
],
|
||||
"vcpus": 1,
|
||||
"volumes": [
|
||||
|
||||
]
|
||||
},
|
||||
"jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1",
|
||||
"jobDefinitionName": "sleep60",
|
||||
"revision": 1,
|
||||
"status": "ACTIVE"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes all of your active job definitions.",
|
||||
"id": "to-describe-active-job-definitions-1481153895831",
|
||||
"title": "To describe active job definitions"
|
||||
}
|
||||
],
|
||||
"DescribeJobQueues": [
|
||||
{
|
||||
"input": {
|
||||
"jobQueues": [
|
||||
"HighPriority"
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"jobQueues": [
|
||||
{
|
||||
"computeEnvironmentOrder": [
|
||||
{
|
||||
"computeEnvironment": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand",
|
||||
"order": 1
|
||||
}
|
||||
],
|
||||
"jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
|
||||
"jobQueueName": "HighPriority",
|
||||
"priority": 1,
|
||||
"state": "ENABLED",
|
||||
"status": "VALID",
|
||||
"statusReason": "JobQueue Healthy"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the HighPriority job queue.",
|
||||
"id": "to-describe-a-job-queue-1481153995804",
|
||||
"title": "To describe a job queue"
|
||||
}
|
||||
],
|
||||
"DescribeJobs": [
|
||||
{
|
||||
"input": {
|
||||
"jobs": [
|
||||
"24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9"
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"jobs": [
|
||||
{
|
||||
"container": {
|
||||
"command": [
|
||||
"sleep",
|
||||
"60"
|
||||
],
|
||||
"containerInstanceArn": "arn:aws:ecs:us-east-1:012345678910:container-instance/5406d7cd-58bd-4b8f-9936-48d7c6b1526c",
|
||||
"environment": [
|
||||
|
||||
],
|
||||
"exitCode": 0,
|
||||
"image": "busybox",
|
||||
"memory": 128,
|
||||
"mountPoints": [
|
||||
|
||||
],
|
||||
"ulimits": [
|
||||
|
||||
],
|
||||
"vcpus": 1,
|
||||
"volumes": [
|
||||
|
||||
]
|
||||
},
|
||||
"createdAt": 1480460782010,
|
||||
"dependsOn": [
|
||||
|
||||
],
|
||||
"jobDefinition": "sleep60",
|
||||
"jobId": "24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9",
|
||||
"jobName": "example",
|
||||
"jobQueue": "arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority",
|
||||
"parameters": {
|
||||
},
|
||||
"startedAt": 1480460816500,
|
||||
"status": "SUCCEEDED",
|
||||
"stoppedAt": 1480460880699
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes a job with the specified job ID.",
|
||||
"id": "to-describe-a-specific-job-1481154090490",
|
||||
"title": "To describe a specific job"
|
||||
}
|
||||
],
|
||||
"ListJobs": [
|
||||
{
|
||||
"input": {
|
||||
"jobQueue": "HighPriority"
|
||||
},
|
||||
"output": {
|
||||
"jobSummaryList": [
|
||||
{
|
||||
"jobId": "e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb",
|
||||
"jobName": "example"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example lists the running jobs in the HighPriority job queue.",
|
||||
"id": "to-list-running-jobs-1481154202164",
|
||||
"title": "To list running jobs"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"jobQueue": "HighPriority",
|
||||
"jobStatus": "SUBMITTED"
|
||||
},
|
||||
"output": {
|
||||
"jobSummaryList": [
|
||||
{
|
||||
"jobId": "68f0c163-fbd4-44e6-9fd1-25b14a434786",
|
||||
"jobName": "example"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.",
|
||||
"id": "to-list-submitted-jobs-1481154251623",
|
||||
"title": "To list submitted jobs"
|
||||
}
|
||||
],
|
||||
"RegisterJobDefinition": [
|
||||
{
|
||||
"input": {
|
||||
"type": "container",
|
||||
"containerProperties": {
|
||||
"command": [
|
||||
"sleep",
|
||||
"10"
|
||||
],
|
||||
"image": "busybox",
|
||||
"memory": 128,
|
||||
"vcpus": 1
|
||||
},
|
||||
"jobDefinitionName": "sleep10"
|
||||
},
|
||||
"output": {
|
||||
"jobDefinitionArn": "arn:aws:batch:us-east-1:012345678910:job-definition/sleep10:1",
|
||||
"jobDefinitionName": "sleep10",
|
||||
"revision": 1
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example registers a job definition for a simple container job.",
|
||||
"id": "to-register-a-job-definition-1481154325325",
|
||||
"title": "To register a job definition"
|
||||
}
|
||||
],
|
||||
"SubmitJob": [
|
||||
{
|
||||
"input": {
|
||||
"jobDefinition": "sleep60",
|
||||
"jobName": "example",
|
||||
"jobQueue": "HighPriority"
|
||||
},
|
||||
"output": {
|
||||
"jobId": "876da822-4198-45f2-a252-6cea32512ea8",
|
||||
"jobName": "example"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example submits a simple container job called example to the HighPriority job queue.",
|
||||
"id": "to-submit-a-job-to-a-queue-1481154481673",
|
||||
"title": "To submit a job to a queue"
|
||||
}
|
||||
],
|
||||
"TerminateJob": [
|
||||
{
|
||||
"input": {
|
||||
"jobId": "61e743ed-35e4-48da-b2de-5c8333821c84",
|
||||
"reason": "Terminating job."
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example terminates a job with the specified job ID.",
|
||||
"id": "to-terminate-a-job-1481154558276",
|
||||
"title": "To terminate a job"
|
||||
}
|
||||
],
|
||||
"UpdateComputeEnvironment": [
|
||||
{
|
||||
"input": {
|
||||
"computeEnvironment": "P2OnDemand",
|
||||
"state": "DISABLED"
|
||||
},
|
||||
"output": {
|
||||
"computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand",
|
||||
"computeEnvironmentName": "P2OnDemand"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example disables the P2OnDemand compute environment so it can be deleted.",
|
||||
"id": "to-update-a-compute-environment-1481154702731",
|
||||
"title": "To update a compute environment"
|
||||
}
|
||||
],
|
||||
"UpdateJobQueue": [
|
||||
{
|
||||
"input": {
|
||||
"jobQueue": "GPGPU",
|
||||
"state": "DISABLED"
|
||||
},
|
||||
"output": {
|
||||
"jobQueueArn": "arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU",
|
||||
"jobQueueName": "GPGPU"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example disables a job queue so that it can be deleted.",
|
||||
"id": "to-update-a-job-queue-1481154806981",
|
||||
"title": "To update a job queue"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
3
botocore/data/batch/2016-08-10/paginators-1.json
Normal file
3
botocore/data/batch/2016-08-10/paginators-1.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
|
|
@ -37,7 +37,7 @@
|
|||
{"shape":"ClientException"},
|
||||
{"shape":"ServerException"}
|
||||
],
|
||||
"documentation":"<p>Creates an AWS Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code>compute environments.</p> <p>In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use the latest Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.</p> <p>In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html\">Container Instance AMIs</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. After you have created your unmanaged compute environment, you can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster that is associated with it and then manually launch your container instances into that Amazon ECS cluster. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html\">Launching an Amazon ECS Container Instance</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p>"
|
||||
"documentation":"<p>Creates an AWS Batch compute environment. You can create <code>MANAGED</code> or <code>UNMANAGED</code> compute environments.</p> <p>In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use the latest Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.</p> <p>In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html\">Container Instance AMIs</a> in the <i>Amazon EC2 Container Service Developer Guide</i>. After you have created your unmanaged compute environment, you can use the <a>DescribeComputeEnvironments</a> operation to find the Amazon ECS cluster that is associated with it and then manually launch your container instances into that Amazon ECS cluster. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html\">Launching an Amazon ECS Container Instance</a> in the <i>Amazon EC2 Container Service Developer Guide</i>.</p>"
|
||||
},
|
||||
"CreateJobQueue":{
|
||||
"name":"CreateJobQueue",
|
||||
|
|
@ -237,6 +237,54 @@
|
|||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AttemptContainerDetail":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"containerInstanceArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.</p>"
|
||||
},
|
||||
"taskArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the job attempt.</p>"
|
||||
},
|
||||
"exitCode":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The exit code for the job attempt. A non-zero exit code is considered a failure.</p>"
|
||||
},
|
||||
"reason":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A short (255 max characters) human-readable string to provide additional details about a running or stopped container.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An object representing the details of a container that is part of a job attempt.</p>"
|
||||
},
|
||||
"AttemptDetail":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"container":{
|
||||
"shape":"AttemptContainerDetail",
|
||||
"documentation":"<p>Details about the container in this job attempt.</p>"
|
||||
},
|
||||
"startedAt":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The Unix timestamp for when the attempt was started (when the task transitioned from the <code>PENDING</code> state to the <code>RUNNING</code> state).</p>"
|
||||
},
|
||||
"stoppedAt":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The Unix timestamp for when the attempt was stopped (when the task transitioned from the <code>RUNNING</code> state to the <code>STOPPED</code> state).</p>"
|
||||
},
|
||||
"statusReason":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A short, human-readable string to provide additional details about the current status of the job attempt.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An object representing a job attempt.</p>"
|
||||
},
|
||||
"AttemptDetails":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AttemptDetail"}
|
||||
},
|
||||
"Boolean":{"type":"boolean"},
|
||||
"CEState":{
|
||||
"type":"string",
|
||||
|
|
@ -406,6 +454,10 @@
|
|||
"shape":"StringList",
|
||||
"documentation":"<p>The instances types that may launched.</p>"
|
||||
},
|
||||
"imageId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.</p>"
|
||||
},
|
||||
"subnets":{
|
||||
"shape":"StringList",
|
||||
"documentation":"<p>The VPC subnets into which the compute resources are launched. </p>"
|
||||
|
|
@ -517,6 +569,10 @@
|
|||
"containerInstanceArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the container instance on which the container is running.</p>"
|
||||
},
|
||||
"taskArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon ECS task that is associated with the container job.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An object representing the details of a container that is part of a job.</p>"
|
||||
|
|
@ -916,6 +972,10 @@
|
|||
"shape":"ParametersMap",
|
||||
"documentation":"<p>Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a <code>SubmitJob</code> request override any corresponding parameter defaults from the job definition.</p>"
|
||||
},
|
||||
"retryStrategy":{
|
||||
"shape":"RetryStrategy",
|
||||
"documentation":"<p>The retry strategy to use for failed jobs that are submitted with this job definition.</p>"
|
||||
},
|
||||
"containerProperties":{
|
||||
"shape":"ContainerProperties",
|
||||
"documentation":"<p>An object with various properties specific to container-based jobs. </p>"
|
||||
|
|
@ -972,6 +1032,10 @@
|
|||
"shape":"JobStatus",
|
||||
"documentation":"<p>The current status for the job.</p>"
|
||||
},
|
||||
"attempts":{
|
||||
"shape":"AttemptDetails",
|
||||
"documentation":"<p>A list of job attempts associated with this job.</p>"
|
||||
},
|
||||
"statusReason":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A short, human-readable string to provide additional details about the current status of the job. </p>"
|
||||
|
|
@ -980,6 +1044,10 @@
|
|||
"shape":"Long",
|
||||
"documentation":"<p>The Unix timestamp for when the job was created (when the task entered the <code>PENDING</code> state). </p>"
|
||||
},
|
||||
"retryStrategy":{
|
||||
"shape":"RetryStrategy",
|
||||
"documentation":"<p>The retry strategy to use for this job if an attempt fails.</p>"
|
||||
},
|
||||
"startedAt":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The Unix timestamp for when the job was started (when the task transitioned from the <code>PENDING</code> state to the <code>RUNNING</code> state). </p>"
|
||||
|
|
@ -1157,7 +1225,7 @@
|
|||
"documentation":"<p>The name of the volume to mount.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Details on a volume mount point that is used in a job's container properties.</p>"
|
||||
"documentation":"<p>Details on a Docker volume mount point that is used in a job's container properties.</p>"
|
||||
},
|
||||
"MountPoints":{
|
||||
"type":"list",
|
||||
|
|
@ -1190,6 +1258,10 @@
|
|||
"containerProperties":{
|
||||
"shape":"ContainerProperties",
|
||||
"documentation":"<p>An object with various properties specific for container-based jobs. This parameter is required if the <code>type</code> parameter is <code>container</code>.</p>"
|
||||
},
|
||||
"retryStrategy":{
|
||||
"shape":"RetryStrategy",
|
||||
"documentation":"<p>The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that is specified during a <a>SubmitJob</a> operation overrides the retry strategy defined here.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1215,6 +1287,16 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"RetryStrategy":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"attempts":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The number of times to move a job to the <code>RUNNABLE</code> status. You may specify between 1 and 10 attempts. If <code>attempts</code> is greater than one, the job is retried if it fails until it has moved to <code>RUNNABLE</code> that many times.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The retry strategy associated with a job.</p>"
|
||||
},
|
||||
"ServerException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1240,7 +1322,7 @@
|
|||
"members":{
|
||||
"jobName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the job.</p>"
|
||||
"documentation":"<p>The name of the job. A name must be 1 to 128 characters in length.</p> <p>Pattern: ^[a-zA-Z0-9_]+$</p>"
|
||||
},
|
||||
"jobQueue":{
|
||||
"shape":"String",
|
||||
|
|
@ -1248,7 +1330,7 @@
|
|||
},
|
||||
"dependsOn":{
|
||||
"shape":"JobDependencyList",
|
||||
"documentation":"<p>A list of job names or IDs on which this job depends. A job can depend upon a maximum of 100 jobs. </p>"
|
||||
"documentation":"<p>A list of job IDs on which this job depends. A job can depend upon a maximum of 100 jobs. </p>"
|
||||
},
|
||||
"jobDefinition":{
|
||||
"shape":"String",
|
||||
|
|
@ -1261,6 +1343,10 @@
|
|||
"containerOverrides":{
|
||||
"shape":"ContainerOverrides",
|
||||
"documentation":"<p>A list of container overrides in JSON format that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container (that is specified in the job definition or the Docker image) with a <code>command</code> override. You can also override existing environment variables (that are specified in the job definition or Docker image) on a container or add new environment variables to it with an <code>environment</code> override.</p>"
|
||||
},
|
||||
"retryStrategy":{
|
||||
"shape":"RetryStrategy",
|
||||
"documentation":"<p>The retry strategy to use for failed jobs from this <a>SubmitJob</a> operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
|
|||
5
botocore/data/budgets/2016-10-20/examples-1.json
Executable file
5
botocore/data/budgets/2016-10-20/examples-1.json
Executable file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
3
botocore/data/budgets/2016-10-20/paginators-1.json
Normal file
3
botocore/data/budgets/2016-10-20/paginators-1.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
|
|
@ -57,7 +57,8 @@
|
|||
{"shape":"InternalErrorException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"CreationLimitExceededException"},
|
||||
{"shape":"DuplicateRecordException"}
|
||||
{"shape":"DuplicateRecordException"},
|
||||
{"shape":"NotFoundException"}
|
||||
],
|
||||
"documentation":"Create a new Subscriber for a notification"
|
||||
},
|
||||
|
|
@ -606,7 +607,7 @@
|
|||
"NotificationThreshold":{
|
||||
"type":"double",
|
||||
"documentation":"The threshold of the a notification. It should be a number between 0 and 100.",
|
||||
"max":100,
|
||||
"max":300,
|
||||
"min":0.1
|
||||
},
|
||||
"NotificationType":{
|
||||
|
|
@ -643,7 +644,7 @@
|
|||
"NumericValue":{
|
||||
"type":"string",
|
||||
"documentation":"A string to represent NumericValue.",
|
||||
"pattern":"[0-9]+(\\.)?[0-9]*"
|
||||
"pattern":"[0-9]*(\\.)?[0-9]+"
|
||||
},
|
||||
"Spend":{
|
||||
"type":"structure",
|
||||
|
|
|
|||
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
|
|
@ -51,7 +51,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidAttachmentException"}
|
||||
],
|
||||
"documentation":"<p>Copies input published schema into <a>Directory</a> with same name and version as that of published schema .</p>"
|
||||
"documentation":"<p>Copies the input published schema into the <a>Directory</a> with the same name and version as that of the published schema .</p>"
|
||||
},
|
||||
"AttachObject":{
|
||||
"name":"AttachObject",
|
||||
|
|
@ -73,9 +73,10 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"LinkNameAlreadyInUseException"},
|
||||
{"shape":"InvalidAttachmentException"},
|
||||
{"shape":"ValidationException"}
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"FacetValidationException"}
|
||||
],
|
||||
"documentation":"<p>Attaches an existing object to another object. An object can be accessed in two ways:</p> <ol> <li> <p>Using the path</p> </li> <li> <p>Using ObjectIdentifier</p> </li> </ol>"
|
||||
"documentation":"<p>Attaches an existing object to another object. An object can be accessed in two ways:</p> <ol> <li> <p>Using the path</p> </li> <li> <p>Using <code>ObjectIdentifier</code> </p> </li> </ol>"
|
||||
},
|
||||
"AttachPolicy":{
|
||||
"name":"AttachPolicy",
|
||||
|
|
@ -124,6 +125,29 @@
|
|||
],
|
||||
"documentation":"<p>Attaches the specified object to the specified index.</p>"
|
||||
},
|
||||
"AttachTypedLink":{
|
||||
"name":"AttachTypedLink",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/attach",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"AttachTypedLinkRequest"},
|
||||
"output":{"shape":"AttachTypedLinkResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidAttachmentException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"FacetValidationException"}
|
||||
],
|
||||
"documentation":"<p>Attaches a typed link to a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
},
|
||||
"BatchRead":{
|
||||
"name":"BatchRead",
|
||||
"http":{
|
||||
|
|
@ -205,7 +229,8 @@
|
|||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"FacetAlreadyExistsException"},
|
||||
{"shape":"InvalidRuleException"}
|
||||
{"shape":"InvalidRuleException"},
|
||||
{"shape":"FacetValidationException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new <a>Facet</a> in a schema. Facet creation is allowed only in development or applied schemas.</p>"
|
||||
},
|
||||
|
|
@ -256,7 +281,7 @@
|
|||
{"shape":"LinkNameAlreadyInUseException"},
|
||||
{"shape":"UnsupportedIndexTypeException"}
|
||||
],
|
||||
"documentation":"<p>Creates an object in a <a>Directory</a>. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of <a>Facet</a> attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet. </p>"
|
||||
"documentation":"<p>Creates an object in a <a>Directory</a>. Additionally attaches the object to a parent, if a parent reference and <code>LinkName</code> is specified. An object is simply a collection of <a>Facet</a> attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet. </p>"
|
||||
},
|
||||
"CreateSchema":{
|
||||
"name":"CreateSchema",
|
||||
|
|
@ -279,6 +304,29 @@
|
|||
],
|
||||
"documentation":"<p>Creates a new schema in a development state. A schema can exist in three phases:</p> <ul> <li> <p> <i>Development:</i> This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.</p> </li> <li> <p> <i>Published:</i> Published schemas are immutable and have a version associated with them.</p> </li> <li> <p> <i>Applied:</i> Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories. </p> </li> </ul>"
|
||||
},
|
||||
"CreateTypedLinkFacet":{
|
||||
"name":"CreateTypedLinkFacet",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/create",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"CreateTypedLinkFacetRequest"},
|
||||
"output":{"shape":"CreateTypedLinkFacetResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"FacetAlreadyExistsException"},
|
||||
{"shape":"InvalidRuleException"},
|
||||
{"shape":"FacetValidationException"}
|
||||
],
|
||||
"documentation":"<p>Creates a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
},
|
||||
"DeleteDirectory":{
|
||||
"name":"DeleteDirectory",
|
||||
"http":{
|
||||
|
|
@ -295,7 +343,9 @@
|
|||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryDeletedException"}
|
||||
{"shape":"DirectoryDeletedException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"InvalidArnException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.</p>"
|
||||
},
|
||||
|
|
@ -319,7 +369,7 @@
|
|||
{"shape":"FacetNotFoundException"},
|
||||
{"shape":"FacetInUseException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a given <a>Facet</a>. All attributes and <a>Rule</a>s associated with the facet will be deleted. Only development schema facets are allowed deletion.</p>"
|
||||
"documentation":"<p>Deletes a given <a>Facet</a>. All attributes and <a>Rule</a>s that are associated with the facet will be deleted. Only development schema facets are allowed deletion.</p>"
|
||||
},
|
||||
"DeleteObject":{
|
||||
"name":"DeleteObject",
|
||||
|
|
@ -364,6 +414,27 @@
|
|||
],
|
||||
"documentation":"<p>Deletes a given schema. Schemas in a development and published state can only be deleted. </p>"
|
||||
},
|
||||
"DeleteTypedLinkFacet":{
|
||||
"name":"DeleteTypedLinkFacet",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/delete",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"DeleteTypedLinkFacetRequest"},
|
||||
"output":{"shape":"DeleteTypedLinkFacetResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"FacetNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
},
|
||||
"DetachFromIndex":{
|
||||
"name":"DetachFromIndex",
|
||||
"http":{
|
||||
|
|
@ -431,6 +502,26 @@
|
|||
],
|
||||
"documentation":"<p>Detaches a policy from an object.</p>"
|
||||
},
|
||||
"DetachTypedLink":{
|
||||
"name":"DetachTypedLink",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/detach",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"DetachTypedLinkRequest"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"FacetValidationException"}
|
||||
],
|
||||
"documentation":"<p>Detaches a typed link from a specified source and target object. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
},
|
||||
"DisableDirectory":{
|
||||
"name":"DisableDirectory",
|
||||
"http":{
|
||||
|
|
@ -446,7 +537,9 @@
|
|||
{"shape":"InternalServiceException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"}
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"InvalidArnException"}
|
||||
],
|
||||
"documentation":"<p>Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.</p>"
|
||||
},
|
||||
|
|
@ -465,7 +558,9 @@
|
|||
{"shape":"InternalServiceException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"}
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"InvalidArnException"}
|
||||
],
|
||||
"documentation":"<p>Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.</p>"
|
||||
},
|
||||
|
|
@ -507,7 +602,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"FacetNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Gets details of the <a>Facet</a>, such as Facet Name, Attributes, <a>Rule</a>s, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied.</p>"
|
||||
"documentation":"<p>Gets details of the <a>Facet</a>, such as facet name, attributes, <a>Rule</a>s, or <code>ObjectType</code>. You can call this on all kinds of schema facets -- published, development, or applied.</p>"
|
||||
},
|
||||
"GetObjectInformation":{
|
||||
"name":"GetObjectInformation",
|
||||
|
|
@ -551,6 +646,28 @@
|
|||
],
|
||||
"documentation":"<p>Retrieves a JSON representation of the schema. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_schemas.html#jsonformat\">JSON Schema Format</a> for more information.</p>"
|
||||
},
|
||||
"GetTypedLinkFacetInformation":{
|
||||
"name":"GetTypedLinkFacetInformation",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/get",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"GetTypedLinkFacetInformationRequest"},
|
||||
"output":{"shape":"GetTypedLinkFacetInformationResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"FacetNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Returns the identity attribute order for a specific <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
},
|
||||
"ListAppliedSchemaArns":{
|
||||
"name":"ListAppliedSchemaArns",
|
||||
"http":{
|
||||
|
|
@ -612,7 +729,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves the ARNs of schemas in the development state.</p>"
|
||||
"documentation":"<p>Retrieves each Amazon Resource Name (ARN) of schemas in the development state.</p>"
|
||||
},
|
||||
"ListDirectories":{
|
||||
"name":"ListDirectories",
|
||||
|
|
@ -677,6 +794,28 @@
|
|||
],
|
||||
"documentation":"<p>Retrieves the names of facets that exist in a schema.</p>"
|
||||
},
|
||||
"ListIncomingTypedLinks":{
|
||||
"name":"ListIncomingTypedLinks",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/incoming",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"ListIncomingTypedLinksRequest"},
|
||||
"output":{"shape":"ListIncomingTypedLinksResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"FacetValidationException"}
|
||||
],
|
||||
"documentation":"<p>Returns a paginated list of all the incoming <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
},
|
||||
"ListIndex":{
|
||||
"name":"ListIndex",
|
||||
"http":{
|
||||
|
|
@ -718,9 +857,10 @@
|
|||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"FacetValidationException"}
|
||||
],
|
||||
"documentation":"<p>Lists all attributes associated with an object. This also supports common namespace prefix (key) listing. For example, if you want to retrieve all attributes associated with facet1, key can be <code>facet1</code>. If key is empty, all attributes are returned in a paginated list.</p>"
|
||||
"documentation":"<p>Lists all attributes that are associated with an object. </p>"
|
||||
},
|
||||
"ListObjectChildren":{
|
||||
"name":"ListObjectChildren",
|
||||
|
|
@ -744,7 +884,29 @@
|
|||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"NotNodeException"}
|
||||
],
|
||||
"documentation":"<p>Returns a paginated list of child objects associated with a given object.</p>"
|
||||
"documentation":"<p>Returns a paginated list of child objects that are associated with a given object.</p>"
|
||||
},
|
||||
"ListObjectParentPaths":{
|
||||
"name":"ListObjectParentPaths",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/object/parentpaths",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"ListObjectParentPathsRequest"},
|
||||
"output":{"shape":"ListObjectParentPathsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"DirectoryNotEnabledException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#dirstructure\">Directory Structure</a>.</p> <p>Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined <code>MaxResults</code>, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.</p>"
|
||||
},
|
||||
"ListObjectParents":{
|
||||
"name":"ListObjectParents",
|
||||
|
|
@ -768,7 +930,7 @@
|
|||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"CannotListParentOfRootException"}
|
||||
],
|
||||
"documentation":"<p>Lists parent objects associated with a given object in pagination fashion.</p>"
|
||||
"documentation":"<p>Lists parent objects that are associated with a given object in pagination fashion.</p>"
|
||||
},
|
||||
"ListObjectPolicies":{
|
||||
"name":"ListObjectPolicies",
|
||||
|
|
@ -792,6 +954,28 @@
|
|||
],
|
||||
"documentation":"<p>Returns policies attached to an object in pagination fashion.</p>"
|
||||
},
|
||||
"ListOutgoingTypedLinks":{
|
||||
"name":"ListOutgoingTypedLinks",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/outgoing",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"ListOutgoingTypedLinksRequest"},
|
||||
"output":{"shape":"ListOutgoingTypedLinksResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"FacetValidationException"}
|
||||
],
|
||||
"documentation":"<p>Returns a paginated list of all the outgoing <a>TypedLinkSpecifier</a> information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
},
|
||||
"ListPolicyAttachments":{
|
||||
"name":"ListPolicyAttachments",
|
||||
"http":{
|
||||
|
|
@ -814,7 +998,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"NotPolicyException"}
|
||||
],
|
||||
"documentation":"<p>Returns all of the ObjectIdentifiers to which a given policy is attached.</p>"
|
||||
"documentation":"<p>Returns all of the <code>ObjectIdentifiers</code> to which a given policy is attached.</p>"
|
||||
},
|
||||
"ListPublishedSchemaArns":{
|
||||
"name":"ListPublishedSchemaArns",
|
||||
|
|
@ -835,7 +1019,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves published schema ARNs.</p>"
|
||||
"documentation":"<p>Retrieves each published schema Amazon Resource Name (ARN).</p>"
|
||||
},
|
||||
"ListTagsForResource":{
|
||||
"name":"ListTagsForResource",
|
||||
|
|
@ -858,6 +1042,49 @@
|
|||
],
|
||||
"documentation":"<p>Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.</p>"
|
||||
},
|
||||
"ListTypedLinkFacetAttributes":{
|
||||
"name":"ListTypedLinkFacetAttributes",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/attributes",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"ListTypedLinkFacetAttributesRequest"},
|
||||
"output":{"shape":"ListTypedLinkFacetAttributesResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"FacetNotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
],
|
||||
"documentation":"<p>Returns a paginated list of all attribute definitions for a particular <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
},
|
||||
"ListTypedLinkFacetNames":{
|
||||
"name":"ListTypedLinkFacetNames",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet/list",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"ListTypedLinkFacetNamesRequest"},
|
||||
"output":{"shape":"ListTypedLinkFacetNamesResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
],
|
||||
"documentation":"<p>Returns a paginated list of <code>TypedLink</code> facet names for a particular schema. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
},
|
||||
"LookupPolicy":{
|
||||
"name":"LookupPolicy",
|
||||
"http":{
|
||||
|
|
@ -879,7 +1106,7 @@
|
|||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the objectIdentifier for such objects. If policies are present, it returns objectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored.</p>"
|
||||
"documentation":"<p>Lists all policies from the root of the <a>Directory</a> to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the <code>ObjectIdentifier</code> for such objects. If policies are present, it returns <code>ObjectIdentifier</code>, <code>policyId</code>, and <code>policyType</code>. Paths that don't lead to the root from the target object are ignored. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
|
||||
},
|
||||
"PublishSchema":{
|
||||
"name":"PublishSchema",
|
||||
|
|
@ -900,7 +1127,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"SchemaAlreadyPublishedException"}
|
||||
],
|
||||
"documentation":"<p>Publishes a development schema with a version. If description and attributes are specified, PublishSchema overrides the development schema description and attributes. If not, the development schema description and attributes are used.</p>"
|
||||
"documentation":"<p>Publishes a development schema with a version. If description and attributes are specified, <code>PublishSchema</code> overrides the development schema description and attributes. If not, the development schema description and attributes are used.</p>"
|
||||
},
|
||||
"PutSchemaFromJson":{
|
||||
"name":"PutSchemaFromJson",
|
||||
|
|
@ -964,7 +1191,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidTaggingRequestException"}
|
||||
],
|
||||
"documentation":"<p>API for adding tags to a resource.</p>"
|
||||
"documentation":"<p>An API operation for adding tags to a resource.</p>"
|
||||
},
|
||||
"UntagResource":{
|
||||
"name":"UntagResource",
|
||||
|
|
@ -985,7 +1212,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InvalidTaggingRequestException"}
|
||||
],
|
||||
"documentation":"<p>API for removing tags from a resource.</p>"
|
||||
"documentation":"<p>An API operation for removing tags from a resource.</p>"
|
||||
},
|
||||
"UpdateFacet":{
|
||||
"name":"UpdateFacet",
|
||||
|
|
@ -1008,7 +1235,7 @@
|
|||
{"shape":"FacetNotFoundException"},
|
||||
{"shape":"InvalidRuleException"}
|
||||
],
|
||||
"documentation":"<p>Does the following:</p> <ol> <li> <p>Adds new Attributes, Rules, or ObjectTypes.</p> </li> <li> <p>Updates existing Attributes, Rules, or ObjectTypes.</p> </li> <li> <p>Deletes existing Attributes, Rules, or ObjectTypes.</p> </li> </ol>"
|
||||
"documentation":"<p>Does the following:</p> <ol> <li> <p>Adds new <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> <li> <p>Updates existing <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> <li> <p>Deletes existing <code>Attributes</code>, <code>Rules</code>, or <code>ObjectTypes</code>.</p> </li> </ol>"
|
||||
},
|
||||
"UpdateObjectAttributes":{
|
||||
"name":"UpdateObjectAttributes",
|
||||
|
|
@ -1051,6 +1278,30 @@
|
|||
{"shape":"ResourceNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Updates the schema name with a new name. Only development schema names can be updated.</p>"
|
||||
},
|
||||
"UpdateTypedLinkFacet":{
|
||||
"name":"UpdateTypedLinkFacet",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/amazonclouddirectory/2017-01-11/typedlink/facet",
|
||||
"responseCode":200
|
||||
},
|
||||
"input":{"shape":"UpdateTypedLinkFacetRequest"},
|
||||
"output":{"shape":"UpdateTypedLinkFacetResponse"},
|
||||
"errors":[
|
||||
{"shape":"InternalServiceException"},
|
||||
{"shape":"InvalidArnException"},
|
||||
{"shape":"RetryableConflictException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AccessDeniedException"},
|
||||
{"shape":"FacetValidationException"},
|
||||
{"shape":"InvalidFacetUpdateException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"FacetNotFoundException"},
|
||||
{"shape":"InvalidRuleException"}
|
||||
],
|
||||
"documentation":"<p>Updates a <a>TypedLinkFacet</a>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -1073,7 +1324,7 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
|
|
@ -1083,7 +1334,7 @@
|
|||
},
|
||||
"ObjectAttributeList":{
|
||||
"shape":"AttributeKeyAndValueList",
|
||||
"documentation":"<p>Attributes on the facet you are adding to the object.</p>"
|
||||
"documentation":"<p>Attributes on the facet that you are adding to the object.</p>"
|
||||
},
|
||||
"ObjectReference":{
|
||||
"shape":"ObjectReference",
|
||||
|
|
@ -1105,11 +1356,11 @@
|
|||
"members":{
|
||||
"PublishedSchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>Published schema ARN that needs to be copied. For more information, see <a>arns</a>.</p>"
|
||||
"documentation":"<p>Published schema Amazon Resource Name (ARN) that needs to be copied. For more information, see <a>arns</a>.</p>"
|
||||
},
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a> into which the schema is copied. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> into which the schema is copied. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
}
|
||||
|
|
@ -1120,11 +1371,11 @@
|
|||
"members":{
|
||||
"AppliedSchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>Applied schema ARN associated with the copied schema in the <a>Directory</a>. You can use this ARN to describe the schema information applied on this directory. For more information, see <a>arns</a>.</p>"
|
||||
"documentation":"<p>The applied schema ARN that is associated with the copied schema in the <a>Directory</a>. You can use this ARN to describe the schema information applied on this directory. For more information, see <a>arns</a>.</p>"
|
||||
},
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>"
|
||||
"documentation":"<p>The ARN that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1144,21 +1395,21 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"ParentReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Parent object reference.</p>"
|
||||
"documentation":"<p>The parent object reference.</p>"
|
||||
},
|
||||
"ChildReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Child object reference to be attached to the object.</p>"
|
||||
"documentation":"<p>The child object reference to be attached to the object.</p>"
|
||||
},
|
||||
"LinkName":{
|
||||
"shape":"LinkName",
|
||||
"documentation":"<p>Link name with which the child object is attached to the parent.</p>"
|
||||
"documentation":"<p>The link name with which the child object is attached to the parent.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1167,7 +1418,7 @@
|
|||
"members":{
|
||||
"AttachedObjectIdentifier":{
|
||||
"shape":"ObjectIdentifier",
|
||||
"documentation":"<p>Attached ObjectIdentifier, which is the child ObjectIdentifier.</p>"
|
||||
"documentation":"<p>The attached <code>ObjectIdentifier</code>, which is the child <code>ObjectIdentifier</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1180,17 +1431,17 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"PolicyReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Reference associated with the policy object.</p>"
|
||||
"documentation":"<p>The reference that is associated with the policy object.</p>"
|
||||
},
|
||||
"ObjectReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Reference that identifies the object to which the policy will be attached.</p>"
|
||||
"documentation":"<p>The reference that identifies the object to which the policy will be attached.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1209,7 +1460,7 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The ARN of the directory where the object and index exist.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the directory where the object and index exist.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
|
|
@ -1228,7 +1479,50 @@
|
|||
"members":{
|
||||
"AttachedObjectIdentifier":{
|
||||
"shape":"ObjectIdentifier",
|
||||
"documentation":"<p>The ObjectIdentifier of the object that was attached to the index.</p>"
|
||||
"documentation":"<p>The <code>ObjectIdentifier</code> of the object that was attached to the index.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"AttachTypedLinkRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DirectoryArn",
|
||||
"SourceObjectReference",
|
||||
"TargetObjectReference",
|
||||
"TypedLinkFacet",
|
||||
"Attributes"
|
||||
],
|
||||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"SourceObjectReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Identifies the source object that the typed link will attach to.</p>"
|
||||
},
|
||||
"TargetObjectReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Identifies the target object that the typed link will attach to.</p>"
|
||||
},
|
||||
"TypedLinkFacet":{
|
||||
"shape":"TypedLinkSchemaAndFacetName",
|
||||
"documentation":"<p>Identifies the typed link facet that is associated with the typed link.</p>"
|
||||
},
|
||||
"Attributes":{
|
||||
"shape":"AttributeNameAndValueList",
|
||||
"documentation":"<p>A set of attributes that are associated with the typed link.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"AttachTypedLinkResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TypedLinkSpecifier":{
|
||||
"shape":"TypedLinkSpecifier",
|
||||
"documentation":"<p>Returns a typed link specifier as output.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1242,11 +1536,11 @@
|
|||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The ARN of the schema that contains the facet and attribute.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.</p>"
|
||||
},
|
||||
"FacetName":{
|
||||
"shape":"FacetName",
|
||||
"documentation":"<p>The name of the facet the attribute exists within.</p>"
|
||||
"documentation":"<p>The name of the facet that the attribute exists within.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"AttributeName",
|
||||
|
|
@ -1287,6 +1581,32 @@
|
|||
"min":1,
|
||||
"pattern":"^[a-zA-Z0-9._-]*$"
|
||||
},
|
||||
"AttributeNameAndValue":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AttributeName",
|
||||
"Value"
|
||||
],
|
||||
"members":{
|
||||
"AttributeName":{
|
||||
"shape":"AttributeName",
|
||||
"documentation":"<p>The attribute name of the typed link.</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"TypedAttributeValue",
|
||||
"documentation":"<p>The value for the typed link.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Identifies the attribute name and value for a typed link.</p>"
|
||||
},
|
||||
"AttributeNameAndValueList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AttributeNameAndValue"}
|
||||
},
|
||||
"AttributeNameList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AttributeName"}
|
||||
},
|
||||
"BatchAddFacetToObject":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -1326,28 +1646,28 @@
|
|||
"members":{
|
||||
"ParentReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Parent object reference.</p>"
|
||||
"documentation":"<p>The parent object reference.</p>"
|
||||
},
|
||||
"ChildReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Child object reference to be attached to the object.</p>"
|
||||
"documentation":"<p>The child object reference that is to be attached to the object.</p>"
|
||||
},
|
||||
"LinkName":{
|
||||
"shape":"LinkName",
|
||||
"documentation":"<p>The name of the link.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of an AttachObject operation.</p>"
|
||||
"documentation":"<p>Represents the output of an <code>AttachObject</code> operation.</p>"
|
||||
},
|
||||
"BatchAttachObjectResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"attachedObjectIdentifier":{
|
||||
"shape":"ObjectIdentifier",
|
||||
"documentation":"<p>The ObjectIdentifier of the object that has been attached.</p>"
|
||||
"documentation":"<p>The <code>ObjectIdentifier</code> of the object that has been attached.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output batch AttachObject response operation.</p>"
|
||||
"documentation":"<p>Represents the output batch <code>AttachObject</code> response operation.</p>"
|
||||
},
|
||||
"BatchCreateObject":{
|
||||
"type":"structure",
|
||||
|
|
@ -1361,11 +1681,11 @@
|
|||
"members":{
|
||||
"SchemaFacet":{
|
||||
"shape":"SchemaFacetList",
|
||||
"documentation":"<p>List of FacetArns that will be associated with the object. For more information, see <a>arns</a>.</p>"
|
||||
"documentation":"<p>A list of <code>FacetArns</code> that will be associated with the object. For more information, see <a>arns</a>.</p>"
|
||||
},
|
||||
"ObjectAttributeList":{
|
||||
"shape":"AttributeKeyAndValueList",
|
||||
"documentation":"<p>Attribute map, which contains an attribute ARN as the key and attribute value as the map value.</p>"
|
||||
"documentation":"<p>An attribute map, which contains an attribute ARN as the key and attribute value as the map value.</p>"
|
||||
},
|
||||
"ParentReference":{
|
||||
"shape":"ObjectReference",
|
||||
|
|
@ -1380,17 +1700,17 @@
|
|||
"documentation":"<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a CreateObject operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>CreateObject</code> operation.</p>"
|
||||
},
|
||||
"BatchCreateObjectResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ObjectIdentifier":{
|
||||
"shape":"ObjectIdentifier",
|
||||
"documentation":"<p>ID associated with the object.</p>"
|
||||
"documentation":"<p>The ID that is associated with the object.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a CreateObject response operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>CreateObject</code> response operation.</p>"
|
||||
},
|
||||
"BatchDeleteObject":{
|
||||
"type":"structure",
|
||||
|
|
@ -1398,16 +1718,16 @@
|
|||
"members":{
|
||||
"ObjectReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Reference that identifies the object.</p>"
|
||||
"documentation":"<p>The reference that identifies the object.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a DeleteObject operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>DeleteObject</code> operation.</p>"
|
||||
},
|
||||
"BatchDeleteObjectResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>Represents the output of a DeleteObject response operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>DeleteObject</code> response operation.</p>"
|
||||
},
|
||||
"BatchDetachObject":{
|
||||
"type":"structure",
|
||||
|
|
@ -1430,17 +1750,17 @@
|
|||
"documentation":"<p>The batch reference name. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches\">Batches</a> for more information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a DetachObject operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>DetachObject</code> operation.</p>"
|
||||
},
|
||||
"BatchDetachObjectResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"detachedObjectIdentifier":{
|
||||
"shape":"ObjectIdentifier",
|
||||
"documentation":"<p>The ObjectIdentifier of the detached object.</p>"
|
||||
"documentation":"<p>The <code>ObjectIdentifier</code> of the detached object.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a DetachObject response operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>DetachObject</code> response operation.</p>"
|
||||
},
|
||||
"BatchListObjectAttributes":{
|
||||
"type":"structure",
|
||||
|
|
@ -1452,28 +1772,32 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Token used for pagination.</p>"
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"NumberResults",
|
||||
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
},
|
||||
"FacetFilter":{
|
||||
"shape":"SchemaFacet",
|
||||
"documentation":"<p>Used to filter the list of object attributes that are associated with a certain facet.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a ListObjectAttributes operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>ListObjectAttributes</code> operation.</p>"
|
||||
},
|
||||
"BatchListObjectAttributesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Attributes":{
|
||||
"shape":"AttributeKeyAndValueList",
|
||||
"documentation":"<p>Attributes map associated with the object. AttributeArn is the key; attribute value is the value.</p>"
|
||||
"documentation":"<p>The attributes map that is associated with the object. <code>AttributeArn</code> is the key; attribute value is the value.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Token used for pagination.</p>"
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a ListObjectAttributes response operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>ListObjectAttributes</code> response operation.</p>"
|
||||
},
|
||||
"BatchListObjectChildren":{
|
||||
"type":"structure",
|
||||
|
|
@ -1485,28 +1809,28 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Token used for pagination.</p>"
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"NumberResults",
|
||||
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a ListObjectChildren operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>ListObjectChildren</code> operation.</p>"
|
||||
},
|
||||
"BatchListObjectChildrenResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Children":{
|
||||
"shape":"LinkNameToObjectIdentifierMap",
|
||||
"documentation":"<p>Children structure, which is a map with key as the LinkName and ObjectIdentifier as the value.</p>"
|
||||
"documentation":"<p>The children structure, which is a map with the key as the <code>LinkName</code> and <code>ObjectIdentifier</code> as the value.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Token used for pagination.</p>"
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a ListObjectChildren response operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>ListObjectChildren</code> response operation.</p>"
|
||||
},
|
||||
"BatchOperationIndex":{"type":"integer"},
|
||||
"BatchReadException":{
|
||||
|
|
@ -1514,14 +1838,14 @@
|
|||
"members":{
|
||||
"Type":{
|
||||
"shape":"BatchReadExceptionType",
|
||||
"documentation":"<p>Type of exception, such as InvalidArnException.</p>"
|
||||
"documentation":"<p>A type of exception, such as <code>InvalidArnException</code>.</p>"
|
||||
},
|
||||
"Message":{
|
||||
"shape":"ExceptionMessage",
|
||||
"documentation":"<p>Exception message associated with the failure.</p>"
|
||||
"documentation":"<p>An exception message that is associated with the failure.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Batch Read Exception structure, which contains exception type and message.</p>"
|
||||
"documentation":"<p>The batch read exception structure, which contains the exception type and message.</p>"
|
||||
},
|
||||
"BatchReadExceptionType":{
|
||||
"type":"string",
|
||||
|
|
@ -1539,14 +1863,14 @@
|
|||
"members":{
|
||||
"ListObjectAttributes":{
|
||||
"shape":"BatchListObjectAttributes",
|
||||
"documentation":"<p>Lists all attributes associated with an object.</p>"
|
||||
"documentation":"<p>Lists all attributes that are associated with an object.</p>"
|
||||
},
|
||||
"ListObjectChildren":{
|
||||
"shape":"BatchListObjectChildren",
|
||||
"documentation":"<p>Returns a paginated list of child objects that are associated with a given object.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a BatchRead operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>BatchRead</code> operation.</p>"
|
||||
},
|
||||
"BatchReadOperationList":{
|
||||
"type":"list",
|
||||
|
|
@ -1564,7 +1888,7 @@
|
|||
"documentation":"<p>Identifies which operation in a batch has failed.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a BatchRead response operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>BatchRead</code> response operation.</p>"
|
||||
},
|
||||
"BatchReadOperationResponseList":{
|
||||
"type":"list",
|
||||
|
|
@ -1579,13 +1903,13 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"Operations":{
|
||||
"shape":"BatchReadOperationList",
|
||||
"documentation":"<p>List of operations that are part of the batch.</p>"
|
||||
"documentation":"<p>A list of operations that are part of the batch.</p>"
|
||||
},
|
||||
"ConsistencyLevel":{
|
||||
"shape":"ConsistencyLevel",
|
||||
|
|
@ -1600,7 +1924,7 @@
|
|||
"members":{
|
||||
"Responses":{
|
||||
"shape":"BatchReadOperationResponseList",
|
||||
"documentation":"<p>List of all the responses for each batch read.</p>"
|
||||
"documentation":"<p>A list of all the responses for each batch read.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1609,14 +1933,14 @@
|
|||
"members":{
|
||||
"ListObjectAttributes":{
|
||||
"shape":"BatchListObjectAttributesResponse",
|
||||
"documentation":"<p>Lists all attributes associated with an object.</p>"
|
||||
"documentation":"<p>Lists all attributes that are associated with an object.</p>"
|
||||
},
|
||||
"ListObjectChildren":{
|
||||
"shape":"BatchListObjectChildrenResponse",
|
||||
"documentation":"<p>Returns a paginated list of child objects associated with a given object.</p>"
|
||||
"documentation":"<p>Returns a paginated list of child objects that are associated with a given object.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a BatchRead success response operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>BatchRead</code> success response operation.</p>"
|
||||
},
|
||||
"BatchReferenceName":{"type":"string"},
|
||||
"BatchRemoveFacetFromObject":{
|
||||
|
|
@ -1635,13 +1959,13 @@
|
|||
"documentation":"<p>A reference to the object whose facet will be removed.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Batch operation to remove a facet from an object.</p>"
|
||||
"documentation":"<p>A batch operation to remove a facet from an object.</p>"
|
||||
},
|
||||
"BatchRemoveFacetFromObjectResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>Empty result representing success.</p>"
|
||||
"documentation":"<p>An empty result that represents success.</p>"
|
||||
},
|
||||
"BatchUpdateObjectAttributes":{
|
||||
"type":"structure",
|
||||
|
|
@ -1659,17 +1983,17 @@
|
|||
"documentation":"<p>Attributes update structure.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a BatchUpdate operation. </p>"
|
||||
"documentation":"<p>Represents the output of a <code>BatchUpdate</code> operation. </p>"
|
||||
},
|
||||
"BatchUpdateObjectAttributesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ObjectIdentifier":{
|
||||
"shape":"ObjectIdentifier",
|
||||
"documentation":"<p>ID associated with the object.</p>"
|
||||
"documentation":"<p>ID that is associated with the object.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a BatchUpdate response operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>BatchUpdate</code> response operation.</p>"
|
||||
},
|
||||
"BatchWriteException":{
|
||||
"type":"structure",
|
||||
|
|
@ -1678,7 +2002,7 @@
|
|||
"Type":{"shape":"BatchWriteExceptionType"},
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>A BatchWrite exception has occurred.</p>",
|
||||
"documentation":"<p>A <code>BatchWrite</code> exception has occurred.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"BatchWriteExceptionType":{
|
||||
|
|
@ -1712,7 +2036,7 @@
|
|||
},
|
||||
"UpdateObjectAttributes":{
|
||||
"shape":"BatchUpdateObjectAttributes",
|
||||
"documentation":"<p>Update a given object's attributes.</p>"
|
||||
"documentation":"<p>Updates a given object's attributes.</p>"
|
||||
},
|
||||
"DeleteObject":{
|
||||
"shape":"BatchDeleteObject",
|
||||
|
|
@ -1720,14 +2044,14 @@
|
|||
},
|
||||
"AddFacetToObject":{
|
||||
"shape":"BatchAddFacetToObject",
|
||||
"documentation":"<p>Batch operation adding a facet to an object.</p>"
|
||||
"documentation":"<p>A batch operation that adds a facet to an object.</p>"
|
||||
},
|
||||
"RemoveFacetFromObject":{
|
||||
"shape":"BatchRemoveFacetFromObject",
|
||||
"documentation":"<p>Batch operation removing a facet from an object.</p>"
|
||||
"documentation":"<p>A batch operation that removes a facet from an object.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a BatchWrite operation. </p>"
|
||||
"documentation":"<p>Represents the output of a <code>BatchWrite</code> operation. </p>"
|
||||
},
|
||||
"BatchWriteOperationList":{
|
||||
"type":"list",
|
||||
|
|
@ -1758,14 +2082,14 @@
|
|||
},
|
||||
"AddFacetToObject":{
|
||||
"shape":"BatchAddFacetToObjectResponse",
|
||||
"documentation":"<p>Result of an add facet to object batch operation.</p>"
|
||||
"documentation":"<p>The result of an add facet to object batch operation.</p>"
|
||||
},
|
||||
"RemoveFacetFromObject":{
|
||||
"shape":"BatchRemoveFacetFromObjectResponse",
|
||||
"documentation":"<p>Result of a batch remove facet from object operation.</p>"
|
||||
"documentation":"<p>The result of a batch remove facet from object operation.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a BatchWrite response operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>BatchWrite</code> response operation.</p>"
|
||||
},
|
||||
"BatchWriteOperationResponseList":{
|
||||
"type":"list",
|
||||
|
|
@ -1780,13 +2104,13 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"Operations":{
|
||||
"shape":"BatchWriteOperationList",
|
||||
"documentation":"<p>List of operations that are part of the batch.</p>"
|
||||
"documentation":"<p>A list of operations that are part of the batch.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1795,7 +2119,7 @@
|
|||
"members":{
|
||||
"Responses":{
|
||||
"shape":"BatchWriteOperationResponseList",
|
||||
"documentation":"<p>List of all the responses for each batch write.</p>"
|
||||
"documentation":"<p>A list of all the responses for each batch write.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1827,11 +2151,11 @@
|
|||
"members":{
|
||||
"Name":{
|
||||
"shape":"DirectoryName",
|
||||
"documentation":"<p>Name of the <a>Directory</a>. Should be unique per account, per region.</p>"
|
||||
"documentation":"<p>The name of the <a>Directory</a>. Should be unique per account, per region.</p>"
|
||||
},
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN of the published schema that will be copied into the data <a>Directory</a>. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the published schema that will be copied into the data <a>Directory</a>. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
}
|
||||
|
|
@ -1848,11 +2172,11 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"DirectoryArn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>"
|
||||
"documentation":"<p>The ARN that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"DirectoryName",
|
||||
"documentation":"<p>Name of the <a>Directory</a>.</p>"
|
||||
"documentation":"<p>The name of the <a>Directory</a>.</p>"
|
||||
},
|
||||
"ObjectIdentifier":{
|
||||
"shape":"ObjectIdentifier",
|
||||
|
|
@ -1860,7 +2184,7 @@
|
|||
},
|
||||
"AppliedSchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN of the published schema in the <a>Directory</a>. Once a published schema is copied into the directory, it has its own ARN which is referred to applied schema ARN. For more information, see <a>arns</a>.</p>"
|
||||
"documentation":"<p>The ARN of the published schema in the <a>Directory</a>. Once a published schema is copied into the directory, it has its own ARN, which is referred to applied schema ARN. For more information, see <a>arns</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1874,21 +2198,21 @@
|
|||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>Schema ARN in which the new <a>Facet</a> will be created. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The schema ARN in which the new <a>Facet</a> will be created. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"FacetName",
|
||||
"documentation":"<p>Name of the <a>Facet</a>, which is unique for a given schema.</p>"
|
||||
"documentation":"<p>The name of the <a>Facet</a>, which is unique for a given schema.</p>"
|
||||
},
|
||||
"Attributes":{
|
||||
"shape":"FacetAttributeList",
|
||||
"documentation":"<p>Attributes associated with the <a>Facet</a>.e</p>"
|
||||
"documentation":"<p>The attributes that are associated with the <a>Facet</a>.</p>"
|
||||
},
|
||||
"ObjectType":{
|
||||
"shape":"ObjectType",
|
||||
"documentation":"<p>Specifies whether a given object created from this facet is of type Node, Leaf Node, Policy or Index.</p> <ul> <li> <p>Node: Can have multiple children but one parent.</p> </li> </ul> <ul> <li> <p>Leaf Node: Cannot have children but can have multiple parents.</p> </li> </ul> <ul> <li> <p>Policy: Allows you to store a policy document and policy type. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p> </li> </ul> <ul> <li> <p>Index: Can be created with the Index API.</p> </li> </ul>"
|
||||
"documentation":"<p>Specifies whether a given object created from this facet is of type node, leaf node, policy or index.</p> <ul> <li> <p>Node: Can have multiple children but one parent.</p> </li> </ul> <ul> <li> <p>Leaf node: Cannot have children but can have multiple parents.</p> </li> </ul> <ul> <li> <p>Policy: Allows you to store a policy document and policy type. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p> </li> </ul> <ul> <li> <p>Index: Can be created with the Index API.</p> </li> </ul>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1913,11 +2237,11 @@
|
|||
},
|
||||
"OrderedIndexedAttributeList":{
|
||||
"shape":"AttributeKeyList",
|
||||
"documentation":"<p>Specifies the Attributes that should be indexed on. Currently only a single attribute is supported.</p>"
|
||||
"documentation":"<p>Specifies the attributes that should be indexed on. Currently only a single attribute is supported.</p>"
|
||||
},
|
||||
"IsUnique":{
|
||||
"shape":"Bool",
|
||||
"documentation":"<p>Indicates whether objects with the same indexed attribute value can be added to the index.</p>"
|
||||
"documentation":"<p>Indicates whether the attribute that is being indexed has unique values or not.</p>"
|
||||
},
|
||||
"ParentReference":{
|
||||
"shape":"ObjectReference",
|
||||
|
|
@ -1934,7 +2258,7 @@
|
|||
"members":{
|
||||
"ObjectIdentifier":{
|
||||
"shape":"ObjectIdentifier",
|
||||
"documentation":"<p>The ObjectIdentifier of the index created by this operation.</p>"
|
||||
"documentation":"<p>The <code>ObjectIdentifier</code> of the index created by this operation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1947,17 +2271,17 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a> in which the object will be created. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> in which the object will be created. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"SchemaFacets":{
|
||||
"shape":"SchemaFacetList",
|
||||
"documentation":"<p>List of facet ARNs to be associated with the object. For more information, see <a>arns</a>.</p>"
|
||||
"documentation":"<p>A list of schema facets to be associated with the object that contains <code>SchemaArn</code> and facet name. For more information, see <a>arns</a>.</p>"
|
||||
},
|
||||
"ObjectAttributeList":{
|
||||
"shape":"AttributeKeyAndValueList",
|
||||
"documentation":"<p>Attribute map whose attribute ARN contains the key and attribute value as the map value.</p>"
|
||||
"documentation":"<p>The attribute map whose attribute ARN contains the key and attribute value as the map value.</p>"
|
||||
},
|
||||
"ParentReference":{
|
||||
"shape":"ObjectReference",
|
||||
|
|
@ -1974,7 +2298,7 @@
|
|||
"members":{
|
||||
"ObjectIdentifier":{
|
||||
"shape":"ObjectIdentifier",
|
||||
"documentation":"<p>Identifier associated with the object.</p>"
|
||||
"documentation":"<p>The identifier that is associated with the object.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1984,7 +2308,7 @@
|
|||
"members":{
|
||||
"Name":{
|
||||
"shape":"SchemaName",
|
||||
"documentation":"<p>Name associated with the schema. This is unique to each account and in each region.</p>"
|
||||
"documentation":"<p>The name that is associated with the schema. This is unique to each account and in each region.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1993,10 +2317,34 @@
|
|||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the schema. For more information, see <a>arns</a>.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateTypedLinkFacetRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SchemaArn",
|
||||
"Facet"
|
||||
],
|
||||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"Facet":{
|
||||
"shape":"TypedLinkFacet",
|
||||
"documentation":"<p> <a>Facet</a> structure that is associated with the typed link facet.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateTypedLinkFacetResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"Date":{"type":"timestamp"},
|
||||
"DatetimeAttributeValue":{"type":"timestamp"},
|
||||
"DeleteDirectoryRequest":{
|
||||
|
|
@ -2030,7 +2378,7 @@
|
|||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
|
|
@ -2054,13 +2402,13 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"ObjectReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Reference that identifies the object.</p>"
|
||||
"documentation":"<p>A reference that identifies the object.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2075,7 +2423,7 @@
|
|||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN of the development schema. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the development schema. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
}
|
||||
|
|
@ -2086,10 +2434,34 @@
|
|||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>Input ARN that is returned as part of the response. For more information, see <a>arns</a>.</p>"
|
||||
"documentation":"<p>The input ARN that is returned as part of the response. For more information, see <a>arns</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteTypedLinkFacetRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SchemaArn",
|
||||
"Name"
|
||||
],
|
||||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"TypedLinkName",
|
||||
"documentation":"<p>The unique name of the typed link facet.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteTypedLinkFacetResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DetachFromIndexRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -2100,7 +2472,7 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The ARN of the directory the index and object exist in.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the directory the index and object exist in.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
|
|
@ -2119,7 +2491,7 @@
|
|||
"members":{
|
||||
"DetachedObjectIdentifier":{
|
||||
"shape":"ObjectIdentifier",
|
||||
"documentation":"<p>The ObjectIdentifier of the object that was detached from the index.</p>"
|
||||
"documentation":"<p>The <code>ObjectIdentifier</code> of the object that was detached from the index.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2133,17 +2505,17 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"ParentReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Parent reference from which the object with the specified link name is detached.</p>"
|
||||
"documentation":"<p>The parent reference from which the object with the specified link name is detached.</p>"
|
||||
},
|
||||
"LinkName":{
|
||||
"shape":"LinkName",
|
||||
"documentation":"<p>Link name associated with the object that needs to be detached.</p>"
|
||||
"documentation":"<p>The link name associated with the object that needs to be detached.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2152,7 +2524,7 @@
|
|||
"members":{
|
||||
"DetachedObjectIdentifier":{
|
||||
"shape":"ObjectIdentifier",
|
||||
"documentation":"<p>The ObjectIdentifier that was detached from the object.</p>"
|
||||
"documentation":"<p>The <code>ObjectIdentifier</code> that was detached from the object.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2166,7 +2538,7 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where both objects reside. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
|
|
@ -2185,6 +2557,25 @@
|
|||
"members":{
|
||||
}
|
||||
},
|
||||
"DetachTypedLinkRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DirectoryArn",
|
||||
"TypedLinkSpecifier"
|
||||
],
|
||||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the directory where you want to detach the typed link.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"TypedLinkSpecifier":{
|
||||
"shape":"TypedLinkSpecifier",
|
||||
"documentation":"<p>Used to accept a typed link specifier as input.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Directory":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2194,11 +2585,11 @@
|
|||
},
|
||||
"DirectoryArn":{
|
||||
"shape":"DirectoryArn",
|
||||
"documentation":"<p>ARN associated with the directory. For more information, see <a>arns</a>.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the directory. For more information, see <a>arns</a>.</p>"
|
||||
},
|
||||
"State":{
|
||||
"shape":"DirectoryState",
|
||||
"documentation":"<p>The state of the directory. Can be either Enabled, Disabled, or Deleted.</p>"
|
||||
"documentation":"<p>The state of the directory. Can be either <code>Enabled</code>, <code>Disabled</code>, or <code>Deleted</code>.</p>"
|
||||
},
|
||||
"CreationDateTime":{
|
||||
"shape":"Date",
|
||||
|
|
@ -2222,7 +2613,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>A directory that has been deleted has been attempted to be accessed. Note: The requested resource will eventually cease to exist.</p>",
|
||||
"documentation":"<p>A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -2316,10 +2707,10 @@
|
|||
},
|
||||
"ObjectType":{
|
||||
"shape":"ObjectType",
|
||||
"documentation":"<p>Object type associated with the facet. See <a>CreateFacetRequest$ObjectType</a> for more details.</p>"
|
||||
"documentation":"<p>The object type that is associated with the facet. See <a>CreateFacetRequest$ObjectType</a> for more details.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure that contains Name, ARN, Attributes, <a>Rule</a>s, and ObjectTypes.</p>"
|
||||
"documentation":"<p>A structure that contains <code>Name</code>, <code>ARN</code>, <code>Attributes</code>, <a>Rule</a>s, and <code>ObjectTypes</code>.</p>"
|
||||
},
|
||||
"FacetAlreadyExistsException":{
|
||||
"type":"structure",
|
||||
|
|
@ -2344,14 +2735,14 @@
|
|||
},
|
||||
"AttributeReference":{
|
||||
"shape":"FacetAttributeReference",
|
||||
"documentation":"<p>Attribute reference associated with the attribute. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
|
||||
"documentation":"<p>An attribute reference that is associated with the attribute. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
|
||||
},
|
||||
"RequiredBehavior":{
|
||||
"shape":"RequiredAttributeBehavior",
|
||||
"documentation":"<p>The required behavior of the FacetAttribute.</p>"
|
||||
"documentation":"<p>The required behavior of the <code>FacetAttribute</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Attribute associated with the <a>Facet</a>.</p>"
|
||||
"documentation":"<p>An attribute that is associated with the <a>Facet</a>.</p>"
|
||||
},
|
||||
"FacetAttributeDefinition":{
|
||||
"type":"structure",
|
||||
|
|
@ -2389,14 +2780,14 @@
|
|||
"members":{
|
||||
"TargetFacetName":{
|
||||
"shape":"FacetName",
|
||||
"documentation":"<p>Target facet name associated with the facet reference. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
|
||||
"documentation":"<p>The target facet name that is associated with the facet reference. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
|
||||
},
|
||||
"TargetAttributeName":{
|
||||
"shape":"AttributeName",
|
||||
"documentation":"<p>Target attribute name associated with the facet reference. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
|
||||
"documentation":"<p>The target attribute name that is associated with the facet reference. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences\">Attribute References</a> for more information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Facet attribute reference that specifies the attribute definition which contains attribute facet name and attribute name.</p>"
|
||||
"documentation":"<p>The facet attribute reference that specifies the attribute definition that contains the attribute facet name and attribute name.</p>"
|
||||
},
|
||||
"FacetAttributeType":{
|
||||
"type":"string",
|
||||
|
|
@ -2431,7 +2822,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>Occurs when deleting a facet that contains an attribute which is a target to an attribute reference in a different facet.</p>",
|
||||
"documentation":"<p>Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -2459,7 +2850,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>The <a>Facet</a> you provided was not well formed or could not be validated with the schema.</p>",
|
||||
"documentation":"<p>The <a>Facet</a> that you provided was not well formed or could not be validated with the schema.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -2494,7 +2885,7 @@
|
|||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
|
|
@ -2509,7 +2900,7 @@
|
|||
"members":{
|
||||
"Facet":{
|
||||
"shape":"Facet",
|
||||
"documentation":"<p> <a>Facet</a> structure associated with the facet.</p>"
|
||||
"documentation":"<p>The <a>Facet</a> structure that is associated with the facet.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2547,7 +2938,7 @@
|
|||
},
|
||||
"ObjectIdentifier":{
|
||||
"shape":"ObjectIdentifier",
|
||||
"documentation":"<p>The ObjectIdentifier of the specified object.</p>"
|
||||
"documentation":"<p>The <code>ObjectIdentifier</code> of the specified object.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2576,6 +2967,34 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"GetTypedLinkFacetInformationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SchemaArn",
|
||||
"Name"
|
||||
],
|
||||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"TypedLinkName",
|
||||
"documentation":"<p>The unique name of the typed link facet.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetTypedLinkFacetInformationResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"IdentityAttributeOrder":{
|
||||
"shape":"AttributeNameList",
|
||||
"documentation":"<p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"IndexAttachment":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2585,7 +3004,7 @@
|
|||
},
|
||||
"ObjectIdentifier":{
|
||||
"shape":"ObjectIdentifier",
|
||||
"documentation":"<p>The ObjectIdentifier of the object attached to the index.</p>"
|
||||
"documentation":"<p>The <code>ObjectIdentifier</code> of the object attached to the index.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents an index and an attached object.</p>"
|
||||
|
|
@ -2626,7 +3045,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>Indicates that an attempt to attach an object with the same link name or to apply a schema with same name has occurred. Rename the link or the schema and then try again.</p>",
|
||||
"documentation":"<p>Indicates that an attempt to attach an object with the same link name or to apply a schema with the same name has occurred. Rename the link or the schema and then try again.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -2644,7 +3063,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>Indicates that the NextToken value is not valid.</p>",
|
||||
"documentation":"<p>Indicates that the <code>NextToken</code> value is not valid.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -2662,7 +3081,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>Indicates that the provided SchemaDoc value is not valid.</p>",
|
||||
"documentation":"<p>Indicates that the provided <code>SchemaDoc</code> value is not valid.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -2680,13 +3099,15 @@
|
|||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>Indicates limits are exceeded. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html\">Limits</a> for more information.</p>",
|
||||
"documentation":"<p>Indicates that limits are exceeded. See <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html\">Limits</a> for more information.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"LinkName":{
|
||||
"type":"string",
|
||||
"max":64
|
||||
"max":64,
|
||||
"min":1,
|
||||
"pattern":"[^\\/\\[\\]\\(\\):\\{\\}#@!?\\s\\\\;]+"
|
||||
},
|
||||
"LinkNameAlreadyInUseException":{
|
||||
"type":"structure",
|
||||
|
|
@ -2828,7 +3249,7 @@
|
|||
"members":{
|
||||
"Directories":{
|
||||
"shape":"DirectoryList",
|
||||
"documentation":"<p>Lists all directories associated with your account in pagination fashion.</p>"
|
||||
"documentation":"<p>Lists all directories that are associated with your account in pagination fashion.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
|
|
@ -2882,7 +3303,7 @@
|
|||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The ARN to retrieve facet names from.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) to retrieve facet names from.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
|
|
@ -2892,7 +3313,7 @@
|
|||
},
|
||||
"MaxResults":{
|
||||
"shape":"NumberResults",
|
||||
"documentation":"<p>The maximum number of results to retrieve</p>"
|
||||
"documentation":"<p>The maximum number of results to retrieve.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2909,6 +3330,58 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"ListIncomingTypedLinksRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DirectoryArn",
|
||||
"ObjectReference"
|
||||
],
|
||||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the directory where you want to list the typed links.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"ObjectReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Reference that identifies the object whose attributes will be listed.</p>"
|
||||
},
|
||||
"FilterAttributeRanges":{
|
||||
"shape":"TypedLinkAttributeRangeList",
|
||||
"documentation":"<p>Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.</p>"
|
||||
},
|
||||
"FilterTypedLink":{
|
||||
"shape":"TypedLinkSchemaAndFacetName",
|
||||
"documentation":"<p>Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"NumberResults",
|
||||
"documentation":"<p>The maximum number of results to retrieve.</p>"
|
||||
},
|
||||
"ConsistencyLevel":{
|
||||
"shape":"ConsistencyLevel",
|
||||
"documentation":"<p>The consistency level to execute the request at.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListIncomingTypedLinksResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"LinkSpecifiers":{
|
||||
"shape":"TypedLinkSpecifierList",
|
||||
"documentation":"<p>Returns one or more typed link specifiers as output.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListIndexRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -2968,27 +3441,31 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"ObjectReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Reference that identifies the object whose attributes will be listed.</p>"
|
||||
"documentation":"<p>The reference that identifies the object whose attributes will be listed.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Token used for pagination.</p>"
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"NumberResults",
|
||||
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
},
|
||||
"ConsistencyLevel":{
|
||||
"shape":"ConsistencyLevel",
|
||||
"documentation":"<p>Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-consistency-level"
|
||||
},
|
||||
"FacetFilter":{
|
||||
"shape":"SchemaFacet",
|
||||
"documentation":"<p>Used to filter the list of object attributes that are associated with a certain facet.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -2997,11 +3474,11 @@
|
|||
"members":{
|
||||
"Attributes":{
|
||||
"shape":"AttributeKeyAndValueList",
|
||||
"documentation":"<p>Attributes map associated with the object. AttributeArn is the key, and attribute value is the value.</p>"
|
||||
"documentation":"<p>Attributes map that is associated with the object. <code>AttributeArn</code> is the key, and attribute value is the value.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Token used for pagination.</p>"
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3014,21 +3491,21 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"ObjectReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Reference that identifies the object for which child objects are being listed.</p>"
|
||||
"documentation":"<p>The reference that identifies the object for which child objects are being listed.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Token used for pagination.</p>"
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"NumberResults",
|
||||
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
},
|
||||
"ConsistencyLevel":{
|
||||
"shape":"ConsistencyLevel",
|
||||
|
|
@ -3043,11 +3520,51 @@
|
|||
"members":{
|
||||
"Children":{
|
||||
"shape":"LinkNameToObjectIdentifierMap",
|
||||
"documentation":"<p>Children structure, which is a map with key as the LinkName and ObjectIdentifier as the value.</p>"
|
||||
"documentation":"<p>Children structure, which is a map with key as the <code>LinkName</code> and <code>ObjectIdentifier</code> as the value.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Token used for pagination.</p>"
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListObjectParentPathsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DirectoryArn",
|
||||
"ObjectReference"
|
||||
],
|
||||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The ARN of the directory to which the parent path applies.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"ObjectReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>The reference that identifies the object whose parent paths are listed.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"NumberResults",
|
||||
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListObjectParentPathsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"PathToObjectIdentifiersList":{
|
||||
"shape":"PathToObjectIdentifiersList",
|
||||
"documentation":"<p>Returns the path to the <code>ObjectIdentifiers</code> that are associated with the directory.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3060,21 +3577,21 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"ObjectReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Reference that identifies the object for which parent objects are being listed.</p>"
|
||||
"documentation":"<p>The reference that identifies the object for which parent objects are being listed.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Token used for pagination.</p>"
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"NumberResults",
|
||||
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
},
|
||||
"ConsistencyLevel":{
|
||||
"shape":"ConsistencyLevel",
|
||||
|
|
@ -3089,11 +3606,11 @@
|
|||
"members":{
|
||||
"Parents":{
|
||||
"shape":"ObjectIdentifierToLinkNameMap",
|
||||
"documentation":"<p>Parent structure, which is a map with key as the ObjectIdentifier and LinkName as the value.</p>"
|
||||
"documentation":"<p>The parent structure, which is a map with key as the <code>ObjectIdentifier</code> and LinkName as the value.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Token used for pagination.</p>"
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3106,7 +3623,7 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
|
|
@ -3116,11 +3633,11 @@
|
|||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Token used for pagination.</p>"
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"NumberResults",
|
||||
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
},
|
||||
"ConsistencyLevel":{
|
||||
"shape":"ConsistencyLevel",
|
||||
|
|
@ -3135,11 +3652,63 @@
|
|||
"members":{
|
||||
"AttachedPolicyIds":{
|
||||
"shape":"ObjectIdentifierList",
|
||||
"documentation":"<p>List of policy ObjectIdentifiers, that are attached to the object.</p>"
|
||||
"documentation":"<p>A list of policy <code>ObjectIdentifiers</code>, that are attached to the object.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Token used for pagination.</p>"
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListOutgoingTypedLinksRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DirectoryArn",
|
||||
"ObjectReference"
|
||||
],
|
||||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the directory where you want to list the typed links.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"ObjectReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>A reference that identifies the object whose attributes will be listed.</p>"
|
||||
},
|
||||
"FilterAttributeRanges":{
|
||||
"shape":"TypedLinkAttributeRangeList",
|
||||
"documentation":"<p>Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.</p>"
|
||||
},
|
||||
"FilterTypedLink":{
|
||||
"shape":"TypedLinkSchemaAndFacetName",
|
||||
"documentation":"<p>Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"NumberResults",
|
||||
"documentation":"<p>The maximum number of results to retrieve.</p>"
|
||||
},
|
||||
"ConsistencyLevel":{
|
||||
"shape":"ConsistencyLevel",
|
||||
"documentation":"<p>The consistency level to execute the request at.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListOutgoingTypedLinksResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TypedLinkSpecifiers":{
|
||||
"shape":"TypedLinkSpecifierList",
|
||||
"documentation":"<p>Returns a typed link specifier as output.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3152,21 +3721,21 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where objects reside. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"PolicyReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Reference that identifies the policy object.</p>"
|
||||
"documentation":"<p>The reference that identifies the policy object.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Token used for pagination.</p>"
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"NumberResults",
|
||||
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
},
|
||||
"ConsistencyLevel":{
|
||||
"shape":"ConsistencyLevel",
|
||||
|
|
@ -3181,11 +3750,11 @@
|
|||
"members":{
|
||||
"ObjectIdentifiers":{
|
||||
"shape":"ObjectIdentifierList",
|
||||
"documentation":"<p>List of ObjectIdentifiers to which the policy is attached.</p>"
|
||||
"documentation":"<p>A list of <code>ObjectIdentifiers</code> to which the policy is attached.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Token used for pagination.</p>"
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3221,15 +3790,15 @@
|
|||
"members":{
|
||||
"ResourceArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN of the resource. Tagging is only supported for directories.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Next token used for pagination. This is for future use. Currently pagination is not supported for tagging.</p>"
|
||||
"documentation":"<p>The pagination token. This is for future use. Currently pagination is not supported for tagging.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"TagsNumberResults",
|
||||
"documentation":"<p>The MaxResults parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.</p>"
|
||||
"documentation":"<p>The <code>MaxResults</code> parameter sets the maximum number of results returned in a single page. This is for future use and is not supported currently.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3238,7 +3807,7 @@
|
|||
"members":{
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>List of tag key value pairs associated with the response.</p>"
|
||||
"documentation":"<p>A list of tag key value pairs that are associated with the response.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
|
|
@ -3246,6 +3815,79 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"ListTypedLinkFacetAttributesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SchemaArn",
|
||||
"Name"
|
||||
],
|
||||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"TypedLinkName",
|
||||
"documentation":"<p>The unique name of the typed link facet.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"NumberResults",
|
||||
"documentation":"<p>The maximum number of results to retrieve.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListTypedLinkFacetAttributesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Attributes":{
|
||||
"shape":"TypedLinkAttributeDefinitionList",
|
||||
"documentation":"<p>An ordered set of attributes associate with the typed link.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListTypedLinkFacetNamesRequest":{
|
||||
"type":"structure",
|
||||
"required":["SchemaArn"],
|
||||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"NumberResults",
|
||||
"documentation":"<p>The maximum number of results to retrieve.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListTypedLinkFacetNamesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"FacetNames":{
|
||||
"shape":"TypedLinkNameList",
|
||||
"documentation":"<p>The names of typed link facets that exist within the schema.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"LookupPolicyRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -3255,7 +3897,7 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a>. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
|
|
@ -3269,7 +3911,7 @@
|
|||
},
|
||||
"MaxResults":{
|
||||
"shape":"NumberResults",
|
||||
"documentation":"<p>Maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
"documentation":"<p>The maximum number of items to be retrieved in a single call. This is an approximate number.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3278,11 +3920,11 @@
|
|||
"members":{
|
||||
"PolicyToPathList":{
|
||||
"shape":"PolicyToPathList",
|
||||
"documentation":"<p>Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, and PolicyType.</p>"
|
||||
"documentation":"<p>Provides list of path to policies. Policies contain <code>PolicyId</code>, <code>ObjectIdentifier</code>, and <code>PolicyType</code>. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>Token used for pagination.</p>"
|
||||
"documentation":"<p>The pagination token.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3292,7 +3934,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>Indicates the requested operation can only operate on index objects.</p>",
|
||||
"documentation":"<p>Indicates that the requested operation can only operate on index objects.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -3301,7 +3943,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>Occurs when any invalid operations are performed on an object which is not a node, such as calling ListObjectChildren for a leaf node object.</p>",
|
||||
"documentation":"<p>Occurs when any invalid operations are performed on an object that is not a node, such as calling <code>ListObjectChildren</code> for a leaf node object.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -3310,21 +3952,21 @@
|
|||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>Indicates the requested operation can only operate on policy objects.</p>",
|
||||
"documentation":"<p>Indicates that the requested operation can only operate on policy objects.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"NumberAttributeValue":{"type":"string"},
|
||||
"NumberResults":{
|
||||
"type":"integer",
|
||||
"min":0
|
||||
"min":1
|
||||
},
|
||||
"ObjectAlreadyDetachedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>Indicates the object is not attached to the index.</p>",
|
||||
"documentation":"<p>Indicates that the object is not attached to the index.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -3333,7 +3975,7 @@
|
|||
"members":{
|
||||
"ObjectAttributeActionType":{
|
||||
"shape":"UpdateActionType",
|
||||
"documentation":"<p>Type can be either Update or Delete.</p>"
|
||||
"documentation":"<p>A type that can be either <code>Update</code> or <code>Delete</code>.</p>"
|
||||
},
|
||||
"ObjectAttributeUpdateValue":{
|
||||
"shape":"TypedAttributeValue",
|
||||
|
|
@ -3347,7 +3989,7 @@
|
|||
"members":{
|
||||
"AttributeKey":{
|
||||
"shape":"AttributeKey",
|
||||
"documentation":"<p>The key of the attribute the attribute range covers.</p>"
|
||||
"documentation":"<p>The key of the attribute that the attribute range covers.</p>"
|
||||
},
|
||||
"Range":{
|
||||
"shape":"TypedAttributeValueRange",
|
||||
|
|
@ -3393,7 +4035,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>Indicates the requested operation cannot be completed because the object has not been detached from the tree.</p>",
|
||||
"documentation":"<p>Indicates that the requested operation cannot be completed because the object has not been detached from the tree.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -3402,10 +4044,10 @@
|
|||
"members":{
|
||||
"Selector":{
|
||||
"shape":"SelectorObjectReference",
|
||||
"documentation":"<p>Allows you to specify an object. You can identify an object in one of the following ways:</p> <ul> <li> <p> <i>$ObjectIdentifier</i> - Identifies the object by ObjectIdentifier</p> </li> <li> <p> <i>/some/path</i> - Identifies the object based on path</p> </li> <li> <p> <i>#SomeBatchReference</i> - Identifies the object in a batch call</p> </li> </ul>"
|
||||
"documentation":"<p>A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#accessingobjects\">Accessing Objects</a>. You can identify an object in one of the following ways:</p> <ul> <li> <p> <i>$ObjectIdentifier</i> - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier</p> </li> <li> <p> <i>/some/path</i> - Identifies the object based on path</p> </li> <li> <p> <i>#SomeBatchReference</i> - Identifies the object in a batch call</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Reference that identifies an object.</p>"
|
||||
"documentation":"<p>The reference that identifies an object.</p>"
|
||||
},
|
||||
"ObjectType":{
|
||||
"type":"string",
|
||||
|
|
@ -3417,23 +4059,41 @@
|
|||
]
|
||||
},
|
||||
"PathString":{"type":"string"},
|
||||
"PathToObjectIdentifiers":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Path":{
|
||||
"shape":"PathString",
|
||||
"documentation":"<p>The path that is used to identify the object starting from directory root.</p>"
|
||||
},
|
||||
"ObjectIdentifiers":{
|
||||
"shape":"ObjectIdentifierList",
|
||||
"documentation":"<p>Lists <code>ObjectIdentifiers</code> starting from directory root to the object in the request.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Returns the path to the <code>ObjectIdentifiers</code> that is associated with the directory.</p>"
|
||||
},
|
||||
"PathToObjectIdentifiersList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"PathToObjectIdentifiers"}
|
||||
},
|
||||
"PolicyAttachment":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"PolicyId":{
|
||||
"shape":"ObjectIdentifier",
|
||||
"documentation":"<p>The ID of PolicyAttachment.</p>"
|
||||
"documentation":"<p>The ID of <code>PolicyAttachment</code>.</p>"
|
||||
},
|
||||
"ObjectIdentifier":{
|
||||
"shape":"ObjectIdentifier",
|
||||
"documentation":"<p>The ObjectIdentifier associated with PolicyAttachment.</p>"
|
||||
"documentation":"<p>The <code>ObjectIdentifier</code> that is associated with <code>PolicyAttachment</code>.</p>"
|
||||
},
|
||||
"PolicyType":{
|
||||
"shape":"PolicyType",
|
||||
"documentation":"<p>The type of policy that can be associated with PolicyAttachment.</p>"
|
||||
"documentation":"<p>The type of policy that can be associated with <code>PolicyAttachment</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains the PolicyType, PolicyId, and the ObjectIdentifier to which it is attached.</p>"
|
||||
"documentation":"<p>Contains the <code>PolicyType</code>, <code>PolicyId</code>, and the <code>ObjectIdentifier</code> to which it is attached. For more information, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies\">Policies</a>.</p>"
|
||||
},
|
||||
"PolicyAttachmentList":{
|
||||
"type":"list",
|
||||
|
|
@ -3451,7 +4111,7 @@
|
|||
"documentation":"<p>List of policy objects.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Used when a regular object exists in a <a>Directory</a> and you want to find all of the policies associated with that object and the parent to that object.</p>"
|
||||
"documentation":"<p>Used when a regular object exists in a <a>Directory</a> and you want to find all of the policies that are associated with that object and the parent to that object.</p>"
|
||||
},
|
||||
"PolicyToPathList":{
|
||||
"type":"list",
|
||||
|
|
@ -3467,17 +4127,17 @@
|
|||
"members":{
|
||||
"DevelopmentSchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the development schema. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"Version":{
|
||||
"shape":"Version",
|
||||
"documentation":"<p>Version under which the schema will be published.</p>"
|
||||
"documentation":"<p>The version under which the schema will be published.</p>"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"SchemaName",
|
||||
"documentation":"<p>New name under which the schema will be published. If this is not provided, the development schema is considered.</p>"
|
||||
"documentation":"<p>The new name under which the schema will be published. If this is not provided, the development schema is considered.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3486,7 +4146,7 @@
|
|||
"members":{
|
||||
"PublishedSchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the published schema. For more information, see <a>arns</a>.</p>"
|
||||
"documentation":"<p>The ARN that is associated with the published schema. For more information, see <a>arns</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3591,10 +4251,10 @@
|
|||
},
|
||||
"Parameters":{
|
||||
"shape":"RuleParameterMap",
|
||||
"documentation":"<p>Min and max parameters associated with the rule.</p>"
|
||||
"documentation":"<p>The minimum and maximum parameters that are associated with the rule.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains an ARN and parameters associated with the rule.</p>"
|
||||
"documentation":"<p>Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.</p>"
|
||||
},
|
||||
"RuleKey":{
|
||||
"type":"string",
|
||||
|
|
@ -3637,7 +4297,7 @@
|
|||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>Indicates a schema is already published.</p>",
|
||||
"documentation":"<p>Indicates that a schema is already published.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -3662,7 +4322,7 @@
|
|||
"SchemaJsonDocument":{"type":"string"},
|
||||
"SchemaName":{
|
||||
"type":"string",
|
||||
"max":50,
|
||||
"max":32,
|
||||
"min":1,
|
||||
"pattern":"^[a-zA-Z0-9._-]*$"
|
||||
},
|
||||
|
|
@ -3682,14 +4342,14 @@
|
|||
"members":{
|
||||
"Key":{
|
||||
"shape":"TagKey",
|
||||
"documentation":"<p>Key associated with the tag.</p>"
|
||||
"documentation":"<p>The key that is associated with the tag.</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"TagValue",
|
||||
"documentation":"<p>Value associated with the tag.</p>"
|
||||
"documentation":"<p>The value that is associated with the tag.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Tag structure which contains tag key and value.</p>"
|
||||
"documentation":"<p>The tag structure that contains a tag key and value.</p>"
|
||||
},
|
||||
"TagKey":{"type":"string"},
|
||||
"TagKeyList":{
|
||||
|
|
@ -3709,11 +4369,11 @@
|
|||
"members":{
|
||||
"ResourceArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN of the resource. Tagging is only supported for directories.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>List of tag key value pairs.</p>"
|
||||
"documentation":"<p>A list of tag key-value pairs.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3762,7 +4422,7 @@
|
|||
"members":{
|
||||
"StartMode":{
|
||||
"shape":"RangeMode",
|
||||
"documentation":"<p>Inclusive or exclusive range start.</p>"
|
||||
"documentation":"<p>The inclusive or exclusive range start.</p>"
|
||||
},
|
||||
"StartValue":{
|
||||
"shape":"TypedAttributeValue",
|
||||
|
|
@ -3770,7 +4430,7 @@
|
|||
},
|
||||
"EndMode":{
|
||||
"shape":"RangeMode",
|
||||
"documentation":"<p>Inclusive or exclusive range end.</p>"
|
||||
"documentation":"<p>The inclusive or exclusive range end.</p>"
|
||||
},
|
||||
"EndValue":{
|
||||
"shape":"TypedAttributeValue",
|
||||
|
|
@ -3779,12 +4439,173 @@
|
|||
},
|
||||
"documentation":"<p>A range of attribute values.</p>"
|
||||
},
|
||||
"TypedLinkAttributeDefinition":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Name",
|
||||
"Type",
|
||||
"RequiredBehavior"
|
||||
],
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"AttributeName",
|
||||
"documentation":"<p>The unique name of the typed link attribute.</p>"
|
||||
},
|
||||
"Type":{
|
||||
"shape":"FacetAttributeType",
|
||||
"documentation":"<p>The type of the attribute.</p>"
|
||||
},
|
||||
"DefaultValue":{
|
||||
"shape":"TypedAttributeValue",
|
||||
"documentation":"<p>The default value of the attribute (if configured).</p>"
|
||||
},
|
||||
"IsImmutable":{
|
||||
"shape":"Bool",
|
||||
"documentation":"<p>Whether the attribute is mutable or not.</p>"
|
||||
},
|
||||
"Rules":{
|
||||
"shape":"RuleMap",
|
||||
"documentation":"<p>Validation rules that are attached to the attribute definition.</p>"
|
||||
},
|
||||
"RequiredBehavior":{
|
||||
"shape":"RequiredAttributeBehavior",
|
||||
"documentation":"<p>The required behavior of the <code>TypedLinkAttributeDefinition</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A typed link attribute definition.</p>"
|
||||
},
|
||||
"TypedLinkAttributeDefinitionList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TypedLinkAttributeDefinition"}
|
||||
},
|
||||
"TypedLinkAttributeRange":{
|
||||
"type":"structure",
|
||||
"required":["Range"],
|
||||
"members":{
|
||||
"AttributeName":{
|
||||
"shape":"AttributeName",
|
||||
"documentation":"<p>The unique name of the typed link attribute.</p>"
|
||||
},
|
||||
"Range":{
|
||||
"shape":"TypedAttributeValueRange",
|
||||
"documentation":"<p>The range of attribute values that are being selected.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Identifies the range of attributes that are used by a specified filter.</p>"
|
||||
},
|
||||
"TypedLinkAttributeRangeList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TypedLinkAttributeRange"}
|
||||
},
|
||||
"TypedLinkFacet":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Name",
|
||||
"Attributes",
|
||||
"IdentityAttributeOrder"
|
||||
],
|
||||
"members":{
|
||||
"Name":{
|
||||
"shape":"TypedLinkName",
|
||||
"documentation":"<p>The unique name of the typed link facet.</p>"
|
||||
},
|
||||
"Attributes":{
|
||||
"shape":"TypedLinkAttributeDefinitionList",
|
||||
"documentation":"<p>A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.</p>"
|
||||
},
|
||||
"IdentityAttributeOrder":{
|
||||
"shape":"AttributeNameList",
|
||||
"documentation":"<p>The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See <a>ListOutgoingTypedLinks</a> and <a>ListIncomingTypeLinks</a> for details.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Defines the typed links structure and its attributes. To create a typed link facet, use the <a>CreateTypedLinkFacet</a> API.</p>"
|
||||
},
|
||||
"TypedLinkFacetAttributeUpdate":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Attribute",
|
||||
"Action"
|
||||
],
|
||||
"members":{
|
||||
"Attribute":{
|
||||
"shape":"TypedLinkAttributeDefinition",
|
||||
"documentation":"<p>The attribute to update.</p>"
|
||||
},
|
||||
"Action":{
|
||||
"shape":"UpdateActionType",
|
||||
"documentation":"<p>The action to perform when updating the attribute.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A typed link facet attribute update.</p>"
|
||||
},
|
||||
"TypedLinkFacetAttributeUpdateList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TypedLinkFacetAttributeUpdate"}
|
||||
},
|
||||
"TypedLinkName":{
|
||||
"type":"string",
|
||||
"pattern":"^[a-zA-Z0-9._-]*$"
|
||||
},
|
||||
"TypedLinkNameList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TypedLinkName"}
|
||||
},
|
||||
"TypedLinkSchemaAndFacetName":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SchemaArn",
|
||||
"TypedLinkName"
|
||||
],
|
||||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>"
|
||||
},
|
||||
"TypedLinkName":{
|
||||
"shape":"TypedLinkName",
|
||||
"documentation":"<p>The unique name of the typed link facet.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link.</p>"
|
||||
},
|
||||
"TypedLinkSpecifier":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TypedLinkFacet",
|
||||
"SourceObjectReference",
|
||||
"TargetObjectReference",
|
||||
"IdentityAttributeValues"
|
||||
],
|
||||
"members":{
|
||||
"TypedLinkFacet":{
|
||||
"shape":"TypedLinkSchemaAndFacetName",
|
||||
"documentation":"<p>Identifies the typed link facet that is associated with the typed link.</p>"
|
||||
},
|
||||
"SourceObjectReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Identifies the source object that the typed link will attach to.</p>"
|
||||
},
|
||||
"TargetObjectReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Identifies the target object that the typed link will attach to.</p>"
|
||||
},
|
||||
"IdentityAttributeValues":{
|
||||
"shape":"AttributeNameAndValueList",
|
||||
"documentation":"<p>Identifies the attribute value to update.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains all the information that is used to uniquely identify a typed link. The parameters discussed in this topic are used to uniquely specify the typed link being operated on. The <a>AttachTypedLink</a> API returns a typed link specifier while the <a>DetachTypedLink</a> API accepts one as input. Similarly, the <a>ListIncomingTypedLinks</a> and <a>ListOutgoingTypedLinks</a> API operations provide typed link specifiers as output. You can also construct a typed link specifier from scratch.</p>"
|
||||
},
|
||||
"TypedLinkSpecifierList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TypedLinkSpecifier"}
|
||||
},
|
||||
"UnsupportedIndexTypeException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>Indicates the requested index type is not supported.</p>",
|
||||
"documentation":"<p>Indicates that the requested index type is not supported.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -3797,11 +4618,11 @@
|
|||
"members":{
|
||||
"ResourceArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN of the resource. Tagging is only supported for directories.</p>"
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.</p>"
|
||||
},
|
||||
"TagKeys":{
|
||||
"shape":"TagKeyList",
|
||||
"documentation":"<p>Keys of the tag that needs to be removed from the resource.</p>"
|
||||
"documentation":"<p>Keys of the tag that need to be removed from the resource.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3826,21 +4647,21 @@
|
|||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Facet</a>. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"FacetName",
|
||||
"documentation":"<p> </p>"
|
||||
"documentation":"<p>The name of the facet.</p>"
|
||||
},
|
||||
"AttributeUpdates":{
|
||||
"shape":"FacetAttributeUpdateList",
|
||||
"documentation":"<p>List of attributes that need to be updated in a given schema <a>Facet</a>. Each attribute is followed by AttributeAction, which specifies the type of update operation to perform. </p>"
|
||||
"documentation":"<p>List of attributes that need to be updated in a given schema <a>Facet</a>. Each attribute is followed by <code>AttributeAction</code>, which specifies the type of update operation to perform. </p>"
|
||||
},
|
||||
"ObjectType":{
|
||||
"shape":"ObjectType",
|
||||
"documentation":"<p>Object type associated with the facet. See <a>CreateFacetRequest$ObjectType</a> for more details.</p>"
|
||||
"documentation":"<p>The object type that is associated with the facet. See <a>CreateFacetRequest$ObjectType</a> for more details.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3859,17 +4680,17 @@
|
|||
"members":{
|
||||
"DirectoryArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the <a>Directory</a> where the object resides. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"ObjectReference":{
|
||||
"shape":"ObjectReference",
|
||||
"documentation":"<p>Reference that identifies the object.</p>"
|
||||
"documentation":"<p>The reference that identifies the object.</p>"
|
||||
},
|
||||
"AttributeUpdates":{
|
||||
"shape":"ObjectAttributeUpdateList",
|
||||
"documentation":"<p>Attributes update structure.</p>"
|
||||
"documentation":"<p>The attributes update structure.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3878,7 +4699,7 @@
|
|||
"members":{
|
||||
"ObjectIdentifier":{
|
||||
"shape":"ObjectIdentifier",
|
||||
"documentation":"<p>ObjectIdentifier of the updated object.</p>"
|
||||
"documentation":"<p>The <code>ObjectIdentifier</code> of the updated object.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3891,13 +4712,13 @@
|
|||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN of the development schema. For more information, see <a>arns</a>.</p>",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the development schema. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"SchemaName",
|
||||
"documentation":"<p>Name of the schema.</p>"
|
||||
"documentation":"<p>The name of the schema.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -3906,16 +4727,50 @@
|
|||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>ARN associated with the updated schema. For more information, see <a>arns</a>.</p>"
|
||||
"documentation":"<p>The ARN that is associated with the updated schema. For more information, see <a>arns</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateTypedLinkFacetRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SchemaArn",
|
||||
"Name",
|
||||
"AttributeUpdates",
|
||||
"IdentityAttributeOrder"
|
||||
],
|
||||
"members":{
|
||||
"SchemaArn":{
|
||||
"shape":"Arn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that is associated with the schema. For more information, see <a>arns</a>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"x-amz-data-partition"
|
||||
},
|
||||
"Name":{
|
||||
"shape":"TypedLinkName",
|
||||
"documentation":"<p>The unique name of the typed link facet.</p>"
|
||||
},
|
||||
"AttributeUpdates":{
|
||||
"shape":"TypedLinkFacetAttributeUpdateList",
|
||||
"documentation":"<p>Attributes update structure.</p>"
|
||||
},
|
||||
"IdentityAttributeOrder":{
|
||||
"shape":"AttributeNameList",
|
||||
"documentation":"<p>The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/objectsandlinks.html#typedlink\">Typed link</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateTypedLinkFacetResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"ValidationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"ExceptionMessage"}
|
||||
},
|
||||
"documentation":"<p>Indicates your request is malformed in some manner. See the exception message.</p>",
|
||||
"documentation":"<p>Indicates that your request is malformed in some manner. See the exception message.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
|
|
@ -3926,5 +4781,5 @@
|
|||
"pattern":"^[a-zA-Z0-9._-]*$"
|
||||
}
|
||||
},
|
||||
"documentation":"<fullname>Amazon Cloud Directory</fullname> <p>Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile and IoT applications. This guide describes the Cloud Directory operations that you can call programatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see <a href=\"https://aws.amazon.com/directoryservice/\">AWS Directory Service</a> and the <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html\">AWS Directory Service Administration Guide</a>.</p>"
|
||||
"documentation":"<fullname>Amazon Cloud Directory</fullname> <p>Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see <a href=\"https://aws.amazon.com/directoryservice/\">AWS Directory Service</a> and the <a href=\"http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html\">AWS Directory Service Administration Guide</a>.</p>"
|
||||
}
|
||||
|
|
|
|||
158
botocore/data/cloudformation/2010-05-15/examples-1.json
Normal file
158
botocore/data/cloudformation/2010-05-15/examples-1.json
Normal file
|
|
@ -0,0 +1,158 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
"CancelUpdateStack": [
|
||||
{
|
||||
"input": {
|
||||
"StackName": "MyStack"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example cancels an update of the specified stack.",
|
||||
"id": "to-cancel-a-stack-update-that-is-in-progress-1472747085196",
|
||||
"title": "To cancel a stack update in progress"
|
||||
}
|
||||
],
|
||||
"UpdateStack": [
|
||||
{
|
||||
"input": {
|
||||
"NotificationARNs": [
|
||||
|
||||
],
|
||||
"Parameters": [
|
||||
{
|
||||
"ParameterKey": "KeyPairName",
|
||||
"ParameterValue": "ExampleKeyPair"
|
||||
},
|
||||
{
|
||||
"ParameterKey": "SubnetIDs",
|
||||
"ParameterValue": "ExampleSubnetID1, ExampleSubnetID2"
|
||||
}
|
||||
],
|
||||
"ResourceTypes": [
|
||||
|
||||
],
|
||||
"StackName": "MyStack",
|
||||
"Tags": [
|
||||
|
||||
],
|
||||
"TemplateURL": "https://s3.amazonaws.com/example/updated.template"
|
||||
},
|
||||
"output": {
|
||||
"StackId": ""
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example updates the template and input parameters for the specified stack.",
|
||||
"id": "to-update-an-aws-cloudformation-stack-1472841931621",
|
||||
"title": "To update an AWS CloudFormation stack"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"NotificationARNs": [
|
||||
|
||||
],
|
||||
"Parameters": [
|
||||
{
|
||||
"ParameterKey": "KeyPairName",
|
||||
"UsePreviousValue": true
|
||||
},
|
||||
{
|
||||
"ParameterKey": "SubnetIDs",
|
||||
"ParameterValue": "SampleSubnetID1, UpdatedSampleSubnetID2"
|
||||
}
|
||||
],
|
||||
"ResourceTypes": [
|
||||
|
||||
],
|
||||
"StackName": "MyStack",
|
||||
"Tags": [
|
||||
|
||||
],
|
||||
"TemplateURL": "https://s3.amazonaws.com/example/updated.template"
|
||||
},
|
||||
"output": {
|
||||
"StackId": ""
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example updates only the the specified parameter value for the specified stack. If you don't specify a parameter value, AWS CloudFormation uses the default value from the template.",
|
||||
"id": "to-update-an-aws-cloudformation-stack-1472841931621",
|
||||
"title": "To update an AWS CloudFormation stack"
|
||||
},
|
||||
{
|
||||
"input": {
|
||||
"Capabilities": [
|
||||
|
||||
],
|
||||
"NotificationARNs": [
|
||||
"arn:aws:sns:use-east-1:123456789012:mytopic1",
|
||||
"arn:aws:sns:us-east-1:123456789012:mytopic2"
|
||||
],
|
||||
"Parameters": [
|
||||
|
||||
],
|
||||
"ResourceTypes": [
|
||||
|
||||
],
|
||||
"StackName": "MyStack",
|
||||
"Tags": [
|
||||
|
||||
],
|
||||
"TemplateURL": "https://s3.amazonaws.com/example/updated.template",
|
||||
"UsePreviousTemplate": true
|
||||
},
|
||||
"output": {
|
||||
"StackId": ""
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example adds two stack notification topics to the specified stack.",
|
||||
"id": "to-update-an-aws-cloudformation-stack-1472841931621",
|
||||
"title": "To update an AWS CloudFormation stack"
|
||||
}
|
||||
],
|
||||
"ValidateTemplate": [
|
||||
{
|
||||
"input": {
|
||||
"TemplateBody": "MyTemplate.json"
|
||||
},
|
||||
"output": {
|
||||
"Capabilities": [
|
||||
|
||||
],
|
||||
"CapabilitiesReason": "",
|
||||
"Description": "AWS CloudFormation Example Template S3_Bucket: An example template that shows how to create a publicly-accessible S3 bucket. IMPORTANT: This template creates an S3 bucket. You will be billed for the AWS resources used if you create a stack from this template.",
|
||||
"Parameters": [
|
||||
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example validates the specified template.",
|
||||
"id": "to-validate-an-aws-cloudformation-template-1472839072307",
|
||||
"title": "To validate an AWS CloudFormation template"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -19,6 +19,16 @@
|
|||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "StackSummaries"
|
||||
},
|
||||
"ListExports": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "Exports"
|
||||
},
|
||||
"ListImports": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "Imports"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -17,6 +17,9 @@
|
|||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CancelUpdateStackInput"},
|
||||
"errors":[
|
||||
{"shape":"TokenAlreadyExistsException"}
|
||||
],
|
||||
"documentation":"<p>Cancels an update on the specified stack. If the call completes successfully, the stack rolls back the update and reverts to the previous stack configuration.</p> <note> <p>You can cancel only stacks that are in the UPDATE_IN_PROGRESS state.</p> </note>"
|
||||
},
|
||||
"ContinueUpdateRollback":{
|
||||
|
|
@ -30,6 +33,9 @@
|
|||
"shape":"ContinueUpdateRollbackOutput",
|
||||
"resultWrapper":"ContinueUpdateRollbackResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"TokenAlreadyExistsException"}
|
||||
],
|
||||
"documentation":"<p>For a specified stack that is in the <code>UPDATE_ROLLBACK_FAILED</code> state, continues rolling it back to the <code>UPDATE_ROLLBACK_COMPLETE</code> state. Depending on the cause of the failure, you can manually <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> fix the error</a> and continue the rollback. By continuing the rollback, you can return your stack to a working state (the <code>UPDATE_ROLLBACK_COMPLETE</code> state), and then try to update the stack again.</p> <p>A stack goes into the <code>UPDATE_ROLLBACK_FAILED</code> state when AWS CloudFormation cannot roll back all changes after a failed stack update. For example, you might have a stack that is rolling back to an old database instance that was deleted outside of AWS CloudFormation. Because AWS CloudFormation doesn't know the database was deleted, it assumes that the database instance still exists and attempts to roll back to it, causing the update rollback to fail.</p>"
|
||||
},
|
||||
"CreateChangeSet":{
|
||||
|
|
@ -48,7 +54,7 @@
|
|||
{"shape":"InsufficientCapabilitiesException"},
|
||||
{"shape":"LimitExceededException"}
|
||||
],
|
||||
"documentation":"<p>Creates a list of changes for a stack. AWS CloudFormation generates the change set by comparing the template's information with the information that you submit. A change set can help you understand which resources AWS CloudFormation will change, and how it will change them, before you update your stack. Change sets allow you to check before making a change to avoid deleting or replacing critical resources.</p> <p>AWS CloudFormation doesn't make any changes to the stack when you create a change set. To make the specified changes, you must execute the change set by using the <a>ExecuteChangeSet</a> action.</p> <p>After the call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set, use the <a>DescribeChangeSet</a> action.</p>"
|
||||
"documentation":"<p>Creates a list of changes that will be applied to a stack so that you can review the changes before executing them. You can create a change set for a stack that doesn't exist or an existing stack. If you create a change set for a stack that doesn't exist, the change set shows all of the resources that AWS CloudFormation will create. If you create a change set for an existing stack, AWS CloudFormation compares the stack's information with the information that you submit in the change set and lists the differences. Use change sets to understand which resources AWS CloudFormation will create or change, and how it will change resources in an existing stack, before you create or update a stack.</p> <p>To create a change set for a stack that doesn't exist, for the <code>ChangeSetType</code> parameter, specify <code>CREATE</code>. To create a change set for an existing stack, specify <code>UPDATE</code> for the <code>ChangeSetType</code> parameter. After the <code>CreateChangeSet</code> call successfully completes, AWS CloudFormation starts creating the change set. To check the status of the change set or to review it, use the <a>DescribeChangeSet</a> action.</p> <p>When you are satisfied with the changes the change set will make, execute the change set by using the <a>ExecuteChangeSet</a> action. AWS CloudFormation doesn't make changes until you execute the change set.</p>"
|
||||
},
|
||||
"CreateStack":{
|
||||
"name":"CreateStack",
|
||||
|
|
@ -64,6 +70,7 @@
|
|||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"AlreadyExistsException"},
|
||||
{"shape":"TokenAlreadyExistsException"},
|
||||
{"shape":"InsufficientCapabilitiesException"}
|
||||
],
|
||||
"documentation":"<p>Creates a stack as specified in the template. After the call completes successfully, the stack creation starts. You can check the status of the stack via the <a>DescribeStacks</a> API.</p>"
|
||||
|
|
@ -91,6 +98,9 @@
|
|||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteStackInput"},
|
||||
"errors":[
|
||||
{"shape":"TokenAlreadyExistsException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a specified stack. Once the call completes successfully, stack deletion starts. Deleted stacks do not show up in the <a>DescribeStacks</a> API if the deletion has been completed successfully.</p>"
|
||||
},
|
||||
"DescribeAccountLimits":{
|
||||
|
|
@ -201,7 +211,8 @@
|
|||
"errors":[
|
||||
{"shape":"InvalidChangeSetStatusException"},
|
||||
{"shape":"ChangeSetNotFoundException"},
|
||||
{"shape":"InsufficientCapabilitiesException"}
|
||||
{"shape":"InsufficientCapabilitiesException"},
|
||||
{"shape":"TokenAlreadyExistsException"}
|
||||
],
|
||||
"documentation":"<p>Updates a stack using the input information that was provided when the specified change set was created. After the call successfully completes, AWS CloudFormation starts updating the stack. Use the <a>DescribeStacks</a> action to view the status of the update.</p> <p>When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack.</p> <p>If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy.</p>"
|
||||
},
|
||||
|
|
@ -342,7 +353,8 @@
|
|||
"resultWrapper":"UpdateStackResult"
|
||||
},
|
||||
"errors":[
|
||||
{"shape":"InsufficientCapabilitiesException"}
|
||||
{"shape":"InsufficientCapabilitiesException"},
|
||||
{"shape":"TokenAlreadyExistsException"}
|
||||
],
|
||||
"documentation":"<p>Updates a stack as specified in the template. After the call completes successfully, the stack update starts. You can check the status of the stack via the <a>DescribeStacks</a> action.</p> <p>To get a copy of the template for an existing stack, you can use the <a>GetTemplate</a> action.</p> <p>For more information about creating an update template, updating a stack, and monitoring the progress of the update, see <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks.html\">Updating a Stack</a>.</p>"
|
||||
},
|
||||
|
|
@ -403,6 +415,10 @@
|
|||
"StackName":{
|
||||
"shape":"StackName",
|
||||
"documentation":"<p>The name or the unique stack ID that is associated with the stack.</p>"
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>A unique identifier for this <code>CancelUpdateStack</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to cancel an update on a stack with the same name. You might retry <code>CancelUpdateStack</code> requests to ensure that AWS CloudFormation successfully received them.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The input for the <a>CancelUpdateStack</a> action.</p>"
|
||||
|
|
@ -553,6 +569,12 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"Change"}
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":1,
|
||||
"pattern":"[a-zA-Z][-a-zA-Z0-9]*"
|
||||
},
|
||||
"ClientToken":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
|
|
@ -572,7 +594,11 @@
|
|||
},
|
||||
"ResourcesToSkip":{
|
||||
"shape":"ResourcesToSkip",
|
||||
"documentation":"<p>A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the <code>UPDATE_FAILED</code> state because a rollback failed. You can't specify resources that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason. </p> <important> <p>Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> troubleshoot</a> resources before skipping them. AWS CloudFormation sets the status of the specified resources to <code>UPDATE_COMPLETE</code> and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. </p> </important> <p>Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. </p> <p>To specify resources in a nested stack, use the following format: <code>NestedStackName.ResourceLogicalID</code>. You can specify a nested stack resource (the logical ID of an <code>AWS::CloudFormation::Stack</code> resource) only if it's in one of the following states: <code>DELETE_IN_PROGRESS</code>, <code>DELETE_COMPLETE</code>, or <code>DELETE_FAILED</code>. </p>"
|
||||
"documentation":"<p>A list of the logical IDs of the resources that AWS CloudFormation skips during the continue update rollback operation. You can specify only resources that are in the <code>UPDATE_FAILED</code> state because a rollback failed. You can't specify resources that are in the <code>UPDATE_FAILED</code> state for other reasons, for example, because an update was canceled. To check why a resource update failed, use the <a>DescribeStackResources</a> action, and view the resource status reason. </p> <important> <p>Specify this property to skip rolling back resources that AWS CloudFormation can't successfully roll back. We recommend that you <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/troubleshooting.html#troubleshooting-errors-update-rollback-failed\"> troubleshoot</a> resources before skipping them. AWS CloudFormation sets the status of the specified resources to <code>UPDATE_COMPLETE</code> and continues to roll back the stack. After the rollback is complete, the state of the skipped resources will be inconsistent with the state of the resources in the stack template. Before performing another stack update, you must update the stack or resources to be consistent with each other. If you don't, subsequent stack updates might fail, and the stack will become unrecoverable. </p> </important> <p>Specify the minimum number of resources required to successfully roll back your stack. For example, a failed resource update might cause dependent resources to fail. In this case, it might not be necessary to skip the dependent resources. </p> <p>To specify resources in a nested stack, use the following format: <code>NestedStackName.ResourceLogicalID</code>. If the <code>ResourceLogicalID</code> is a stack resource (<code>Type: AWS::CloudFormation::Stack</code>), it must be in one of the following states: <code>DELETE_IN_PROGRESS</code>, <code>DELETE_COMPLETE</code>, or <code>DELETE_FAILED</code>. </p>"
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>A unique identifier for this <code>ContinueUpdateRollback</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to continue the rollback to a stack with the same name. You might retry <code>ContinueUpdateRollback</code> requests to ensure that AWS CloudFormation successfully received them.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The input for the <a>ContinueUpdateRollback</a> action.</p>"
|
||||
|
|
@ -693,7 +719,7 @@
|
|||
},
|
||||
"NotificationARNs":{
|
||||
"shape":"NotificationARNs",
|
||||
"documentation":"<p>The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the <a href=\"https://console.aws.amazon.com/sns\">SNS console</a> or your Command Line Interface (CLI).</p>"
|
||||
"documentation":"<p>The Simple Notification Service (SNS) topic ARNs to publish stack related events. You can find your SNS topic ARNs using the SNS console or your Command Line Interface (CLI).</p>"
|
||||
},
|
||||
"Capabilities":{
|
||||
"shape":"Capabilities",
|
||||
|
|
@ -722,6 +748,10 @@
|
|||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 10 tags can be specified.</p>"
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>A unique identifier for this <code>CreateStack</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to create a stack with the same name. You might retry <code>CreateStack</code> requests to ensure that AWS CloudFormation successfully received them.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The input for <a>CreateStack</a> action.</p>"
|
||||
|
|
@ -773,6 +803,10 @@
|
|||
"RoleARN":{
|
||||
"shape":"RoleARN",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that AWS CloudFormation assumes to delete the stack. AWS CloudFormation uses the role's credentials to make calls on your behalf.</p> <p>If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials.</p>"
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>A unique identifier for this <code>DeleteStack</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to delete a stack with the same name. You might retry <code>DeleteStack</code> requests to ensure that AWS CloudFormation successfully received them.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The input for <a>DeleteStack</a> action.</p>"
|
||||
|
|
@ -1052,6 +1086,10 @@
|
|||
"StackName":{
|
||||
"shape":"StackNameOrId",
|
||||
"documentation":"<p>If you specified the name of a change set, specify the stack name or ID (ARN) that is associated with the change set you want to execute.</p>"
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>A unique identifier for this <code>ExecuteChangeSet</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to execute a change set to update a stack with the same name. You might retry <code>ExecuteChangeSet</code> requests to ensure that AWS CloudFormation successfully received them.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The input for the <a>ExecuteChangeSet</a> action.</p>"
|
||||
|
|
@ -1835,6 +1873,10 @@
|
|||
"ResourceProperties":{
|
||||
"shape":"ResourceProperties",
|
||||
"documentation":"<p>BLOB of the properties used to create the resource.</p>"
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>The token passed to the operation that generated this event.</p> <p>For example, if you execute a <code>CreateStack</code> operation with the token <code>token1</code>, then all the <code>StackEvents</code> generated by that operation will have <code>ClientRequestToken</code> set as <code>token1</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The StackEvent data type.</p>"
|
||||
|
|
@ -2164,6 +2206,18 @@
|
|||
"min":1
|
||||
},
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"TokenAlreadyExistsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>A client request token already exists.</p>",
|
||||
"error":{
|
||||
"code":"TokenAlreadyExistsException",
|
||||
"httpStatusCode":400,
|
||||
"senderFault":true
|
||||
},
|
||||
"exception":true
|
||||
},
|
||||
"TransformName":{"type":"string"},
|
||||
"TransformsList":{
|
||||
"type":"list",
|
||||
|
|
@ -2179,15 +2233,15 @@
|
|||
},
|
||||
"TemplateBody":{
|
||||
"shape":"TemplateBody",
|
||||
"documentation":"<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.)</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>"
|
||||
"documentation":"<p>Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. (For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.)</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>"
|
||||
},
|
||||
"TemplateURL":{
|
||||
"shape":"TemplateURL",
|
||||
"documentation":"<p>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify either the <code>TemplateBody</code> or the <code>TemplateURL</code> parameter, but not both.</p>"
|
||||
"documentation":"<p>Location of file containing the template body. The URL must point to a template that is located in an Amazon S3 bucket. For more information, go to <a href=\"http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html\">Template Anatomy</a> in the AWS CloudFormation User Guide.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>"
|
||||
},
|
||||
"UsePreviousTemplate":{
|
||||
"shape":"UsePreviousTemplate",
|
||||
"documentation":"<p>Reuse the existing template that is associated with the stack that you are updating.</p>"
|
||||
"documentation":"<p>Reuse the existing template that is associated with the stack that you are updating.</p> <p>Conditional: You must specify only one of the following parameters: <code>TemplateBody</code>, <code>TemplateURL</code>, or set the <code>UsePreviousTemplate</code> to <code>true</code>.</p>"
|
||||
},
|
||||
"StackPolicyDuringUpdateBody":{
|
||||
"shape":"StackPolicyDuringUpdateBody",
|
||||
|
|
@ -2228,6 +2282,10 @@
|
|||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 10 tags.</p> <p>If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.</p>"
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>A unique identifier for this <code>UpdateStack</code> request. Specify this token if you plan to retry requests so that AWS CloudFormation knows that you're not attempting to update a stack with the same name. You might retry <code>UpdateStack</code> requests to ensure that AWS CloudFormation successfully received them.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The input for an <a>UpdateStack</a> action.</p>"
|
||||
|
|
@ -2287,5 +2345,5 @@
|
|||
},
|
||||
"Version":{"type":"string"}
|
||||
},
|
||||
"documentation":"<fullname>AWS CloudFormation</fullname> <p>AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.</p> <p>With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.</p> <p>For more information about AWS CloudFormation, see the <a href=\"http://aws.amazon.com/cloudformation/\">AWS CloudFormation Product Page</a>.</p> <p>Amazon CloudFormation makes use of other AWS products. For additional technical information about a specific AWS product, see its <a href=\"http://docs.aws.amazon.com/\">technical documentation</a>.</p>"
|
||||
"documentation":"<fullname>AWS CloudFormation</fullname> <p>AWS CloudFormation allows you to create and manage AWS infrastructure deployments predictably and repeatedly. You can use AWS CloudFormation to leverage AWS products, such as Amazon Elastic Compute Cloud, Amazon Elastic Block Store, Amazon Simple Notification Service, Elastic Load Balancing, and Auto Scaling to build highly-reliable, highly scalable, cost-effective applications without creating or configuring the underlying AWS infrastructure.</p> <p>With AWS CloudFormation, you declare all of your resources and dependencies in a template file. The template defines a collection of resources as a single unit called a stack. AWS CloudFormation creates and deletes all member resources of the stack together and manages all dependencies between the resources for you.</p> <p>For more information about AWS CloudFormation, see the <a href=\"http://aws.amazon.com/cloudformation/\">AWS CloudFormation Product Page</a>.</p> <p>Amazon CloudFormation makes use of other AWS products. If you need additional technical information about a specific AWS product, you can find the product's technical documentation at <a href=\"http://docs.aws.amazon.com/\">docs.aws.amazon.com</a>.</p>"
|
||||
}
|
||||
|
|
|
|||
5
botocore/data/cloudfront/2016-11-25/examples-1.json
Normal file
5
botocore/data/cloudfront/2016-11-25/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
5
botocore/data/cloudfront/2017-03-25/examples-1.json
Normal file
5
botocore/data/cloudfront/2017-03-25/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
32
botocore/data/cloudfront/2017-03-25/paginators-1.json
Normal file
32
botocore/data/cloudfront/2017-03-25/paginators-1.json
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
{
|
||||
"pagination": {
|
||||
"ListCloudFrontOriginAccessIdentities": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "CloudFrontOriginAccessIdentityList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "CloudFrontOriginAccessIdentityList.IsTruncated",
|
||||
"result_key": "CloudFrontOriginAccessIdentityList.Items"
|
||||
},
|
||||
"ListDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "DistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "DistributionList.IsTruncated",
|
||||
"result_key": "DistributionList.Items"
|
||||
},
|
||||
"ListInvalidations": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "InvalidationList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "InvalidationList.IsTruncated",
|
||||
"result_key": "InvalidationList.Items"
|
||||
},
|
||||
"ListStreamingDistributions": {
|
||||
"input_token": "Marker",
|
||||
"output_token": "StreamingDistributionList.NextMarker",
|
||||
"limit_key": "MaxItems",
|
||||
"more_results": "StreamingDistributionList.IsTruncated",
|
||||
"result_key": "StreamingDistributionList.Items"
|
||||
}
|
||||
}
|
||||
}
|
||||
3607
botocore/data/cloudfront/2017-03-25/service-2.json
Normal file
3607
botocore/data/cloudfront/2017-03-25/service-2.json
Normal file
|
|
@ -0,0 +1,3607 @@
|
|||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2017-03-25",
|
||||
"endpointPrefix":"cloudfront",
|
||||
"globalEndpoint":"cloudfront.amazonaws.com",
|
||||
"protocol":"rest-xml",
|
||||
"serviceAbbreviation":"CloudFront",
|
||||
"serviceFullName":"Amazon CloudFront",
|
||||
"signatureVersion":"v4",
|
||||
"uid":"cloudfront-2017-03-25"
|
||||
},
|
||||
"operations":{
|
||||
"CreateCloudFrontOriginAccessIdentity":{
|
||||
"name":"CreateCloudFrontOriginAccessIdentity2017_03_25",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/2017-03-25/origin-access-identity/cloudfront",
|
||||
"responseCode":201
|
||||
},
|
||||
"input":{"shape":"CreateCloudFrontOriginAccessIdentityRequest"},
|
||||
"output":{"shape":"CreateCloudFrontOriginAccessIdentityResult"},
|
||||
"errors":[
|
||||
{"shape":"CloudFrontOriginAccessIdentityAlreadyExists"},
|
||||
{"shape":"MissingBody"},
|
||||
{"shape":"TooManyCloudFrontOriginAccessIdentities"},
|
||||
{"shape":"InvalidArgument"},
|
||||
{"shape":"InconsistentQuantities"}
|
||||
],
|
||||
"documentation":"<p>Creates a new origin access identity. If you're using Amazon S3 for your origin, you can use an origin access identity to require users to access your content using a CloudFront URL instead of the Amazon S3 URL. For more information about how to use origin access identities, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"CreateDistribution":{
|
||||
"name":"CreateDistribution2017_03_25",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/2017-03-25/distribution",
|
||||
"responseCode":201
|
||||
},
|
||||
"input":{"shape":"CreateDistributionRequest"},
|
||||
"output":{"shape":"CreateDistributionResult"},
|
||||
"errors":[
|
||||
{"shape":"CNAMEAlreadyExists"},
|
||||
{"shape":"DistributionAlreadyExists"},
|
||||
{"shape":"InvalidOrigin"},
|
||||
{"shape":"InvalidOriginAccessIdentity"},
|
||||
{"shape":"AccessDenied"},
|
||||
{"shape":"TooManyTrustedSigners"},
|
||||
{"shape":"TrustedSignerDoesNotExist"},
|
||||
{"shape":"InvalidViewerCertificate"},
|
||||
{"shape":"InvalidMinimumProtocolVersion"},
|
||||
{"shape":"MissingBody"},
|
||||
{"shape":"TooManyDistributionCNAMEs"},
|
||||
{"shape":"TooManyDistributions"},
|
||||
{"shape":"InvalidDefaultRootObject"},
|
||||
{"shape":"InvalidRelativePath"},
|
||||
{"shape":"InvalidErrorCode"},
|
||||
{"shape":"InvalidResponseCode"},
|
||||
{"shape":"InvalidArgument"},
|
||||
{"shape":"InvalidRequiredProtocol"},
|
||||
{"shape":"NoSuchOrigin"},
|
||||
{"shape":"TooManyOrigins"},
|
||||
{"shape":"TooManyCacheBehaviors"},
|
||||
{"shape":"TooManyCookieNamesInWhiteList"},
|
||||
{"shape":"InvalidForwardCookies"},
|
||||
{"shape":"TooManyHeadersInForwardedValues"},
|
||||
{"shape":"InvalidHeadersForS3Origin"},
|
||||
{"shape":"InconsistentQuantities"},
|
||||
{"shape":"TooManyCertificates"},
|
||||
{"shape":"InvalidLocationCode"},
|
||||
{"shape":"InvalidGeoRestrictionParameter"},
|
||||
{"shape":"InvalidProtocolSettings"},
|
||||
{"shape":"InvalidTTLOrder"},
|
||||
{"shape":"InvalidWebACLId"},
|
||||
{"shape":"TooManyOriginCustomHeaders"},
|
||||
{"shape":"TooManyQueryStringParameters"},
|
||||
{"shape":"InvalidQueryStringParameters"},
|
||||
{"shape":"TooManyDistributionsWithLambdaAssociations"},
|
||||
{"shape":"TooManyLambdaFunctionAssociations"},
|
||||
{"shape":"InvalidLambdaFunctionAssociation"},
|
||||
{"shape":"InvalidOriginReadTimeout"},
|
||||
{"shape":"InvalidOriginKeepaliveTimeout"}
|
||||
],
|
||||
"documentation":"<p>Creates a new web distribution. Send a <code>POST</code> request to the <code>/<i>CloudFront API version</i>/distribution</code>/<code>distribution ID</code> resource.</p>"
|
||||
},
|
||||
"CreateDistributionWithTags":{
|
||||
"name":"CreateDistributionWithTags2017_03_25",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/2017-03-25/distribution?WithTags",
|
||||
"responseCode":201
|
||||
},
|
||||
"input":{"shape":"CreateDistributionWithTagsRequest"},
|
||||
"output":{"shape":"CreateDistributionWithTagsResult"},
|
||||
"errors":[
|
||||
{"shape":"CNAMEAlreadyExists"},
|
||||
{"shape":"DistributionAlreadyExists"},
|
||||
{"shape":"InvalidOrigin"},
|
||||
{"shape":"InvalidOriginAccessIdentity"},
|
||||
{"shape":"AccessDenied"},
|
||||
{"shape":"TooManyTrustedSigners"},
|
||||
{"shape":"TrustedSignerDoesNotExist"},
|
||||
{"shape":"InvalidViewerCertificate"},
|
||||
{"shape":"InvalidMinimumProtocolVersion"},
|
||||
{"shape":"MissingBody"},
|
||||
{"shape":"TooManyDistributionCNAMEs"},
|
||||
{"shape":"TooManyDistributions"},
|
||||
{"shape":"InvalidDefaultRootObject"},
|
||||
{"shape":"InvalidRelativePath"},
|
||||
{"shape":"InvalidErrorCode"},
|
||||
{"shape":"InvalidResponseCode"},
|
||||
{"shape":"InvalidArgument"},
|
||||
{"shape":"InvalidRequiredProtocol"},
|
||||
{"shape":"NoSuchOrigin"},
|
||||
{"shape":"TooManyOrigins"},
|
||||
{"shape":"TooManyCacheBehaviors"},
|
||||
{"shape":"TooManyCookieNamesInWhiteList"},
|
||||
{"shape":"InvalidForwardCookies"},
|
||||
{"shape":"TooManyHeadersInForwardedValues"},
|
||||
{"shape":"InvalidHeadersForS3Origin"},
|
||||
{"shape":"InconsistentQuantities"},
|
||||
{"shape":"TooManyCertificates"},
|
||||
{"shape":"InvalidLocationCode"},
|
||||
{"shape":"InvalidGeoRestrictionParameter"},
|
||||
{"shape":"InvalidProtocolSettings"},
|
||||
{"shape":"InvalidTTLOrder"},
|
||||
{"shape":"InvalidWebACLId"},
|
||||
{"shape":"TooManyOriginCustomHeaders"},
|
||||
{"shape":"InvalidTagging"},
|
||||
{"shape":"TooManyQueryStringParameters"},
|
||||
{"shape":"InvalidQueryStringParameters"},
|
||||
{"shape":"TooManyDistributionsWithLambdaAssociations"},
|
||||
{"shape":"TooManyLambdaFunctionAssociations"},
|
||||
{"shape":"InvalidLambdaFunctionAssociation"},
|
||||
{"shape":"InvalidOriginReadTimeout"},
|
||||
{"shape":"InvalidOriginKeepaliveTimeout"}
|
||||
],
|
||||
"documentation":"<p>Create a new distribution with tags.</p>"
|
||||
},
|
||||
"CreateInvalidation":{
|
||||
"name":"CreateInvalidation2017_03_25",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/2017-03-25/distribution/{DistributionId}/invalidation",
|
||||
"responseCode":201
|
||||
},
|
||||
"input":{"shape":"CreateInvalidationRequest"},
|
||||
"output":{"shape":"CreateInvalidationResult"},
|
||||
"errors":[
|
||||
{"shape":"AccessDenied"},
|
||||
{"shape":"MissingBody"},
|
||||
{"shape":"InvalidArgument"},
|
||||
{"shape":"NoSuchDistribution"},
|
||||
{"shape":"BatchTooLarge"},
|
||||
{"shape":"TooManyInvalidationsInProgress"},
|
||||
{"shape":"InconsistentQuantities"}
|
||||
],
|
||||
"documentation":"<p>Create a new invalidation. </p>"
|
||||
},
|
||||
"CreateStreamingDistribution":{
|
||||
"name":"CreateStreamingDistribution2017_03_25",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/2017-03-25/streaming-distribution",
|
||||
"responseCode":201
|
||||
},
|
||||
"input":{"shape":"CreateStreamingDistributionRequest"},
|
||||
"output":{"shape":"CreateStreamingDistributionResult"},
|
||||
"errors":[
|
||||
{"shape":"CNAMEAlreadyExists"},
|
||||
{"shape":"StreamingDistributionAlreadyExists"},
|
||||
{"shape":"InvalidOrigin"},
|
||||
{"shape":"InvalidOriginAccessIdentity"},
|
||||
{"shape":"AccessDenied"},
|
||||
{"shape":"TooManyTrustedSigners"},
|
||||
{"shape":"TrustedSignerDoesNotExist"},
|
||||
{"shape":"MissingBody"},
|
||||
{"shape":"TooManyStreamingDistributionCNAMEs"},
|
||||
{"shape":"TooManyStreamingDistributions"},
|
||||
{"shape":"InvalidArgument"},
|
||||
{"shape":"InconsistentQuantities"}
|
||||
],
|
||||
"documentation":"<p>Creates a new RMTP distribution. An RTMP distribution is similar to a web distribution, but an RTMP distribution streams media files using the Adobe Real-Time Messaging Protocol (RTMP) instead of serving files using HTTP. </p> <p>To create a new web distribution, submit a <code>POST</code> request to the <i>CloudFront API version</i>/distribution resource. The request body must include a document with a <i>StreamingDistributionConfig</i> element. The response echoes the <code>StreamingDistributionConfig</code> element and returns other information about the RTMP distribution.</p> <p>To get the status of your request, use the <i>GET StreamingDistribution</i> API action. When the value of <code>Enabled</code> is <code>true</code> and the value of <code>Status</code> is <code>Deployed</code>, your distribution is ready. A distribution usually deploys in less than 15 minutes.</p> <p>For more information about web distributions, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-rtmp.html\">Working with RTMP Distributions</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <important> <p>Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a web distribution or an RTMP distribution, and when you invalidate objects. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the <code>Quantity</code> element and the number of values specified.</p> </important>"
|
||||
},
|
||||
"CreateStreamingDistributionWithTags":{
|
||||
"name":"CreateStreamingDistributionWithTags2017_03_25",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/2017-03-25/streaming-distribution?WithTags",
|
||||
"responseCode":201
|
||||
},
|
||||
"input":{"shape":"CreateStreamingDistributionWithTagsRequest"},
|
||||
"output":{"shape":"CreateStreamingDistributionWithTagsResult"},
|
||||
"errors":[
|
||||
{"shape":"CNAMEAlreadyExists"},
|
||||
{"shape":"StreamingDistributionAlreadyExists"},
|
||||
{"shape":"InvalidOrigin"},
|
||||
{"shape":"InvalidOriginAccessIdentity"},
|
||||
{"shape":"AccessDenied"},
|
||||
{"shape":"TooManyTrustedSigners"},
|
||||
{"shape":"TrustedSignerDoesNotExist"},
|
||||
{"shape":"MissingBody"},
|
||||
{"shape":"TooManyStreamingDistributionCNAMEs"},
|
||||
{"shape":"TooManyStreamingDistributions"},
|
||||
{"shape":"InvalidArgument"},
|
||||
{"shape":"InconsistentQuantities"},
|
||||
{"shape":"InvalidTagging"}
|
||||
],
|
||||
"documentation":"<p>Create a new streaming distribution with tags.</p>"
|
||||
},
|
||||
"DeleteCloudFrontOriginAccessIdentity":{
|
||||
"name":"DeleteCloudFrontOriginAccessIdentity2017_03_25",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/2017-03-25/origin-access-identity/cloudfront/{Id}",
|
||||
"responseCode":204
|
||||
},
|
||||
"input":{"shape":"DeleteCloudFrontOriginAccessIdentityRequest"},
|
||||
"errors":[
|
||||
{"shape":"AccessDenied"},
|
||||
{"shape":"InvalidIfMatchVersion"},
|
||||
{"shape":"NoSuchCloudFrontOriginAccessIdentity"},
|
||||
{"shape":"PreconditionFailed"},
|
||||
{"shape":"CloudFrontOriginAccessIdentityInUse"}
|
||||
],
|
||||
"documentation":"<p>Delete an origin access identity. </p>"
|
||||
},
|
||||
"DeleteDistribution":{
|
||||
"name":"DeleteDistribution2017_03_25",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/2017-03-25/distribution/{Id}",
|
||||
"responseCode":204
|
||||
},
|
||||
"input":{"shape":"DeleteDistributionRequest"},
|
||||
"errors":[
|
||||
{"shape":"AccessDenied"},
|
||||
{"shape":"DistributionNotDisabled"},
|
||||
{"shape":"InvalidIfMatchVersion"},
|
||||
{"shape":"NoSuchDistribution"},
|
||||
{"shape":"PreconditionFailed"}
|
||||
],
|
||||
"documentation":"<p>Delete a distribution. </p>"
|
||||
},
|
||||
"DeleteStreamingDistribution":{
|
||||
"name":"DeleteStreamingDistribution2017_03_25",
|
||||
"http":{
|
||||
"method":"DELETE",
|
||||
"requestUri":"/2017-03-25/streaming-distribution/{Id}",
|
||||
"responseCode":204
|
||||
},
|
||||
"input":{"shape":"DeleteStreamingDistributionRequest"},
|
||||
"errors":[
|
||||
{"shape":"AccessDenied"},
|
||||
{"shape":"StreamingDistributionNotDisabled"},
|
||||
{"shape":"InvalidIfMatchVersion"},
|
||||
{"shape":"NoSuchStreamingDistribution"},
|
||||
{"shape":"PreconditionFailed"}
|
||||
],
|
||||
"documentation":"<p>Delete a streaming distribution. To delete an RTMP distribution using the CloudFront API, perform the following steps.</p> <p> <b>To delete an RTMP distribution using the CloudFront API</b>:</p> <ol> <li> <p>Disable the RTMP distribution.</p> </li> <li> <p>Submit a <code>GET Streaming Distribution Config</code> request to get the current configuration and the <code>Etag</code> header for the distribution. </p> </li> <li> <p>Update the XML document that was returned in the response to your <code>GET Streaming Distribution Config</code> request to change the value of <code>Enabled</code> to <code>false</code>.</p> </li> <li> <p>Submit a <code>PUT Streaming Distribution Config</code> request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Then set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Streaming Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to the <code>PUT Streaming Distribution Config</code> request to confirm that the distribution was successfully disabled.</p> </li> <li> <p>Submit a <code>GET Streaming Distribution Config</code> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>.</p> </li> <li> <p>Submit a <code>DELETE Streaming Distribution</code> request. Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Streaming Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to your <code>DELETE Streaming Distribution</code> request to confirm that the distribution was successfully deleted.</p> </li> </ol> <p>For information about deleting a distribution using the CloudFront console, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html\">Deleting a Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"GetCloudFrontOriginAccessIdentity":{
|
||||
"name":"GetCloudFrontOriginAccessIdentity2017_03_25",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2017-03-25/origin-access-identity/cloudfront/{Id}"
|
||||
},
|
||||
"input":{"shape":"GetCloudFrontOriginAccessIdentityRequest"},
|
||||
"output":{"shape":"GetCloudFrontOriginAccessIdentityResult"},
|
||||
"errors":[
|
||||
{"shape":"NoSuchCloudFrontOriginAccessIdentity"},
|
||||
{"shape":"AccessDenied"}
|
||||
],
|
||||
"documentation":"<p>Get the information about an origin access identity. </p>"
|
||||
},
|
||||
"GetCloudFrontOriginAccessIdentityConfig":{
|
||||
"name":"GetCloudFrontOriginAccessIdentityConfig2017_03_25",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2017-03-25/origin-access-identity/cloudfront/{Id}/config"
|
||||
},
|
||||
"input":{"shape":"GetCloudFrontOriginAccessIdentityConfigRequest"},
|
||||
"output":{"shape":"GetCloudFrontOriginAccessIdentityConfigResult"},
|
||||
"errors":[
|
||||
{"shape":"NoSuchCloudFrontOriginAccessIdentity"},
|
||||
{"shape":"AccessDenied"}
|
||||
],
|
||||
"documentation":"<p>Get the configuration information about an origin access identity. </p>"
|
||||
},
|
||||
"GetDistribution":{
|
||||
"name":"GetDistribution2017_03_25",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2017-03-25/distribution/{Id}"
|
||||
},
|
||||
"input":{"shape":"GetDistributionRequest"},
|
||||
"output":{"shape":"GetDistributionResult"},
|
||||
"errors":[
|
||||
{"shape":"NoSuchDistribution"},
|
||||
{"shape":"AccessDenied"}
|
||||
],
|
||||
"documentation":"<p>Get the information about a distribution. </p>"
|
||||
},
|
||||
"GetDistributionConfig":{
|
||||
"name":"GetDistributionConfig2017_03_25",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2017-03-25/distribution/{Id}/config"
|
||||
},
|
||||
"input":{"shape":"GetDistributionConfigRequest"},
|
||||
"output":{"shape":"GetDistributionConfigResult"},
|
||||
"errors":[
|
||||
{"shape":"NoSuchDistribution"},
|
||||
{"shape":"AccessDenied"}
|
||||
],
|
||||
"documentation":"<p>Get the configuration information about a distribution. </p>"
|
||||
},
|
||||
"GetInvalidation":{
|
||||
"name":"GetInvalidation2017_03_25",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2017-03-25/distribution/{DistributionId}/invalidation/{Id}"
|
||||
},
|
||||
"input":{"shape":"GetInvalidationRequest"},
|
||||
"output":{"shape":"GetInvalidationResult"},
|
||||
"errors":[
|
||||
{"shape":"NoSuchInvalidation"},
|
||||
{"shape":"NoSuchDistribution"},
|
||||
{"shape":"AccessDenied"}
|
||||
],
|
||||
"documentation":"<p>Get the information about an invalidation. </p>"
|
||||
},
|
||||
"GetStreamingDistribution":{
|
||||
"name":"GetStreamingDistribution2017_03_25",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2017-03-25/streaming-distribution/{Id}"
|
||||
},
|
||||
"input":{"shape":"GetStreamingDistributionRequest"},
|
||||
"output":{"shape":"GetStreamingDistributionResult"},
|
||||
"errors":[
|
||||
{"shape":"NoSuchStreamingDistribution"},
|
||||
{"shape":"AccessDenied"}
|
||||
],
|
||||
"documentation":"<p>Gets information about a specified RTMP distribution, including the distribution configuration.</p>"
|
||||
},
|
||||
"GetStreamingDistributionConfig":{
|
||||
"name":"GetStreamingDistributionConfig2017_03_25",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2017-03-25/streaming-distribution/{Id}/config"
|
||||
},
|
||||
"input":{"shape":"GetStreamingDistributionConfigRequest"},
|
||||
"output":{"shape":"GetStreamingDistributionConfigResult"},
|
||||
"errors":[
|
||||
{"shape":"NoSuchStreamingDistribution"},
|
||||
{"shape":"AccessDenied"}
|
||||
],
|
||||
"documentation":"<p>Get the configuration information about a streaming distribution. </p>"
|
||||
},
|
||||
"ListCloudFrontOriginAccessIdentities":{
|
||||
"name":"ListCloudFrontOriginAccessIdentities2017_03_25",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2017-03-25/origin-access-identity/cloudfront"
|
||||
},
|
||||
"input":{"shape":"ListCloudFrontOriginAccessIdentitiesRequest"},
|
||||
"output":{"shape":"ListCloudFrontOriginAccessIdentitiesResult"},
|
||||
"errors":[
|
||||
{"shape":"InvalidArgument"}
|
||||
],
|
||||
"documentation":"<p>Lists origin access identities.</p>"
|
||||
},
|
||||
"ListDistributions":{
|
||||
"name":"ListDistributions2017_03_25",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2017-03-25/distribution"
|
||||
},
|
||||
"input":{"shape":"ListDistributionsRequest"},
|
||||
"output":{"shape":"ListDistributionsResult"},
|
||||
"errors":[
|
||||
{"shape":"InvalidArgument"}
|
||||
],
|
||||
"documentation":"<p>List distributions. </p>"
|
||||
},
|
||||
"ListDistributionsByWebACLId":{
|
||||
"name":"ListDistributionsByWebACLId2017_03_25",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2017-03-25/distributionsByWebACLId/{WebACLId}"
|
||||
},
|
||||
"input":{"shape":"ListDistributionsByWebACLIdRequest"},
|
||||
"output":{"shape":"ListDistributionsByWebACLIdResult"},
|
||||
"errors":[
|
||||
{"shape":"InvalidArgument"},
|
||||
{"shape":"InvalidWebACLId"}
|
||||
],
|
||||
"documentation":"<p>List the distributions that are associated with a specified AWS WAF web ACL. </p>"
|
||||
},
|
||||
"ListInvalidations":{
|
||||
"name":"ListInvalidations2017_03_25",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2017-03-25/distribution/{DistributionId}/invalidation"
|
||||
},
|
||||
"input":{"shape":"ListInvalidationsRequest"},
|
||||
"output":{"shape":"ListInvalidationsResult"},
|
||||
"errors":[
|
||||
{"shape":"InvalidArgument"},
|
||||
{"shape":"NoSuchDistribution"},
|
||||
{"shape":"AccessDenied"}
|
||||
],
|
||||
"documentation":"<p>Lists invalidation batches. </p>"
|
||||
},
|
||||
"ListStreamingDistributions":{
|
||||
"name":"ListStreamingDistributions2017_03_25",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2017-03-25/streaming-distribution"
|
||||
},
|
||||
"input":{"shape":"ListStreamingDistributionsRequest"},
|
||||
"output":{"shape":"ListStreamingDistributionsResult"},
|
||||
"errors":[
|
||||
{"shape":"InvalidArgument"}
|
||||
],
|
||||
"documentation":"<p>List streaming distributions. </p>"
|
||||
},
|
||||
"ListTagsForResource":{
|
||||
"name":"ListTagsForResource2017_03_25",
|
||||
"http":{
|
||||
"method":"GET",
|
||||
"requestUri":"/2017-03-25/tagging"
|
||||
},
|
||||
"input":{"shape":"ListTagsForResourceRequest"},
|
||||
"output":{"shape":"ListTagsForResourceResult"},
|
||||
"errors":[
|
||||
{"shape":"AccessDenied"},
|
||||
{"shape":"InvalidArgument"},
|
||||
{"shape":"InvalidTagging"},
|
||||
{"shape":"NoSuchResource"}
|
||||
],
|
||||
"documentation":"<p>List tags for a CloudFront resource.</p>"
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource2017_03_25",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/2017-03-25/tagging?Operation=Tag",
|
||||
"responseCode":204
|
||||
},
|
||||
"input":{"shape":"TagResourceRequest"},
|
||||
"errors":[
|
||||
{"shape":"AccessDenied"},
|
||||
{"shape":"InvalidArgument"},
|
||||
{"shape":"InvalidTagging"},
|
||||
{"shape":"NoSuchResource"}
|
||||
],
|
||||
"documentation":"<p>Add tags to a CloudFront resource.</p>"
|
||||
},
|
||||
"UntagResource":{
|
||||
"name":"UntagResource2017_03_25",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/2017-03-25/tagging?Operation=Untag",
|
||||
"responseCode":204
|
||||
},
|
||||
"input":{"shape":"UntagResourceRequest"},
|
||||
"errors":[
|
||||
{"shape":"AccessDenied"},
|
||||
{"shape":"InvalidArgument"},
|
||||
{"shape":"InvalidTagging"},
|
||||
{"shape":"NoSuchResource"}
|
||||
],
|
||||
"documentation":"<p>Remove tags from a CloudFront resource.</p>"
|
||||
},
|
||||
"UpdateCloudFrontOriginAccessIdentity":{
|
||||
"name":"UpdateCloudFrontOriginAccessIdentity2017_03_25",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/2017-03-25/origin-access-identity/cloudfront/{Id}/config"
|
||||
},
|
||||
"input":{"shape":"UpdateCloudFrontOriginAccessIdentityRequest"},
|
||||
"output":{"shape":"UpdateCloudFrontOriginAccessIdentityResult"},
|
||||
"errors":[
|
||||
{"shape":"AccessDenied"},
|
||||
{"shape":"IllegalUpdate"},
|
||||
{"shape":"InvalidIfMatchVersion"},
|
||||
{"shape":"MissingBody"},
|
||||
{"shape":"NoSuchCloudFrontOriginAccessIdentity"},
|
||||
{"shape":"PreconditionFailed"},
|
||||
{"shape":"InvalidArgument"},
|
||||
{"shape":"InconsistentQuantities"}
|
||||
],
|
||||
"documentation":"<p>Update an origin access identity. </p>"
|
||||
},
|
||||
"UpdateDistribution":{
|
||||
"name":"UpdateDistribution2017_03_25",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/2017-03-25/distribution/{Id}/config"
|
||||
},
|
||||
"input":{"shape":"UpdateDistributionRequest"},
|
||||
"output":{"shape":"UpdateDistributionResult"},
|
||||
"errors":[
|
||||
{"shape":"AccessDenied"},
|
||||
{"shape":"CNAMEAlreadyExists"},
|
||||
{"shape":"IllegalUpdate"},
|
||||
{"shape":"InvalidIfMatchVersion"},
|
||||
{"shape":"MissingBody"},
|
||||
{"shape":"NoSuchDistribution"},
|
||||
{"shape":"PreconditionFailed"},
|
||||
{"shape":"TooManyDistributionCNAMEs"},
|
||||
{"shape":"InvalidDefaultRootObject"},
|
||||
{"shape":"InvalidRelativePath"},
|
||||
{"shape":"InvalidErrorCode"},
|
||||
{"shape":"InvalidResponseCode"},
|
||||
{"shape":"InvalidArgument"},
|
||||
{"shape":"InvalidOriginAccessIdentity"},
|
||||
{"shape":"TooManyTrustedSigners"},
|
||||
{"shape":"TrustedSignerDoesNotExist"},
|
||||
{"shape":"InvalidViewerCertificate"},
|
||||
{"shape":"InvalidMinimumProtocolVersion"},
|
||||
{"shape":"InvalidRequiredProtocol"},
|
||||
{"shape":"NoSuchOrigin"},
|
||||
{"shape":"TooManyOrigins"},
|
||||
{"shape":"TooManyCacheBehaviors"},
|
||||
{"shape":"TooManyCookieNamesInWhiteList"},
|
||||
{"shape":"InvalidForwardCookies"},
|
||||
{"shape":"TooManyHeadersInForwardedValues"},
|
||||
{"shape":"InvalidHeadersForS3Origin"},
|
||||
{"shape":"InconsistentQuantities"},
|
||||
{"shape":"TooManyCertificates"},
|
||||
{"shape":"InvalidLocationCode"},
|
||||
{"shape":"InvalidGeoRestrictionParameter"},
|
||||
{"shape":"InvalidTTLOrder"},
|
||||
{"shape":"InvalidWebACLId"},
|
||||
{"shape":"TooManyOriginCustomHeaders"},
|
||||
{"shape":"TooManyQueryStringParameters"},
|
||||
{"shape":"InvalidQueryStringParameters"},
|
||||
{"shape":"TooManyDistributionsWithLambdaAssociations"},
|
||||
{"shape":"TooManyLambdaFunctionAssociations"},
|
||||
{"shape":"InvalidLambdaFunctionAssociation"},
|
||||
{"shape":"InvalidOriginReadTimeout"},
|
||||
{"shape":"InvalidOriginKeepaliveTimeout"}
|
||||
],
|
||||
"documentation":"<p>Updates the configuration for a web distribution. Perform the following steps.</p> <p>For information about updating a distribution using the CloudFront console, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-creating-console.html\">Creating or Updating a Web Distribution Using the CloudFront Console </a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p> <b>To update a web distribution using the CloudFront API</b> </p> <ol> <li> <p>Submit a <a>GetDistributionConfig</a> request to get the current configuration and an <code>Etag</code> header for the distribution.</p> <note> <p>If you update the distribution again, you need to get a new <code>Etag</code> header.</p> </note> </li> <li> <p>Update the XML document that was returned in the response to your <code>GetDistributionConfig</code> request to include the desired changes. You can't change the value of <code>CallerReference</code>. If you try to change this value, CloudFront returns an <code>IllegalUpdate</code> error.</p> <important> <p>The new configuration replaces the existing configuration; the values that you specify in an <code>UpdateDistribution</code> request are not merged into the existing configuration. When you add, delete, or replace values in an element that allows multiple values (for example, <code>CNAME</code>), you must specify all of the values that you want to appear in the updated distribution. In addition, you must update the corresponding <code>Quantity</code> element.</p> </important> </li> <li> <p>Submit an <code>UpdateDistribution</code> request to update the configuration for your distribution:</p> <ul> <li> <p>In the request body, include the XML document that you updated in Step 2. The request body must include an XML document with a <code>DistributionConfig</code> element.</p> </li> <li> <p>Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GetDistributionConfig</code> request in Step 1.</p> </li> </ul> </li> <li> <p>Review the response to the <code>UpdateDistribution</code> request to confirm that the configuration was successfully updated.</p> </li> <li> <p>Optional: Submit a <a>GetDistribution</a> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>.</p> <important> <p>Beginning with the 2012-05-05 version of the CloudFront API, we made substantial changes to the format of the XML document that you include in the request body when you create or update a distribution. With previous versions of the API, we discovered that it was too easy to accidentally delete one or more values for an element that accepts multiple values, for example, CNAMEs and trusted signers. Our changes for the 2012-05-05 release are intended to prevent these accidental deletions and to notify you when there's a mismatch between the number of values you say you're specifying in the <code>Quantity</code> element and the number of values you're actually specifying.</p> </important> </li> </ol>"
|
||||
},
|
||||
"UpdateStreamingDistribution":{
|
||||
"name":"UpdateStreamingDistribution2017_03_25",
|
||||
"http":{
|
||||
"method":"PUT",
|
||||
"requestUri":"/2017-03-25/streaming-distribution/{Id}/config"
|
||||
},
|
||||
"input":{"shape":"UpdateStreamingDistributionRequest"},
|
||||
"output":{"shape":"UpdateStreamingDistributionResult"},
|
||||
"errors":[
|
||||
{"shape":"AccessDenied"},
|
||||
{"shape":"CNAMEAlreadyExists"},
|
||||
{"shape":"IllegalUpdate"},
|
||||
{"shape":"InvalidIfMatchVersion"},
|
||||
{"shape":"MissingBody"},
|
||||
{"shape":"NoSuchStreamingDistribution"},
|
||||
{"shape":"PreconditionFailed"},
|
||||
{"shape":"TooManyStreamingDistributionCNAMEs"},
|
||||
{"shape":"InvalidArgument"},
|
||||
{"shape":"InvalidOriginAccessIdentity"},
|
||||
{"shape":"TooManyTrustedSigners"},
|
||||
{"shape":"TrustedSignerDoesNotExist"},
|
||||
{"shape":"InconsistentQuantities"}
|
||||
],
|
||||
"documentation":"<p>Update a streaming distribution. </p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AccessDenied":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Access denied.</p>",
|
||||
"error":{"httpStatusCode":403},
|
||||
"exception":true
|
||||
},
|
||||
"ActiveTrustedSigners":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Enabled",
|
||||
"Quantity"
|
||||
],
|
||||
"members":{
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Enabled is <code>true</code> if any of the AWS accounts listed in the <code>TrustedSigners</code> complex type for this RTMP distribution have active CloudFront key pairs. If not, <code>Enabled</code> is <code>false</code>.</p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>"
|
||||
},
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>A complex type that contains one <code>Signer</code> complex type for each trusted signer specified in the <code>TrustedSigners</code> complex type.</p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"SignerList",
|
||||
"documentation":"<p>A complex type that contains one <code>Signer</code> complex type for each trusted signer that is specified in the <code>TrustedSigners</code> complex type.</p> <p>For more information, see <a>ActiveTrustedSigners</a>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that lists the AWS accounts, if any, that you included in the <code>TrustedSigners</code> complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.</p> <p>The <code>Signer</code> complex type lists the AWS account number of the trusted signer or <code>self</code> if the signer is the AWS account that created the distribution. The <code>Signer</code> element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no <code>KeyPairId</code> element appears for a <code>Signer</code>, that signer can't create signed URLs. </p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"AliasList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"string",
|
||||
"locationName":"CNAME"
|
||||
}
|
||||
},
|
||||
"Aliases":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of CNAME aliases, if any, that you want to associate with this distribution.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"AliasList",
|
||||
"documentation":"<p>A complex type that contains the CNAME aliases, if any, that you want to associate with this distribution.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution. </p>"
|
||||
},
|
||||
"AllowedMethods":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Quantity",
|
||||
"Items"
|
||||
],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of HTTP methods that you want CloudFront to forward to your origin. Valid values are 2 (for <code>GET</code> and <code>HEAD</code> requests), 3 (for <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests) and 7 (for <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and <code>DELETE</code> requests).</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"MethodsList",
|
||||
"documentation":"<p>A complex type that contains the HTTP methods that you want CloudFront to process and forward to your origin.</p>"
|
||||
},
|
||||
"CachedMethods":{"shape":"CachedMethods"}
|
||||
},
|
||||
"documentation":"<p>A complex type that controls which HTTP methods CloudFront processes and forwards to your Amazon S3 bucket or your custom origin. There are three choices:</p> <ul> <li> <p>CloudFront forwards only <code>GET</code> and <code>HEAD</code> requests.</p> </li> <li> <p>CloudFront forwards only <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests.</p> </li> <li> <p>CloudFront forwards <code>GET, HEAD, OPTIONS, PUT, PATCH, POST</code>, and <code>DELETE</code> requests.</p> </li> </ul> <p>If you pick the third choice, you may need to restrict access to your Amazon S3 bucket or to your custom origin so users can't perform operations that you don't want them to. For example, you might not want users to have permissions to delete objects from your origin.</p>"
|
||||
},
|
||||
"AwsAccountNumberList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"string",
|
||||
"locationName":"AwsAccountNumber"
|
||||
}
|
||||
},
|
||||
"BatchTooLarge":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":413},
|
||||
"exception":true
|
||||
},
|
||||
"CNAMEAlreadyExists":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":409},
|
||||
"exception":true
|
||||
},
|
||||
"CacheBehavior":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"PathPattern",
|
||||
"TargetOriginId",
|
||||
"ForwardedValues",
|
||||
"TrustedSigners",
|
||||
"ViewerProtocolPolicy",
|
||||
"MinTTL"
|
||||
],
|
||||
"members":{
|
||||
"PathPattern":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The pattern (for example, <code>images/*.jpg</code>) that specifies which requests to apply the behavior to. When CloudFront receives a viewer request, the requested path is compared with path patterns in the order in which cache behaviors are listed in the distribution.</p> <note> <p>You can optionally include a slash (<code>/</code>) at the beginning of the path pattern. For example, <code>/images/*.jpg</code>. CloudFront behavior is the same with or without the leading <code>/</code>.</p> </note> <p>The path pattern for the default cache behavior is <code>*</code> and cannot be changed. If the request for an object does not match the path pattern for any cache behaviors, CloudFront applies the behavior in the default cache behavior.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesPathPattern\">Path Pattern</a> in the <i> Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"TargetOriginId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of <code>ID</code> for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.</p>"
|
||||
},
|
||||
"ForwardedValues":{
|
||||
"shape":"ForwardedValues",
|
||||
"documentation":"<p>A complex type that specifies how CloudFront handles query strings and cookies.</p>"
|
||||
},
|
||||
"TrustedSigners":{
|
||||
"shape":"TrustedSigners",
|
||||
"documentation":"<p>A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.</p> <p>If you want to require signed URLs in requests for objects in the target origin that match the <code>PathPattern</code> for this cache behavior, specify <code>true</code> for <code>Enabled</code>, and specify the applicable values for <code>Quantity</code> and <code>Items</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p> <p>If you don't want to require signed URLs in requests for objects that match <code>PathPattern</code>, specify <code>false</code> for <code>Enabled</code> and <code>0</code> for <code>Quantity</code>. Omit <code>Items</code>.</p> <p>To add, change, or remove one or more trusted signers, change <code>Enabled</code> to <code>true</code> (if it's currently <code>false</code>), change <code>Quantity</code> as applicable, and specify all of the trusted signers that you want to include in the updated distribution.</p>"
|
||||
},
|
||||
"ViewerProtocolPolicy":{
|
||||
"shape":"ViewerProtocolPolicy",
|
||||
"documentation":"<p>The protocol that viewers can use to access the files in the origin specified by <code>TargetOriginId</code> when a request matches the path pattern in <code>PathPattern</code>. You can specify the following options:</p> <ul> <li> <p> <code>allow-all</code>: Viewers can use HTTP or HTTPS.</p> </li> <li> <p> <code>redirect-to-https</code>: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL. </p> </li> <li> <p> <code>https-only</code>: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden). </p> </li> </ul> <p>For more information about requiring the HTTPS protocol, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html\">Using an HTTPS Connection to Access Your Objects</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <note> <p>The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </note>"
|
||||
},
|
||||
"MinTTL":{
|
||||
"shape":"long",
|
||||
"documentation":"<p>The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p> <p>You must specify <code>0</code> for <code>MinTTL</code> if you configure CloudFront to forward all headers to your origin (under <code>Headers</code>, if you specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>).</p>"
|
||||
},
|
||||
"AllowedMethods":{"shape":"AllowedMethods"},
|
||||
"SmoothStreaming":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify <code>true</code>; if not, specify <code>false</code>. If you specify <code>true</code> for <code>SmoothStreaming</code>, you can still distribute other content using this cache behavior if the content matches the value of <code>PathPattern</code>. </p>"
|
||||
},
|
||||
"DefaultTTL":{
|
||||
"shape":"long",
|
||||
"documentation":"<p>The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> to objects. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"MaxTTL":{
|
||||
"shape":"long",
|
||||
"documentation":"<p>The maximum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin adds HTTP headers such as <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> to objects. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"Compress":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify true; if not, specify false. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html\">Serving Compressed Files</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"LambdaFunctionAssociations":{
|
||||
"shape":"LambdaFunctionAssociations",
|
||||
"documentation":"<p>A complex type that contains zero or more Lambda function associations for a cache behavior.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that describes how CloudFront processes requests.</p> <p>You must create at least as many cache behaviors (including the default cache behavior) as you have origins if you want CloudFront to distribute objects from all of the origins. Each cache behavior specifies the one origin from which you want CloudFront to get objects. If you have two origins and only the default cache behavior, the default cache behavior will cause CloudFront to get objects from one of the origins, but the other origin is never used.</p> <p>For the current limit on the number of cache behaviors that you can add to a distribution, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_cloudfront\">Amazon CloudFront Limits</a> in the <i>AWS General Reference</i>.</p> <p>If you don't want to specify any cache behaviors, include only an empty <code>CacheBehaviors</code> element. Don't include an empty <code>CacheBehavior</code> element, or CloudFront returns a <code>MalformedXML</code> error.</p> <p>To delete all cache behaviors in an existing distribution, update the distribution configuration and include only an empty <code>CacheBehaviors</code> element.</p> <p>To add, change, or remove one or more cache behaviors, update the distribution configuration and specify all of the cache behaviors that you want to include in the updated distribution.</p> <p>For more information about cache behaviors, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior\">Cache Behaviors</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"CacheBehaviorList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"CacheBehavior",
|
||||
"locationName":"CacheBehavior"
|
||||
}
|
||||
},
|
||||
"CacheBehaviors":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of cache behaviors for this distribution. </p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"CacheBehaviorList",
|
||||
"documentation":"<p>Optional: A complex type that contains cache behaviors for this distribution. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains zero or more <code>CacheBehavior</code> elements. </p>"
|
||||
},
|
||||
"CachedMethods":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Quantity",
|
||||
"Items"
|
||||
],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of HTTP methods for which you want CloudFront to cache responses. Valid values are <code>2</code> (for caching responses to <code>GET</code> and <code>HEAD</code> requests) and <code>3</code> (for caching responses to <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests).</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"MethodsList",
|
||||
"documentation":"<p>A complex type that contains the HTTP methods that you want CloudFront to cache responses to.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that controls whether CloudFront caches the response to requests using the specified HTTP methods. There are two choices:</p> <ul> <li> <p>CloudFront caches responses to <code>GET</code> and <code>HEAD</code> requests.</p> </li> <li> <p>CloudFront caches responses to <code>GET</code>, <code>HEAD</code>, and <code>OPTIONS</code> requests.</p> </li> </ul> <p>If you pick the second choice for your Amazon S3 Origin, you may need to forward Access-Control-Request-Method, Access-Control-Request-Headers, and Origin headers for the responses to be cached correctly. </p>"
|
||||
},
|
||||
"CertificateSource":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"cloudfront",
|
||||
"iam",
|
||||
"acm"
|
||||
]
|
||||
},
|
||||
"CloudFrontOriginAccessIdentity":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Id",
|
||||
"S3CanonicalUserId"
|
||||
],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The ID for the origin access identity. For example: <code>E74FTE3AJFJ256A</code>. </p>"
|
||||
},
|
||||
"S3CanonicalUserId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The Amazon S3 canonical user ID for the origin access identity, used when giving the origin access identity read permission to an object in Amazon S3. </p>"
|
||||
},
|
||||
"CloudFrontOriginAccessIdentityConfig":{
|
||||
"shape":"CloudFrontOriginAccessIdentityConfig",
|
||||
"documentation":"<p>The current configuration information for the identity. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>CloudFront origin access identity.</p>"
|
||||
},
|
||||
"CloudFrontOriginAccessIdentityAlreadyExists":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>If the <code>CallerReference</code> is a value you already sent in a previous request to create an identity but the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is different from the original request, CloudFront returns a <code>CloudFrontOriginAccessIdentityAlreadyExists</code> error. </p>",
|
||||
"error":{"httpStatusCode":409},
|
||||
"exception":true
|
||||
},
|
||||
"CloudFrontOriginAccessIdentityConfig":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"CallerReference",
|
||||
"Comment"
|
||||
],
|
||||
"members":{
|
||||
"CallerReference":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>A unique number that ensures the request can't be replayed.</p> <p>If the <code>CallerReference</code> is new (no matter the content of the <code>CloudFrontOriginAccessIdentityConfig</code> object), a new origin access identity is created.</p> <p>If the <code>CallerReference</code> is a value already sent in a previous identity request, and the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is identical to the original request (ignoring white space), the response includes the same information returned to the original request. </p> <p>If the <code>CallerReference</code> is a value you already sent in a previous request to create an identity, but the content of the <code>CloudFrontOriginAccessIdentityConfig</code> is different from the original request, CloudFront returns a <code>CloudFrontOriginAccessIdentityAlreadyExists</code> error. </p>"
|
||||
},
|
||||
"Comment":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Any comments you want to include about the origin access identity. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Origin access identity configuration. Send a <code>GET</code> request to the <code>/<i>CloudFront API version</i>/CloudFront/identity ID/config</code> resource. </p>"
|
||||
},
|
||||
"CloudFrontOriginAccessIdentityInUse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":409},
|
||||
"exception":true
|
||||
},
|
||||
"CloudFrontOriginAccessIdentityList":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Marker",
|
||||
"MaxItems",
|
||||
"IsTruncated",
|
||||
"Quantity"
|
||||
],
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response (which is also the ID of the last identity on that page). </p>"
|
||||
},
|
||||
"NextMarker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>If <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value you can use for the <code>Marker</code> request parameter to continue listing your origin access identities where they left off. </p>"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The maximum number of origin access identities you want in the response body. </p>"
|
||||
},
|
||||
"IsTruncated":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>A flag that indicates whether more origin access identities remain to be listed. If your results were truncated, you can make a follow-up pagination request using the <code>Marker</code> request parameter to retrieve more items in the list.</p>"
|
||||
},
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of CloudFront origin access identities that were created by the current AWS account. </p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"CloudFrontOriginAccessIdentitySummaryList",
|
||||
"documentation":"<p>A complex type that contains one <code>CloudFrontOriginAccessIdentitySummary</code> element for each origin access identity that was created by the current AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Lists the origin access identities for CloudFront.Send a <code>GET</code> request to the <code>/<i>CloudFront API version</i>/origin-access-identity/cloudfront</code> resource. The response includes a <code>CloudFrontOriginAccessIdentityList</code> element with zero or more <code>CloudFrontOriginAccessIdentitySummary</code> child elements. By default, your entire list of origin access identities is returned in one single page. If the list is long, you can paginate it using the <code>MaxItems</code> and <code>Marker</code> parameters.</p>"
|
||||
},
|
||||
"CloudFrontOriginAccessIdentitySummary":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Id",
|
||||
"S3CanonicalUserId",
|
||||
"Comment"
|
||||
],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The ID for the origin access identity. For example: <code>E74FTE3AJFJ256A</code>.</p>"
|
||||
},
|
||||
"S3CanonicalUserId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The Amazon S3 canonical user ID for the origin access identity, which you use when giving the origin access identity read permission to an object in Amazon S3.</p>"
|
||||
},
|
||||
"Comment":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The comment for this origin access identity, as originally specified when created.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Summary of the information about a CloudFront origin access identity.</p>"
|
||||
},
|
||||
"CloudFrontOriginAccessIdentitySummaryList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"CloudFrontOriginAccessIdentitySummary",
|
||||
"locationName":"CloudFrontOriginAccessIdentitySummary"
|
||||
}
|
||||
},
|
||||
"CookieNameList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"string",
|
||||
"locationName":"Name"
|
||||
}
|
||||
},
|
||||
"CookieNames":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of different cookies that you want CloudFront to forward to the origin for this cache behavior.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"CookieNameList",
|
||||
"documentation":"<p>A complex type that contains one <code>Name</code> element for each cookie that you want CloudFront to forward to the origin for this cache behavior.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html\">How CloudFront Forwards, Caches, and Logs Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"CookiePreference":{
|
||||
"type":"structure",
|
||||
"required":["Forward"],
|
||||
"members":{
|
||||
"Forward":{
|
||||
"shape":"ItemSelection",
|
||||
"documentation":"<p>Specifies which cookies to forward to the origin for this cache behavior: all, none, or the list of cookies specified in the <code>WhitelistedNames</code> complex type.</p> <p>Amazon S3 doesn't process cookies. When the cache behavior is forwarding requests to an Amazon S3 origin, specify none for the <code>Forward</code> element. </p>"
|
||||
},
|
||||
"WhitelistedNames":{
|
||||
"shape":"CookieNames",
|
||||
"documentation":"<p>Required if you specify <code>whitelist</code> for the value of <code>Forward:</code>. A complex type that specifies how many different cookies you want CloudFront to forward to the origin for this cache behavior and, if you want to forward selected cookies, the names of those cookies.</p> <p>If you specify <code>all</code> or none for the value of <code>Forward</code>, omit <code>WhitelistedNames</code>. If you change the value of <code>Forward</code> from <code>whitelist</code> to all or none and you don't delete the <code>WhitelistedNames</code> element and its child elements, CloudFront deletes them automatically.</p> <p>For the current limit on the number of cookie names that you can whitelist for each cache behavior, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_cloudfront\">Amazon CloudFront Limits</a> in the <i>AWS General Reference</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html\">How CloudFront Forwards, Caches, and Logs Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"CreateCloudFrontOriginAccessIdentityRequest":{
|
||||
"type":"structure",
|
||||
"required":["CloudFrontOriginAccessIdentityConfig"],
|
||||
"members":{
|
||||
"CloudFrontOriginAccessIdentityConfig":{
|
||||
"shape":"CloudFrontOriginAccessIdentityConfig",
|
||||
"documentation":"<p>The current configuration information for the identity.</p>",
|
||||
"locationName":"CloudFrontOriginAccessIdentityConfig",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to create a new origin access identity.</p>",
|
||||
"payload":"CloudFrontOriginAccessIdentityConfig"
|
||||
},
|
||||
"CreateCloudFrontOriginAccessIdentityResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CloudFrontOriginAccessIdentity":{
|
||||
"shape":"CloudFrontOriginAccessIdentity",
|
||||
"documentation":"<p>The origin access identity's information.</p>"
|
||||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new origin access identity just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/origin-access-identity/cloudfront/E74FTE3AJFJ256A</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the origin access identity created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"CloudFrontOriginAccessIdentity"
|
||||
},
|
||||
"CreateDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":["DistributionConfig"],
|
||||
"members":{
|
||||
"DistributionConfig":{
|
||||
"shape":"DistributionConfig",
|
||||
"documentation":"<p>The distribution's configuration information.</p>",
|
||||
"locationName":"DistributionConfig",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to create a new distribution.</p>",
|
||||
"payload":"DistributionConfig"
|
||||
},
|
||||
"CreateDistributionResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Distribution":{
|
||||
"shape":"Distribution",
|
||||
"documentation":"<p>The distribution's information.</p>"
|
||||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new distribution resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the distribution created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"Distribution"
|
||||
},
|
||||
"CreateDistributionWithTagsRequest":{
|
||||
"type":"structure",
|
||||
"required":["DistributionConfigWithTags"],
|
||||
"members":{
|
||||
"DistributionConfigWithTags":{
|
||||
"shape":"DistributionConfigWithTags",
|
||||
"documentation":"<p>The distribution's configuration information. </p>",
|
||||
"locationName":"DistributionConfigWithTags",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to create a new distribution with tags. </p>",
|
||||
"payload":"DistributionConfigWithTags"
|
||||
},
|
||||
"CreateDistributionWithTagsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Distribution":{
|
||||
"shape":"Distribution",
|
||||
"documentation":"<p>The distribution's information. </p>"
|
||||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new distribution resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/distribution/EDFDVBD632BHDS5</code>. </p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the distribution created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request. </p>",
|
||||
"payload":"Distribution"
|
||||
},
|
||||
"CreateInvalidationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DistributionId",
|
||||
"InvalidationBatch"
|
||||
],
|
||||
"members":{
|
||||
"DistributionId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution's id.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"DistributionId"
|
||||
},
|
||||
"InvalidationBatch":{
|
||||
"shape":"InvalidationBatch",
|
||||
"documentation":"<p>The batch information for the invalidation.</p>",
|
||||
"locationName":"InvalidationBatch",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to create an invalidation.</p>",
|
||||
"payload":"InvalidationBatch"
|
||||
},
|
||||
"CreateInvalidationResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the distribution and invalidation batch request, including the <code>Invalidation ID</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
"Invalidation":{
|
||||
"shape":"Invalidation",
|
||||
"documentation":"<p>The invalidation's information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"Invalidation"
|
||||
},
|
||||
"CreateStreamingDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":["StreamingDistributionConfig"],
|
||||
"members":{
|
||||
"StreamingDistributionConfig":{
|
||||
"shape":"StreamingDistributionConfig",
|
||||
"documentation":"<p>The streaming distribution's configuration information.</p>",
|
||||
"locationName":"StreamingDistributionConfig",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to create a new streaming distribution.</p>",
|
||||
"payload":"StreamingDistributionConfig"
|
||||
},
|
||||
"CreateStreamingDistributionResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StreamingDistribution":{
|
||||
"shape":"StreamingDistribution",
|
||||
"documentation":"<p>The streaming distribution's information.</p>"
|
||||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new streaming distribution resource just created. For example: <code>https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the streaming distribution created.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"StreamingDistribution"
|
||||
},
|
||||
"CreateStreamingDistributionWithTagsRequest":{
|
||||
"type":"structure",
|
||||
"required":["StreamingDistributionConfigWithTags"],
|
||||
"members":{
|
||||
"StreamingDistributionConfigWithTags":{
|
||||
"shape":"StreamingDistributionConfigWithTags",
|
||||
"documentation":"<p> The streaming distribution's configuration information. </p>",
|
||||
"locationName":"StreamingDistributionConfigWithTags",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to create a new streaming distribution with tags.</p>",
|
||||
"payload":"StreamingDistributionConfigWithTags"
|
||||
},
|
||||
"CreateStreamingDistributionWithTagsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StreamingDistribution":{
|
||||
"shape":"StreamingDistribution",
|
||||
"documentation":"<p>The streaming distribution's information. </p>"
|
||||
},
|
||||
"Location":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The fully qualified URI of the new streaming distribution resource just created. For example:<code> https://cloudfront.amazonaws.com/2010-11-01/streaming-distribution/EGTXBD79H29TRA8</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"Location"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request. </p>",
|
||||
"payload":"StreamingDistribution"
|
||||
},
|
||||
"CustomErrorResponse":{
|
||||
"type":"structure",
|
||||
"required":["ErrorCode"],
|
||||
"members":{
|
||||
"ErrorCode":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The HTTP status code for which you want to specify a custom error page and/or a caching duration.</p>"
|
||||
},
|
||||
"ResponsePagePath":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The path to the custom error page that you want CloudFront to return to a viewer when your origin returns the HTTP status code specified by <code>ErrorCode</code>, for example, <code>/4xx-errors/403-forbidden.html</code>. If you want to store your objects and your custom error pages in different locations, your distribution must include a cache behavior for which the following is true:</p> <ul> <li> <p>The value of <code>PathPattern</code> matches the path to your custom error messages. For example, suppose you saved custom error pages for 4xx errors in an Amazon S3 bucket in a directory named <code>/4xx-errors</code>. Your distribution must include a cache behavior for which the path pattern routes requests for your custom error pages to that location, for example, <code>/4xx-errors/*</code>. </p> </li> <li> <p>The value of <code>TargetOriginId</code> specifies the value of the <code>ID</code> element for the origin that contains your custom error pages.</p> </li> </ul> <p>If you specify a value for <code>ResponsePagePath</code>, you must also specify a value for <code>ResponseCode</code>. If you don't want to specify a value, include an empty element, <code><ResponsePagePath></code>, in the XML document.</p> <p>We recommend that you store custom error pages in an Amazon S3 bucket. If you store custom error pages on an HTTP server and the server starts to return 5xx errors, CloudFront can't get the files that you want to return to viewers because the origin server is unavailable.</p>"
|
||||
},
|
||||
"ResponseCode":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The HTTP status code that you want CloudFront to return to the viewer along with the custom error page. There are a variety of reasons that you might want CloudFront to return a status code different from the status code that your origin returned to CloudFront, for example:</p> <ul> <li> <p>Some Internet devices (some firewalls and corporate proxies, for example) intercept HTTP 4xx and 5xx and prevent the response from being returned to the viewer. If you substitute <code>200</code>, the response typically won't be intercepted.</p> </li> <li> <p>If you don't care about distinguishing among different client errors or server errors, you can specify <code>400</code> or <code>500</code> as the <code>ResponseCode</code> for all 4xx or 5xx errors.</p> </li> <li> <p>You might want to return a <code>200</code> status code (OK) and static website so your customers don't know that your website is down.</p> </li> </ul> <p>If you specify a value for <code>ResponseCode</code>, you must also specify a value for <code>ResponsePagePath</code>. If you don't want to specify a value, include an empty element, <code><ResponseCode></code>, in the XML document.</p>"
|
||||
},
|
||||
"ErrorCachingMinTTL":{
|
||||
"shape":"long",
|
||||
"documentation":"<p>The minimum amount of time, in seconds, that you want CloudFront to cache the HTTP status code specified in <code>ErrorCode</code>. When this time period has elapsed, CloudFront queries your origin to see whether the problem that caused the error has been resolved and the requested object is now available.</p> <p>If you don't want to specify a value, include an empty element, <code><ErrorCachingMinTTL></code>, in the XML document.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that controls:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer. </p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"CustomErrorResponseList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"CustomErrorResponse",
|
||||
"locationName":"CustomErrorResponse"
|
||||
}
|
||||
},
|
||||
"CustomErrorResponses":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of HTTP status codes for which you want to specify a custom error page and/or a caching duration. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"CustomErrorResponseList",
|
||||
"documentation":"<p>A complex type that contains a <code>CustomErrorResponse</code> element for each HTTP status code for which you want to specify a custom error page and/or a caching duration. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that controls:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.</p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"CustomHeaders":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of custom headers, if any, for this distribution.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"OriginCustomHeadersList",
|
||||
"documentation":"<p> <b>Optional</b>: A list that contains one <code>OriginCustomHeader</code> element for each custom header that you want CloudFront to forward to the origin. If Quantity is <code>0</code>, omit <code>Items</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains the list of Custom Headers for each origin. </p>"
|
||||
},
|
||||
"CustomOriginConfig":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"HTTPPort",
|
||||
"HTTPSPort",
|
||||
"OriginProtocolPolicy"
|
||||
],
|
||||
"members":{
|
||||
"HTTPPort":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The HTTP port the custom origin listens on.</p>"
|
||||
},
|
||||
"HTTPSPort":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The HTTPS port the custom origin listens on.</p>"
|
||||
},
|
||||
"OriginProtocolPolicy":{
|
||||
"shape":"OriginProtocolPolicy",
|
||||
"documentation":"<p>The origin protocol policy to apply to your origin.</p>"
|
||||
},
|
||||
"OriginSslProtocols":{
|
||||
"shape":"OriginSslProtocols",
|
||||
"documentation":"<p>The SSL/TLS protocols that you want CloudFront to use when communicating with your origin over HTTPS.</p>"
|
||||
},
|
||||
"OriginReadTimeout":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>You can create a custom origin read timeout. All timeout units are in seconds. The default origin read timeout is 30 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 4 seconds; the maximum is 60 seconds.</p> <p>If you need to increase the maximum time limit, contact the <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support Center</a>.</p>"
|
||||
},
|
||||
"OriginKeepaliveTimeout":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>You can create a custom keep-alive timeout. All timeout units are in seconds. The default keep-alive timeout is 5 seconds, but you can configure custom timeout lengths using the CloudFront API. The minimum timeout length is 1 second; the maximum is 60 seconds.</p> <p>If you need to increase the maximum time limit, contact the <a href=\"https://console.aws.amazon.com/support/home#/\">AWS Support Center</a>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A customer origin.</p>"
|
||||
},
|
||||
"DefaultCacheBehavior":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TargetOriginId",
|
||||
"ForwardedValues",
|
||||
"TrustedSigners",
|
||||
"ViewerProtocolPolicy",
|
||||
"MinTTL"
|
||||
],
|
||||
"members":{
|
||||
"TargetOriginId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of <code>ID</code> for the origin that you want CloudFront to route requests to when a request matches the path pattern either for a cache behavior or for the default cache behavior.</p>"
|
||||
},
|
||||
"ForwardedValues":{
|
||||
"shape":"ForwardedValues",
|
||||
"documentation":"<p>A complex type that specifies how CloudFront handles query strings and cookies.</p>"
|
||||
},
|
||||
"TrustedSigners":{
|
||||
"shape":"TrustedSigners",
|
||||
"documentation":"<p>A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.</p> <p>If you want to require signed URLs in requests for objects in the target origin that match the <code>PathPattern</code> for this cache behavior, specify <code>true</code> for <code>Enabled</code>, and specify the applicable values for <code>Quantity</code> and <code>Items</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p> <p>If you don't want to require signed URLs in requests for objects that match <code>PathPattern</code>, specify <code>false</code> for <code>Enabled</code> and <code>0</code> for <code>Quantity</code>. Omit <code>Items</code>.</p> <p>To add, change, or remove one or more trusted signers, change <code>Enabled</code> to <code>true</code> (if it's currently <code>false</code>), change <code>Quantity</code> as applicable, and specify all of the trusted signers that you want to include in the updated distribution.</p>"
|
||||
},
|
||||
"ViewerProtocolPolicy":{
|
||||
"shape":"ViewerProtocolPolicy",
|
||||
"documentation":"<p>The protocol that viewers can use to access the files in the origin specified by <code>TargetOriginId</code> when a request matches the path pattern in <code>PathPattern</code>. You can specify the following options:</p> <ul> <li> <p> <code>allow-all</code>: Viewers can use HTTP or HTTPS.</p> </li> <li> <p> <code>redirect-to-https</code>: If a viewer submits an HTTP request, CloudFront returns an HTTP status code of 301 (Moved Permanently) to the viewer along with the HTTPS URL. The viewer then resubmits the request using the new URL.</p> </li> <li> <p> <code>https-only</code>: If a viewer sends an HTTP request, CloudFront returns an HTTP status code of 403 (Forbidden).</p> </li> </ul> <p>For more information about requiring the HTTPS protocol, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html\">Using an HTTPS Connection to Access Your Objects</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <note> <p>The only way to guarantee that viewers retrieve an object that was fetched from the origin using HTTPS is never to use any other protocol to fetch the object. If you have recently changed from HTTP to HTTPS, we recommend that you clear your objects' cache because cached objects are protocol agnostic. That means that an edge location will return an object from the cache regardless of whether the current request protocol matches the protocol used previously. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </note>"
|
||||
},
|
||||
"MinTTL":{
|
||||
"shape":"long",
|
||||
"documentation":"<p>The minimum amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p> <p>You must specify <code>0</code> for <code>MinTTL</code> if you configure CloudFront to forward all headers to your origin (under <code>Headers</code>, if you specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>).</p>"
|
||||
},
|
||||
"AllowedMethods":{"shape":"AllowedMethods"},
|
||||
"SmoothStreaming":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Indicates whether you want to distribute media files in the Microsoft Smooth Streaming format using the origin that is associated with this cache behavior. If so, specify <code>true</code>; if not, specify <code>false</code>. If you specify <code>true</code> for <code>SmoothStreaming</code>, you can still distribute other content using this cache behavior if the content matches the value of <code>PathPattern</code>. </p>"
|
||||
},
|
||||
"DefaultTTL":{
|
||||
"shape":"long",
|
||||
"documentation":"<p>The default amount of time that you want objects to stay in CloudFront caches before CloudFront forwards another request to your origin to determine whether the object has been updated. The value that you specify applies only when your origin does not add HTTP headers such as <code>Cache-Control max-age</code>, <code>Cache-Control s-maxage</code>, and <code>Expires</code> to objects. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Expiration.html\">Specifying How Long Objects and Errors Stay in a CloudFront Edge Cache (Expiration)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"MaxTTL":{"shape":"long"},
|
||||
"Compress":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Whether you want CloudFront to automatically compress certain files for this cache behavior. If so, specify <code>true</code>; if not, specify <code>false</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html\">Serving Compressed Files</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"LambdaFunctionAssociations":{
|
||||
"shape":"LambdaFunctionAssociations",
|
||||
"documentation":"<p>A complex type that contains zero or more Lambda function associations for a cache behavior.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that describes the default cache behavior if you do not specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>"
|
||||
},
|
||||
"DeleteCloudFrontOriginAccessIdentityRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The origin access identity's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
},
|
||||
"IfMatch":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of the <code>ETag</code> header you received from a previous <code>GET</code> or <code>PUT</code> request. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"If-Match"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Deletes a origin access identity.</p>"
|
||||
},
|
||||
"DeleteDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution ID. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
},
|
||||
"IfMatch":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of the <code>ETag</code> header that you received when you disabled the distribution. For example: <code>E2QWRUHAPOMQZL</code>. </p>",
|
||||
"location":"header",
|
||||
"locationName":"If-Match"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>This action deletes a web distribution. To delete a web distribution using the CloudFront API, perform the following steps.</p> <p> <b>To delete a web distribution using the CloudFront API:</b> </p> <ol> <li> <p>Disable the web distribution </p> </li> <li> <p>Submit a <code>GET Distribution Config</code> request to get the current configuration and the <code>Etag</code> header for the distribution.</p> </li> <li> <p>Update the XML document that was returned in the response to your <code>GET Distribution Config</code> request to change the value of <code>Enabled</code> to <code>false</code>.</p> </li> <li> <p>Submit a <code>PUT Distribution Config</code> request to update the configuration for your distribution. In the request body, include the XML document that you updated in Step 3. Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Distribution Config</code> request in Step 2.</p> </li> <li> <p>Review the response to the <code>PUT Distribution Config</code> request to confirm that the distribution was successfully disabled.</p> </li> <li> <p>Submit a <code>GET Distribution</code> request to confirm that your changes have propagated. When propagation is complete, the value of <code>Status</code> is <code>Deployed</code>.</p> </li> <li> <p>Submit a <code>DELETE Distribution</code> request. Set the value of the HTTP <code>If-Match</code> header to the value of the <code>ETag</code> header that CloudFront returned when you submitted the <code>GET Distribution Config</code> request in Step 6.</p> </li> <li> <p>Review the response to your <code>DELETE Distribution</code> request to confirm that the distribution was successfully deleted.</p> </li> </ol> <p>For information about deleting a distribution using the CloudFront console, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToDeleteDistribution.html\">Deleting a Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"DeleteStreamingDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution ID. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
},
|
||||
"IfMatch":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of the <code>ETag</code> header that you received when you disabled the streaming distribution. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"If-Match"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to delete a streaming distribution.</p>"
|
||||
},
|
||||
"Distribution":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Id",
|
||||
"ARN",
|
||||
"Status",
|
||||
"LastModifiedTime",
|
||||
"InProgressInvalidationBatches",
|
||||
"DomainName",
|
||||
"ActiveTrustedSigners",
|
||||
"DistributionConfig"
|
||||
],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The identifier for the distribution. For example: <code>EDFDVBD632BHDS5</code>. </p>"
|
||||
},
|
||||
"ARN":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The ARN (Amazon Resource Name) for the distribution. For example: <code>arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your AWS account ID.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>This response element indicates the current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is fully propagated to all CloudFront edge locations. </p>"
|
||||
},
|
||||
"LastModifiedTime":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>The date and time the distribution was last modified. </p>"
|
||||
},
|
||||
"InProgressInvalidationBatches":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of invalidation batches currently in progress. </p>"
|
||||
},
|
||||
"DomainName":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The domain name corresponding to the distribution. For example: <code>d604721fxaaqy9.cloudfront.net</code>. </p>"
|
||||
},
|
||||
"ActiveTrustedSigners":{
|
||||
"shape":"ActiveTrustedSigners",
|
||||
"documentation":"<p>CloudFront automatically adds this element to the response only if you've set up the distribution to serve private content with signed URLs. The element lists the key pair IDs that CloudFront is aware of for each trusted signer. The <code>Signer</code> child element lists the AWS account number of the trusted signer (or an empty <code>Self</code> element if the signer is you). The <code>Signer</code> element also includes the IDs of any active key pairs associated with the trusted signer's AWS account. If no <code>KeyPairId</code> element appears for a <code>Signer</code>, that signer can't create working signed URLs.</p>"
|
||||
},
|
||||
"DistributionConfig":{
|
||||
"shape":"DistributionConfig",
|
||||
"documentation":"<p>The current configuration information for the distribution. Send a <code>GET</code> request to the <code>/<i>CloudFront API version</i>/distribution ID/config</code> resource.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The distribution's information.</p>"
|
||||
},
|
||||
"DistributionAlreadyExists":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The caller reference you attempted to create the distribution with is associated with another distribution.</p>",
|
||||
"error":{"httpStatusCode":409},
|
||||
"exception":true
|
||||
},
|
||||
"DistributionConfig":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"CallerReference",
|
||||
"Origins",
|
||||
"DefaultCacheBehavior",
|
||||
"Comment",
|
||||
"Enabled"
|
||||
],
|
||||
"members":{
|
||||
"CallerReference":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>A unique value (for example, a date-time stamp) that ensures that the request can't be replayed.</p> <p>If the value of <code>CallerReference</code> is new (regardless of the content of the <code>DistributionConfig</code> object), CloudFront creates a new distribution.</p> <p>If <code>CallerReference</code> is a value you already sent in a previous request to create a distribution, and if the content of the <code>DistributionConfig</code> is identical to the original request (ignoring white space), CloudFront returns the same the response that it returned to the original request.</p> <p>If <code>CallerReference</code> is a value you already sent in a previous request to create a distribution but the content of the <code>DistributionConfig</code> is different from the original request, CloudFront returns a <code>DistributionAlreadyExists</code> error.</p>"
|
||||
},
|
||||
"Aliases":{
|
||||
"shape":"Aliases",
|
||||
"documentation":"<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.</p>"
|
||||
},
|
||||
"DefaultRootObject":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The object that you want CloudFront to request from your origin (for example, <code>index.html</code>) when a viewer requests the root URL for your distribution (<code>http://www.example.com</code>) instead of an object in your distribution (<code>http://www.example.com/product-description.html</code>). Specifying a default root object avoids exposing the contents of your distribution.</p> <p>Specify only the object name, for example, <code>index.html</code>. Do not add a <code>/</code> before the object name.</p> <p>If you don't want to specify a default root object when you create a distribution, include an empty <code>DefaultRootObject</code> element.</p> <p>To delete the default root object from an existing distribution, update the distribution configuration and include an empty <code>DefaultRootObject</code> element.</p> <p>To replace the default root object, update the distribution configuration and specify the new object.</p> <p>For more information about the default root object, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/DefaultRootObject.html\">Creating a Default Root Object</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"Origins":{
|
||||
"shape":"Origins",
|
||||
"documentation":"<p>A complex type that contains information about origins for this distribution. </p>"
|
||||
},
|
||||
"DefaultCacheBehavior":{
|
||||
"shape":"DefaultCacheBehavior",
|
||||
"documentation":"<p>A complex type that describes the default cache behavior if you do not specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>"
|
||||
},
|
||||
"CacheBehaviors":{
|
||||
"shape":"CacheBehaviors",
|
||||
"documentation":"<p>A complex type that contains zero or more <code>CacheBehavior</code> elements. </p>"
|
||||
},
|
||||
"CustomErrorResponses":{
|
||||
"shape":"CustomErrorResponses",
|
||||
"documentation":"<p>A complex type that controls the following:</p> <ul> <li> <p>Whether CloudFront replaces HTTP status codes in the 4xx and 5xx range with custom error messages before returning the response to the viewer.</p> </li> <li> <p>How long CloudFront caches HTTP status codes in the 4xx and 5xx range.</p> </li> </ul> <p>For more information about custom error pages, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/custom-error-pages.html\">Customizing Error Responses</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"Comment":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Any comments you want to include about the distribution.</p> <p>If you don't want to specify a comment, include an empty <code>Comment</code> element.</p> <p>To delete an existing comment, update the distribution configuration and include an empty <code>Comment</code> element.</p> <p>To add or change a comment, update the distribution configuration and specify the new comment.</p>"
|
||||
},
|
||||
"Logging":{
|
||||
"shape":"LoggingConfig",
|
||||
"documentation":"<p>A complex type that controls whether access logs are written for the distribution.</p> <p>For more information about logging, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/AccessLogs.html\">Access Logs</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"PriceClass":{
|
||||
"shape":"PriceClass",
|
||||
"documentation":"<p>The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify <code>PriceClass_All</code>, CloudFront responds to requests for your objects from all CloudFront edge locations.</p> <p>If you specify a price class other than <code>PriceClass_All</code>, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.</p> <p>For more information about price classes, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PriceClass.html\">Choosing the Price Class for a CloudFront Distribution</a> in the <i>Amazon CloudFront Developer Guide</i>. For information about CloudFront pricing, including how price classes map to CloudFront regions, see <a href=\"https://aws.amazon.com/cloudfront/pricing/\">Amazon CloudFront Pricing</a>.</p>"
|
||||
},
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>From this field, you can enable or disable the selected distribution.</p> <p>If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code> and <code>Prefix</code>, the values are automatically deleted.</p>"
|
||||
},
|
||||
"ViewerCertificate":{"shape":"ViewerCertificate"},
|
||||
"Restrictions":{"shape":"Restrictions"},
|
||||
"WebACLId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>A unique identifier that specifies the AWS WAF web ACL, if any, to associate with this distribution.</p> <p>AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to CloudFront, and lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, CloudFront responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You can also configure CloudFront to return a custom error page when a request is blocked. For more information about AWS WAF, see the <a href=\"http://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html\">AWS WAF Developer Guide</a>. </p>"
|
||||
},
|
||||
"HttpVersion":{
|
||||
"shape":"HttpVersion",
|
||||
"documentation":"<p>(Optional) Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is http2. Viewers that don't support HTTP/2 automatically use an earlier HTTP version.</p> <p>For viewers and CloudFront to use HTTP/2, viewers must support TLS 1.2 or later, and must support Server Name Identification (SNI).</p> <p>In general, configuring CloudFront to communicate with viewers using HTTP/2 reduces latency. You can improve performance by optimizing for HTTP/2. For more information, do an Internet search for \"http/2 optimization.\" </p>"
|
||||
},
|
||||
"IsIPV6Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>If you want CloudFront to respond to IPv6 DNS requests with an IPv6 address for your distribution, specify <code>true</code>. If you specify <code>false</code>, CloudFront responds to IPv6 DNS requests with the DNS response code <code>NOERROR</code> and with no IP addresses. This allows viewers to submit a second request, for an IPv4 address for your distribution. </p> <p>In general, you should enable IPv6 if you have users on IPv6 networks who want to access your content. However, if you're using signed URLs or signed cookies to restrict access to your content, and if you're using a custom policy that includes the <code>IpAddress</code> parameter to restrict the IP addresses that can access your content, do not enable IPv6. If you want to restrict access to some content by IP address and not restrict access to other content (or restrict access but not by IP address), you can create two distributions. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-creating-signed-url-custom-policy.html\">Creating a Signed URL Using a Custom Policy</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> <p>If you're using an Amazon Route 53 alias resource record set to route traffic to your CloudFront distribution, you need to create a second alias resource record set when both of the following are true:</p> <ul> <li> <p>You enable IPv6 for the distribution</p> </li> <li> <p>You're using alternate domain names in the URLs for your objects</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/Route53/latest/DeveloperGuide/routing-to-cloudfront-distribution.html\">Routing Traffic to an Amazon CloudFront Web Distribution by Using Your Domain Name</a> in the <i>Amazon Route 53 Developer Guide</i>.</p> <p>If you created a CNAME resource record set, either with Amazon Route 53 or with another DNS service, you don't need to make any changes. A CNAME record will route traffic to your distribution regardless of the IP address format of the viewer request.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A distribution configuration.</p>"
|
||||
},
|
||||
"DistributionConfigWithTags":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DistributionConfig",
|
||||
"Tags"
|
||||
],
|
||||
"members":{
|
||||
"DistributionConfig":{
|
||||
"shape":"DistributionConfig",
|
||||
"documentation":"<p>A distribution configuration.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>A complex type that contains zero or more <code>Tag</code> elements.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A distribution Configuration and a list of tags to be associated with the distribution.</p>"
|
||||
},
|
||||
"DistributionList":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Marker",
|
||||
"MaxItems",
|
||||
"IsTruncated",
|
||||
"Quantity"
|
||||
],
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value you provided for the <code>Marker</code> request parameter.</p>"
|
||||
},
|
||||
"NextMarker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>If <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value you can use for the <code>Marker</code> request parameter to continue listing your distributions where they left off. </p>"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The value you provided for the <code>MaxItems</code> request parameter.</p>"
|
||||
},
|
||||
"IsTruncated":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>A flag that indicates whether more distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the <code>Marker</code> request parameter to retrieve more distributions in the list.</p>"
|
||||
},
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of distributions that were created by the current AWS account. </p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"DistributionSummaryList",
|
||||
"documentation":"<p>A complex type that contains one <code>DistributionSummary</code> element for each distribution that was created by the current AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A distribution list.</p>"
|
||||
},
|
||||
"DistributionNotDisabled":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":409},
|
||||
"exception":true
|
||||
},
|
||||
"DistributionSummary":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Id",
|
||||
"ARN",
|
||||
"Status",
|
||||
"LastModifiedTime",
|
||||
"DomainName",
|
||||
"Aliases",
|
||||
"Origins",
|
||||
"DefaultCacheBehavior",
|
||||
"CacheBehaviors",
|
||||
"CustomErrorResponses",
|
||||
"Comment",
|
||||
"PriceClass",
|
||||
"Enabled",
|
||||
"ViewerCertificate",
|
||||
"Restrictions",
|
||||
"WebACLId",
|
||||
"HttpVersion",
|
||||
"IsIPV6Enabled"
|
||||
],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The identifier for the distribution. For example: <code>EDFDVBD632BHDS5</code>.</p>"
|
||||
},
|
||||
"ARN":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The ARN (Amazon Resource Name) for the distribution. For example: <code>arn:aws:cloudfront::123456789012:distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your AWS account ID.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is propagated to all CloudFront edge locations.</p>"
|
||||
},
|
||||
"LastModifiedTime":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>The date and time the distribution was last modified.</p>"
|
||||
},
|
||||
"DomainName":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The domain name that corresponds to the distribution. For example: <code>d604721fxaaqy9.cloudfront.net</code>.</p>"
|
||||
},
|
||||
"Aliases":{
|
||||
"shape":"Aliases",
|
||||
"documentation":"<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this distribution.</p>"
|
||||
},
|
||||
"Origins":{
|
||||
"shape":"Origins",
|
||||
"documentation":"<p>A complex type that contains information about origins for this distribution.</p>"
|
||||
},
|
||||
"DefaultCacheBehavior":{
|
||||
"shape":"DefaultCacheBehavior",
|
||||
"documentation":"<p>A complex type that describes the default cache behavior if you do not specify a <code>CacheBehavior</code> element or if files don't match any of the values of <code>PathPattern</code> in <code>CacheBehavior</code> elements. You must create exactly one default cache behavior.</p>"
|
||||
},
|
||||
"CacheBehaviors":{
|
||||
"shape":"CacheBehaviors",
|
||||
"documentation":"<p>A complex type that contains zero or more <code>CacheBehavior</code> elements.</p>"
|
||||
},
|
||||
"CustomErrorResponses":{
|
||||
"shape":"CustomErrorResponses",
|
||||
"documentation":"<p>A complex type that contains zero or more <code>CustomErrorResponses</code> elements.</p>"
|
||||
},
|
||||
"Comment":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The comment originally specified when this distribution was created.</p>"
|
||||
},
|
||||
"PriceClass":{"shape":"PriceClass"},
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Whether the distribution is enabled to accept user requests for content.</p>"
|
||||
},
|
||||
"ViewerCertificate":{"shape":"ViewerCertificate"},
|
||||
"Restrictions":{"shape":"Restrictions"},
|
||||
"WebACLId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The Web ACL Id (if any) associated with the distribution.</p>"
|
||||
},
|
||||
"HttpVersion":{
|
||||
"shape":"HttpVersion",
|
||||
"documentation":"<p> Specify the maximum HTTP version that you want viewers to use to communicate with CloudFront. The default value for new web distributions is <code>http2</code>. Viewers that don't support <code>HTTP/2</code> will automatically use an earlier version.</p>"
|
||||
},
|
||||
"IsIPV6Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Whether CloudFront responds to IPv6 DNS requests with an IPv6 address for your distribution.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A summary of the information about a CloudFront distribution.</p>"
|
||||
},
|
||||
"DistributionSummaryList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"DistributionSummary",
|
||||
"locationName":"DistributionSummary"
|
||||
}
|
||||
},
|
||||
"EventType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"viewer-request",
|
||||
"viewer-response",
|
||||
"origin-request",
|
||||
"origin-response"
|
||||
]
|
||||
},
|
||||
"ForwardedValues":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"QueryString",
|
||||
"Cookies"
|
||||
],
|
||||
"members":{
|
||||
"QueryString":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Indicates whether you want CloudFront to forward query strings to the origin that is associated with this cache behavior and cache based on the query string parameters. CloudFront behavior depends on the value of <code>QueryString</code> and on the values that you specify for <code>QueryStringCacheKeys</code>, if any:</p> <p>If you specify true for <code>QueryString</code> and you don't specify any values for <code>QueryStringCacheKeys</code>, CloudFront forwards all query string parameters to the origin and caches based on all query string parameters. Depending on how many query string parameters and values you have, this can adversely affect performance because CloudFront must forward more requests to the origin.</p> <p>If you specify true for <code>QueryString</code> and you specify one or more values for <code>QueryStringCacheKeys</code>, CloudFront forwards all query string parameters to the origin, but it only caches based on the query string parameters that you specify.</p> <p>If you specify false for <code>QueryString</code>, CloudFront doesn't forward any query string parameters to the origin, and doesn't cache based on query string parameters.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/QueryStringParameters.html\">Configuring CloudFront to Cache Based on Query String Parameters</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"Cookies":{
|
||||
"shape":"CookiePreference",
|
||||
"documentation":"<p>A complex type that specifies whether you want CloudFront to forward cookies to the origin and, if so, which ones. For more information about forwarding cookies to the origin, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Cookies.html\">How CloudFront Forwards, Caches, and Logs Cookies</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"Headers":{
|
||||
"shape":"Headers",
|
||||
"documentation":"<p>A complex type that specifies the <code>Headers</code>, if any, that you want CloudFront to vary upon for this cache behavior. </p>"
|
||||
},
|
||||
"QueryStringCacheKeys":{
|
||||
"shape":"QueryStringCacheKeys",
|
||||
"documentation":"<p>A complex type that contains information about the query string parameters that you want CloudFront to use for caching for this cache behavior.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that specifies how CloudFront handles query strings and cookies.</p>"
|
||||
},
|
||||
"GeoRestriction":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"RestrictionType",
|
||||
"Quantity"
|
||||
],
|
||||
"members":{
|
||||
"RestrictionType":{
|
||||
"shape":"GeoRestrictionType",
|
||||
"documentation":"<p>The method that you want to use to restrict distribution of your content by country:</p> <ul> <li> <p> <code>none</code>: No geo restriction is enabled, meaning access to content is not restricted by client geo location.</p> </li> <li> <p> <code>blacklist</code>: The <code>Location</code> elements specify the countries in which you do not want CloudFront to distribute your content.</p> </li> <li> <p> <code>whitelist</code>: The <code>Location</code> elements specify the countries in which you want CloudFront to distribute your content.</p> </li> </ul>"
|
||||
},
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>When geo restriction is <code>enabled</code>, this is the number of countries in your <code>whitelist</code> or <code>blacklist</code>. Otherwise, when it is not enabled, <code>Quantity</code> is <code>0</code>, and you can omit <code>Items</code>.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"LocationList",
|
||||
"documentation":"<p> A complex type that contains a <code>Location</code> element for each country in which you want CloudFront either to distribute your content (<code>whitelist</code>) or not distribute your content (<code>blacklist</code>).</p> <p>The <code>Location</code> element is a two-letter, uppercase country code for a country that you want to include in your <code>blacklist</code> or <code>whitelist</code>. Include one <code>Location</code> element for each country.</p> <p>CloudFront and <code>MaxMind</code> both use <code>ISO 3166</code> country codes. For the current list of countries and the corresponding codes, see <code>ISO 3166-1-alpha-2</code> code on the <i>International Organization for Standardization</i> website. You can also refer to the country list in the CloudFront console, which includes both country names and codes.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that controls the countries in which your content is distributed. CloudFront determines the location of your users using <code>MaxMind</code> GeoIP databases. </p>"
|
||||
},
|
||||
"GeoRestrictionType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"blacklist",
|
||||
"whitelist",
|
||||
"none"
|
||||
]
|
||||
},
|
||||
"GetCloudFrontOriginAccessIdentityConfigRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The identity's ID. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The origin access identity's configuration information. For more information, see <a>CloudFrontOriginAccessIdentityConfigComplexType</a>.</p>"
|
||||
},
|
||||
"GetCloudFrontOriginAccessIdentityConfigResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CloudFrontOriginAccessIdentityConfig":{
|
||||
"shape":"CloudFrontOriginAccessIdentityConfig",
|
||||
"documentation":"<p>The origin access identity's configuration information. </p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"CloudFrontOriginAccessIdentityConfig"
|
||||
},
|
||||
"GetCloudFrontOriginAccessIdentityRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The identity's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to get an origin access identity's information.</p>"
|
||||
},
|
||||
"GetCloudFrontOriginAccessIdentityResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CloudFrontOriginAccessIdentity":{
|
||||
"shape":"CloudFrontOriginAccessIdentity",
|
||||
"documentation":"<p>The origin access identity's information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the origin access identity's information. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"CloudFrontOriginAccessIdentity"
|
||||
},
|
||||
"GetDistributionConfigRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to get a distribution configuration.</p>"
|
||||
},
|
||||
"GetDistributionConfigResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DistributionConfig":{
|
||||
"shape":"DistributionConfig",
|
||||
"documentation":"<p>The distribution's configuration information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"DistributionConfig"
|
||||
},
|
||||
"GetDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to get a distribution's information.</p>"
|
||||
},
|
||||
"GetDistributionResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Distribution":{
|
||||
"shape":"Distribution",
|
||||
"documentation":"<p>The distribution's information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the distribution's information. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"Distribution"
|
||||
},
|
||||
"GetInvalidationRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DistributionId",
|
||||
"Id"
|
||||
],
|
||||
"members":{
|
||||
"DistributionId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"DistributionId"
|
||||
},
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The identifier for the invalidation request, for example, <code>IDFDVBD632BHDS5</code>.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to get an invalidation's information. </p>"
|
||||
},
|
||||
"GetInvalidationResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Invalidation":{
|
||||
"shape":"Invalidation",
|
||||
"documentation":"<p>The invalidation's information. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/InvalidationDatatype.html\">Invalidation Complex Type</a>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"Invalidation"
|
||||
},
|
||||
"GetStreamingDistributionConfigRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The streaming distribution's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>To request to get a streaming distribution configuration.</p>"
|
||||
},
|
||||
"GetStreamingDistributionConfigResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StreamingDistributionConfig":{
|
||||
"shape":"StreamingDistributionConfig",
|
||||
"documentation":"<p>The streaming distribution's configuration information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>. </p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"StreamingDistributionConfig"
|
||||
},
|
||||
"GetStreamingDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":["Id"],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The streaming distribution's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to get a streaming distribution's information.</p>"
|
||||
},
|
||||
"GetStreamingDistributionResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StreamingDistribution":{
|
||||
"shape":"StreamingDistribution",
|
||||
"documentation":"<p>The streaming distribution's information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the streaming distribution's information. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"StreamingDistribution"
|
||||
},
|
||||
"HeaderList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"string",
|
||||
"locationName":"Name"
|
||||
}
|
||||
},
|
||||
"Headers":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of different headers that you want CloudFront to forward to the origin for this cache behavior. You can configure each cache behavior in a web distribution to do one of the following:</p> <ul> <li> <p> <b>Forward all headers to your origin</b>: Specify <code>1</code> for <code>Quantity</code> and <code>*</code> for <code>Name</code>.</p> <important> <p>If you configure CloudFront to forward all headers to your origin, CloudFront doesn't cache the objects associated with this cache behavior. Instead, it sends every request to the origin.</p> </important> </li> <li> <p> <i>Forward a whitelist of headers you specify</i>: Specify the number of headers that you want to forward, and specify the header names in <code>Name</code> elements. CloudFront caches your objects based on the values in all of the specified headers. CloudFront also forwards the headers that it forwards by default, but it caches your objects based only on the headers that you specify. </p> </li> <li> <p> <b>Forward only the default headers</b>: Specify <code>0</code> for <code>Quantity</code> and omit <code>Items</code>. In this configuration, CloudFront doesn't cache based on the values in the request headers.</p> </li> </ul>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"HeaderList",
|
||||
"documentation":"<p>A complex type that contains one <code>Name</code> element for each header that you want CloudFront to forward to the origin and to vary on for this cache behavior. If <code>Quantity</code> is <code>0</code>, omit <code>Items</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that specifies the headers that you want CloudFront to forward to the origin for this cache behavior.</p> <p>For the headers that you specify, CloudFront also caches separate versions of a specified object based on the header values in viewer requests. For example, suppose viewer requests for <code>logo.jpg</code> contain a custom <code>Product</code> header that has a value of either <code>Acme</code> or <code>Apex</code>, and you configure CloudFront to cache your content based on values in the <code>Product</code> header. CloudFront forwards the <code>Product</code> header to the origin and caches the response from the origin once for each header value. For more information about caching based on header values, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/header-caching.html\">How CloudFront Forwards and Caches Headers</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"HttpVersion":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"http1.1",
|
||||
"http2"
|
||||
]
|
||||
},
|
||||
"IllegalUpdate":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Origin and <code>CallerReference</code> cannot be updated. </p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InconsistentQuantities":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The value of <code>Quantity</code> and the size of <code>Items</code> do not match.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidArgument":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The argument is invalid.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidDefaultRootObject":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The default root object file name is too big or contains an invalid character.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidErrorCode":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidForwardCookies":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Your request contains forward cookies option which doesn't match with the expectation for the <code>whitelisted</code> list of cookie names. Either list of cookie names has been specified when not allowed or list of cookie names is missing when expected.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidGeoRestrictionParameter":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidHeadersForS3Origin":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidIfMatchVersion":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The <code>If-Match</code> version is missing or not valid for the distribution.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidLambdaFunctionAssociation":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The specified Lambda function association is invalid.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidLocationCode":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidMinimumProtocolVersion":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidOrigin":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The Amazon S3 origin server specified does not refer to a valid Amazon S3 bucket.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidOriginAccessIdentity":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The origin access identity is not valid or doesn't exist.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidOriginKeepaliveTimeout":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidOriginReadTimeout":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidProtocolSettings":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>You cannot specify SSLv3 as the minimum protocol version if you only want to support only clients that support Server Name Indication (SNI).</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidQueryStringParameters":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidRelativePath":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The relative path is too big, is not URL-encoded, or does not begin with a slash (/).</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidRequiredProtocol":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>This operation requires the HTTPS protocol. Ensure that you specify the HTTPS protocol in your request, or omit the <code>RequiredProtocols</code> element from your distribution configuration.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidResponseCode":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidTTLOrder":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidTagging":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidViewerCertificate":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"InvalidWebACLId":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"Invalidation":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Id",
|
||||
"Status",
|
||||
"CreateTime",
|
||||
"InvalidationBatch"
|
||||
],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The identifier for the invalidation request. For example: <code>IDFDVBD632BHDS5</code>.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The status of the invalidation request. When the invalidation batch is finished, the status is <code>Completed</code>.</p>"
|
||||
},
|
||||
"CreateTime":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>The date and time the invalidation request was first made. </p>"
|
||||
},
|
||||
"InvalidationBatch":{
|
||||
"shape":"InvalidationBatch",
|
||||
"documentation":"<p>The current invalidation information for the batch request. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An invalidation. </p>"
|
||||
},
|
||||
"InvalidationBatch":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Paths",
|
||||
"CallerReference"
|
||||
],
|
||||
"members":{
|
||||
"Paths":{
|
||||
"shape":"Paths",
|
||||
"documentation":"<p>A complex type that contains information about the objects that you want to invalidate. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects\">Specifying the Objects to Invalidate</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>"
|
||||
},
|
||||
"CallerReference":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>A value that you specify to uniquely identify an invalidation request. CloudFront uses the value to prevent you from accidentally resubmitting an identical request. Whenever you create a new invalidation request, you must specify a new value for <code>CallerReference</code> and change other values in the request as applicable. One way to ensure that the value of <code>CallerReference</code> is unique is to use a <code>timestamp</code>, for example, <code>20120301090000</code>.</p> <p>If you make a second invalidation request with the same value for <code>CallerReference</code>, and if the rest of the request is the same, CloudFront doesn't create a new invalidation request. Instead, CloudFront returns information about the invalidation request that you previously created with the same <code>CallerReference</code>.</p> <p>If <code>CallerReference</code> is a value you already sent in a previous invalidation batch request but the content of any <code>Path</code> is different from the original request, CloudFront returns an <code>InvalidationBatchAlreadyExists</code> error.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An invalidation batch.</p>"
|
||||
},
|
||||
"InvalidationList":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Marker",
|
||||
"MaxItems",
|
||||
"IsTruncated",
|
||||
"Quantity"
|
||||
],
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value that you provided for the <code>Marker</code> request parameter.</p>"
|
||||
},
|
||||
"NextMarker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>If <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value that you can use for the <code>Marker</code> request parameter to continue listing your invalidation batches where they left off.</p>"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The value that you provided for the <code>MaxItems</code> request parameter.</p>"
|
||||
},
|
||||
"IsTruncated":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>A flag that indicates whether more invalidation batch requests remain to be listed. If your results were truncated, you can make a follow-up pagination request using the <code>Marker</code> request parameter to retrieve more invalidation batches in the list.</p>"
|
||||
},
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of invalidation batches that were created by the current AWS account. </p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"InvalidationSummaryList",
|
||||
"documentation":"<p>A complex type that contains one <code>InvalidationSummary</code> element for each invalidation batch created by the current AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The <code>InvalidationList</code> complex type describes the list of invalidation objects. For more information about invalidation, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html\">Invalidating Objects (Web Distributions Only)</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"InvalidationSummary":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Id",
|
||||
"CreateTime",
|
||||
"Status"
|
||||
],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The unique ID for an invalidation request.</p>"
|
||||
},
|
||||
"CreateTime":{"shape":"timestamp"},
|
||||
"Status":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The status of an invalidation request.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A summary of an invalidation request.</p>"
|
||||
},
|
||||
"InvalidationSummaryList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"InvalidationSummary",
|
||||
"locationName":"InvalidationSummary"
|
||||
}
|
||||
},
|
||||
"ItemSelection":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"none",
|
||||
"whitelist",
|
||||
"all"
|
||||
]
|
||||
},
|
||||
"KeyPairIdList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"string",
|
||||
"locationName":"KeyPairId"
|
||||
}
|
||||
},
|
||||
"KeyPairIds":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of active CloudFront key pairs for <code>AwsAccountNumber</code>.</p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"KeyPairIdList",
|
||||
"documentation":"<p>A complex type that lists the active CloudFront key pairs, if any, that are associated with <code>AwsAccountNumber</code>.</p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that lists the active CloudFront key pairs, if any, that are associated with <code>AwsAccountNumber</code>. </p> <p>For more information, see <a>ActiveTrustedSigners</a>.</p>"
|
||||
},
|
||||
"LambdaFunctionAssociation":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"LambdaFunctionARN":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The ARN of the Lambda function.</p>"
|
||||
},
|
||||
"EventType":{
|
||||
"shape":"EventType",
|
||||
"documentation":"<p>Specifies the event type that triggers a Lambda function invocation. Valid values are:</p> <ul> <li> <p> <code>viewer-request</code> </p> </li> <li> <p> <code>origin-request</code> </p> </li> <li> <p> <code>viewer-response</code> </p> </li> <li> <p> <code>origin-response</code> </p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains a Lambda function association.</p>"
|
||||
},
|
||||
"LambdaFunctionAssociationList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"LambdaFunctionAssociation",
|
||||
"locationName":"LambdaFunctionAssociation"
|
||||
}
|
||||
},
|
||||
"LambdaFunctionAssociations":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of Lambda function associations for this cache behavior.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"LambdaFunctionAssociationList",
|
||||
"documentation":"<p> <b>Optional</b>: A complex type that contains <code>LambdaFunctionAssociation</code> items for this cache behavior. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that specifies a list of Lambda functions associations for a cache behavior.</p> <p>If you want to invoke one or more Lambda functions triggered by requests that match the <code>PathPattern</code> of the cache behavior, specify the applicable values for <code>Quantity</code> and <code>Items</code>. Note that there can be up to 4 <code>LambdaFunctionAssociation</code> items in this list (one for each possible value of <code>EventType</code>) and each <code>EventType</code> can be associated with the Lambda function only once.</p> <p>If you don't want to invoke any Lambda functions for the requests that match <code>PathPattern</code>, specify <code>0</code> for <code>Quantity</code> and omit <code>Items</code>. </p>"
|
||||
},
|
||||
"ListCloudFrontOriginAccessIdentitiesRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Use this when paginating results to indicate where to begin in your list of origin access identities. The results include identities in the list that occur after the marker. To get the next page of results, set the <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response (which is also the ID of the last identity on that page).</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Marker"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The maximum number of origin access identities you want in the response body. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"MaxItems"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to list origin access identities. </p>"
|
||||
},
|
||||
"ListCloudFrontOriginAccessIdentitiesResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CloudFrontOriginAccessIdentityList":{
|
||||
"shape":"CloudFrontOriginAccessIdentityList",
|
||||
"documentation":"<p>The <code>CloudFrontOriginAccessIdentityList</code> type. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request. </p>",
|
||||
"payload":"CloudFrontOriginAccessIdentityList"
|
||||
},
|
||||
"ListDistributionsByWebACLIdRequest":{
|
||||
"type":"structure",
|
||||
"required":["WebACLId"],
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Use <code>Marker</code> and <code>MaxItems</code> to control pagination of results. If you have more than <code>MaxItems</code> distributions that satisfy the request, the response includes a <code>NextMarker</code> element. To get the next page of results, submit another request. For the value of <code>Marker</code>, specify the value of <code>NextMarker</code> from the last response. (For the first request, omit <code>Marker</code>.) </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Marker"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The maximum number of distributions that you want CloudFront to return in the response body. The maximum and default values are both 100.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"MaxItems"
|
||||
},
|
||||
"WebACLId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The ID of the AWS WAF web ACL that you want to list the associated distributions. If you specify \"null\" for the ID, the request returns a list of the distributions that aren't associated with a web ACL. </p>",
|
||||
"location":"uri",
|
||||
"locationName":"WebACLId"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to list distributions that are associated with a specified AWS WAF web ACL. </p>"
|
||||
},
|
||||
"ListDistributionsByWebACLIdResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DistributionList":{
|
||||
"shape":"DistributionList",
|
||||
"documentation":"<p>The <code>DistributionList</code> type. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The response to a request to list the distributions that are associated with a specified AWS WAF web ACL. </p>",
|
||||
"payload":"DistributionList"
|
||||
},
|
||||
"ListDistributionsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Use this when paginating results to indicate where to begin in your list of distributions. The results include distributions in the list that occur after the marker. To get the next page of results, set the <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response (which is also the ID of the last distribution on that page).</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Marker"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The maximum number of distributions you want in the response body.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"MaxItems"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to list your distributions. </p>"
|
||||
},
|
||||
"ListDistributionsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DistributionList":{
|
||||
"shape":"DistributionList",
|
||||
"documentation":"<p>The <code>DistributionList</code> type. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request. </p>",
|
||||
"payload":"DistributionList"
|
||||
},
|
||||
"ListInvalidationsRequest":{
|
||||
"type":"structure",
|
||||
"required":["DistributionId"],
|
||||
"members":{
|
||||
"DistributionId":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution's ID.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"DistributionId"
|
||||
},
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Use this parameter when paginating results to indicate where to begin in your list of invalidation batches. Because the results are returned in decreasing order from most recent to oldest, the most recent results are on the first page, the second page will contain earlier results, and so on. To get the next page of results, set <code>Marker</code> to the value of the <code>NextMarker</code> from the current page's response. This value is the same as the ID of the last invalidation batch on that page. </p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Marker"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The maximum number of invalidation batches that you want in the response body.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"MaxItems"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to list invalidations. </p>"
|
||||
},
|
||||
"ListInvalidationsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"InvalidationList":{
|
||||
"shape":"InvalidationList",
|
||||
"documentation":"<p>Information about invalidation batches. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request. </p>",
|
||||
"payload":"InvalidationList"
|
||||
},
|
||||
"ListStreamingDistributionsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value that you provided for the <code>Marker</code> request parameter.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Marker"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value that you provided for the <code>MaxItems</code> request parameter.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"MaxItems"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to list your streaming distributions. </p>"
|
||||
},
|
||||
"ListStreamingDistributionsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StreamingDistributionList":{
|
||||
"shape":"StreamingDistributionList",
|
||||
"documentation":"<p>The <code>StreamingDistributionList</code> type. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request. </p>",
|
||||
"payload":"StreamingDistributionList"
|
||||
},
|
||||
"ListTagsForResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":["Resource"],
|
||||
"members":{
|
||||
"Resource":{
|
||||
"shape":"ResourceARN",
|
||||
"documentation":"<p> An ARN of a CloudFront resource.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Resource"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> The request to list tags for a CloudFront resource.</p>"
|
||||
},
|
||||
"ListTagsForResourceResult":{
|
||||
"type":"structure",
|
||||
"required":["Tags"],
|
||||
"members":{
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p> A complex type that contains zero or more <code>Tag</code> elements.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> The returned result of the corresponding request.</p>",
|
||||
"payload":"Tags"
|
||||
},
|
||||
"LocationList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"string",
|
||||
"locationName":"Location"
|
||||
}
|
||||
},
|
||||
"LoggingConfig":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Enabled",
|
||||
"IncludeCookies",
|
||||
"Bucket",
|
||||
"Prefix"
|
||||
],
|
||||
"members":{
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify <code>false</code> for <code>Enabled</code>, and specify empty <code>Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code>, <code>prefix</code>, and <code>IncludeCookies</code>, the values are automatically deleted.</p>"
|
||||
},
|
||||
"IncludeCookies":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Specifies whether you want CloudFront to include cookies in access logs, specify <code>true</code> for <code>IncludeCookies</code>. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you do not want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify <code>false</code> for <code>IncludeCookies</code>.</p>"
|
||||
},
|
||||
"Bucket":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The Amazon S3 bucket to store the access logs in, for example, <code>myawslogbucket.s3.amazonaws.com</code>.</p>"
|
||||
},
|
||||
"Prefix":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>An optional string that you want CloudFront to prefix to the access log <code>filenames</code> for this distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that controls whether access logs are written for the distribution.</p>"
|
||||
},
|
||||
"Method":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"GET",
|
||||
"HEAD",
|
||||
"POST",
|
||||
"PUT",
|
||||
"PATCH",
|
||||
"OPTIONS",
|
||||
"DELETE"
|
||||
]
|
||||
},
|
||||
"MethodsList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"Method",
|
||||
"locationName":"Method"
|
||||
}
|
||||
},
|
||||
"MinimumProtocolVersion":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"SSLv3",
|
||||
"TLSv1"
|
||||
]
|
||||
},
|
||||
"MissingBody":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>This operation requires a body. Ensure that the body is present and the Content-Type header is set.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"NoSuchCloudFrontOriginAccessIdentity":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The specified origin access identity does not exist.</p>",
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"NoSuchDistribution":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The specified distribution does not exist.</p>",
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"NoSuchInvalidation":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The specified invalidation does not exist.</p>",
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"NoSuchOrigin":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>No origin exists with the specified <code>Origin Id</code>. </p>",
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"NoSuchResource":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"NoSuchStreamingDistribution":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The specified streaming distribution does not exist.</p>",
|
||||
"error":{"httpStatusCode":404},
|
||||
"exception":true
|
||||
},
|
||||
"Origin":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Id",
|
||||
"DomainName"
|
||||
],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>A unique identifier for the origin. The value of <code>Id</code> must be unique within the distribution.</p> <p>When you specify the value of <code>TargetOriginId</code> for the default cache behavior or for another cache behavior, you indicate the origin to which you want the cache behavior to route requests by specifying the value of the <code>Id</code> element for that origin. When a request matches the path pattern for that cache behavior, CloudFront routes the request to the specified origin. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/distribution-web-values-specify.html#DownloadDistValuesCacheBehavior\">Cache Behavior Settings</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"DomainName":{
|
||||
"shape":"string",
|
||||
"documentation":"<p> <b>Amazon S3 origins</b>: The DNS name of the Amazon S3 bucket from which you want CloudFront to get objects for this origin, for example, <code>myawsbucket.s3.amazonaws.com</code>.</p> <p>Constraints for Amazon S3 origins: </p> <ul> <li> <p>If you configured Amazon S3 Transfer Acceleration for your bucket, do not specify the <code>s3-accelerate</code> endpoint for <code>DomainName</code>.</p> </li> <li> <p>The bucket name must be between 3 and 63 characters long (inclusive).</p> </li> <li> <p>The bucket name must contain only lowercase characters, numbers, periods, underscores, and dashes.</p> </li> <li> <p>The bucket name must not contain adjacent periods.</p> </li> </ul> <p> <b>Custom Origins</b>: The DNS domain name for the HTTP server from which you want CloudFront to get objects for this origin, for example, <code>www.example.com</code>. </p> <p>Constraints for custom origins:</p> <ul> <li> <p> <code>DomainName</code> must be a valid DNS name that contains only a-z, A-Z, 0-9, dot (.), hyphen (-), or underscore (_) characters.</p> </li> <li> <p>The name cannot exceed 128 characters.</p> </li> </ul>"
|
||||
},
|
||||
"OriginPath":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>An optional element that causes CloudFront to request your content from a directory in your Amazon S3 bucket or your custom origin. When you include the <code>OriginPath</code> element, specify the directory name, beginning with a <code>/</code>. CloudFront appends the directory name to the value of <code>DomainName</code>, for example, <code>example.com/production</code>. Do not include a <code>/</code> at the end of the directory name.</p> <p>For example, suppose you've specified the following values for your distribution:</p> <ul> <li> <p> <code>DomainName</code>: An Amazon S3 bucket named <code>myawsbucket</code>.</p> </li> <li> <p> <code>OriginPath</code>: <code>/production</code> </p> </li> <li> <p> <code>CNAME</code>: <code>example.com</code> </p> </li> </ul> <p>When a user enters <code>example.com/index.html</code> in a browser, CloudFront sends a request to Amazon S3 for <code>myawsbucket/production/index.html</code>.</p> <p>When a user enters <code>example.com/acme/index.html</code> in a browser, CloudFront sends a request to Amazon S3 for <code>myawsbucket/production/acme/index.html</code>.</p>"
|
||||
},
|
||||
"CustomHeaders":{
|
||||
"shape":"CustomHeaders",
|
||||
"documentation":"<p>A complex type that contains names and values for the custom headers that you want.</p>"
|
||||
},
|
||||
"S3OriginConfig":{
|
||||
"shape":"S3OriginConfig",
|
||||
"documentation":"<p>A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the <code>CustomOriginConfig</code> element instead.</p>"
|
||||
},
|
||||
"CustomOriginConfig":{
|
||||
"shape":"CustomOriginConfig",
|
||||
"documentation":"<p>A complex type that contains information about a custom origin. If the origin is an Amazon S3 bucket, use the <code>S3OriginConfig</code> element instead.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that describes the Amazon S3 bucket or the HTTP server (for example, a web server) from which CloudFront gets your files. You must create at least one origin.</p> <p>For the current limit on the number of origins that you can create for a distribution, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_cloudfront\">Amazon CloudFront Limits</a> in the <i>AWS General Reference</i>.</p>"
|
||||
},
|
||||
"OriginCustomHeader":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"HeaderName",
|
||||
"HeaderValue"
|
||||
],
|
||||
"members":{
|
||||
"HeaderName":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The name of a header that you want CloudFront to forward to your origin. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/forward-custom-headers.html\">Forwarding Custom Headers to Your Origin (Web Distributions Only)</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"HeaderValue":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value for the header that you specified in the <code>HeaderName</code> field.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains <code>HeaderName</code> and <code>HeaderValue</code> elements, if any, for this distribution. </p>"
|
||||
},
|
||||
"OriginCustomHeadersList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"OriginCustomHeader",
|
||||
"locationName":"OriginCustomHeader"
|
||||
}
|
||||
},
|
||||
"OriginList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"Origin",
|
||||
"locationName":"Origin"
|
||||
},
|
||||
"min":1
|
||||
},
|
||||
"OriginProtocolPolicy":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"http-only",
|
||||
"match-viewer",
|
||||
"https-only"
|
||||
]
|
||||
},
|
||||
"OriginSslProtocols":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Quantity",
|
||||
"Items"
|
||||
],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of SSL/TLS protocols that you want to allow CloudFront to use when establishing an HTTPS connection with this origin. </p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"SslProtocolsList",
|
||||
"documentation":"<p>A list that contains allowed SSL/TLS protocols for this distribution.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains information about the SSL/TLS protocols that CloudFront can use when establishing an HTTPS connection with your origin. </p>"
|
||||
},
|
||||
"Origins":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of origins for this distribution.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"OriginList",
|
||||
"documentation":"<p>A complex type that contains origins for this distribution.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains information about origins for this distribution. </p>"
|
||||
},
|
||||
"PathList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"string",
|
||||
"locationName":"Path"
|
||||
}
|
||||
},
|
||||
"Paths":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of objects that you want to invalidate.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"PathList",
|
||||
"documentation":"<p>A complex type that contains a list of the paths that you want to invalidate.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains information about the objects that you want to invalidate. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/Invalidation.html#invalidation-specifying-objects\">Specifying the Objects to Invalidate</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>"
|
||||
},
|
||||
"PreconditionFailed":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>The precondition given in one or more of the request-header fields evaluated to <code>false</code>. </p>",
|
||||
"error":{"httpStatusCode":412},
|
||||
"exception":true
|
||||
},
|
||||
"PriceClass":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"PriceClass_100",
|
||||
"PriceClass_200",
|
||||
"PriceClass_All"
|
||||
]
|
||||
},
|
||||
"QueryStringCacheKeys":{
|
||||
"type":"structure",
|
||||
"required":["Quantity"],
|
||||
"members":{
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of <code>whitelisted</code> query string parameters for this cache behavior.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"QueryStringCacheKeysList",
|
||||
"documentation":"<p>(Optional) A list that contains the query string parameters that you want CloudFront to use as a basis for caching for this cache behavior. If <code>Quantity</code> is 0, you can omit <code>Items</code>. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"QueryStringCacheKeysList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"string",
|
||||
"locationName":"Name"
|
||||
}
|
||||
},
|
||||
"ResourceARN":{
|
||||
"type":"string",
|
||||
"pattern":"arn:aws:cloudfront::[0-9]+:.*"
|
||||
},
|
||||
"Restrictions":{
|
||||
"type":"structure",
|
||||
"required":["GeoRestriction"],
|
||||
"members":{
|
||||
"GeoRestriction":{"shape":"GeoRestriction"}
|
||||
},
|
||||
"documentation":"<p>A complex type that identifies ways in which you want to restrict distribution of your content.</p>"
|
||||
},
|
||||
"S3Origin":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DomainName",
|
||||
"OriginAccessIdentity"
|
||||
],
|
||||
"members":{
|
||||
"DomainName":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The DNS name of the Amazon S3 origin. </p>"
|
||||
},
|
||||
"OriginAccessIdentity":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The CloudFront origin access identity to associate with the RTMP distribution. Use an origin access identity to configure the distribution so that end users can only access objects in an Amazon S3 bucket through CloudFront.</p> <p>If you want end users to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To replace the origin access identity, update the distribution configuration and specify the new origin access identity.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html\">Using an Origin Access Identity to Restrict Access to Your Amazon S3 Content</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.</p>"
|
||||
},
|
||||
"S3OriginConfig":{
|
||||
"type":"structure",
|
||||
"required":["OriginAccessIdentity"],
|
||||
"members":{
|
||||
"OriginAccessIdentity":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The CloudFront origin access identity to associate with the origin. Use an origin access identity to configure the origin so that viewers can <i>only</i> access objects in an Amazon S3 bucket through CloudFront. The format of the value is:</p> <p>origin-access-identity/cloudfront/<i>ID-of-origin-access-identity</i> </p> <p>where <code> <i>ID-of-origin-access-identity</i> </code> is the value that CloudFront returned in the <code>ID</code> element when you created the origin access identity.</p> <p>If you want viewers to be able to access objects using either the CloudFront URL or the Amazon S3 URL, specify an empty <code>OriginAccessIdentity</code> element.</p> <p>To delete the origin access identity from an existing distribution, update the distribution configuration and include an empty <code>OriginAccessIdentity</code> element.</p> <p>To replace the origin access identity, update the distribution configuration and specify the new origin access identity.</p> <p>For more information about the origin access identity, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that contains information about the Amazon S3 origin. If the origin is a custom origin, use the <code>CustomOriginConfig</code> element instead.</p>"
|
||||
},
|
||||
"SSLSupportMethod":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"sni-only",
|
||||
"vip"
|
||||
]
|
||||
},
|
||||
"Signer":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"AwsAccountNumber":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>An AWS account that is included in the <code>TrustedSigners</code> complex type for this RTMP distribution. Valid values include:</p> <ul> <li> <p> <code>self</code>, which is the AWS account used to create the distribution.</p> </li> <li> <p>An AWS account number.</p> </li> </ul>"
|
||||
},
|
||||
"KeyPairIds":{
|
||||
"shape":"KeyPairIds",
|
||||
"documentation":"<p>A complex type that lists the active CloudFront key pairs, if any, that are associated with <code>AwsAccountNumber</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that lists the AWS accounts that were included in the <code>TrustedSigners</code> complex type, as well as their active CloudFront key pair IDs, if any. </p>"
|
||||
},
|
||||
"SignerList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"Signer",
|
||||
"locationName":"Signer"
|
||||
}
|
||||
},
|
||||
"SslProtocol":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"SSLv3",
|
||||
"TLSv1",
|
||||
"TLSv1.1",
|
||||
"TLSv1.2"
|
||||
]
|
||||
},
|
||||
"SslProtocolsList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"SslProtocol",
|
||||
"locationName":"SslProtocol"
|
||||
}
|
||||
},
|
||||
"StreamingDistribution":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Id",
|
||||
"ARN",
|
||||
"Status",
|
||||
"DomainName",
|
||||
"ActiveTrustedSigners",
|
||||
"StreamingDistributionConfig"
|
||||
],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The identifier for the RTMP distribution. For example: <code>EGTXBD79EXAMPLE</code>.</p>"
|
||||
},
|
||||
"ARN":{"shape":"string"},
|
||||
"Status":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current status of the RTMP distribution. When the status is <code>Deployed</code>, the distribution's information is propagated to all CloudFront edge locations.</p>"
|
||||
},
|
||||
"LastModifiedTime":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>The date and time that the distribution was last modified. </p>"
|
||||
},
|
||||
"DomainName":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The domain name that corresponds to the streaming distribution. For example: <code>s5c39gqb8ow64r.cloudfront.net</code>. </p>"
|
||||
},
|
||||
"ActiveTrustedSigners":{
|
||||
"shape":"ActiveTrustedSigners",
|
||||
"documentation":"<p>A complex type that lists the AWS accounts, if any, that you included in the <code>TrustedSigners</code> complex type for this distribution. These are the accounts that you want to allow to create signed URLs for private content.</p> <p>The <code>Signer</code> complex type lists the AWS account number of the trusted signer or <code>self</code> if the signer is the AWS account that created the distribution. The <code>Signer</code> element also includes the IDs of any active CloudFront key pairs that are associated with the trusted signer's AWS account. If no <code>KeyPairId</code> element appears for a <code>Signer</code>, that signer can't create signed URLs.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>"
|
||||
},
|
||||
"StreamingDistributionConfig":{
|
||||
"shape":"StreamingDistributionConfig",
|
||||
"documentation":"<p>The current configuration information for the RTMP distribution.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A streaming distribution. </p>"
|
||||
},
|
||||
"StreamingDistributionAlreadyExists":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":409},
|
||||
"exception":true
|
||||
},
|
||||
"StreamingDistributionConfig":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"CallerReference",
|
||||
"S3Origin",
|
||||
"Comment",
|
||||
"TrustedSigners",
|
||||
"Enabled"
|
||||
],
|
||||
"members":{
|
||||
"CallerReference":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>A unique number that ensures that the request can't be replayed. If the <code>CallerReference</code> is new (no matter the content of the <code>StreamingDistributionConfig</code> object), a new streaming distribution is created. If the <code>CallerReference</code> is a value that you already sent in a previous request to create a streaming distribution, and the content of the <code>StreamingDistributionConfig</code> is identical to the original request (ignoring white space), the response includes the same information returned to the original request. If the <code>CallerReference</code> is a value that you already sent in a previous request to create a streaming distribution but the content of the <code>StreamingDistributionConfig</code> is different from the original request, CloudFront returns a <code>DistributionAlreadyExists</code> error. </p>"
|
||||
},
|
||||
"S3Origin":{
|
||||
"shape":"S3Origin",
|
||||
"documentation":"<p>A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution. </p>"
|
||||
},
|
||||
"Aliases":{
|
||||
"shape":"Aliases",
|
||||
"documentation":"<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution. </p>"
|
||||
},
|
||||
"Comment":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Any comments you want to include about the streaming distribution. </p>"
|
||||
},
|
||||
"Logging":{
|
||||
"shape":"StreamingLoggingConfig",
|
||||
"documentation":"<p>A complex type that controls whether access logs are written for the streaming distribution. </p>"
|
||||
},
|
||||
"TrustedSigners":{
|
||||
"shape":"TrustedSigners",
|
||||
"documentation":"<p>A complex type that specifies any AWS accounts that you want to permit to create signed URLs for private content. If you want the distribution to use signed URLs, include this element; if you want the distribution to use public URLs, remove this element. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>"
|
||||
},
|
||||
"PriceClass":{
|
||||
"shape":"PriceClass",
|
||||
"documentation":"<p>A complex type that contains information about price class for this streaming distribution. </p>"
|
||||
},
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Whether the streaming distribution is enabled to accept user requests for content.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The RTMP distribution's configuration information.</p>"
|
||||
},
|
||||
"StreamingDistributionConfigWithTags":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"StreamingDistributionConfig",
|
||||
"Tags"
|
||||
],
|
||||
"members":{
|
||||
"StreamingDistributionConfig":{
|
||||
"shape":"StreamingDistributionConfig",
|
||||
"documentation":"<p>A streaming distribution Configuration.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p>A complex type that contains zero or more <code>Tag</code> elements.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A streaming distribution Configuration and a list of tags to be associated with the streaming distribution.</p>"
|
||||
},
|
||||
"StreamingDistributionList":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Marker",
|
||||
"MaxItems",
|
||||
"IsTruncated",
|
||||
"Quantity"
|
||||
],
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value you provided for the <code>Marker</code> request parameter. </p>"
|
||||
},
|
||||
"NextMarker":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>If <code>IsTruncated</code> is <code>true</code>, this element is present and contains the value you can use for the <code>Marker</code> request parameter to continue listing your RTMP distributions where they left off. </p>"
|
||||
},
|
||||
"MaxItems":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The value you provided for the <code>MaxItems</code> request parameter. </p>"
|
||||
},
|
||||
"IsTruncated":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>A flag that indicates whether more streaming distributions remain to be listed. If your results were truncated, you can make a follow-up pagination request using the <code>Marker</code> request parameter to retrieve more distributions in the list. </p>"
|
||||
},
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of streaming distributions that were created by the current AWS account. </p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"StreamingDistributionSummaryList",
|
||||
"documentation":"<p>A complex type that contains one <code>StreamingDistributionSummary</code> element for each distribution that was created by the current AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A streaming distribution list. </p>"
|
||||
},
|
||||
"StreamingDistributionNotDisabled":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":409},
|
||||
"exception":true
|
||||
},
|
||||
"StreamingDistributionSummary":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Id",
|
||||
"ARN",
|
||||
"Status",
|
||||
"LastModifiedTime",
|
||||
"DomainName",
|
||||
"S3Origin",
|
||||
"Aliases",
|
||||
"TrustedSigners",
|
||||
"Comment",
|
||||
"PriceClass",
|
||||
"Enabled"
|
||||
],
|
||||
"members":{
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The identifier for the distribution. For example: <code>EDFDVBD632BHDS5</code>.</p>"
|
||||
},
|
||||
"ARN":{
|
||||
"shape":"string",
|
||||
"documentation":"<p> The ARN (Amazon Resource Name) for the streaming distribution. For example: <code>arn:aws:cloudfront::123456789012:streaming-distribution/EDFDVBD632BHDS5</code>, where <code>123456789012</code> is your AWS account ID.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"string",
|
||||
"documentation":"<p> Indicates the current status of the distribution. When the status is <code>Deployed</code>, the distribution's information is fully propagated throughout the Amazon CloudFront system.</p>"
|
||||
},
|
||||
"LastModifiedTime":{
|
||||
"shape":"timestamp",
|
||||
"documentation":"<p>The date and time the distribution was last modified.</p>"
|
||||
},
|
||||
"DomainName":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The domain name corresponding to the distribution. For example: <code>d604721fxaaqy9.cloudfront.net</code>.</p>"
|
||||
},
|
||||
"S3Origin":{
|
||||
"shape":"S3Origin",
|
||||
"documentation":"<p>A complex type that contains information about the Amazon S3 bucket from which you want CloudFront to get your media files for distribution.</p>"
|
||||
},
|
||||
"Aliases":{
|
||||
"shape":"Aliases",
|
||||
"documentation":"<p>A complex type that contains information about CNAMEs (alternate domain names), if any, for this streaming distribution.</p>"
|
||||
},
|
||||
"TrustedSigners":{
|
||||
"shape":"TrustedSigners",
|
||||
"documentation":"<p>A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content. If you want to require signed URLs in requests for objects in the target origin that match the <code>PathPattern</code> for this cache behavior, specify <code>true</code> for <code>Enabled</code>, and specify the applicable values for <code>Quantity</code> and <code>Items</code>.If you don't want to require signed URLs in requests for objects that match <code>PathPattern</code>, specify <code>false</code> for <code>Enabled</code> and <code>0</code> for <code>Quantity</code>. Omit <code>Items</code>. To add, change, or remove one or more trusted signers, change <code>Enabled</code> to <code>true</code> (if it's currently <code>false</code>), change <code>Quantity</code> as applicable, and specify all of the trusted signers that you want to include in the updated distribution.</p>"
|
||||
},
|
||||
"Comment":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The comment originally specified when this distribution was created.</p>"
|
||||
},
|
||||
"PriceClass":{"shape":"PriceClass"},
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Whether the distribution is enabled to accept end user requests for content.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> A summary of the information for an Amazon CloudFront streaming distribution.</p>"
|
||||
},
|
||||
"StreamingDistributionSummaryList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"StreamingDistributionSummary",
|
||||
"locationName":"StreamingDistributionSummary"
|
||||
}
|
||||
},
|
||||
"StreamingLoggingConfig":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Enabled",
|
||||
"Bucket",
|
||||
"Prefix"
|
||||
],
|
||||
"members":{
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you do not want to enable logging when you create a streaming distribution or if you want to disable logging for an existing streaming distribution, specify <code>false</code> for <code>Enabled</code>, and specify <code>empty Bucket</code> and <code>Prefix</code> elements. If you specify <code>false</code> for <code>Enabled</code> but you specify values for <code>Bucket</code> and <code>Prefix</code>, the values are automatically deleted. </p>"
|
||||
},
|
||||
"Bucket":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The Amazon S3 bucket to store the access logs in, for example, <code>myawslogbucket.s3.amazonaws.com</code>.</p>"
|
||||
},
|
||||
"Prefix":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>An optional string that you want CloudFront to prefix to the access log <code>filenames</code> for this streaming distribution, for example, <code>myprefix/</code>. If you want to enable logging, but you do not want to specify a prefix, you still must include an empty <code>Prefix</code> element in the <code>Logging</code> element.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that controls whether access logs are written for this streaming distribution.</p>"
|
||||
},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"required":["Key"],
|
||||
"members":{
|
||||
"Key":{
|
||||
"shape":"TagKey",
|
||||
"documentation":"<p> A string that contains <code>Tag</code> key.</p> <p>The string length should be between 1 and 128 characters. Valid characters include <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, space, and the special characters <code>_ - . : / = + @</code>.</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"TagValue",
|
||||
"documentation":"<p> A string that contains an optional <code>Tag</code> value.</p> <p>The string length should be between 0 and 256 characters. Valid characters include <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, space, and the special characters <code>_ - . : / = + @</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> A complex type that contains <code>Tag</code> key and <code>Tag</code> value.</p>"
|
||||
},
|
||||
"TagKey":{
|
||||
"type":"string",
|
||||
"documentation":"<p> A string that contains <code>Tag</code> key.</p> <p>The string length should be between 1 and 128 characters. Valid characters include <code>a-z</code>, <code>A-Z</code>, <code>0-9</code>, space, and the special characters <code>_ - . : / = + @</code>.</p>",
|
||||
"max":128,
|
||||
"min":1,
|
||||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||||
},
|
||||
"TagKeyList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"TagKey",
|
||||
"locationName":"Key"
|
||||
}
|
||||
},
|
||||
"TagKeys":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Items":{
|
||||
"shape":"TagKeyList",
|
||||
"documentation":"<p> A complex type that contains <code>Tag</code> key elements.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> A complex type that contains zero or more <code>Tag</code> elements.</p>"
|
||||
},
|
||||
"TagList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"Tag",
|
||||
"locationName":"Tag"
|
||||
}
|
||||
},
|
||||
"TagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Resource",
|
||||
"Tags"
|
||||
],
|
||||
"members":{
|
||||
"Resource":{
|
||||
"shape":"ResourceARN",
|
||||
"documentation":"<p> An ARN of a CloudFront resource.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Resource"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"Tags",
|
||||
"documentation":"<p> A complex type that contains zero or more <code>Tag</code> elements.</p>",
|
||||
"locationName":"Tags",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p> The request to add tags to a CloudFront resource.</p>",
|
||||
"payload":"Tags"
|
||||
},
|
||||
"TagValue":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":0,
|
||||
"pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$"
|
||||
},
|
||||
"Tags":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Items":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p> A complex type that contains <code>Tag</code> elements.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p> A complex type that contains zero or more <code>Tag</code> elements.</p>"
|
||||
},
|
||||
"TooManyCacheBehaviors":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>You cannot create more cache behaviors for the distribution.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyCertificates":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>You cannot create anymore custom SSL/TLS certificates.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyCloudFrontOriginAccessIdentities":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Processing your request would cause you to exceed the maximum number of origin access identities allowed.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyCookieNamesInWhiteList":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Your request contains more cookie names in the whitelist than are allowed per cache behavior.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyDistributionCNAMEs":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Your request contains more CNAMEs than are allowed per distribution.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyDistributions":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Processing your request would cause you to exceed the maximum number of distributions allowed.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyDistributionsWithLambdaAssociations":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Processing your request would cause the maximum number of distributions with Lambda function associations per owner to be exceeded.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyHeadersInForwardedValues":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyInvalidationsInProgress":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>You have exceeded the maximum number of allowable InProgress invalidation batch requests, or invalidation objects.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyLambdaFunctionAssociations":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Your request contains more Lambda function associations than are allowed per distribution.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyOriginCustomHeaders":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyOrigins":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>You cannot create more origins for the distribution.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyQueryStringParameters":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyStreamingDistributionCNAMEs":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyStreamingDistributions":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Processing your request would cause you to exceed the maximum number of streaming distributions allowed.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TooManyTrustedSigners":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>Your request contains more trusted signers than are allowed per distribution.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TrustedSignerDoesNotExist":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Message":{"shape":"string"}
|
||||
},
|
||||
"documentation":"<p>One or more of your trusted signers do not exist.</p>",
|
||||
"error":{"httpStatusCode":400},
|
||||
"exception":true
|
||||
},
|
||||
"TrustedSigners":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Enabled",
|
||||
"Quantity"
|
||||
],
|
||||
"members":{
|
||||
"Enabled":{
|
||||
"shape":"boolean",
|
||||
"documentation":"<p>Specifies whether you want to require viewers to use signed URLs to access the files specified by <code>PathPattern</code> and <code>TargetOriginId</code>.</p>"
|
||||
},
|
||||
"Quantity":{
|
||||
"shape":"integer",
|
||||
"documentation":"<p>The number of trusted signers for this cache behavior.</p>"
|
||||
},
|
||||
"Items":{
|
||||
"shape":"AwsAccountNumberList",
|
||||
"documentation":"<p> <b>Optional</b>: A complex type that contains trusted signers for this cache behavior. If <code>Quantity</code> is <code>0</code>, you can omit <code>Items</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that specifies the AWS accounts, if any, that you want to allow to create signed URLs for private content.</p> <p>If you want to require signed URLs in requests for objects in the target origin that match the <code>PathPattern</code> for this cache behavior, specify <code>true</code> for <code>Enabled</code>, and specify the applicable values for <code>Quantity</code> and <code>Items</code>. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/PrivateContent.html\">Serving Private Content through CloudFront</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p> <p>If you don't want to require signed URLs in requests for objects that match <code>PathPattern</code>, specify <code>false</code> for <code>Enabled</code> and <code>0</code> for <code>Quantity</code>. Omit <code>Items</code>.</p> <p>To add, change, or remove one or more trusted signers, change <code>Enabled</code> to <code>true</code> (if it's currently <code>false</code>), change <code>Quantity</code> as applicable, and specify all of the trusted signers that you want to include in the updated distribution.</p> <p>For more information about updating the distribution configuration, see <a>DistributionConfig</a> .</p>"
|
||||
},
|
||||
"UntagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Resource",
|
||||
"TagKeys"
|
||||
],
|
||||
"members":{
|
||||
"Resource":{
|
||||
"shape":"ResourceARN",
|
||||
"documentation":"<p> An ARN of a CloudFront resource.</p>",
|
||||
"location":"querystring",
|
||||
"locationName":"Resource"
|
||||
},
|
||||
"TagKeys":{
|
||||
"shape":"TagKeys",
|
||||
"documentation":"<p> A complex type that contains zero or more <code>Tag</code> key elements.</p>",
|
||||
"locationName":"TagKeys",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"}
|
||||
}
|
||||
},
|
||||
"documentation":"<p> The request to remove tags from a CloudFront resource.</p>",
|
||||
"payload":"TagKeys"
|
||||
},
|
||||
"UpdateCloudFrontOriginAccessIdentityRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"CloudFrontOriginAccessIdentityConfig",
|
||||
"Id"
|
||||
],
|
||||
"members":{
|
||||
"CloudFrontOriginAccessIdentityConfig":{
|
||||
"shape":"CloudFrontOriginAccessIdentityConfig",
|
||||
"documentation":"<p>The identity's configuration information.</p>",
|
||||
"locationName":"CloudFrontOriginAccessIdentityConfig",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"}
|
||||
},
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The identity's id.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
},
|
||||
"IfMatch":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of the <code>ETag</code> header that you received when retrieving the identity's configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"If-Match"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to update an origin access identity.</p>",
|
||||
"payload":"CloudFrontOriginAccessIdentityConfig"
|
||||
},
|
||||
"UpdateCloudFrontOriginAccessIdentityResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CloudFrontOriginAccessIdentity":{
|
||||
"shape":"CloudFrontOriginAccessIdentity",
|
||||
"documentation":"<p>The origin access identity's information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"CloudFrontOriginAccessIdentity"
|
||||
},
|
||||
"UpdateDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"DistributionConfig",
|
||||
"Id"
|
||||
],
|
||||
"members":{
|
||||
"DistributionConfig":{
|
||||
"shape":"DistributionConfig",
|
||||
"documentation":"<p>The distribution's configuration information.</p>",
|
||||
"locationName":"DistributionConfig",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"}
|
||||
},
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The distribution's id.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
},
|
||||
"IfMatch":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of the <code>ETag</code> header that you received when retrieving the distribution's configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"If-Match"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to update a distribution.</p>",
|
||||
"payload":"DistributionConfig"
|
||||
},
|
||||
"UpdateDistributionResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Distribution":{
|
||||
"shape":"Distribution",
|
||||
"documentation":"<p>The distribution's information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"Distribution"
|
||||
},
|
||||
"UpdateStreamingDistributionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"StreamingDistributionConfig",
|
||||
"Id"
|
||||
],
|
||||
"members":{
|
||||
"StreamingDistributionConfig":{
|
||||
"shape":"StreamingDistributionConfig",
|
||||
"documentation":"<p>The streaming distribution's configuration information.</p>",
|
||||
"locationName":"StreamingDistributionConfig",
|
||||
"xmlNamespace":{"uri":"http://cloudfront.amazonaws.com/doc/2017-03-25/"}
|
||||
},
|
||||
"Id":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The streaming distribution's id.</p>",
|
||||
"location":"uri",
|
||||
"locationName":"Id"
|
||||
},
|
||||
"IfMatch":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The value of the <code>ETag</code> header that you received when retrieving the streaming distribution's configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"If-Match"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to update a streaming distribution.</p>",
|
||||
"payload":"StreamingDistributionConfig"
|
||||
},
|
||||
"UpdateStreamingDistributionResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"StreamingDistribution":{
|
||||
"shape":"StreamingDistribution",
|
||||
"documentation":"<p>The streaming distribution's information.</p>"
|
||||
},
|
||||
"ETag":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>The current version of the configuration. For example: <code>E2QWRUHAPOMQZL</code>.</p>",
|
||||
"location":"header",
|
||||
"locationName":"ETag"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The returned result of the corresponding request.</p>",
|
||||
"payload":"StreamingDistribution"
|
||||
},
|
||||
"ViewerCertificate":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CloudFrontDefaultCertificate":{"shape":"boolean"},
|
||||
"IAMCertificateId":{"shape":"string"},
|
||||
"ACMCertificateArn":{"shape":"string"},
|
||||
"SSLSupportMethod":{
|
||||
"shape":"SSLSupportMethod",
|
||||
"documentation":"<p>If you specify a value for <code>ACMCertificateArn</code> or for <code>IAMCertificateId</code>, you must also specify how you want CloudFront to serve HTTPS requests: using a method that works for all clients or one that works for most clients:</p> <ul> <li> <p> <code>vip</code>: CloudFront uses dedicated IP addresses for your content and can respond to HTTPS requests from any viewer. However, you will incur additional monthly charges.</p> </li> <li> <p> <code>sni-only</code>: CloudFront can respond to HTTPS requests from viewers that support Server Name Indication (SNI). All modern browsers support SNI, but some browsers still in use don't support SNI. If some of your users' browsers don't support SNI, we recommend that you do one of the following:</p> <ul> <li> <p>Use the <code>vip</code> option (dedicated IP addresses) instead of <code>sni-only</code>.</p> </li> <li> <p>Use the CloudFront SSL/TLS certificate instead of a custom certificate. This requires that you use the CloudFront domain name of your distribution in the URLs for your objects, for example, <code>https://d111111abcdef8.cloudfront.net/logo.png</code>.</p> </li> <li> <p>If you can control which browser your users use, upgrade the browser to one that supports SNI.</p> </li> <li> <p>Use HTTP instead of HTTPS.</p> </li> </ul> </li> </ul> <p>Do not specify a value for <code>SSLSupportMethod</code> if you specified <code><CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate></code>.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS.html\">Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"MinimumProtocolVersion":{
|
||||
"shape":"MinimumProtocolVersion",
|
||||
"documentation":"<p>Specify the minimum version of the SSL/TLS protocol that you want CloudFront to use for HTTPS connections between viewers and CloudFront: <code>SSLv3</code> or <code>TLSv1</code>. CloudFront serves your objects only to viewers that support SSL/TLS version that you specify and later versions. The <code>TLSv1</code> protocol is more secure, so we recommend that you specify <code>SSLv3</code> only if your users are using browsers or devices that don't support <code>TLSv1</code>. Note the following:</p> <ul> <li> <p>If you specify <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate>, the minimum SSL protocol version is <code>TLSv1</code> and can't be changed.</p> </li> <li> <p>If you're using a custom certificate (if you specify a value for <code>ACMCertificateArn</code> or for <code>IAMCertificateId</code>) and if you're using SNI (if you specify <code>sni-only</code> for <code>SSLSupportMethod</code>), you must specify <code>TLSv1</code> for <code>MinimumProtocolVersion</code>.</p> </li> </ul>"
|
||||
},
|
||||
"Certificate":{
|
||||
"shape":"string",
|
||||
"documentation":"<p>Include one of these values to specify the following:</p> <ul> <li> <p>Whether you want viewers to use HTTP or HTTPS to request your objects.</p> </li> <li> <p>If you want viewers to use HTTPS, whether you're using an alternate domain name such as example.com or the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code>.</p> </li> <li> <p>If you're using an alternate domain name, whether AWS Certificate Manager (ACM) provided the certificate, or you purchased a certificate from a third-party certificate authority and imported it into ACM or uploaded it to the IAM certificate store.</p> </li> </ul> <p>You must specify one (and only one) of the three values. Do not specify <code>false</code> for <code>CloudFrontDefaultCertificate</code>.</p> <p> <b>If you want viewers to use HTTP to request your objects</b>: Specify the following value:</p> <p> <code><CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate></code> </p> <p>In addition, specify <code>allow-all</code> for <code>ViewerProtocolPolicy</code> for all of your cache behaviors.</p> <p> <b>If you want viewers to use HTTPS to request your objects</b>: Choose the type of certificate that you want to use based on whether you're using an alternate domain name for your objects or the CloudFront domain name:</p> <ul> <li> <p> <b>If you're using an alternate domain name, such as example.com</b>: Specify one of the following values, depending on whether ACM provided your certificate or you purchased your certificate from third-party certificate authority:</p> <ul> <li> <p> <code><ACMCertificateArn>ARN for ACM SSL/TLS certificate<ACMCertificateArn></code> where ARN for ACM SSL/TLS certificate is the ARN for the ACM SSL/TLS certificate that you want to use for this distribution.</p> </li> <li> <p> <code><IAMCertificateId>IAM certificate ID<IAMCertificateId></code> where IAM certificate ID is the ID that IAM returned when you added the certificate to the IAM certificate store.</p> </li> </ul> <p>If you specify <code>ACMCertificateArn</code> or <code>IAMCertificateId</code>, you must also specify a value for <code>SSLSupportMethod</code>.</p> <p>If you choose to use an ACM certificate or a certificate in the IAM certificate store, we recommend that you use only an alternate domain name in your object URLs (<code>https://example.com/logo.jpg</code>). If you use the domain name that is associated with your CloudFront distribution (<code>https://d111111abcdef8.cloudfront.net/logo.jpg</code>) and the viewer supports <code>SNI</code>, then CloudFront behaves normally. However, if the browser does not support SNI, the user's experience depends on the value that you choose for <code>SSLSupportMethod</code>:</p> <ul> <li> <p> <code>vip</code>: The viewer displays a warning because there is a mismatch between the CloudFront domain name and the domain name in your SSL/TLS certificate.</p> </li> <li> <p> <code>sni-only</code>: CloudFront drops the connection with the browser without returning the object.</p> </li> </ul> </li> <li> <p> <b>If you're using the CloudFront domain name for your distribution, such as <code>d111111abcdef8.cloudfront.net</code> </b>: Specify the following value:</p> <p> <code> <CloudFrontDefaultCertificate>true<CloudFrontDefaultCertificate> </code> </p> <p>If you want viewers to use HTTPS, you must also specify one of the following values in your cache behaviors:</p> <ul> <li> <p> <code> <ViewerProtocolPolicy>https-only<ViewerProtocolPolicy> </code> </p> </li> <li> <p> <code> <ViewerProtocolPolicy>redirect-to-https<ViewerProtocolPolicy> </code> </p> </li> </ul> <p>You can also optionally require that CloudFront use HTTPS to communicate with your origin by specifying one of the following values for the applicable origins:</p> <ul> <li> <p> <code> <OriginProtocolPolicy>https-only<OriginProtocolPolicy> </code> </p> </li> <li> <p> <code> <OriginProtocolPolicy>match-viewer<OriginProtocolPolicy> </code> </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html#CNAMEsAndHTTPS\">Using Alternate Domain Names and HTTPS</a> in the <i>Amazon CloudFront Developer Guide</i>.</p> </li> </ul>",
|
||||
"deprecated":true
|
||||
},
|
||||
"CertificateSource":{
|
||||
"shape":"CertificateSource",
|
||||
"documentation":"<note> <p>This field is deprecated. You can use one of the following: <code>[ACMCertificateArn</code>, <code>IAMCertificateId</code>, or <code>CloudFrontDefaultCertificate]</code>.</p> </note>",
|
||||
"deprecated":true
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A complex type that specifies the following:</p> <ul> <li> <p>Which SSL/TLS certificate to use when viewers request objects using HTTPS</p> </li> <li> <p>Whether you want CloudFront to use dedicated IP addresses or SNI when you're using alternate domain names in your object names</p> </li> <li> <p>The minimum protocol version that you want CloudFront to use when communicating with viewers</p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/SecureConnections.html\">Using an HTTPS Connection to Access Your Objects</a> in the <i>Amazon Amazon CloudFront Developer Guide</i>.</p>"
|
||||
},
|
||||
"ViewerProtocolPolicy":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"allow-all",
|
||||
"https-only",
|
||||
"redirect-to-https"
|
||||
]
|
||||
},
|
||||
"boolean":{"type":"boolean"},
|
||||
"integer":{"type":"integer"},
|
||||
"long":{"type":"long"},
|
||||
"string":{"type":"string"},
|
||||
"timestamp":{"type":"timestamp"}
|
||||
},
|
||||
"documentation":"<fullname>Amazon CloudFront</fullname> <p>This is the <i>Amazon CloudFront API Reference</i>. This guide is for developers who need detailed information about the CloudFront API actions, data types, and errors. For detailed information about CloudFront features and their associated API calls, see the <i>Amazon CloudFront Developer Guide</i>.</p>"
|
||||
}
|
||||
47
botocore/data/cloudfront/2017-03-25/waiters-2.json
Normal file
47
botocore/data/cloudfront/2017-03-25/waiters-2.json
Normal file
|
|
@ -0,0 +1,47 @@
|
|||
{
|
||||
"version": 2,
|
||||
"waiters": {
|
||||
"DistributionDeployed": {
|
||||
"delay": 60,
|
||||
"operation": "GetDistribution",
|
||||
"maxAttempts": 25,
|
||||
"description": "Wait until a distribution is deployed.",
|
||||
"acceptors": [
|
||||
{
|
||||
"expected": "Deployed",
|
||||
"matcher": "path",
|
||||
"state": "success",
|
||||
"argument": "Distribution.Status"
|
||||
}
|
||||
]
|
||||
},
|
||||
"InvalidationCompleted": {
|
||||
"delay": 20,
|
||||
"operation": "GetInvalidation",
|
||||
"maxAttempts": 60,
|
||||
"description": "Wait until an invalidation has completed.",
|
||||
"acceptors": [
|
||||
{
|
||||
"expected": "Completed",
|
||||
"matcher": "path",
|
||||
"state": "success",
|
||||
"argument": "Invalidation.Status"
|
||||
}
|
||||
]
|
||||
},
|
||||
"StreamingDistributionDeployed": {
|
||||
"delay": 60,
|
||||
"operation": "GetStreamingDistribution",
|
||||
"maxAttempts": 25,
|
||||
"description": "Wait until a streaming distribution is deployed.",
|
||||
"acceptors": [
|
||||
{
|
||||
"expected": "Deployed",
|
||||
"matcher": "path",
|
||||
"state": "success",
|
||||
"argument": "StreamingDistribution.Status"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
5
botocore/data/cloudhsm/2014-05-30/examples-1.json
Normal file
5
botocore/data/cloudhsm/2014-05-30/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
3
botocore/data/cloudsearch/2013-01-01/paginators-1.json
Normal file
3
botocore/data/cloudsearch/2013-01-01/paginators-1.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
5
botocore/data/cloudtrail/2013-11-01/examples-1.json
Normal file
5
botocore/data/cloudtrail/2013-11-01/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
10
botocore/data/cloudtrail/2013-11-01/paginators-1.json
Normal file
10
botocore/data/cloudtrail/2013-11-01/paginators-1.json
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
{
|
||||
"pagination": {
|
||||
"LookupEvents": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"result_key": "Events"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
@ -112,7 +112,7 @@
|
|||
{"shape":"UnsupportedOperationException"},
|
||||
{"shape":"OperationNotPermittedException"}
|
||||
],
|
||||
"documentation":"<p>Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:</p> <ul> <li> <p>The S3 objects that you are logging for data events.</p> </li> <li> <p>If your event selector includes management events.</p> </li> <li> <p>If your event selector includes read-only events, write-only events, or all. </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create-event-selectors-for-a-trail.html\">Configuring Event Selectors for Trails</a> in the <i>AWS CloudTrail User Guide</i>.</p>",
|
||||
"documentation":"<p>Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:</p> <ul> <li> <p>The S3 objects that you are logging for data events.</p> </li> <li> <p>If your event selector includes management events.</p> </li> <li> <p>If your event selector includes read-only events, write-only events, or all. </p> </li> </ul> <p>For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html\">Logging Data and Management Events for Trails </a> in the <i>AWS CloudTrail User Guide</i>.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"GetTrailStatus":{
|
||||
|
|
@ -181,7 +181,7 @@
|
|||
{"shape":"InvalidMaxResultsException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
],
|
||||
"documentation":"<p>Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports the following attributes:</p> <ul> <li> <p>Event ID</p> </li> <li> <p>Event name</p> </li> <li> <p>Resource name</p> </li> <li> <p>Resource type</p> </li> <li> <p>User name</p> </li> </ul> <p>All attributes are optional. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.</p> <important> <p>The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.</p> </important> <important> <p>Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.</p> </important>",
|
||||
"documentation":"<p>Looks up API activity events captured by CloudTrail that create, update, or delete resources in your account. Events for a region can be looked up for the times in which you had CloudTrail turned on in that region during the last seven days. Lookup supports the following attributes:</p> <ul> <li> <p>Event ID</p> </li> <li> <p>Event name</p> </li> <li> <p>Event source</p> </li> <li> <p>Resource name</p> </li> <li> <p>Resource type</p> </li> <li> <p>User name</p> </li> </ul> <p>All attributes are optional. The default number of results returned is 10, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.</p> <important> <p>The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.</p> </important> <important> <p>Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.</p> </important>",
|
||||
"idempotent":true
|
||||
},
|
||||
"PutEventSelectors":{
|
||||
|
|
@ -200,7 +200,7 @@
|
|||
{"shape":"UnsupportedOperationException"},
|
||||
{"shape":"OperationNotPermittedException"}
|
||||
],
|
||||
"documentation":"<p>Configures an event selector for your trail. Use event selectors to specify the type of events that you want your trail to log. When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. </p> <p>Example</p> <ol> <li> <p>You create an event selector for a trail and specify that you want write-only events.</p> </li> <li> <p>The EC2 <code>GetConsoleOutput</code> and <code>RunInstances</code> API operations occur in your account.</p> </li> <li> <p>CloudTrail evaluates whether the events match your event selectors.</p> </li> <li> <p>The <code>RunInstances</code> is a write-only event and it matches your event selector. The trail logs the event.</p> </li> <li> <p>The <code>GetConsoleOutput</code> is a read-only event but it doesn't match your event selector. The trail doesn't log the event. </p> </li> </ol> <p>The <code>PutEventSelectors</code> operation must be called from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> is thrown.</p> <p>You can configure up to five event selectors for each trail. For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create-event-selectors-for-a-trail.html\">Configuring Event Selectors for Trails</a> in the <i>AWS CloudTrail User Guide</i>.</p>",
|
||||
"documentation":"<p>Configures an event selector for your trail. Use event selectors to specify whether you want your trail to log management and/or data events. When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event. </p> <p>Example</p> <ol> <li> <p>You create an event selector for a trail and specify that you want write-only events.</p> </li> <li> <p>The EC2 <code>GetConsoleOutput</code> and <code>RunInstances</code> API operations occur in your account.</p> </li> <li> <p>CloudTrail evaluates whether the events match your event selectors.</p> </li> <li> <p>The <code>RunInstances</code> is a write-only event and it matches your event selector. The trail logs the event.</p> </li> <li> <p>The <code>GetConsoleOutput</code> is a read-only event but it doesn't match your event selector. The trail doesn't log the event. </p> </li> </ol> <p>The <code>PutEventSelectors</code> operation must be called from the region in which the trail was created; otherwise, an <code>InvalidHomeRegionException</code> is thrown.</p> <p>You can configure up to five event selectors for each trail. For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html\">Logging Data and Management Events for Trails </a> in the <i>AWS CloudTrail User Guide</i>.</p>",
|
||||
"idempotent":true
|
||||
},
|
||||
"RemoveTags":{
|
||||
|
|
@ -373,7 +373,7 @@
|
|||
},
|
||||
"KmsKeyId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.</p> <p>Examples:</p> <ul> <li> <p>alias/MyAliasName</p> </li> <li> <p>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</p> </li> <li> <p>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</p> </li> <li> <p>12345678-1234-1234-1234-123456789012</p> </li> </ul>"
|
||||
"documentation":"<p>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.</p> <p>Examples:</p> <ul> <li> <p>alias/MyAliasName</p> </li> <li> <p>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</p> </li> <li> <p>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</p> </li> <li> <p>12345678-1234-1234-1234-123456789012</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Specifies the settings for each trail.</p>"
|
||||
|
|
@ -445,7 +445,7 @@
|
|||
"documentation":"<p>A list of ARN-like strings for the specified S3 objects.</p> <p>To log data events for all objects in an S3 bucket, specify the bucket and an empty object prefix such as <code>arn:aws:s3:::bucket-1/</code>. The trail logs data events for all objects in this S3 bucket.</p> <p>To log data events for specific objects, specify the S3 bucket and object prefix such as <code>arn:aws:s3:::bucket-1/example-images</code>. The trail logs data events for objects in this S3 bucket that match the prefix.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The Amazon S3 objects that you specify in your event selectors for your trail to log data events. Data events are object level API operations that access S3 objects, such as <code>GetObject</code>, <code>DeleteObject</code>, and <code>PutObject</code>. You can specify up to 50 S3 buckets and object prefixes for an event selector. </p> <p>Example</p> <ol> <li> <p>You create an event selector for a trail and specify an S3 bucket and an empty prefix, such as <code>arn:aws:s3:::bucket-1/</code>.</p> </li> <li> <p>You upload an image file to <code>bucket-1</code>.</p> </li> <li> <p>The <code>PutObject</code> API operation occurs on an object in the S3 bucket that you specified in the event selector. The trail processes and logs the event.</p> </li> <li> <p>You upload another image file to a different S3 bucket named <code>arn:aws:s3:::bucket-2</code>.</p> </li> <li> <p>The event occurs on an object in an S3 bucket that you didn't specify in the event selector. The trail doesn’t log the event.</p> </li> </ol>"
|
||||
"documentation":"<p>The Amazon S3 objects that you specify in your event selectors for your trail to log data events. Data events are object-level API operations that access S3 objects, such as <code>GetObject</code>, <code>DeleteObject</code>, and <code>PutObject</code>. You can specify up to 250 S3 buckets and object prefixes for a trail. </p> <p>Example</p> <ol> <li> <p>You create an event selector for a trail and specify an S3 bucket and an empty prefix, such as <code>arn:aws:s3:::bucket-1/</code>.</p> </li> <li> <p>You upload an image file to <code>bucket-1</code>.</p> </li> <li> <p>The <code>PutObject</code> API operation occurs on an object in the S3 bucket that you specified in the event selector. The trail processes and logs the event.</p> </li> <li> <p>You upload another image file to a different S3 bucket named <code>arn:aws:s3:::bucket-2</code>.</p> </li> <li> <p>The event occurs on an object in an S3 bucket that you didn't specify in the event selector. The trail doesn’t log the event.</p> </li> </ol>"
|
||||
},
|
||||
"DataResourceValues":{
|
||||
"type":"list",
|
||||
|
|
@ -540,14 +540,14 @@
|
|||
},
|
||||
"IncludeManagementEvents":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Specify if you want your event selector to include management events for your trail.</p> <p> For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create-event-selectors-for-a-trail.html#event-selector-for-management-events\">Management Events</a> in the <i>AWS CloudTrail User Guide</i>.</p> <p>By default, the value is <code>true</code>.</p>"
|
||||
"documentation":"<p>Specify if you want your event selector to include management events for your trail.</p> <p> For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-management-events\">Management Events</a> in the <i>AWS CloudTrail User Guide</i>.</p> <p>By default, the value is <code>true</code>.</p>"
|
||||
},
|
||||
"DataResources":{
|
||||
"shape":"DataResources",
|
||||
"documentation":"<p>CloudTrail supports logging only data events for S3 objects. You can specify up to 50 S3 buckets and object prefixes for an event selector.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/create-event-selectors-for-a-trail.html#data-events-resources\">Data Events</a> in the <i>AWS CloudTrail User Guide</i>.</p>"
|
||||
"documentation":"<p>CloudTrail supports logging only data events for S3 objects. You can specify up to 250 S3 buckets and object prefixes for a trail.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/awscloudtrail/latest/userguide/logging-management-and-data-events-with-cloudtrail.html#logging-data-events\">Data Events</a> in the <i>AWS CloudTrail User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Use event selectors to specify the types of events that you want your trail to log. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.</p> <p>You can configure up to five event selectors for a trail.</p>"
|
||||
"documentation":"<p>Use event selectors to specify whether you want your trail to log management and/or data events. When an event occurs in your account, CloudTrail evaluates the event selector for all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.</p> <p>You can configure up to five event selectors for a trail.</p>"
|
||||
},
|
||||
"EventSelectors":{
|
||||
"type":"list",
|
||||
|
|
@ -559,6 +559,7 @@
|
|||
},
|
||||
"GetEventSelectorsRequest":{
|
||||
"type":"structure",
|
||||
"required":["TrailName"],
|
||||
"members":{
|
||||
"TrailName":{
|
||||
"shape":"String",
|
||||
|
|
@ -703,7 +704,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>This exception is thrown when the <code>PutEventSelectors</code> operation is called with an invalid number of event selectors, data resources, or an invalid value for a parameter:</p> <ul> <li> <p>Specify a valid number of event selectors (1 to 5) for a trail.</p> </li> <li> <p>Specify a valid number of data resources (1 to 50) for an event selector.</p> </li> <li> <p>Specify a valid value for a parameter. For example, specifying the <code>ReadWriteType</code> parameter with a value of <code>read-only</code> is invalid.</p> </li> </ul>",
|
||||
"documentation":"<p>This exception is thrown when the <code>PutEventSelectors</code> operation is called with an invalid number of event selectors, data resources, or an invalid value for a parameter:</p> <ul> <li> <p>Specify a valid number of event selectors (1 to 5) for a trail.</p> </li> <li> <p>Specify a valid number of data resources (1 to 250) for an event selector.</p> </li> <li> <p>Specify a valid value for a parameter. For example, specifying the <code>ReadWriteType</code> parameter with a value of <code>read-only</code> is invalid.</p> </li> </ul>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidHomeRegionException":{
|
||||
|
|
@ -869,7 +870,10 @@
|
|||
"ListTagsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ResourceTagList":{"shape":"ResourceTagList"},
|
||||
"ResourceTagList":{
|
||||
"shape":"ResourceTagList",
|
||||
"documentation":"<p>A list of resource tags.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Reserved for future use.</p>"
|
||||
|
|
@ -998,6 +1002,10 @@
|
|||
},
|
||||
"PutEventSelectorsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TrailName",
|
||||
"EventSelectors"
|
||||
],
|
||||
"members":{
|
||||
"TrailName":{
|
||||
"shape":"String",
|
||||
|
|
@ -1088,14 +1096,16 @@
|
|||
"shape":"String",
|
||||
"documentation":"<p>Specifies the ARN of the resource.</p>"
|
||||
},
|
||||
"TagsList":{"shape":"TagsList"}
|
||||
"TagsList":{
|
||||
"shape":"TagsList",
|
||||
"documentation":"<p>A list of tags.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A resource tag.</p>"
|
||||
},
|
||||
"ResourceTagList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ResourceTag"},
|
||||
"documentation":"<p>A list of resource tags.</p>"
|
||||
"member":{"shape":"ResourceTag"}
|
||||
},
|
||||
"ResourceTypeNotSupportedException":{
|
||||
"type":"structure",
|
||||
|
|
@ -1314,7 +1324,7 @@
|
|||
},
|
||||
"KmsKeyId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be a an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.</p> <p>Examples:</p> <ul> <li> <p>alias/MyAliasName</p> </li> <li> <p>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</p> </li> <li> <p>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</p> </li> <li> <p>12345678-1234-1234-1234-123456789012</p> </li> </ul>"
|
||||
"documentation":"<p>Specifies the KMS key ID to use to encrypt the logs delivered by CloudTrail. The value can be an alias name prefixed by \"alias/\", a fully specified ARN to an alias, a fully specified ARN to a key, or a globally unique identifier.</p> <p>Examples:</p> <ul> <li> <p>alias/MyAliasName</p> </li> <li> <p>arn:aws:kms:us-east-1:123456789012:alias/MyAliasName</p> </li> <li> <p>arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012</p> </li> <li> <p>12345678-1234-1234-1234-123456789012</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Specifies settings to update for the trail.</p>"
|
||||
|
|
|
|||
5
botocore/data/cloudwatch/2010-08-01/examples-1.json
Normal file
5
botocore/data/cloudwatch/2010-08-01/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
|
|
@ -1,13 +1,13 @@
|
|||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"uid":"monitoring-2010-08-01",
|
||||
"apiVersion":"2010-08-01",
|
||||
"endpointPrefix":"monitoring",
|
||||
"protocol":"query",
|
||||
"serviceAbbreviation":"CloudWatch",
|
||||
"serviceFullName":"Amazon CloudWatch",
|
||||
"signatureVersion":"v4",
|
||||
"uid":"monitoring-2010-08-01",
|
||||
"xmlNamespace":"http://monitoring.amazonaws.com/doc/2010-08-01/"
|
||||
},
|
||||
"operations":{
|
||||
|
|
@ -103,7 +103,7 @@
|
|||
{"shape":"InvalidParameterCombinationException"},
|
||||
{"shape":"InternalServiceFault"}
|
||||
],
|
||||
"documentation":"<p>Gets statistics for the specified metric.</p> <p>Amazon CloudWatch retains metric data as follows:</p> <ul> <li> <p>Data points with a period of 60 seconds (1 minute) are available for 15 days</p> </li> <li> <p>Data points with a period of 300 seconds (5 minute) are available for 63 days</p> </li> <li> <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months)</p> </li> </ul> <p>Note that CloudWatch started retaining 5-minute and 1-hour metric data as of 9 July 2016.</p> <p>The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, Amazon CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. A period can be as short as one minute (60 seconds). Note that data points are not returned in chronological order.</p> <p>Amazon CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, Amazon CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.</p> <p>For a list of metrics and dimensions supported by AWS services, see the <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html\">Amazon CloudWatch Metrics and Dimensions Reference</a> in the <i>Amazon CloudWatch User Guide</i>.</p>"
|
||||
"documentation":"<p>Gets statistics for the specified metric.</p> <p>Amazon CloudWatch retains metric data as follows:</p> <ul> <li> <p>Data points with a period of 60 seconds (1 minute) are available for 15 days</p> </li> <li> <p>Data points with a period of 300 seconds (5 minute) are available for 63 days</p> </li> <li> <p>Data points with a period of 3600 seconds (1 hour) are available for 455 days (15 months)</p> </li> </ul> <p>Note that CloudWatch started retaining 5-minute and 1-hour metric data as of 9 July 2016.</p> <p>The maximum number of data points returned from a single call is 1,440. If you request more than 1,440 data points, Amazon CloudWatch returns an error. To reduce the number of data points, you can narrow the specified time range and make multiple requests across adjacent time ranges, or you can increase the specified period. A period can be as short as one minute (60 seconds). Note that data points are not returned in chronological order.</p> <p>Amazon CloudWatch aggregates data points based on the length of the period that you specify. For example, if you request statistics with a one-hour period, Amazon CloudWatch aggregates all data points with time stamps that fall within each one-hour period. Therefore, the number of values aggregated by CloudWatch is larger than the number of data points returned.</p> <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you cannot retrieve percentile statistics for this data unless one of the following conditions is true:</p> <ul> <li> <p>The SampleCount of the statistic set is 1</p> </li> <li> <p>The Min and the Max of the statistic set are equal</p> </li> </ul> <p>For a list of metrics and dimensions supported by AWS services, see the <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CW_Support_For_AWS.html\">Amazon CloudWatch Metrics and Dimensions Reference</a> in the <i>Amazon CloudWatch User Guide</i>.</p>"
|
||||
},
|
||||
"ListMetrics":{
|
||||
"name":"ListMetrics",
|
||||
|
|
@ -147,7 +147,7 @@
|
|||
{"shape":"InvalidParameterCombinationException"},
|
||||
{"shape":"InternalServiceFault"}
|
||||
],
|
||||
"documentation":"<p>Publishes metric data points to Amazon CloudWatch. Amazon CloudWatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric. When Amazon CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to <a>ListMetrics</a>.</p> <p>Each <code>PutMetricData</code> request is limited to 8 KB in size for HTTP GET requests and is limited to 40 KB in size for HTTP POST requests.</p> <p>Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported.</p> <p>Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for <a>GetMetricStatistics</a> from the time they are submitted.</p>"
|
||||
"documentation":"<p>Publishes metric data points to Amazon CloudWatch. Amazon CloudWatch associates the data points with the specified metric. If the specified metric does not exist, Amazon CloudWatch creates the metric. When Amazon CloudWatch creates a metric, it can take up to fifteen minutes for the metric to appear in calls to <a>ListMetrics</a>.</p> <p>Each <code>PutMetricData</code> request is limited to 40 KB in size for HTTP POST requests.</p> <p>Although the <code>Value</code> parameter accepts numbers of type <code>Double</code>, Amazon CloudWatch rejects values that are either too small or too large. Values must be in the range of 8.515920e-109 to 1.174271e+108 (Base 10) or 2e-360 to 2e360 (Base 2). In addition, special values (e.g., NaN, +Infinity, -Infinity) are not supported.</p> <p>You can use up to 10 dimensions per metric to further clarify what data the metric collects. For more information on specifying dimensions, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html\">Publishing Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p> <p>Data points with time stamps from 24 hours ago or longer can take at least 48 hours to become available for <a>GetMetricStatistics</a> from the time they are submitted.</p> <p>CloudWatch needs raw data points to calculate percentile statistics. If you publish data using a statistic set instead, you cannot retrieve percentile statistics for this data unless one of the following conditions is true:</p> <ul> <li> <p>The SampleCount of the statistic set is 1</p> </li> <li> <p>The Min and the Max of the statistic set are equal</p> </li> </ul>"
|
||||
},
|
||||
"SetAlarmState":{
|
||||
"name":"SetAlarmState",
|
||||
|
|
@ -515,6 +515,11 @@
|
|||
"max":255,
|
||||
"min":1
|
||||
},
|
||||
"EvaluateLowSampleCountPercentile":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1
|
||||
},
|
||||
"EvaluationPeriods":{
|
||||
"type":"integer",
|
||||
"min":1
|
||||
|
|
@ -550,7 +555,7 @@
|
|||
},
|
||||
"Dimensions":{
|
||||
"shape":"Dimensions",
|
||||
"documentation":"<p>The dimensions. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. You must specify the same dimensions that were used when the metrics were created. For an example, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations\">Dimension Combinations</a> in the <i>Amazon CloudWatch User Guide</i>.</p>"
|
||||
"documentation":"<p>The dimensions. If the metric contains multiple dimensions, you must include a value for each dimension. CloudWatch treats each unique combination of dimensions as a separate metric. You can't retrieve statistics using combinations of dimensions that were not specially published. You must specify the same dimensions that were used when the metrics were created. For an example, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#dimension-combinations\">Dimension Combinations</a> in the <i>Amazon CloudWatch User Guide</i>. For more information on specifying dimensions, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html\">Publishing Metrics</a> in the <i>Amazon CloudWatch User Guide</i>.</p>"
|
||||
},
|
||||
"StartTime":{
|
||||
"shape":"Timestamp",
|
||||
|
|
@ -861,7 +866,9 @@
|
|||
"ComparisonOperator":{
|
||||
"shape":"ComparisonOperator",
|
||||
"documentation":"<p>The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.</p>"
|
||||
}
|
||||
},
|
||||
"TreatMissingData":{"shape":"TreatMissingData"},
|
||||
"EvaluateLowSampleCountPercentile":{"shape":"EvaluateLowSampleCountPercentile"}
|
||||
},
|
||||
"documentation":"<p>Represents an alarm.</p>",
|
||||
"xmlOrder":[
|
||||
|
|
@ -886,7 +893,9 @@
|
|||
"EvaluationPeriods",
|
||||
"Threshold",
|
||||
"ComparisonOperator",
|
||||
"ExtendedStatistic"
|
||||
"ExtendedStatistic",
|
||||
"TreatMissingData",
|
||||
"EvaluateLowSampleCountPercentile"
|
||||
]
|
||||
},
|
||||
"MetricAlarms":{
|
||||
|
|
@ -1044,6 +1053,14 @@
|
|||
"ComparisonOperator":{
|
||||
"shape":"ComparisonOperator",
|
||||
"documentation":"<p> The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.</p>"
|
||||
},
|
||||
"TreatMissingData":{
|
||||
"shape":"TreatMissingData",
|
||||
"documentation":"<p> Sets how this alarm is to handle missing data points. If <code>TreatMissingData</code> is omitted, the default behavior of <code>missing</code> is used. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#alarms-and-missing-data\">Configuring How CloudWatch Alarms Treats Missing Data</a>.</p> <p>Valid Values: <code>breaching | notBreaching | ignore | missing</code> </p>"
|
||||
},
|
||||
"EvaluateLowSampleCountPercentile":{
|
||||
"shape":"EvaluateLowSampleCountPercentile",
|
||||
"documentation":"<p> Used only for alarms based on percentiles. If you specify <code>ignore</code>, the alarm state will not change during periods with too few data points to be statistically significant. If you specify <code>evaluate</code> or omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/AlarmThatSendsEmail.html#percentiles-with-low-samples\">Percentile-Based CloudWatch Alarms and Low Data Samples</a>.</p> <p>Valid Values: <code>evaluate | ignore</code> </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1211,7 +1228,12 @@
|
|||
"min":1
|
||||
},
|
||||
"Threshold":{"type":"double"},
|
||||
"Timestamp":{"type":"timestamp"}
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"TreatMissingData":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Amazon CloudWatch monitors your Amazon Web Services (AWS) resources and the applications you run on AWS in real-time. You can use CloudWatch to collect and track metrics, which are the variables you want to measure for your resources and applications.</p> <p>CloudWatch alarms send notifications or automatically make changes to the resources you are monitoring based on rules that you define. For example, you can monitor the CPU usage and disk reads and writes of your Amazon Elastic Compute Cloud (Amazon EC2) instances and then use this data to determine whether you should launch additional instances to handle increased load. You can also use this data to stop under-used instances to save money.</p> <p>In addition to monitoring the built-in metrics that come with AWS, you can monitor your own custom metrics. With CloudWatch, you gain system-wide visibility into resource utilization, application performance, and operational health.</p>"
|
||||
}
|
||||
|
|
|
|||
18
botocore/data/cloudwatch/2010-08-01/waiters-2.json
Normal file
18
botocore/data/cloudwatch/2010-08-01/waiters-2.json
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
{
|
||||
"version": 2,
|
||||
"waiters": {
|
||||
"AlarmExists": {
|
||||
"delay": 5,
|
||||
"maxAttempts": 40,
|
||||
"operation": "DescribeAlarms",
|
||||
"acceptors": [
|
||||
{
|
||||
"matcher": "path",
|
||||
"expected": true,
|
||||
"argument": "length(MetricAlarms[]) > `0`",
|
||||
"state": "success"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
5
botocore/data/codebuild/2016-10-06/examples-1.json
Normal file
5
botocore/data/codebuild/2016-10-06/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
3
botocore/data/codebuild/2016-10-06/paginators-1.json
Normal file
3
botocore/data/codebuild/2016-10-06/paginators-1.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
|
|
@ -533,7 +533,7 @@
|
|||
},
|
||||
"value":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The value of the environment variable.</p>"
|
||||
"documentation":"<p>The value of the environment variable.</p> <important> <p>We strongly discourage using environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using tools such as the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI).</p> </important>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about an environment variable for a build project or a build.</p>"
|
||||
|
|
@ -830,6 +830,10 @@
|
|||
"environmentVariables":{
|
||||
"shape":"EnvironmentVariables",
|
||||
"documentation":"<p>A set of environment variables to make available to builds for this build project.</p>"
|
||||
},
|
||||
"privilegedMode":{
|
||||
"shape":"WrapperBoolean",
|
||||
"documentation":"<p>If set to true, enables running the Docker daemon inside a Docker container; otherwise, false or not specified (the default). This value must be set to true only if this build project will be used to build Docker images, and the specified build environment image is not one provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that your builds can interact with it as needed. One way to do this is to initialize the Docker daemon in the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)</p> <p> <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=vfs& - timeout -t 15 sh -c \"until docker info; do echo .; sleep 1; done\"</code> </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about the build environment of the build project.</p>"
|
||||
|
|
@ -864,7 +868,7 @@
|
|||
},
|
||||
"location":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Information about the location of the source code to be built. Valid values include:</p> <ul> <li> <p>For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, <code>location</code> should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.</p> </li> <li> <p>For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, <code>https://git-codecommit.<i>region-ID</i>.amazonaws.com/v1/repos/<i>repo-name</i> </code>).</p> </li> <li> <p>For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, <code> <i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>object-name</i>.zip</code>)</p> </li> <li> <p>For source code in a GitHub repository, instead of specifying a value here, you connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project, and follow the on-screen instructions to complete the connection. (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> </ul>"
|
||||
"documentation":"<p>Information about the location of the source code to be built. Valid values include:</p> <ul> <li> <p>For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, <code>location</code> should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.</p> </li> <li> <p>For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, <code>https://git-codecommit.<i>region-ID</i>.amazonaws.com/v1/repos/<i>repo-name</i> </code>).</p> </li> <li> <p>For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, <code> <i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>object-name</i>.zip</code>)</p> </li> <li> <p>For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub <b>Authorize application</b> page that displays, for <b>Organization access</b>, choose <b>Request access</b> next to each repository you want to allow AWS CodeBuild to have access to. Then choose <b>Authorize application</b>. (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</p> </li> </ul>"
|
||||
},
|
||||
"buildspec":{
|
||||
"shape":"String",
|
||||
|
|
@ -1023,7 +1027,7 @@
|
|||
"TimeOut":{
|
||||
"type":"integer",
|
||||
"max":480,
|
||||
"min":1
|
||||
"min":5
|
||||
},
|
||||
"Timestamp":{"type":"timestamp"},
|
||||
"UpdateProjectInput":{
|
||||
|
|
@ -1083,6 +1087,7 @@
|
|||
"min":1,
|
||||
"pattern":"^([\\\\p{L}\\\\p{Z}\\\\p{N}_.:/=@+\\\\-]*)$"
|
||||
},
|
||||
"WrapperBoolean":{"type":"boolean"},
|
||||
"WrapperInt":{"type":"integer"},
|
||||
"WrapperLong":{"type":"long"}
|
||||
},
|
||||
|
|
|
|||
5
botocore/data/codecommit/2015-04-13/examples-1.json
Normal file
5
botocore/data/codecommit/2015-04-13/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
|
|
@ -1,14 +1,14 @@
|
|||
{
|
||||
"pagination": {
|
||||
"ListBranches": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "branches"
|
||||
},
|
||||
"ListRepositories": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "repositories"
|
||||
}
|
||||
"pagination": {
|
||||
"ListBranches": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "branches"
|
||||
},
|
||||
"ListRepositories": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "repositories"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
5
botocore/data/codedeploy/2014-10-06/examples-1.json
Normal file
5
botocore/data/codedeploy/2014-10-06/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
34
botocore/data/codedeploy/2014-10-06/paginators-1.json
Normal file
34
botocore/data/codedeploy/2014-10-06/paginators-1.json
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
{
|
||||
"pagination": {
|
||||
"ListApplicationRevisions": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "revisions"
|
||||
},
|
||||
"ListApplications": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "applications"
|
||||
},
|
||||
"ListDeploymentConfigs": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "deploymentConfigsList"
|
||||
},
|
||||
"ListDeploymentGroups": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "deploymentGroups"
|
||||
},
|
||||
"ListDeploymentInstances": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "instancesList"
|
||||
},
|
||||
"ListDeployments": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "deployments"
|
||||
}
|
||||
}
|
||||
}
|
||||
297
botocore/data/codedeploy/2014-10-06/service-2.json
Executable file → Normal file
297
botocore/data/codedeploy/2014-10-06/service-2.json
Executable file → Normal file
|
|
@ -145,7 +145,7 @@
|
|||
{"shape":"DeploymentIsNotInReadyStateException"},
|
||||
{"shape":"UnsupportedActionForDeploymentTypeException"}
|
||||
],
|
||||
"documentation":"<p>Starts the process of rerouting traffic from instances in the original environment to instances in thereplacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.) </p>"
|
||||
"documentation":"<p>For a blue/green deployment, starts the process of rerouting traffic from instances in the original environment to instances in the replacement environment without waiting for a specified wait time to elapse. (Traffic rerouting, which is achieved by registering instances in the replacement environment with the load balancer, can start as soon as all instances have a status of Ready.) </p>"
|
||||
},
|
||||
"CreateApplication":{
|
||||
"name":"CreateApplication",
|
||||
|
|
@ -187,7 +187,8 @@
|
|||
{"shape":"DeploymentLimitExceededException"},
|
||||
{"shape":"InvalidTargetInstancesException"},
|
||||
{"shape":"InvalidAutoRollbackConfigException"},
|
||||
{"shape":"InvalidLoadBalancerInfoException"}
|
||||
{"shape":"InvalidLoadBalancerInfoException"},
|
||||
{"shape":"InvalidFileExistsBehaviorException"}
|
||||
],
|
||||
"documentation":"<p>Deploys an application revision through the specified deployment group.</p>"
|
||||
},
|
||||
|
|
@ -494,7 +495,8 @@
|
|||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"InvalidDeploymentIdException"},
|
||||
{"shape":"InvalidInstanceStatusException"},
|
||||
{"shape":"InvalidInstanceTypeException"}
|
||||
{"shape":"InvalidInstanceTypeException"},
|
||||
{"shape":"InvalidDeploymentInstanceTypeException"}
|
||||
],
|
||||
"documentation":"<p>Lists the instance for a deployment associated with the applicable IAM user or AWS account.</p>"
|
||||
},
|
||||
|
|
@ -519,6 +521,20 @@
|
|||
],
|
||||
"documentation":"<p>Lists the deployments in a deployment group for an application registered with the applicable IAM user or AWS account.</p>"
|
||||
},
|
||||
"ListGitHubAccountTokenNames":{
|
||||
"name":"ListGitHubAccountTokenNames",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListGitHubAccountTokenNamesInput"},
|
||||
"output":{"shape":"ListGitHubAccountTokenNamesOutput"},
|
||||
"errors":[
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ResourceValidationException"}
|
||||
],
|
||||
"documentation":"<p>Lists the names of stored connections to GitHub accounts.</p>"
|
||||
},
|
||||
"ListOnPremisesInstances":{
|
||||
"name":"ListOnPremisesInstances",
|
||||
"http":{
|
||||
|
|
@ -765,6 +781,10 @@
|
|||
"linkedToGitHub":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>True if the user has authenticated with GitHub for the specified application; otherwise, false.</p>"
|
||||
},
|
||||
"gitHubAccountName":{
|
||||
"shape":"GitHubAccountTokenName",
|
||||
"documentation":"<p>The name for a connection to a GitHub account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about an application.</p>"
|
||||
|
|
@ -870,7 +890,7 @@
|
|||
"documentation":"<p>Information to get about the application revisions, including type and location.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a batch get application revisions operation.</p>"
|
||||
"documentation":"<p>Represents the input of a BatchGetApplicationRevisions operation.</p>"
|
||||
},
|
||||
"BatchGetApplicationRevisionsOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -888,7 +908,7 @@
|
|||
"documentation":"<p>Additional information about the revisions, including the type and location.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a batch get application revisions operation.</p>"
|
||||
"documentation":"<p>Represents the output of a BatchGetApplicationRevisions operation.</p>"
|
||||
},
|
||||
"BatchGetApplicationsInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -898,7 +918,7 @@
|
|||
"documentation":"<p>A list of application names separated by spaces.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a batch get applications operation.</p>"
|
||||
"documentation":"<p>Represents the input of a BatchGetApplications operation.</p>"
|
||||
},
|
||||
"BatchGetApplicationsOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -908,7 +928,7 @@
|
|||
"documentation":"<p>Information about the applications.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a batch get applications operation.</p>"
|
||||
"documentation":"<p>Represents the output of a BatchGetApplications operation.</p>"
|
||||
},
|
||||
"BatchGetDeploymentGroupsInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -926,7 +946,7 @@
|
|||
"documentation":"<p>The deployment groups' names.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a batch get deployment groups operation.</p>"
|
||||
"documentation":"<p>Represents the input of a BatchGetDeploymentGroups operation.</p>"
|
||||
},
|
||||
"BatchGetDeploymentGroupsOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -940,7 +960,7 @@
|
|||
"documentation":"<p>Information about errors that may have occurred during the API call.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a batch get deployment groups operation.</p>"
|
||||
"documentation":"<p>Represents the output of a BatchGetDeploymentGroups operation.</p>"
|
||||
},
|
||||
"BatchGetDeploymentInstancesInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -958,7 +978,7 @@
|
|||
"documentation":"<p>The unique IDs of instances in the deployment group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a batch get deployment instances operation.</p>"
|
||||
"documentation":"<p>Represents the input of a BatchGetDeploymentInstances operation.</p>"
|
||||
},
|
||||
"BatchGetDeploymentInstancesOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -972,7 +992,7 @@
|
|||
"documentation":"<p>Information about errors that may have occurred during the API call.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a batch get deployment instance operation.</p>"
|
||||
"documentation":"<p>Represents the output of a BatchGetDeploymentInstances operation.</p>"
|
||||
},
|
||||
"BatchGetDeploymentsInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -982,7 +1002,7 @@
|
|||
"documentation":"<p>A list of deployment IDs, separated by spaces.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a batch get deployments operation.</p>"
|
||||
"documentation":"<p>Represents the input of a BatchGetDeployments operation.</p>"
|
||||
},
|
||||
"BatchGetDeploymentsOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -992,7 +1012,7 @@
|
|||
"documentation":"<p>Information about the deployments.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a batch get deployments operation.</p>"
|
||||
"documentation":"<p>Represents the output of a BatchGetDeployments operation.</p>"
|
||||
},
|
||||
"BatchGetOnPremisesInstancesInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1002,7 +1022,7 @@
|
|||
"documentation":"<p>The names of the on-premises instances about which to get information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a batch get on-premises instances operation.</p>"
|
||||
"documentation":"<p>Represents the input of a BatchGetOnPremisesInstances operation.</p>"
|
||||
},
|
||||
"BatchGetOnPremisesInstancesOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1012,7 +1032,7 @@
|
|||
"documentation":"<p>Information about the on-premises instances.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a batch get on-premises instances operation.</p>"
|
||||
"documentation":"<p>Represents the output of a BatchGetOnPremisesInstances operation.</p>"
|
||||
},
|
||||
"BatchLimitExceededException":{
|
||||
"type":"structure",
|
||||
|
|
@ -1088,7 +1108,7 @@
|
|||
"documentation":"<p>The name of the application. This name must be unique with the applicable IAM user or AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a create application operation.</p>"
|
||||
"documentation":"<p>Represents the input of a CreateApplication operation.</p>"
|
||||
},
|
||||
"CreateApplicationOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1098,7 +1118,7 @@
|
|||
"documentation":"<p>A unique application ID.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a create application operation.</p>"
|
||||
"documentation":"<p>Represents the output of a CreateApplication operation.</p>"
|
||||
},
|
||||
"CreateDeploymentConfigInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1113,7 +1133,7 @@
|
|||
"documentation":"<p>The minimum number of healthy instances that should be available at any time during the deployment. There are two parameters expected in the input: type and value.</p> <p>The type parameter takes either of the following values:</p> <ul> <li> <p>HOST_COUNT: The value parameter represents the minimum number of healthy instances as an absolute value.</p> </li> <li> <p>FLEET_PERCENT: The value parameter represents the minimum number of healthy instances as a percentage of the total number of instances in the deployment. If you specify FLEET_PERCENT, at the start of the deployment, AWS CodeDeploy converts the percentage to the equivalent number of instance and rounds up fractional instances.</p> </li> </ul> <p>The value parameter takes an integer.</p> <p>For example, to set a minimum of 95% healthy instance, specify a type of FLEET_PERCENT and a value of 95.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a create deployment configuration operation.</p>"
|
||||
"documentation":"<p>Represents the input of a CreateDeploymentConfig operation.</p>"
|
||||
},
|
||||
"CreateDeploymentConfigOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1123,7 +1143,7 @@
|
|||
"documentation":"<p>A unique deployment configuration ID.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a create deployment configuration operation.</p>"
|
||||
"documentation":"<p>Represents the output of a CreateDeploymentConfig operation.</p>"
|
||||
},
|
||||
"CreateDeploymentGroupInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1143,15 +1163,15 @@
|
|||
},
|
||||
"deploymentConfigName":{
|
||||
"shape":"DeploymentConfigName",
|
||||
"documentation":"<p>If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.</p> <p>CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or the deployment group.</p> <p>For more information about the predefined deployment configurations in AWS CodeDeploy, see see <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html\">Working with Deployment Groups in AWS CodeDeploy</a> in the AWS CodeDeploy User Guide.</p>"
|
||||
"documentation":"<p>If specified, the deployment configuration name can be either one of the predefined configurations provided with AWS CodeDeploy or a custom deployment configuration that you create by calling the create deployment configuration operation.</p> <p>CodeDeployDefault.OneAtATime is the default deployment configuration. It is used if a configuration isn't specified for the deployment or the deployment group.</p> <p>For more information about the predefined deployment configurations in AWS CodeDeploy, see <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide/deployment-configurations.html\">Working with Deployment Groups in AWS CodeDeploy</a> in the AWS CodeDeploy User Guide.</p>"
|
||||
},
|
||||
"ec2TagFilters":{
|
||||
"shape":"EC2TagFilterList",
|
||||
"documentation":"<p>The Amazon EC2 tags on which to filter.</p>"
|
||||
"documentation":"<p>The Amazon EC2 tags on which to filter. The deployment group will include EC2 instances with any of the specified tags.</p>"
|
||||
},
|
||||
"onPremisesInstanceTagFilters":{
|
||||
"shape":"TagFilterList",
|
||||
"documentation":"<p>The on-premises instance tags on which to filter.</p>"
|
||||
"documentation":"<p>The on-premises instance tags on which to filter. The deployment group will include on-premises instances with any of the specified tags.</p>"
|
||||
},
|
||||
"autoScalingGroups":{
|
||||
"shape":"AutoScalingGroupNameList",
|
||||
|
|
@ -1167,7 +1187,7 @@
|
|||
},
|
||||
"alarmConfiguration":{
|
||||
"shape":"AlarmConfiguration",
|
||||
"documentation":"<p>Information to add about Amazon CloudWatch alarms when the deployment group is created. </p>"
|
||||
"documentation":"<p>Information to add about Amazon CloudWatch alarms when the deployment group is created.</p>"
|
||||
},
|
||||
"autoRollbackConfiguration":{
|
||||
"shape":"AutoRollbackConfiguration",
|
||||
|
|
@ -1175,7 +1195,7 @@
|
|||
},
|
||||
"deploymentStyle":{
|
||||
"shape":"DeploymentStyle",
|
||||
"documentation":"<p>Information about the type of deployment, standard or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.</p>"
|
||||
"documentation":"<p>Information about the type of deployment, in-place or blue/green, that you want to run and whether to route deployment traffic behind a load balancer.</p>"
|
||||
},
|
||||
"blueGreenDeploymentConfiguration":{
|
||||
"shape":"BlueGreenDeploymentConfiguration",
|
||||
|
|
@ -1183,10 +1203,10 @@
|
|||
},
|
||||
"loadBalancerInfo":{
|
||||
"shape":"LoadBalancerInfo",
|
||||
"documentation":"<p>Information about the load balancer used in a blue/green deployment.</p>"
|
||||
"documentation":"<p>Information about the load balancer used in a deployment.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a create deployment group operation.</p>"
|
||||
"documentation":"<p>Represents the input of a CreateDeploymentGroup operation.</p>"
|
||||
},
|
||||
"CreateDeploymentGroupOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1196,7 +1216,7 @@
|
|||
"documentation":"<p>A unique deployment group ID.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a create deployment group operation.</p>"
|
||||
"documentation":"<p>Represents the output of a CreateDeploymentGroup operation.</p>"
|
||||
},
|
||||
"CreateDeploymentInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1237,9 +1257,13 @@
|
|||
"updateOutdatedInstancesOnly":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Indicates whether to deploy to all instances or only to instances that are not running the latest application revision.</p>"
|
||||
},
|
||||
"fileExistsBehavior":{
|
||||
"shape":"FileExistsBehavior",
|
||||
"documentation":"<p>Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.</p> <p>The fileExistsBehavior parameter takes any of the following values:</p> <ul> <li> <p>DISALLOW: The deployment fails. This is also the default behavior if no option is specified.</p> </li> <li> <p>OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.</p> </li> <li> <p>RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a create deployment operation.</p>"
|
||||
"documentation":"<p>Represents the input of a CreateDeployment operation.</p>"
|
||||
},
|
||||
"CreateDeploymentOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1249,7 +1273,7 @@
|
|||
"documentation":"<p>A unique deployment ID.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a create deployment operation.</p>"
|
||||
"documentation":"<p>Represents the output of a CreateDeployment operation.</p>"
|
||||
},
|
||||
"DeleteApplicationInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1260,7 +1284,7 @@
|
|||
"documentation":"<p>The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a delete application operation.</p>"
|
||||
"documentation":"<p>Represents the input of a DeleteApplication operation.</p>"
|
||||
},
|
||||
"DeleteDeploymentConfigInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1271,7 +1295,7 @@
|
|||
"documentation":"<p>The name of a deployment configuration associated with the applicable IAM user or AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a delete deployment configuration operation.</p>"
|
||||
"documentation":"<p>Represents the input of a DeleteDeploymentConfig operation.</p>"
|
||||
},
|
||||
"DeleteDeploymentGroupInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1289,7 +1313,7 @@
|
|||
"documentation":"<p>The name of an existing deployment group for the specified application.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a delete deployment group operation.</p>"
|
||||
"documentation":"<p>Represents the input of a DeleteDeploymentGroup operation.</p>"
|
||||
},
|
||||
"DeleteDeploymentGroupOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1299,7 +1323,7 @@
|
|||
"documentation":"<p>If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a delete deployment group operation.</p>"
|
||||
"documentation":"<p>Represents the output of a DeleteDeploymentGroup operation.</p>"
|
||||
},
|
||||
"DeploymentAlreadyCompletedException":{
|
||||
"type":"structure",
|
||||
|
|
@ -1458,7 +1482,7 @@
|
|||
},
|
||||
"deploymentStyle":{
|
||||
"shape":"DeploymentStyle",
|
||||
"documentation":"<p>Information about the type of deployment, either standard or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>"
|
||||
"documentation":"<p>Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>"
|
||||
},
|
||||
"blueGreenDeploymentConfiguration":{
|
||||
"shape":"BlueGreenDeploymentConfiguration",
|
||||
|
|
@ -1466,7 +1490,15 @@
|
|||
},
|
||||
"loadBalancerInfo":{
|
||||
"shape":"LoadBalancerInfo",
|
||||
"documentation":"<p>Information about the load balancer to use in a blue/green deployment.</p>"
|
||||
"documentation":"<p>Information about the load balancer to use in a deployment.</p>"
|
||||
},
|
||||
"lastSuccessfulDeployment":{
|
||||
"shape":"LastDeploymentInfo",
|
||||
"documentation":"<p>Information about the most recent successful deployment to the deployment group.</p>"
|
||||
},
|
||||
"lastAttemptedDeployment":{
|
||||
"shape":"LastDeploymentInfo",
|
||||
"documentation":"<p>Information about the most recent attempted deployment to the deployment group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a deployment group.</p>"
|
||||
|
|
@ -1525,6 +1557,10 @@
|
|||
"shape":"DeploymentId",
|
||||
"documentation":"<p>The deployment ID.</p>"
|
||||
},
|
||||
"previousRevision":{
|
||||
"shape":"RevisionLocation",
|
||||
"documentation":"<p>Information about the application revision that was deployed to the deployment group before the most recent successful deployment.</p>"
|
||||
},
|
||||
"revision":{
|
||||
"shape":"RevisionLocation",
|
||||
"documentation":"<p>Information about the location of stored application artifacts and the service from which to retrieve them.</p>"
|
||||
|
|
@ -1579,7 +1615,7 @@
|
|||
},
|
||||
"deploymentStyle":{
|
||||
"shape":"DeploymentStyle",
|
||||
"documentation":"<p>Information about the type of deployment, either standard or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>"
|
||||
"documentation":"<p>Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>"
|
||||
},
|
||||
"targetInstances":{
|
||||
"shape":"TargetInstances",
|
||||
|
|
@ -1595,11 +1631,15 @@
|
|||
},
|
||||
"loadBalancerInfo":{
|
||||
"shape":"LoadBalancerInfo",
|
||||
"documentation":"<p>Information about the load balancer used in this blue/green deployment.</p>"
|
||||
"documentation":"<p>Information about the load balancer used in the deployment.</p>"
|
||||
},
|
||||
"additionalDeploymentStatusInfo":{
|
||||
"shape":"AdditionalDeploymentStatusInfo",
|
||||
"documentation":"<p>Provides information about the results of a deployment, such as whether instances in the original environment in a blue/green deployment were not terminated.</p>"
|
||||
},
|
||||
"fileExistsBehavior":{
|
||||
"shape":"FileExistsBehavior",
|
||||
"documentation":"<p>Information about how AWS CodeDeploy handles files that already exist in a deployment target location but weren't part of the previous successful deployment.</p> <ul> <li> <p>DISALLOW: The deployment fails. This is also the default behavior if no option is specified.</p> </li> <li> <p>OVERWRITE: The version of the file from the application revision currently being deployed replaces the version already on the instance.</p> </li> <li> <p>RETAIN: The version of the file already on the instance is kept and used as part of the new deployment.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a deployment.</p>"
|
||||
|
|
@ -1704,14 +1744,14 @@
|
|||
"members":{
|
||||
"deploymentType":{
|
||||
"shape":"DeploymentType",
|
||||
"documentation":"<p>Indicates whether to run a standard deployment or a blue/green deployment.</p>"
|
||||
"documentation":"<p>Indicates whether to run an in-place deployment or a blue/green deployment.</p>"
|
||||
},
|
||||
"deploymentOption":{
|
||||
"shape":"DeploymentOption",
|
||||
"documentation":"<p>Indicates whether to route deployment traffic behind a load balancer.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about the type of deployment, either standard or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>"
|
||||
"documentation":"<p>Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>"
|
||||
},
|
||||
"DeploymentType":{
|
||||
"type":"string",
|
||||
|
|
@ -1737,7 +1777,7 @@
|
|||
"documentation":"<p>The name of the on-premises instance to deregister.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a deregister on-premises instance operation.</p>"
|
||||
"documentation":"<p>Represents the input of a DeregisterOnPremisesInstance operation.</p>"
|
||||
},
|
||||
"Description":{"type":"string"},
|
||||
"DescriptionTooLongException":{
|
||||
|
|
@ -1786,7 +1826,7 @@
|
|||
"documentation":"<p>The tag filter type:</p> <ul> <li> <p>KEY_ONLY: Key only.</p> </li> <li> <p>VALUE_ONLY: Value only.</p> </li> <li> <p>KEY_AND_VALUE: Key and value.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a tag filter.</p>"
|
||||
"documentation":"<p>Information about an EC2 tag filter.</p>"
|
||||
},
|
||||
"EC2TagFilterList":{
|
||||
"type":"list",
|
||||
|
|
@ -1805,10 +1845,10 @@
|
|||
"members":{
|
||||
"name":{
|
||||
"shape":"ELBName",
|
||||
"documentation":"<p>The name of the load balancer that will be used to route traffic from original instances to replacement instances in a blue/green deployment.</p>"
|
||||
"documentation":"<p>For blue/green deployments, the name of the load balancer that will be used to route traffic from original instances to replacement instances in a blue/green deployment. For in-place deployments, the name of the load balancer that instances are deregistered from so they are not serving traffic during a deployment, and then re-registered with after the deployment completes.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a load balancer in Elastic Load Balancing to use in a blue/green deployment.</p>"
|
||||
"documentation":"<p>Information about a load balancer in Elastic Load Balancing to use in a deployment.</p>"
|
||||
},
|
||||
"ELBInfoList":{
|
||||
"type":"list",
|
||||
|
|
@ -1854,6 +1894,14 @@
|
|||
"documentation":"<p>Information about a deployment error.</p>"
|
||||
},
|
||||
"ErrorMessage":{"type":"string"},
|
||||
"FileExistsBehavior":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"DISALLOW",
|
||||
"OVERWRITE",
|
||||
"RETAIN"
|
||||
]
|
||||
},
|
||||
"GenericRevisionInfo":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1889,7 +1937,7 @@
|
|||
"documentation":"<p>The name of an AWS CodeDeploy application associated with the applicable IAM user or AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a get application operation.</p>"
|
||||
"documentation":"<p>Represents the input of a GetApplication operation.</p>"
|
||||
},
|
||||
"GetApplicationOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1899,7 +1947,7 @@
|
|||
"documentation":"<p>Information about the application.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a get application operation.</p>"
|
||||
"documentation":"<p>Represents the output of a GetApplication operation.</p>"
|
||||
},
|
||||
"GetApplicationRevisionInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1917,7 +1965,7 @@
|
|||
"documentation":"<p>Information about the application revision to get, including type and location.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a get application revision operation.</p>"
|
||||
"documentation":"<p>Represents the input of a GetApplicationRevision operation.</p>"
|
||||
},
|
||||
"GetApplicationRevisionOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1935,7 +1983,7 @@
|
|||
"documentation":"<p>General information about the revision.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a get application revision operation.</p>"
|
||||
"documentation":"<p>Represents the output of a GetApplicationRevision operation.</p>"
|
||||
},
|
||||
"GetDeploymentConfigInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1946,7 +1994,7 @@
|
|||
"documentation":"<p>The name of a deployment configuration associated with the applicable IAM user or AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a get deployment configuration operation.</p>"
|
||||
"documentation":"<p>Represents the input of a GetDeploymentConfig operation.</p>"
|
||||
},
|
||||
"GetDeploymentConfigOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1956,7 +2004,7 @@
|
|||
"documentation":"<p>Information about the deployment configuration.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a get deployment configuration operation.</p>"
|
||||
"documentation":"<p>Represents the output of a GetDeploymentConfig operation.</p>"
|
||||
},
|
||||
"GetDeploymentGroupInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1974,7 +2022,7 @@
|
|||
"documentation":"<p>The name of an existing deployment group for the specified application.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a get deployment group operation.</p>"
|
||||
"documentation":"<p>Represents the input of a GetDeploymentGroup operation.</p>"
|
||||
},
|
||||
"GetDeploymentGroupOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1984,7 +2032,7 @@
|
|||
"documentation":"<p>Information about the deployment group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a get deployment group operation.</p>"
|
||||
"documentation":"<p>Represents the output of a GetDeploymentGroup operation.</p>"
|
||||
},
|
||||
"GetDeploymentInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -1995,7 +2043,7 @@
|
|||
"documentation":"<p>A deployment ID associated with the applicable IAM user or AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a get deployment operation.</p>"
|
||||
"documentation":"<p>Represents the input of a GetDeployment operation.</p>"
|
||||
},
|
||||
"GetDeploymentInstanceInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2013,7 +2061,7 @@
|
|||
"documentation":"<p>The unique ID of an instance in the deployment group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a get deployment instance operation.</p>"
|
||||
"documentation":"<p>Represents the input of a GetDeploymentInstance operation.</p>"
|
||||
},
|
||||
"GetDeploymentInstanceOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2023,7 +2071,7 @@
|
|||
"documentation":"<p>Information about the instance.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a get deployment instance operation.</p>"
|
||||
"documentation":"<p>Represents the output of a GetDeploymentInstance operation.</p>"
|
||||
},
|
||||
"GetDeploymentOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2033,7 +2081,7 @@
|
|||
"documentation":"<p>Information about the deployment.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a get deployment operation.</p>"
|
||||
"documentation":"<p>Represents the output of a GetDeployment operation.</p>"
|
||||
},
|
||||
"GetOnPremisesInstanceInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2044,7 +2092,7 @@
|
|||
"documentation":"<p>The name of the on-premises instance about which to get information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a get on-premises instance operation.</p>"
|
||||
"documentation":"<p>Represents the input of a GetOnPremisesInstance operation.</p>"
|
||||
},
|
||||
"GetOnPremisesInstanceOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2054,7 +2102,19 @@
|
|||
"documentation":"<p>Information about the on-premises instance.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a get on-premises instance operation.</p>"
|
||||
"documentation":"<p>Represents the output of a GetOnPremisesInstance operation.</p>"
|
||||
},
|
||||
"GitHubAccountTokenDoesNotExistException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>No GitHub account connection exists with the named specified in the call.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"GitHubAccountTokenName":{"type":"string"},
|
||||
"GitHubAccountTokenNameList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"GitHubAccountTokenName"}
|
||||
},
|
||||
"GitHubLocation":{
|
||||
"type":"structure",
|
||||
|
|
@ -2347,6 +2407,13 @@
|
|||
"documentation":"<p>At least one of the deployment IDs was specified in an invalid format.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidDeploymentInstanceTypeException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>An instance type was specified for an in-place deployment. Instance types are supported for blue/green deployments only.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidDeploymentStatusException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2358,7 +2425,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>An invalid deployment style was specified. Valid deployment types include \"IN_PLACE\" and \"BLUE_GREEN\". Valid deployment options for blue/green deployments include \"WITH_TRAFFIC_CONTROL\" and \"WITHOUT_TRAFFIC_CONTROL\".</p>",
|
||||
"documentation":"<p>An invalid deployment style was specified. Valid deployment types include \"IN_PLACE\" and \"BLUE_GREEN\". Valid deployment options include \"WITH_TRAFFIC_CONTROL\" and \"WITHOUT_TRAFFIC_CONTROL\".</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidEC2TagException":{
|
||||
|
|
@ -2368,6 +2435,13 @@
|
|||
"documentation":"<p>The tag was specified in an invalid format.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidFileExistsBehaviorException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>An invalid fileExistsBehavior option was specified to determine how AWS CodeDeploy handles files or directories that already exist in a deployment target location but weren't part of the previous successful deployment. Valid values include \"DISALLOW\", \"OVERWRITE\", and \"RETAIN\".</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidIamSessionArnException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2509,6 +2583,28 @@
|
|||
"exception":true
|
||||
},
|
||||
"Key":{"type":"string"},
|
||||
"LastDeploymentInfo":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"deploymentId":{
|
||||
"shape":"DeploymentId",
|
||||
"documentation":"<p>The deployment ID.</p>"
|
||||
},
|
||||
"status":{
|
||||
"shape":"DeploymentStatus",
|
||||
"documentation":"<p>The status of the most recent deployment.</p>"
|
||||
},
|
||||
"endTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>A timestamp indicating when the most recent deployment to the deployment group completed.</p>"
|
||||
},
|
||||
"createTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>A timestamp indicating when the most recent deployment to the deployment group started.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about the most recent attempted or successful deployment to a deployment group.</p>"
|
||||
},
|
||||
"LifecycleErrorCode":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -2603,7 +2699,7 @@
|
|||
"documentation":"<p>An identifier returned from the previous list application revisions call. It can be used to return the next set of applications in the list.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a list application revisions operation.</p>"
|
||||
"documentation":"<p>Represents the input of a ListApplicationRevisions operation.</p>"
|
||||
},
|
||||
"ListApplicationRevisionsOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2617,7 +2713,7 @@
|
|||
"documentation":"<p>If a large amount of information is returned, an identifier will also be returned. It can be used in a subsequent list application revisions call to return the next set of application revisions in the list.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a list application revisions operation.</p>"
|
||||
"documentation":"<p>Represents the output of a ListApplicationRevisions operation.</p>"
|
||||
},
|
||||
"ListApplicationsInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2627,7 +2723,7 @@
|
|||
"documentation":"<p>An identifier returned from the previous list applications call. It can be used to return the next set of applications in the list.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a list applications operation.</p>"
|
||||
"documentation":"<p>Represents the input of a ListApplications operation.</p>"
|
||||
},
|
||||
"ListApplicationsOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2641,7 +2737,7 @@
|
|||
"documentation":"<p>If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list applications call to return the next set of applications, will also be returned. in the list.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a list applications operation.</p>"
|
||||
"documentation":"<p>Represents the output of a ListApplications operation.</p>"
|
||||
},
|
||||
"ListDeploymentConfigsInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2651,7 +2747,7 @@
|
|||
"documentation":"<p>An identifier returned from the previous list deployment configurations call. It can be used to return the next set of deployment configurations in the list. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a list deployment configurations operation.</p>"
|
||||
"documentation":"<p>Represents the input of a ListDeploymentConfigs operation.</p>"
|
||||
},
|
||||
"ListDeploymentConfigsOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2665,7 +2761,7 @@
|
|||
"documentation":"<p>If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment configurations call to return the next set of deployment configurations in the list.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a list deployment configurations operation.</p>"
|
||||
"documentation":"<p>Represents the output of a ListDeploymentConfigs operation.</p>"
|
||||
},
|
||||
"ListDeploymentGroupsInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2680,7 +2776,7 @@
|
|||
"documentation":"<p>An identifier returned from the previous list deployment groups call. It can be used to return the next set of deployment groups in the list.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a list deployment groups operation.</p>"
|
||||
"documentation":"<p>Represents the input of a ListDeploymentGroups operation.</p>"
|
||||
},
|
||||
"ListDeploymentGroupsOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2698,7 +2794,7 @@
|
|||
"documentation":"<p>If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment groups call to return the next set of deployment groups in the list.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a list deployment groups operation.</p>"
|
||||
"documentation":"<p>Represents the output of a ListDeploymentGroups operation.</p>"
|
||||
},
|
||||
"ListDeploymentInstancesInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2721,7 +2817,7 @@
|
|||
"documentation":"<p>The set of instances in a blue/green deployment, either those in the original environment (\"BLUE\") or those in the replacement environment (\"GREEN\"), for which you want to view instance information.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a list deployment instances operation.</p>"
|
||||
"documentation":"<p>Represents the input of a ListDeploymentInstances operation.</p>"
|
||||
},
|
||||
"ListDeploymentInstancesOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2735,7 +2831,7 @@
|
|||
"documentation":"<p>If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment instances call to return the next set of deployment instances in the list.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a list deployment instances operation.</p>"
|
||||
"documentation":"<p>Represents the output of a ListDeploymentInstances operation.</p>"
|
||||
},
|
||||
"ListDeploymentsInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2761,7 +2857,7 @@
|
|||
"documentation":"<p>An identifier returned from the previous list deployments call. It can be used to return the next set of deployments in the list.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a list deployments operation.</p>"
|
||||
"documentation":"<p>Represents the input of a ListDeployments operation.</p>"
|
||||
},
|
||||
"ListDeploymentsOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2775,7 +2871,31 @@
|
|||
"documentation":"<p>If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployments call to return the next set of deployments in the list.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a list deployments operation.</p>"
|
||||
"documentation":"<p>Represents the output of a ListDeployments operation.</p>"
|
||||
},
|
||||
"ListGitHubAccountTokenNamesInput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>An identifier returned from the previous ListGitHubAccountTokenNames call. It can be used to return the next set of names in the list. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a ListGitHubAccountTokenNames operation.</p>"
|
||||
},
|
||||
"ListGitHubAccountTokenNamesOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"tokenNameList":{
|
||||
"shape":"GitHubAccountTokenNameList",
|
||||
"documentation":"<p>A list of names of connections to GitHub accounts.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent ListGitHubAccountTokenNames call to return the next set of names in the list. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a ListGitHubAccountTokenNames operation.</p>"
|
||||
},
|
||||
"ListOnPremisesInstancesInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2793,7 +2913,7 @@
|
|||
"documentation":"<p>An identifier returned from the previous list on-premises instances call. It can be used to return the next set of on-premises instances in the list.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a list on-premises instances operation.</p>"
|
||||
"documentation":"<p>Represents the input of a ListOnPremisesInstances operation.</p>"
|
||||
},
|
||||
"ListOnPremisesInstancesOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2822,10 +2942,10 @@
|
|||
"members":{
|
||||
"elbInfoList":{
|
||||
"shape":"ELBInfoList",
|
||||
"documentation":"<p>An array containing information about the load balancer in Elastic Load Balancing to use in a blue/green deployment.</p>"
|
||||
"documentation":"<p>An array containing information about the load balancer in Elastic Load Balancing to use in a deployment.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about the load balancer used in a blue/green deployment.</p>"
|
||||
"documentation":"<p>Information about the load balancer used in a deployment.</p>"
|
||||
},
|
||||
"LogTail":{"type":"string"},
|
||||
"Message":{"type":"string"},
|
||||
|
|
@ -2838,7 +2958,7 @@
|
|||
},
|
||||
"type":{
|
||||
"shape":"MinimumHealthyHostsType",
|
||||
"documentation":"<p>The minimum healthy instance type:</p> <ul> <li> <p>HOST_COUNT: The minimum number of healthy instance as an absolute value.</p> </li> <li> <p>FLEET_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment.</p> </li> </ul> <p>In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment will be successful if six or more instances are deployed to successfully; otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instance at a time. The deployment will be successful if four or more instance are deployed to successfully; otherwise, the deployment fails.</p> <note> <p>In a call to the get deployment configuration operation, CodeDeployDefault.OneAtATime will return a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy will try to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment still succeeds.</p> </note>"
|
||||
"documentation":"<p>The minimum healthy instance type:</p> <ul> <li> <p>HOST_COUNT: The minimum number of healthy instance as an absolute value.</p> </li> <li> <p>FLEET_PERCENT: The minimum number of healthy instance as a percentage of the total number of instance in the deployment.</p> </li> </ul> <p>In an example of nine instance, if a HOST_COUNT of six is specified, deploy to up to three instances at a time. The deployment will be successful if six or more instances are deployed to successfully; otherwise, the deployment fails. If a FLEET_PERCENT of 40 is specified, deploy to up to five instance at a time. The deployment will be successful if four or more instance are deployed to successfully; otherwise, the deployment fails.</p> <note> <p>In a call to the get deployment configuration operation, CodeDeployDefault.OneAtATime will return a minimum healthy instance type of MOST_CONCURRENCY and a value of 1. This means a deployment to only one instance at a time. (You cannot set the type to MOST_CONCURRENCY, only to HOST_COUNT or FLEET_PERCENT.) In addition, with CodeDeployDefault.OneAtATime, AWS CodeDeploy will try to ensure that all instances but one are kept in a healthy state during the deployment. Although this allows one instance at a time to be taken offline for a new deployment, it also means that if the deployment to the last instance fails, the overall deployment still succeeds.</p> </note> <p>For more information, see <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide/instances-health.html\">AWS CodeDeploy Instance Health</a> in the <i>AWS CodeDeploy User Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about minimum healthy instance.</p>"
|
||||
|
|
@ -2880,7 +3000,7 @@
|
|||
"documentation":"<p>Information about the application revision to register, including type and location.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a register application revision operation.</p>"
|
||||
"documentation":"<p>Represents the input of a RegisterApplicationRevision operation.</p>"
|
||||
},
|
||||
"RegisterOnPremisesInstanceInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -2924,9 +3044,16 @@
|
|||
"documentation":"<p>The names of the on-premises instances from which to remove tags.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a remove tags from on-premises instances operation.</p>"
|
||||
"documentation":"<p>Represents the input of a RemoveTagsFromOnPremisesInstances operation.</p>"
|
||||
},
|
||||
"Repository":{"type":"string"},
|
||||
"ResourceValidationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The specified resource could not be validated.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"RevisionDoesNotExistException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -3072,7 +3199,7 @@
|
|||
"documentation":"<p>Indicates, when a deployment is stopped, whether instances that have been updated should be rolled back to the previous version of the application revision.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a stop deployment operation.</p>"
|
||||
"documentation":"<p>Represents the input of a StopDeployment operation.</p>"
|
||||
},
|
||||
"StopDeploymentOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -3086,7 +3213,7 @@
|
|||
"documentation":"<p>An accompanying status message.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a stop deployment operation.</p>"
|
||||
"documentation":"<p>Represents the output of a StopDeployment operation.</p>"
|
||||
},
|
||||
"StopStatus":{
|
||||
"type":"string",
|
||||
|
|
@ -3255,7 +3382,7 @@
|
|||
"documentation":"<p>The new name to give the application.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of an update application operation.</p>"
|
||||
"documentation":"<p>Represents the input of an UpdateApplication operation.</p>"
|
||||
},
|
||||
"UpdateDeploymentGroupInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -3302,7 +3429,7 @@
|
|||
},
|
||||
"alarmConfiguration":{
|
||||
"shape":"AlarmConfiguration",
|
||||
"documentation":"<p>Information to add or change about Amazon CloudWatch alarms when the deployment group is updated. </p>"
|
||||
"documentation":"<p>Information to add or change about Amazon CloudWatch alarms when the deployment group is updated.</p>"
|
||||
},
|
||||
"autoRollbackConfiguration":{
|
||||
"shape":"AutoRollbackConfiguration",
|
||||
|
|
@ -3310,7 +3437,7 @@
|
|||
},
|
||||
"deploymentStyle":{
|
||||
"shape":"DeploymentStyle",
|
||||
"documentation":"<p>Information about the type of deployment, either standard or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>"
|
||||
"documentation":"<p>Information about the type of deployment, either in-place or blue/green, you want to run and whether to route deployment traffic behind a load balancer.</p>"
|
||||
},
|
||||
"blueGreenDeploymentConfiguration":{
|
||||
"shape":"BlueGreenDeploymentConfiguration",
|
||||
|
|
@ -3318,10 +3445,10 @@
|
|||
},
|
||||
"loadBalancerInfo":{
|
||||
"shape":"LoadBalancerInfo",
|
||||
"documentation":"<p>Information about the load balancer used in a blue/green deployment.</p>"
|
||||
"documentation":"<p>Information about the load balancer used in a deployment.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of an update deployment group operation.</p>"
|
||||
"documentation":"<p>Represents the input of an UpdateDeploymentGroup operation.</p>"
|
||||
},
|
||||
"UpdateDeploymentGroupOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -3331,10 +3458,10 @@
|
|||
"documentation":"<p>If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the AWS account. If the output contains data, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the AWS account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of an update deployment group operation.</p>"
|
||||
"documentation":"<p>Represents the output of an UpdateDeploymentGroup operation.</p>"
|
||||
},
|
||||
"Value":{"type":"string"},
|
||||
"VersionId":{"type":"string"}
|
||||
},
|
||||
"documentation":"<fullname>AWS CodeDeploy</fullname> <p> <b>Overview</b> </p> <p>This reference guide provides descriptions of the AWS CodeDeploy APIs. For more information about AWS CodeDeploy, see the <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide\">AWS CodeDeploy User Guide</a>.</p> <p> <b>Using the APIs</b> </p> <p>You can use the AWS CodeDeploy APIs to work with the following:</p> <ul> <li> <p>Applications are unique identifiers used by AWS CodeDeploy to ensure the correct combinations of revisions, deployment configurations, and deployment groups are being referenced during deployments.</p> <p>You can use the AWS CodeDeploy APIs to create, delete, get, list, and update applications.</p> </li> <li> <p>Deployment configurations are sets of deployment rules and success and failure conditions used by AWS CodeDeploy during deployments.</p> <p>You can use the AWS CodeDeploy APIs to create, delete, get, and list deployment configurations.</p> </li> <li> <p>Deployment groups are groups of instances to which application revisions can be deployed.</p> <p>You can use the AWS CodeDeploy APIs to create, delete, get, list, and update deployment groups.</p> </li> <li> <p>Instances represent Amazon EC2 instances to which application revisions are deployed. Instances are identified by their Amazon EC2 tags or Auto Scaling group names. Instances belong to deployment groups.</p> <p>You can use the AWS CodeDeploy APIs to get and list instance.</p> </li> <li> <p>Deployments represent the process of deploying revisions to instances.</p> <p>You can use the AWS CodeDeploy APIs to create, get, list, and stop deployments.</p> </li> <li> <p>Application revisions are archive files stored in Amazon S3 buckets or GitHub repositories. These revisions contain source content (such as source code, web pages, executable files, and deployment scripts) along with an application specification (AppSpec) file. (The AppSpec file is unique to AWS CodeDeploy; it defines the deployment actions you want AWS CodeDeploy to execute.) For application revisions stored in Amazon S3 buckets, an application revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For application revisions stored in GitHub repositories, an application revision is uniquely identified by its repository name and commit ID. Application revisions are deployed through deployment groups.</p> <p>You can use the AWS CodeDeploy APIs to get, list, and register application revisions.</p> </li> </ul>"
|
||||
"documentation":"<fullname>AWS CodeDeploy</fullname> <p>AWS CodeDeploy is a deployment service that automates application deployments to Amazon EC2 instances or on-premises instances running in your own facility.</p> <p>You can deploy a nearly unlimited variety of application content, such as code, web and configuration files, executables, packages, scripts, multimedia files, and so on. AWS CodeDeploy can deploy application content stored in Amazon S3 buckets, GitHub repositories, or Bitbucket repositories. You do not need to make changes to your existing code before you can use AWS CodeDeploy.</p> <p>AWS CodeDeploy makes it easier for you to rapidly release new features, helps you avoid downtime during application deployment, and handles the complexity of updating your applications, without many of the risks associated with error-prone manual deployments.</p> <p> <b>AWS CodeDeploy Components</b> </p> <p>Use the information in this guide to help you work with the following AWS CodeDeploy components:</p> <ul> <li> <p> <b>Application</b>: A name that uniquely identifies the application you want to deploy. AWS CodeDeploy uses this name, which functions as a container, to ensure the correct combination of revision, deployment configuration, and deployment group are referenced during a deployment.</p> </li> <li> <p> <b>Deployment group</b>: A set of individual instances. A deployment group contains individually tagged instances, Amazon EC2 instances in Auto Scaling groups, or both. </p> </li> <li> <p> <b>Deployment configuration</b>: A set of deployment rules and deployment success and failure conditions used by AWS CodeDeploy during a deployment.</p> </li> <li> <p> <b>Deployment</b>: The process, and the components involved in the process, of installing content on one or more instances. </p> </li> <li> <p> <b>Application revisions</b>: An archive file containing source content—source code, web pages, executable files, and deployment scripts—along with an application specification file (AppSpec file). Revisions are stored in Amazon S3 buckets or GitHub repositories. For Amazon S3, a revision is uniquely identified by its Amazon S3 object key and its ETag, version, or both. For GitHub, a revision is uniquely identified by its commit ID.</p> </li> </ul> <p>This guide also contains information to help you get details about the instances in your deployments and to make on-premises instances available for AWS CodeDeploy deployments.</p> <p> <b>AWS CodeDeploy Information Resources</b> </p> <ul> <li> <p> <a href=\"http://docs.aws.amazon.com/codedeploy/latest/userguide\">AWS CodeDeploy User Guide</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/codedeploy/latest/APIReference/\">AWS CodeDeploy API Reference Guide</a> </p> </li> <li> <p> <a href=\"http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html\">AWS CLI Reference for AWS CodeDeploy</a> </p> </li> <li> <p> <a href=\"https://forums.aws.amazon.com/forum.jspa?forumID=179\">AWS CodeDeploy Developer Forum</a> </p> </li> </ul>"
|
||||
}
|
||||
|
|
|
|||
5
botocore/data/codepipeline/2015-07-09/examples-1.json
Normal file
5
botocore/data/codepipeline/2015-07-09/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
3
botocore/data/codepipeline/2015-07-09/paginators-1.json
Normal file
3
botocore/data/codepipeline/2015-07-09/paginators-1.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
|
|
@ -216,6 +216,21 @@
|
|||
],
|
||||
"documentation":"<p>Gets a summary of all AWS CodePipeline action types associated with your account.</p>"
|
||||
},
|
||||
"ListPipelineExecutions":{
|
||||
"name":"ListPipelineExecutions",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListPipelineExecutionsInput"},
|
||||
"output":{"shape":"ListPipelineExecutionsOutput"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"PipelineNotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"}
|
||||
],
|
||||
"documentation":"<p>Gets a summary of the most recent executions for a pipeline.</p>"
|
||||
},
|
||||
"ListPipelines":{
|
||||
"name":"ListPipelines",
|
||||
"http":{
|
||||
|
|
@ -575,7 +590,7 @@
|
|||
},
|
||||
"ActionConfigurationQueryableValue":{
|
||||
"type":"string",
|
||||
"max":20,
|
||||
"max":50,
|
||||
"min":1,
|
||||
"pattern":"[a-zA-Z0-9_-]+"
|
||||
},
|
||||
|
|
@ -745,8 +760,14 @@
|
|||
"shape":"ActionName",
|
||||
"documentation":"<p>The name of the action.</p>"
|
||||
},
|
||||
"currentRevision":{"shape":"ActionRevision"},
|
||||
"latestExecution":{"shape":"ActionExecution"},
|
||||
"currentRevision":{
|
||||
"shape":"ActionRevision",
|
||||
"documentation":"<p>Represents information about the version (or revision) of an action.</p>"
|
||||
},
|
||||
"latestExecution":{
|
||||
"shape":"ActionExecution",
|
||||
"documentation":"<p>Represents information about the run of an action.</p>"
|
||||
},
|
||||
"entityUrl":{
|
||||
"shape":"Url",
|
||||
"documentation":"<p>A URL link for more information about the state of the action, such as a deployment group details page.</p>"
|
||||
|
|
@ -770,7 +791,10 @@
|
|||
"outputArtifactDetails"
|
||||
],
|
||||
"members":{
|
||||
"id":{"shape":"ActionTypeId"},
|
||||
"id":{
|
||||
"shape":"ActionTypeId",
|
||||
"documentation":"<p>Represents information about an action type.</p>"
|
||||
},
|
||||
"settings":{
|
||||
"shape":"ActionTypeSettings",
|
||||
"documentation":"<p>The settings for the action type.</p>"
|
||||
|
|
@ -1003,14 +1027,14 @@
|
|||
},
|
||||
"location":{
|
||||
"shape":"ArtifactStoreLocation",
|
||||
"documentation":"<p>The location for storing the artifacts for a pipeline, such as an S3 bucket or folder.</p>"
|
||||
"documentation":"<p>The Amazon S3 bucket used for storing the artifacts for a pipeline. You can specify the name of an S3 bucket but not a folder within the bucket. A folder to contain the pipeline artifacts is created for you based on the name of the pipeline. You can use any Amazon S3 bucket in the same AWS Region as the pipeline to store your pipeline artifacts.</p>"
|
||||
},
|
||||
"encryptionKey":{
|
||||
"shape":"EncryptionKey",
|
||||
"documentation":"<p>The encryption key used to encrypt the data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. If this is undefined, the default key for Amazon S3 is used.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The Amazon S3 location where artifacts are stored for the pipeline. If this Amazon S3 bucket is created manually, it must meet the requirements for AWS CodePipeline. For more information, see the <a href=\"http://docs.aws.amazon.com/codepipeline/latest/userguide/concepts.html#CPS3Bucket\">Concepts</a>.</p>"
|
||||
"documentation":"<p>The Amazon S3 bucket where artifacts are stored for the pipeline.</p>"
|
||||
},
|
||||
"ArtifactStoreLocation":{
|
||||
"type":"string",
|
||||
|
|
@ -1079,13 +1103,22 @@
|
|||
"shape":"Version",
|
||||
"documentation":"<p>The version identifier of the custom action.</p>"
|
||||
},
|
||||
"settings":{"shape":"ActionTypeSettings"},
|
||||
"settings":{
|
||||
"shape":"ActionTypeSettings",
|
||||
"documentation":"<p>Returns information about the settings for an action type.</p>"
|
||||
},
|
||||
"configurationProperties":{
|
||||
"shape":"ActionConfigurationPropertyList",
|
||||
"documentation":"<p>The configuration properties for the custom action.</p> <note> <p>You can refer to a name in the configuration properties of the custom action within the URL templates by following the format of {Config:name}, as long as the configuration property is both required and not secret. For more information, see <a href=\"http://docs.aws.amazon.com/codepipeline/latest/userguide/how-to-create-custom-action.html\">Create a Custom Action for a Pipeline</a>.</p> </note>"
|
||||
},
|
||||
"inputArtifactDetails":{"shape":"ArtifactDetails"},
|
||||
"outputArtifactDetails":{"shape":"ArtifactDetails"}
|
||||
"inputArtifactDetails":{
|
||||
"shape":"ArtifactDetails",
|
||||
"documentation":"<p>The details of the input artifact for the action, such as its commit ID.</p>"
|
||||
},
|
||||
"outputArtifactDetails":{
|
||||
"shape":"ArtifactDetails",
|
||||
"documentation":"<p>The details of the output artifact of the action, such as its commit ID.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a create custom action operation.</p>"
|
||||
},
|
||||
|
|
@ -1093,7 +1126,10 @@
|
|||
"type":"structure",
|
||||
"required":["actionType"],
|
||||
"members":{
|
||||
"actionType":{"shape":"ActionType"}
|
||||
"actionType":{
|
||||
"shape":"ActionType",
|
||||
"documentation":"<p>Returns information about the details of an action type.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a create custom action operation.</p>"
|
||||
},
|
||||
|
|
@ -1101,14 +1137,20 @@
|
|||
"type":"structure",
|
||||
"required":["pipeline"],
|
||||
"members":{
|
||||
"pipeline":{"shape":"PipelineDeclaration"}
|
||||
"pipeline":{
|
||||
"shape":"PipelineDeclaration",
|
||||
"documentation":"<p>Represents the structure of actions and stages to be performed in the pipeline. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a create pipeline action.</p>"
|
||||
},
|
||||
"CreatePipelineOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"pipeline":{"shape":"PipelineDeclaration"}
|
||||
"pipeline":{
|
||||
"shape":"PipelineDeclaration",
|
||||
"documentation":"<p>Represents the structure of actions and stages to be performed in the pipeline. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a create pipeline action.</p>"
|
||||
},
|
||||
|
|
@ -1400,7 +1442,10 @@
|
|||
"GetPipelineOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"pipeline":{"shape":"PipelineDeclaration"}
|
||||
"pipeline":{
|
||||
"shape":"PipelineDeclaration",
|
||||
"documentation":"<p>Represents the structure of actions and stages to be performed in the pipeline. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a get pipeline action.</p>"
|
||||
},
|
||||
|
|
@ -1579,9 +1624,18 @@
|
|||
"JobData":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"actionTypeId":{"shape":"ActionTypeId"},
|
||||
"actionConfiguration":{"shape":"ActionConfiguration"},
|
||||
"pipelineContext":{"shape":"PipelineContext"},
|
||||
"actionTypeId":{
|
||||
"shape":"ActionTypeId",
|
||||
"documentation":"<p>Represents information about an action type.</p>"
|
||||
},
|
||||
"actionConfiguration":{
|
||||
"shape":"ActionConfiguration",
|
||||
"documentation":"<p>Represents information about an action configuration.</p>"
|
||||
},
|
||||
"pipelineContext":{
|
||||
"shape":"PipelineContext",
|
||||
"documentation":"<p>Represents information about a pipeline to a job worker.</p>"
|
||||
},
|
||||
"inputArtifacts":{
|
||||
"shape":"ArtifactList",
|
||||
"documentation":"<p>The artifact supplied to the job.</p>"
|
||||
|
|
@ -1590,12 +1644,18 @@
|
|||
"shape":"ArtifactList",
|
||||
"documentation":"<p>The output of the job.</p>"
|
||||
},
|
||||
"artifactCredentials":{"shape":"AWSSessionCredentials"},
|
||||
"artifactCredentials":{
|
||||
"shape":"AWSSessionCredentials",
|
||||
"documentation":"<p>Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline.</p>"
|
||||
},
|
||||
"continuationToken":{
|
||||
"shape":"ContinuationToken",
|
||||
"documentation":"<p>A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.</p>"
|
||||
},
|
||||
"encryptionKey":{"shape":"EncryptionKey"}
|
||||
"encryptionKey":{
|
||||
"shape":"EncryptionKey",
|
||||
"documentation":"<p>Represents information about the key used to encrypt data in the artifact store, such as an AWS Key Management Service (AWS KMS) key. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents additional information about a job required for a job worker to complete the job.</p>"
|
||||
},
|
||||
|
|
@ -1606,7 +1666,10 @@
|
|||
"shape":"JobId",
|
||||
"documentation":"<p>The unique system-generated ID of the job.</p>"
|
||||
},
|
||||
"data":{"shape":"JobData"},
|
||||
"data":{
|
||||
"shape":"JobData",
|
||||
"documentation":"<p>Represents additional information about a job required for a job worker to complete the job. </p>"
|
||||
},
|
||||
"accountId":{
|
||||
"shape":"AccountId",
|
||||
"documentation":"<p>The AWS account ID associated with the job.</p>"
|
||||
|
|
@ -1680,6 +1743,39 @@
|
|||
},
|
||||
"documentation":"<p>Represents the output of a list action types action.</p>"
|
||||
},
|
||||
"ListPipelineExecutionsInput":{
|
||||
"type":"structure",
|
||||
"required":["pipelineName"],
|
||||
"members":{
|
||||
"pipelineName":{
|
||||
"shape":"PipelineName",
|
||||
"documentation":"<p>The name of the pipeline for which you want to get execution summary information.</p>"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value. The available pipeline execution history is limited to the most recent 12 months, based on pipeline execution start times. Default value is 100.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The token that was returned from the previous list pipeline executions call, which can be used to return the next set of pipeline executions in the list.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a list pipeline executions action.</p>"
|
||||
},
|
||||
"ListPipelineExecutionsOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"pipelineExecutionSummaries":{
|
||||
"shape":"PipelineExecutionSummaryList",
|
||||
"documentation":"<p>A list of executions in the history of a pipeline.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>A token that can be used in the next list pipeline executions call to return the next set of pipeline executions. To view all items in the list, continue to call this operation with each subsequent token until no more nextToken values are returned.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a list pipeline executions action. </p>"
|
||||
},
|
||||
"ListPipelinesInput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1708,6 +1804,11 @@
|
|||
"type":"integer",
|
||||
"min":1
|
||||
},
|
||||
"MaxResults":{
|
||||
"type":"integer",
|
||||
"max":100,
|
||||
"min":1
|
||||
},
|
||||
"MaximumArtifactCount":{
|
||||
"type":"integer",
|
||||
"max":5,
|
||||
|
|
@ -1759,7 +1860,10 @@
|
|||
"shape":"StageContext",
|
||||
"documentation":"<p>The stage of the pipeline.</p>"
|
||||
},
|
||||
"action":{"shape":"ActionContext"}
|
||||
"action":{
|
||||
"shape":"ActionContext",
|
||||
"documentation":"<p/>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents information about a pipeline to a job worker.</p>"
|
||||
},
|
||||
|
|
@ -1780,7 +1884,10 @@
|
|||
"shape":"RoleArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) for AWS CodePipeline to use to either perform actions with no actionRoleArn, or to use to assume roles for actions with an actionRoleArn.</p>"
|
||||
},
|
||||
"artifactStore":{"shape":"ArtifactStore"},
|
||||
"artifactStore":{
|
||||
"shape":"ArtifactStore",
|
||||
"documentation":"<p>Represents the context of an action within the stage of a pipeline to a job worker. </p>"
|
||||
},
|
||||
"stages":{
|
||||
"shape":"PipelineStageDeclarationList",
|
||||
"documentation":"<p>The stage in which to perform the action.</p>"
|
||||
|
|
@ -1809,7 +1916,7 @@
|
|||
},
|
||||
"status":{
|
||||
"shape":"PipelineExecutionStatus",
|
||||
"documentation":"<p>The status of the pipeline execution.</p> <ul> <li> <p>InProgress: The pipeline execution is currently running.</p> </li> <li> <p>Succeeded: The pipeline execution completed successfully. </p> </li> <li> <p>Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution caught up and continued through the pipeline instead. </p> </li> <li> <p>Failed: The pipeline did not complete successfully.</p> </li> </ul>"
|
||||
"documentation":"<p>The status of the pipeline execution.</p> <ul> <li> <p>InProgress: The pipeline execution is currently running.</p> </li> <li> <p>Succeeded: The pipeline execution completed successfully. </p> </li> <li> <p>Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution caught up and continued through the pipeline instead. </p> </li> <li> <p>Failed: The pipeline execution did not complete successfully.</p> </li> </ul>"
|
||||
},
|
||||
"artifactRevisions":{
|
||||
"shape":"ArtifactRevisionList",
|
||||
|
|
@ -1838,6 +1945,32 @@
|
|||
"Failed"
|
||||
]
|
||||
},
|
||||
"PipelineExecutionSummary":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"pipelineExecutionId":{
|
||||
"shape":"PipelineExecutionId",
|
||||
"documentation":"<p>The ID of the pipeline execution.</p>"
|
||||
},
|
||||
"status":{
|
||||
"shape":"PipelineExecutionStatus",
|
||||
"documentation":"<p>The status of the pipeline execution.</p> <ul> <li> <p>InProgress: The pipeline execution is currently running.</p> </li> <li> <p>Succeeded: The pipeline execution completed successfully. </p> </li> <li> <p>Superseded: While this pipeline execution was waiting for the next stage to be completed, a newer pipeline execution caught up and continued through the pipeline instead. </p> </li> <li> <p>Failed: The pipeline execution did not complete successfully.</p> </li> </ul>"
|
||||
},
|
||||
"startTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time when the pipeline execution began, in timestamp format.</p>"
|
||||
},
|
||||
"lastUpdateTime":{
|
||||
"shape":"Timestamp",
|
||||
"documentation":"<p>The date and time of the last change to the pipeline execution, in timestamp format.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Summary information about a pipeline execution.</p>"
|
||||
},
|
||||
"PipelineExecutionSummaryList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"PipelineExecutionSummary"}
|
||||
},
|
||||
"PipelineList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"PipelineSummary"}
|
||||
|
|
@ -1903,7 +2036,10 @@
|
|||
"type":"structure",
|
||||
"required":["actionTypeId"],
|
||||
"members":{
|
||||
"actionTypeId":{"shape":"ActionTypeId"},
|
||||
"actionTypeId":{
|
||||
"shape":"ActionTypeId",
|
||||
"documentation":"<p>Represents information about an action type.</p>"
|
||||
},
|
||||
"maxBatchSize":{
|
||||
"shape":"MaxBatchSize",
|
||||
"documentation":"<p>The maximum number of jobs to return in a poll for jobs call.</p>"
|
||||
|
|
@ -1929,7 +2065,10 @@
|
|||
"type":"structure",
|
||||
"required":["actionTypeId"],
|
||||
"members":{
|
||||
"actionTypeId":{"shape":"ActionTypeId"},
|
||||
"actionTypeId":{
|
||||
"shape":"ActionTypeId",
|
||||
"documentation":"<p>Represents information about an action type.</p>"
|
||||
},
|
||||
"maxBatchSize":{
|
||||
"shape":"MaxBatchSize",
|
||||
"documentation":"<p>The maximum number of jobs to return in a poll for jobs call.</p>"
|
||||
|
|
@ -1968,7 +2107,10 @@
|
|||
"shape":"ActionName",
|
||||
"documentation":"<p>The name of the action that will process the revision.</p>"
|
||||
},
|
||||
"actionRevision":{"shape":"ActionRevision"}
|
||||
"actionRevision":{
|
||||
"shape":"ActionRevision",
|
||||
"documentation":"<p>Represents information about the version (or revision) of an action.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a put action revision action.</p>"
|
||||
},
|
||||
|
|
@ -2086,7 +2228,10 @@
|
|||
"shape":"ClientToken",
|
||||
"documentation":"<p>The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</p>"
|
||||
},
|
||||
"failureDetails":{"shape":"FailureDetails"}
|
||||
"failureDetails":{
|
||||
"shape":"FailureDetails",
|
||||
"documentation":"<p>Represents information about failure details.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a third party job failure result action.</p>"
|
||||
},
|
||||
|
|
@ -2105,12 +2250,18 @@
|
|||
"shape":"ClientToken",
|
||||
"documentation":"<p>The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.</p>"
|
||||
},
|
||||
"currentRevision":{"shape":"CurrentRevision"},
|
||||
"currentRevision":{
|
||||
"shape":"CurrentRevision",
|
||||
"documentation":"<p>Represents information about a current revision.</p>"
|
||||
},
|
||||
"continuationToken":{
|
||||
"shape":"ContinuationToken",
|
||||
"documentation":"<p>A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the partner action. When the action is complete, no continuation token should be supplied.</p>"
|
||||
},
|
||||
"executionDetails":{"shape":"ExecutionDetails"}
|
||||
"executionDetails":{
|
||||
"shape":"ExecutionDetails",
|
||||
"documentation":"<p>The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a put third party job success result action.</p>"
|
||||
},
|
||||
|
|
@ -2362,9 +2513,18 @@
|
|||
"ThirdPartyJobData":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"actionTypeId":{"shape":"ActionTypeId"},
|
||||
"actionConfiguration":{"shape":"ActionConfiguration"},
|
||||
"pipelineContext":{"shape":"PipelineContext"},
|
||||
"actionTypeId":{
|
||||
"shape":"ActionTypeId",
|
||||
"documentation":"<p>Represents information about an action type.</p>"
|
||||
},
|
||||
"actionConfiguration":{
|
||||
"shape":"ActionConfiguration",
|
||||
"documentation":"<p>Represents information about an action configuration.</p>"
|
||||
},
|
||||
"pipelineContext":{
|
||||
"shape":"PipelineContext",
|
||||
"documentation":"<p>Represents information about a pipeline to a job worker.</p>"
|
||||
},
|
||||
"inputArtifacts":{
|
||||
"shape":"ArtifactList",
|
||||
"documentation":"<p>The name of the artifact that will be worked upon by the action, if any. This name might be system-generated, such as \"MyApp\", or might be defined by the user when the action is created. The input artifact name must match the name of an output artifact generated by an action in an earlier action or stage of the pipeline.</p>"
|
||||
|
|
@ -2373,7 +2533,10 @@
|
|||
"shape":"ArtifactList",
|
||||
"documentation":"<p>The name of the artifact that will be the result of the action, if any. This name might be system-generated, such as \"MyBuiltApp\", or might be defined by the user when the action is created.</p>"
|
||||
},
|
||||
"artifactCredentials":{"shape":"AWSSessionCredentials"},
|
||||
"artifactCredentials":{
|
||||
"shape":"AWSSessionCredentials",
|
||||
"documentation":"<p>Represents an AWS session credentials object. These credentials are temporary credentials that are issued by AWS Secure Token Service (STS). They can be used to access input and output artifacts in the Amazon S3 bucket used to store artifact for the pipeline in AWS CodePipeline. </p>"
|
||||
},
|
||||
"continuationToken":{
|
||||
"shape":"ContinuationToken",
|
||||
"documentation":"<p>A system-generated token, such as a AWS CodeDeploy deployment ID, that a job requires in order to continue the job asynchronously.</p>"
|
||||
|
|
|
|||
3
botocore/data/codestar/2017-04-19/paginators-1.json
Normal file
3
botocore/data/codestar/2017-04-19/paginators-1.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
1063
botocore/data/codestar/2017-04-19/service-2.json
Normal file
1063
botocore/data/codestar/2017-04-19/service-2.json
Normal file
|
|
@ -0,0 +1,1063 @@
|
|||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2017-04-19",
|
||||
"endpointPrefix":"codestar",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceAbbreviation":"CodeStar",
|
||||
"serviceFullName":"AWS CodeStar",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"CodeStar_20170419",
|
||||
"uid":"codestar-2017-04-19"
|
||||
},
|
||||
"operations":{
|
||||
"AssociateTeamMember":{
|
||||
"name":"AssociateTeamMember",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"AssociateTeamMemberRequest"},
|
||||
"output":{"shape":"AssociateTeamMemberResult"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ProjectNotFoundException"},
|
||||
{"shape":"TeamMemberAlreadyAssociatedException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InvalidServiceRoleException"},
|
||||
{"shape":"ProjectConfigurationException"},
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
],
|
||||
"documentation":"<p>Adds an IAM user to the team for an AWS CodeStar project.</p>"
|
||||
},
|
||||
"CreateProject":{
|
||||
"name":"CreateProject",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateProjectRequest"},
|
||||
"output":{"shape":"CreateProjectResult"},
|
||||
"errors":[
|
||||
{"shape":"ProjectAlreadyExistsException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"ProjectCreationFailedException"},
|
||||
{"shape":"InvalidServiceRoleException"},
|
||||
{"shape":"ProjectConfigurationException"},
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
],
|
||||
"documentation":"<p>Reserved for future use. To create a project, use the AWS CodeStar console.</p>"
|
||||
},
|
||||
"CreateUserProfile":{
|
||||
"name":"CreateUserProfile",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateUserProfileRequest"},
|
||||
"output":{"shape":"CreateUserProfileResult"},
|
||||
"errors":[
|
||||
{"shape":"UserProfileAlreadyExistsException"},
|
||||
{"shape":"ValidationException"}
|
||||
],
|
||||
"documentation":"<p>Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.</p>"
|
||||
},
|
||||
"DeleteProject":{
|
||||
"name":"DeleteProject",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteProjectRequest"},
|
||||
"output":{"shape":"DeleteProjectResult"},
|
||||
"errors":[
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InvalidServiceRoleException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a project, including project resources. Does not delete users associated with the project, but does delete the IAM roles that allowed access to the project.</p>"
|
||||
},
|
||||
"DeleteUserProfile":{
|
||||
"name":"DeleteUserProfile",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteUserProfileRequest"},
|
||||
"output":{"shape":"DeleteUserProfileResult"},
|
||||
"errors":[
|
||||
{"shape":"ValidationException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of that user, for example the history of commits made by that user.</p>"
|
||||
},
|
||||
"DescribeProject":{
|
||||
"name":"DescribeProject",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeProjectRequest"},
|
||||
"output":{"shape":"DescribeProjectResult"},
|
||||
"errors":[
|
||||
{"shape":"ProjectNotFoundException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InvalidServiceRoleException"},
|
||||
{"shape":"ProjectConfigurationException"},
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
],
|
||||
"documentation":"<p>Describes a project and its resources.</p>"
|
||||
},
|
||||
"DescribeUserProfile":{
|
||||
"name":"DescribeUserProfile",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeUserProfileRequest"},
|
||||
"output":{"shape":"DescribeUserProfileResult"},
|
||||
"errors":[
|
||||
{"shape":"UserProfileNotFoundException"},
|
||||
{"shape":"ValidationException"}
|
||||
],
|
||||
"documentation":"<p>Describes a user in AWS CodeStar and the user attributes across all projects.</p>"
|
||||
},
|
||||
"DisassociateTeamMember":{
|
||||
"name":"DisassociateTeamMember",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DisassociateTeamMemberRequest"},
|
||||
"output":{"shape":"DisassociateTeamMemberResult"},
|
||||
"errors":[
|
||||
{"shape":"ProjectNotFoundException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InvalidServiceRoleException"},
|
||||
{"shape":"ConcurrentModificationException"}
|
||||
],
|
||||
"documentation":"<p>Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a team member does not remove that user's profile from AWS CodeStar. It does not remove the user from IAM.</p>"
|
||||
},
|
||||
"ListProjects":{
|
||||
"name":"ListProjects",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListProjectsRequest"},
|
||||
"output":{"shape":"ListProjectsResult"},
|
||||
"errors":[
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ValidationException"}
|
||||
],
|
||||
"documentation":"<p>Lists all projects in AWS CodeStar associated with your AWS account.</p>"
|
||||
},
|
||||
"ListResources":{
|
||||
"name":"ListResources",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListResourcesRequest"},
|
||||
"output":{"shape":"ListResourcesResult"},
|
||||
"errors":[
|
||||
{"shape":"ProjectNotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ValidationException"}
|
||||
],
|
||||
"documentation":"<p>Lists resources associated with a project in AWS CodeStar.</p>"
|
||||
},
|
||||
"ListTeamMembers":{
|
||||
"name":"ListTeamMembers",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListTeamMembersRequest"},
|
||||
"output":{"shape":"ListTeamMembersResult"},
|
||||
"errors":[
|
||||
{"shape":"ProjectNotFoundException"},
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ValidationException"}
|
||||
],
|
||||
"documentation":"<p>Lists all team members associated with a project.</p>"
|
||||
},
|
||||
"ListUserProfiles":{
|
||||
"name":"ListUserProfiles",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListUserProfilesRequest"},
|
||||
"output":{"shape":"ListUserProfilesResult"},
|
||||
"errors":[
|
||||
{"shape":"InvalidNextTokenException"},
|
||||
{"shape":"ValidationException"}
|
||||
],
|
||||
"documentation":"<p>Lists all the user profiles configured for your AWS account in AWS CodeStar.</p>"
|
||||
},
|
||||
"UpdateProject":{
|
||||
"name":"UpdateProject",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateProjectRequest"},
|
||||
"output":{"shape":"UpdateProjectResult"},
|
||||
"errors":[
|
||||
{"shape":"ProjectNotFoundException"},
|
||||
{"shape":"ValidationException"}
|
||||
],
|
||||
"documentation":"<p>Updates a project in AWS CodeStar.</p>"
|
||||
},
|
||||
"UpdateTeamMember":{
|
||||
"name":"UpdateTeamMember",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateTeamMemberRequest"},
|
||||
"output":{"shape":"UpdateTeamMemberResult"},
|
||||
"errors":[
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ProjectNotFoundException"},
|
||||
{"shape":"ValidationException"},
|
||||
{"shape":"InvalidServiceRoleException"},
|
||||
{"shape":"ProjectConfigurationException"},
|
||||
{"shape":"ConcurrentModificationException"},
|
||||
{"shape":"TeamMemberNotFoundException"}
|
||||
],
|
||||
"documentation":"<p>Updates a team member's attributes in an AWS CodeStar project. For example, you can change a team member's role in the project, or change whether they have remote access to project resources.</p>"
|
||||
},
|
||||
"UpdateUserProfile":{
|
||||
"name":"UpdateUserProfile",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateUserProfileRequest"},
|
||||
"output":{"shape":"UpdateUserProfileResult"},
|
||||
"errors":[
|
||||
{"shape":"UserProfileNotFoundException"},
|
||||
{"shape":"ValidationException"}
|
||||
],
|
||||
"documentation":"<p>Updates a user's profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar. </p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AssociateTeamMemberRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"projectId",
|
||||
"userArn",
|
||||
"projectRole"
|
||||
],
|
||||
"members":{
|
||||
"projectId":{
|
||||
"shape":"ProjectId",
|
||||
"documentation":"<p>The ID of the project to which you will add the IAM user.</p>"
|
||||
},
|
||||
"clientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>A user- or system-generated token that identifies the entity that requested the team member association to the project. This token can be used to repeat the request. </p>"
|
||||
},
|
||||
"userArn":{
|
||||
"shape":"UserArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) for the IAM user you want to add to the DevHub project.</p>"
|
||||
},
|
||||
"projectRole":{
|
||||
"shape":"Role",
|
||||
"documentation":"<p>The AWS CodeStar project role that will apply to this user. This role determines what actions a user can take in an AWS CodeStar project.</p>"
|
||||
},
|
||||
"remoteAccessAllowed":{
|
||||
"shape":"RemoteAccessAllowed",
|
||||
"documentation":"<p>Whether the team member is allowed to use an SSH public/private key pair to remotely access project resources, for example Amazon EC2 instances.</p>",
|
||||
"box":true
|
||||
}
|
||||
}
|
||||
},
|
||||
"AssociateTeamMemberResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"clientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>The user- or system-generated token from the initial request that can be used to repeat the request. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ClientRequestToken":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":1,
|
||||
"pattern":"^[\\w:/-]+$"
|
||||
},
|
||||
"ConcurrentModificationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>Another modification is being made. That modification must complete before you can make your change.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"CreateProjectRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"name",
|
||||
"id"
|
||||
],
|
||||
"members":{
|
||||
"name":{
|
||||
"shape":"ProjectName",
|
||||
"documentation":"<p>Reserved for future use.</p>"
|
||||
},
|
||||
"id":{
|
||||
"shape":"ProjectId",
|
||||
"documentation":"<p>Reserved for future use.</p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"ProjectDescription",
|
||||
"documentation":"<p>Reserved for future use.</p>"
|
||||
},
|
||||
"clientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>Reserved for future use.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateProjectResult":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"id",
|
||||
"arn"
|
||||
],
|
||||
"members":{
|
||||
"id":{
|
||||
"shape":"ProjectId",
|
||||
"documentation":"<p>Reserved for future use.</p>"
|
||||
},
|
||||
"arn":{
|
||||
"shape":"ProjectArn",
|
||||
"documentation":"<p>Reserved for future use.</p>"
|
||||
},
|
||||
"clientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>Reserved for future use.</p>"
|
||||
},
|
||||
"projectTemplateId":{
|
||||
"shape":"ProjectTemplateId",
|
||||
"documentation":"<p>Reserved for future use.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateUserProfileRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"userArn",
|
||||
"displayName",
|
||||
"emailAddress"
|
||||
],
|
||||
"members":{
|
||||
"userArn":{
|
||||
"shape":"UserArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the user in IAM.</p>"
|
||||
},
|
||||
"displayName":{
|
||||
"shape":"UserProfileDisplayName",
|
||||
"documentation":"<p>The name that will be displayed as the friendly name for the user in AWS CodeStar. </p>"
|
||||
},
|
||||
"emailAddress":{
|
||||
"shape":"Email",
|
||||
"documentation":"<p>The email address that will be displayed as part of the user's profile in AWS CodeStar.</p>"
|
||||
},
|
||||
"sshPublicKey":{
|
||||
"shape":"SshPublicKey",
|
||||
"documentation":"<p>The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateUserProfileResult":{
|
||||
"type":"structure",
|
||||
"required":["userArn"],
|
||||
"members":{
|
||||
"userArn":{
|
||||
"shape":"UserArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the user in IAM.</p>"
|
||||
},
|
||||
"displayName":{
|
||||
"shape":"UserProfileDisplayName",
|
||||
"documentation":"<p>The name that is displayed as the friendly name for the user in AWS CodeStar.</p>"
|
||||
},
|
||||
"emailAddress":{
|
||||
"shape":"Email",
|
||||
"documentation":"<p>The email address that is displayed as part of the user's profile in AWS CodeStar.</p>"
|
||||
},
|
||||
"sshPublicKey":{
|
||||
"shape":"SshPublicKey",
|
||||
"documentation":"<p>The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project owner allows the user remote access to those resources.</p>"
|
||||
},
|
||||
"createdTimestamp":{
|
||||
"shape":"CreatedTimestamp",
|
||||
"documentation":"<p>The date the user profile was created, in timestamp format.</p>"
|
||||
},
|
||||
"lastModifiedTimestamp":{
|
||||
"shape":"LastModifiedTimestamp",
|
||||
"documentation":"<p>The date the user profile was last modified, in timestamp format.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreatedTimestamp":{"type":"timestamp"},
|
||||
"DeleteProjectRequest":{
|
||||
"type":"structure",
|
||||
"required":["id"],
|
||||
"members":{
|
||||
"id":{
|
||||
"shape":"ProjectId",
|
||||
"documentation":"<p>The ID of the project to be deleted in AWS CodeStar.</p>"
|
||||
},
|
||||
"clientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request. </p>"
|
||||
},
|
||||
"deleteStack":{
|
||||
"shape":"DeleteStack",
|
||||
"documentation":"<p>Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the project and its resources. This option will delete all AWS resources for the project (except for any buckets in Amazon S3) as well as deleting the project itself. Recommended for most use cases.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteProjectResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"stackId":{
|
||||
"shape":"StackId",
|
||||
"documentation":"<p>The ID of the primary stack in AWS CloudFormation that will be deleted as part of deleting the project and its resources.</p>"
|
||||
},
|
||||
"projectArn":{
|
||||
"shape":"ProjectArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the deleted project.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteStack":{"type":"boolean"},
|
||||
"DeleteUserProfileRequest":{
|
||||
"type":"structure",
|
||||
"required":["userArn"],
|
||||
"members":{
|
||||
"userArn":{
|
||||
"shape":"UserArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteUserProfileResult":{
|
||||
"type":"structure",
|
||||
"required":["userArn"],
|
||||
"members":{
|
||||
"userArn":{
|
||||
"shape":"UserArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the user deleted from AWS CodeStar.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeProjectRequest":{
|
||||
"type":"structure",
|
||||
"required":["id"],
|
||||
"members":{
|
||||
"id":{
|
||||
"shape":"ProjectId",
|
||||
"documentation":"<p>The ID of the project.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeProjectResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"name":{
|
||||
"shape":"ProjectName",
|
||||
"documentation":"<p>The display name for the project.</p>"
|
||||
},
|
||||
"id":{
|
||||
"shape":"ProjectId",
|
||||
"documentation":"<p>The ID of the project.</p>"
|
||||
},
|
||||
"arn":{
|
||||
"shape":"ProjectArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) for the project.</p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"ProjectDescription",
|
||||
"documentation":"<p>The description of the project, if any.</p>"
|
||||
},
|
||||
"clientRequestToken":{
|
||||
"shape":"ClientRequestToken",
|
||||
"documentation":"<p>A user- or system-generated token that identifies the entity that requested project creation. </p>"
|
||||
},
|
||||
"createdTimeStamp":{
|
||||
"shape":"CreatedTimestamp",
|
||||
"documentation":"<p>The date and time the project was created, in timestamp format.</p>"
|
||||
},
|
||||
"stackId":{
|
||||
"shape":"StackId",
|
||||
"documentation":"<p>The ID of the primary stack in AWS CloudFormation used to generate resources for the project.</p>"
|
||||
},
|
||||
"projectTemplateId":{
|
||||
"shape":"ProjectTemplateId",
|
||||
"documentation":"<p>The ID for the AWS CodeStar project template used to create the project.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeUserProfileRequest":{
|
||||
"type":"structure",
|
||||
"required":["userArn"],
|
||||
"members":{
|
||||
"userArn":{
|
||||
"shape":"UserArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the user.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeUserProfileResult":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"userArn",
|
||||
"createdTimestamp",
|
||||
"lastModifiedTimestamp"
|
||||
],
|
||||
"members":{
|
||||
"userArn":{
|
||||
"shape":"UserArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the user.</p>"
|
||||
},
|
||||
"displayName":{
|
||||
"shape":"UserProfileDisplayName",
|
||||
"documentation":"<p>The display name shown for the user in AWS CodeStar projects. For example, this could be set to both first and last name (\"Mary Major\") or a single name (\"Mary\"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example \"Mary Jane Major\") would generate an initial icon using the first character and the first character after the space (\"MJ\", not \"MM\").</p>"
|
||||
},
|
||||
"emailAddress":{
|
||||
"shape":"Email",
|
||||
"documentation":"<p>The email address for the user. Optional.</p>"
|
||||
},
|
||||
"sshPublicKey":{
|
||||
"shape":"SshPublicKey",
|
||||
"documentation":"<p>The SSH public key associated with the user. This SSH public key is associated with the user profile, and can be used in conjunction with the associated private key for access to project resources, such as Amazon EC2 instances, if a project owner grants remote access to those resources.</p>"
|
||||
},
|
||||
"createdTimestamp":{
|
||||
"shape":"CreatedTimestamp",
|
||||
"documentation":"<p>The date and time when the user profile was created in AWS CodeStar, in timestamp format.</p>"
|
||||
},
|
||||
"lastModifiedTimestamp":{
|
||||
"shape":"LastModifiedTimestamp",
|
||||
"documentation":"<p>The date and time when the user profile was last modified, in timestamp format.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DisassociateTeamMemberRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"projectId",
|
||||
"userArn"
|
||||
],
|
||||
"members":{
|
||||
"projectId":{
|
||||
"shape":"ProjectId",
|
||||
"documentation":"<p>The ID of the AWS CodeStar project from which you want to remove a team member.</p>"
|
||||
},
|
||||
"userArn":{
|
||||
"shape":"UserArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove from the project.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DisassociateTeamMemberResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"Email":{
|
||||
"type":"string",
|
||||
"max":128,
|
||||
"min":3,
|
||||
"pattern":"^[\\w-.+]+@[\\w-.+]+$"
|
||||
},
|
||||
"InvalidNextTokenException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The next token is not valid.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidServiceRoleException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The service role is not valid.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"LastModifiedTimestamp":{"type":"timestamp"},
|
||||
"LimitExceededException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>A resource limit has been exceeded.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ListProjectsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The continuation token to be used to return the next set of results, if the results cannot be returned in one response.</p>"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum amount of data that can be contained in a single set of results.</p>",
|
||||
"box":true
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListProjectsResult":{
|
||||
"type":"structure",
|
||||
"required":["projects"],
|
||||
"members":{
|
||||
"projects":{
|
||||
"shape":"ProjectsList",
|
||||
"documentation":"<p>A list of projects.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The continuation token to use when requesting the next set of results, if there are more results to be returned.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListResourcesRequest":{
|
||||
"type":"structure",
|
||||
"required":["projectId"],
|
||||
"members":{
|
||||
"projectId":{
|
||||
"shape":"ProjectId",
|
||||
"documentation":"<p>The ID of the project.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The continuation token for the next set of results, if the results cannot be returned in one response.</p>"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>he maximum amount of data that can be contained in a single set of results.</p>",
|
||||
"box":true
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListResourcesResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"resources":{
|
||||
"shape":"ResourcesResult",
|
||||
"documentation":"<p>An array of resources associated with the project. </p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The continuation token to use when requesting the next set of results, if there are more results to be returned.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListTeamMembersRequest":{
|
||||
"type":"structure",
|
||||
"required":["projectId"],
|
||||
"members":{
|
||||
"projectId":{
|
||||
"shape":"ProjectId",
|
||||
"documentation":"<p>The ID of the project for which you want to list team members.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The continuation token for the next set of results, if the results cannot be returned in one response.</p>"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of team members you want returned in a response.</p>",
|
||||
"box":true
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListTeamMembersResult":{
|
||||
"type":"structure",
|
||||
"required":["teamMembers"],
|
||||
"members":{
|
||||
"teamMembers":{
|
||||
"shape":"TeamMemberResult",
|
||||
"documentation":"<p>A list of team member objects for the project.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The continuation token to use when requesting the next set of results, if there are more results to be returned.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListUserProfilesRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The continuation token for the next set of results, if the results cannot be returned in one response.</p>"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"MaxResults",
|
||||
"documentation":"<p>The maximum number of results to return in a response.</p>",
|
||||
"box":true
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListUserProfilesResult":{
|
||||
"type":"structure",
|
||||
"required":["userProfiles"],
|
||||
"members":{
|
||||
"userProfiles":{
|
||||
"shape":"UserProfilesList",
|
||||
"documentation":"<p>All the user profiles configured in AWS CodeStar for an AWS account.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>The continuation token to use when requesting the next set of results, if there are more results to be returned.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"MaxResults":{
|
||||
"type":"integer",
|
||||
"max":100,
|
||||
"min":1
|
||||
},
|
||||
"PaginationToken":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":1,
|
||||
"pattern":"^[\\w/+=]+$"
|
||||
},
|
||||
"ProjectAlreadyExistsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>An AWS CodeStar project with the same ID already exists in this region for the AWS account. AWS CodeStar project IDs must be unique within a region for the AWS account.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ProjectArn":{
|
||||
"type":"string",
|
||||
"pattern":"^arn:aws[^:\\s]*:codestar:[^:\\s]+:[0-9]{12}:project\\/[a-z]([a-z0-9|-])+$"
|
||||
},
|
||||
"ProjectConfigurationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>Project configuration information is required but not specified.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ProjectCreationFailedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The project creation request was valid, but a nonspecific exception or error occurred during project creation. The project could not be created in AWS CodeStar.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ProjectDescription":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
"pattern":"^$|^\\S(.*\\S)?$",
|
||||
"sensitive":true
|
||||
},
|
||||
"ProjectId":{
|
||||
"type":"string",
|
||||
"max":15,
|
||||
"min":2,
|
||||
"pattern":"^[a-z][a-z0-9-]+$"
|
||||
},
|
||||
"ProjectName":{
|
||||
"type":"string",
|
||||
"max":100,
|
||||
"min":1,
|
||||
"pattern":"^\\S(.*\\S)?$",
|
||||
"sensitive":true
|
||||
},
|
||||
"ProjectNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The specified AWS CodeStar project was not found.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ProjectSummary":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"projectId":{
|
||||
"shape":"ProjectId",
|
||||
"documentation":"<p>The ID of the project.</p>"
|
||||
},
|
||||
"projectArn":{
|
||||
"shape":"ProjectArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the project.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about the metadata for a project.</p>"
|
||||
},
|
||||
"ProjectTemplateId":{
|
||||
"type":"string",
|
||||
"min":1,
|
||||
"pattern":"^arn:aws[^:\\s]{0,5}:codestar:[^:\\s]+::project-template\\/[a-z0-9-]+$"
|
||||
},
|
||||
"ProjectsList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ProjectSummary"}
|
||||
},
|
||||
"RemoteAccessAllowed":{"type":"boolean"},
|
||||
"Resource":{
|
||||
"type":"structure",
|
||||
"required":["id"],
|
||||
"members":{
|
||||
"id":{
|
||||
"shape":"ResourceId",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the resource.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a resource for a project.</p>"
|
||||
},
|
||||
"ResourceId":{
|
||||
"type":"string",
|
||||
"min":11,
|
||||
"pattern":"^arn\\:aws\\:\\S.*\\:.*"
|
||||
},
|
||||
"ResourcesResult":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Resource"}
|
||||
},
|
||||
"Role":{
|
||||
"type":"string",
|
||||
"pattern":"^(Owner|Viewer|Contributor)$"
|
||||
},
|
||||
"SshPublicKey":{
|
||||
"type":"string",
|
||||
"max":16384,
|
||||
"pattern":"^[\\t\\r\\n\\u0020-\\u00FF]*$"
|
||||
},
|
||||
"StackId":{
|
||||
"type":"string",
|
||||
"pattern":"^arn:aws[^:\\s]*:cloudformation:[^:\\s]+:[0-9]{12}:stack\\/[^:\\s]+\\/[^:\\s]+$"
|
||||
},
|
||||
"TeamMember":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"userArn",
|
||||
"projectRole"
|
||||
],
|
||||
"members":{
|
||||
"userArn":{
|
||||
"shape":"UserArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the user in IAM.</p>"
|
||||
},
|
||||
"projectRole":{
|
||||
"shape":"Role",
|
||||
"documentation":"<p>The role assigned to the user in the project. Project roles have different levels of access. For more information, see <a href=\"http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html\">Working with Teams</a> in the AWS CodeStar User Guide. </p>"
|
||||
},
|
||||
"remoteAccessAllowed":{
|
||||
"shape":"RemoteAccessAllowed",
|
||||
"documentation":"<p>Whether the user is allowed to remotely access project resources using an SSH public/private key pair.</p>",
|
||||
"box":true
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a team member in a project.</p>"
|
||||
},
|
||||
"TeamMemberAlreadyAssociatedException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The team member is already associated with a role in this project.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"TeamMemberNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The specified team member was not found.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"TeamMemberResult":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TeamMember"}
|
||||
},
|
||||
"UpdateProjectRequest":{
|
||||
"type":"structure",
|
||||
"required":["id"],
|
||||
"members":{
|
||||
"id":{
|
||||
"shape":"ProjectId",
|
||||
"documentation":"<p>The ID of the project you want to update.</p>"
|
||||
},
|
||||
"name":{
|
||||
"shape":"ProjectName",
|
||||
"documentation":"<p>The name of the project you want to update.</p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"ProjectDescription",
|
||||
"documentation":"<p>The description of the project, if any.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateProjectResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"UpdateTeamMemberRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"projectId",
|
||||
"userArn"
|
||||
],
|
||||
"members":{
|
||||
"projectId":{
|
||||
"shape":"ProjectId",
|
||||
"documentation":"<p>The ID of the project.</p>"
|
||||
},
|
||||
"userArn":{
|
||||
"shape":"UserArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes.</p>"
|
||||
},
|
||||
"projectRole":{
|
||||
"shape":"Role",
|
||||
"documentation":"<p>The role assigned to the user in the project. Project roles have different levels of access. For more information, see <a href=\"http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html\">Working with Teams</a> in the AWS CodeStar User Guide.</p>"
|
||||
},
|
||||
"remoteAccessAllowed":{
|
||||
"shape":"RemoteAccessAllowed",
|
||||
"documentation":"<p>Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile. Even if this is set to True, the user must associate a public key with their profile before the user can access resources.</p>",
|
||||
"box":true
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateTeamMemberResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"userArn":{
|
||||
"shape":"UserArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the user whose team membership attributes were updated.</p>"
|
||||
},
|
||||
"projectRole":{
|
||||
"shape":"Role",
|
||||
"documentation":"<p>The project role granted to the user.</p>"
|
||||
},
|
||||
"remoteAccessAllowed":{
|
||||
"shape":"RemoteAccessAllowed",
|
||||
"documentation":"<p>Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user's profile.</p>",
|
||||
"box":true
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateUserProfileRequest":{
|
||||
"type":"structure",
|
||||
"required":["userArn"],
|
||||
"members":{
|
||||
"userArn":{
|
||||
"shape":"UserArn",
|
||||
"documentation":"<p>The name that will be displayed as the friendly name for the user in AWS CodeStar.</p>"
|
||||
},
|
||||
"displayName":{
|
||||
"shape":"UserProfileDisplayName",
|
||||
"documentation":"<p>The name that is displayed as the friendly name for the user in AWS CodeStar.</p>"
|
||||
},
|
||||
"emailAddress":{
|
||||
"shape":"Email",
|
||||
"documentation":"<p>The email address that is displayed as part of the user's profile in AWS CodeStar.</p>"
|
||||
},
|
||||
"sshPublicKey":{
|
||||
"shape":"SshPublicKey",
|
||||
"documentation":"<p>The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateUserProfileResult":{
|
||||
"type":"structure",
|
||||
"required":["userArn"],
|
||||
"members":{
|
||||
"userArn":{
|
||||
"shape":"UserArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the user in IAM.</p>"
|
||||
},
|
||||
"displayName":{
|
||||
"shape":"UserProfileDisplayName",
|
||||
"documentation":"<p>The name that is displayed as the friendly name for the user in AWS CodeStar.</p>"
|
||||
},
|
||||
"emailAddress":{
|
||||
"shape":"Email",
|
||||
"documentation":"<p>The email address that is displayed as part of the user's profile in AWS CodeStar.</p>"
|
||||
},
|
||||
"sshPublicKey":{
|
||||
"shape":"SshPublicKey",
|
||||
"documentation":"<p>The SSH public key associated with the user in AWS CodeStar. This is the public portion of the public/private keypair the user can use to access project resources if a project owner allows the user remote access to those resources.</p>"
|
||||
},
|
||||
"createdTimestamp":{
|
||||
"shape":"CreatedTimestamp",
|
||||
"documentation":"<p>The date the user profile was created, in timestamp format.</p>"
|
||||
},
|
||||
"lastModifiedTimestamp":{
|
||||
"shape":"LastModifiedTimestamp",
|
||||
"documentation":"<p>The date the user profile was last modified, in timestamp format.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UserArn":{
|
||||
"type":"string",
|
||||
"max":95,
|
||||
"min":32,
|
||||
"pattern":"arn:aws:iam::\\d{12}:user\\/[\\w-]+"
|
||||
},
|
||||
"UserProfileAlreadyExistsException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>A user profile with that name already exists in this region for the AWS account. AWS CodeStar user profile names must be unique within a region for the AWS account. </p>",
|
||||
"exception":true
|
||||
},
|
||||
"UserProfileDisplayName":{
|
||||
"type":"string",
|
||||
"max":64,
|
||||
"min":1,
|
||||
"pattern":"^\\S(.*\\S)?$"
|
||||
},
|
||||
"UserProfileNotFoundException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The user profile was not found.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"UserProfileSummary":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"userArn":{
|
||||
"shape":"UserArn",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the user in IAM.</p>"
|
||||
},
|
||||
"displayName":{
|
||||
"shape":"UserProfileDisplayName",
|
||||
"documentation":"<p>The display name of a user in AWS CodeStar. For example, this could be set to both first and last name (\"Mary Major\") or a single name (\"Mary\"). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example \"Mary Jane Major\") would generate an initial icon using the first character and the first character after the space (\"MJ\", not \"MM\").</p>"
|
||||
},
|
||||
"emailAddress":{
|
||||
"shape":"Email",
|
||||
"documentation":"<p>The email address associated with the user.</p>"
|
||||
},
|
||||
"sshPublicKey":{
|
||||
"shape":"SshPublicKey",
|
||||
"documentation":"<p>The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user's private key for SSH access.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about a user's profile in AWS CodeStar.</p>"
|
||||
},
|
||||
"UserProfilesList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"UserProfileSummary"}
|
||||
},
|
||||
"ValidationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The specified input is either not valid, or it could not be validated.</p>",
|
||||
"exception":true
|
||||
}
|
||||
},
|
||||
"documentation":"<fullname>AWS CodeStar</fullname> <p>This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.</p> <p>You can use the AWS CodeStar API to work with:</p> <p>Projects and their resources, by calling the following:</p> <ul> <li> <p> <a>DeleteProject</a>, which deletes a project in AWS CodeStar.</p> </li> <li> <p> <a>DescribeProject</a>, which lists the attributes of a project.</p> </li> <li> <p> <a>ListProjects</a>, which lists all AWS CodeStar projects associated with your AWS account.</p> </li> <li> <p> <a>ListResources</a>, which lists the resources associated with an AWS CodeStar project.</p> </li> <li> <p> <a>UpdateProject</a>, which updates the attributes of an AWS CodeStar project.</p> </li> </ul> <p>Teams and team members, by calling the following:</p> <ul> <li> <p> <a>AssociateTeamMember</a>, which adds an IAM user to the team for an AWS CodeStar project.</p> </li> <li> <p> <a>DisassociateTeamMember</a>, which removes an IAM user from the team for an AWS CodeStar project.</p> </li> <li> <p> <a>ListTeamMembers</a>, which lists all the IAM users in the team for an AWS CodeStar project, including their roles and attributes.</p> </li> </ul> <p>Users, by calling the following:</p> <ul> <li> <p> <a>CreateUserProfile</a>, which creates a user profile that contains data associated with the user across all AWS CodeStar projects.</p> </li> <li> <p> <a>DeleteUserProfile</a>, which deletes all user profile information across all AWS CodeStar projects.</p> </li> <li> <p> <a>DescribeUserProfile</a>, which describes the profile of a user.</p> </li> <li> <p> <a>ListUserProfiles</a>, which lists all AWS CodeStar user profiles.</p> </li> <li> <p> <a>UpdateUserProfile</a>, which updates the profile for an AWS CodeStar user. </p> </li> </ul>"
|
||||
}
|
||||
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
|
|
@ -374,6 +374,11 @@
|
|||
"ClientId":{
|
||||
"shape":"CognitoIdentityProviderClientId",
|
||||
"documentation":"<p>The client ID for the Amazon Cognito Identity User Pool.</p>"
|
||||
},
|
||||
"ServerSideTokenCheck":{
|
||||
"shape":"CognitoIdentityProviderTokenCheck",
|
||||
"documentation":"<p>TRUE if server-side token validation is enabled for the identity provider’s token.</p>",
|
||||
"box":true
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A provider representing an Amazon Cognito Identity User Pool and its client ID.</p>"
|
||||
|
|
@ -394,6 +399,7 @@
|
|||
"min":1,
|
||||
"pattern":"[\\w._:/-]+"
|
||||
},
|
||||
"CognitoIdentityProviderTokenCheck":{"type":"boolean"},
|
||||
"ConcurrentModificationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
|
|||
5
botocore/data/cognito-idp/2016-04-18/examples-1.json
Executable file
5
botocore/data/cognito-idp/2016-04-18/examples-1.json
Executable file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
3
botocore/data/cognito-idp/2016-04-18/paginators-1.json
Normal file
3
botocore/data/cognito-idp/2016-04-18/paginators-1.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
943
botocore/data/cognito-idp/2016-04-18/service-2.json
Executable file → Normal file
943
botocore/data/cognito-idp/2016-04-18/service-2.json
Executable file → Normal file
|
|
@ -95,7 +95,7 @@
|
|||
{"shape":"UnsupportedUserStateException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to CreateUserPool or UpdateUserPool. This template includes your custom sign-up instructions and placeholders for user name and temporary password.</p> <p>Requires developer credentials.</p>"
|
||||
"documentation":"<p>Creates a new user in the specified user pool and sends a welcome message via email or phone (SMS). This message is based on a template that you configured in your call to <a href=\"API_CreateUserPool.html\">CreateUserPool</a> or <a href=\"API_UpdateUserPool.html\">UpdateUserPool</a>. This template includes your custom sign-up instructions and placeholders for user name and temporary password.</p> <p>Requires developer credentials.</p>"
|
||||
},
|
||||
"AdminDeleteUser":{
|
||||
"name":"AdminDeleteUser",
|
||||
|
|
@ -411,7 +411,7 @@
|
|||
{"shape":"UserNotFoundException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.</p> <p>Requires developer credentials.</p>"
|
||||
"documentation":"<p>Updates the specified user's attributes, including developer attributes, as an administrator. Works on any user.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p> <p>In addition to updating user attributes, this API can also be used to mark phone and email as verified.</p> <p>Requires developer credentials.</p>"
|
||||
},
|
||||
"AdminUserGlobalSignOut":{
|
||||
"name":"AdminUserGlobalSignOut",
|
||||
|
|
@ -476,7 +476,7 @@
|
|||
{"shape":"UserNotConfirmedException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Confirms tracking of the device. This API call is the call that beings device tracking.</p>"
|
||||
"documentation":"<p>Confirms tracking of the device. This API call is the call that begins device tracking.</p>"
|
||||
},
|
||||
"ConfirmForgotPassword":{
|
||||
"name":"ConfirmForgotPassword",
|
||||
|
|
@ -503,7 +503,7 @@
|
|||
{"shape":"UserNotConfirmedException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Allows a user to enter a code provided when they reset their password to update their password.</p>",
|
||||
"documentation":"<p>Allows a user to enter a confirmation code to reset a forgotten password.</p>",
|
||||
"authtype":"none"
|
||||
},
|
||||
"ConfirmSignUp":{
|
||||
|
|
@ -552,6 +552,25 @@
|
|||
],
|
||||
"documentation":"<p>Creates a new group in the specified user pool.</p> <p>Requires developer credentials.</p>"
|
||||
},
|
||||
"CreateIdentityProvider":{
|
||||
"name":"CreateIdentityProvider",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateIdentityProviderRequest"},
|
||||
"output":{"shape":"CreateIdentityProviderResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"DuplicateProviderException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"NotAuthorizedException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Creates an identity provider for a user pool.</p>"
|
||||
},
|
||||
"CreateUserImportJob":{
|
||||
"name":"CreateUserImportJob",
|
||||
"http":{
|
||||
|
|
@ -606,10 +625,28 @@
|
|||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"NotAuthorizedException"},
|
||||
{"shape":"ScopeDoesNotExistException"},
|
||||
{"shape":"InvalidOAuthFlowException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Creates the user pool client.</p>"
|
||||
},
|
||||
"CreateUserPoolDomain":{
|
||||
"name":"CreateUserPoolDomain",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateUserPoolDomainRequest"},
|
||||
"output":{"shape":"CreateUserPoolDomainResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"NotAuthorizedException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new domain for a user pool.</p>"
|
||||
},
|
||||
"DeleteGroup":{
|
||||
"name":"DeleteGroup",
|
||||
"http":{
|
||||
|
|
@ -626,6 +663,23 @@
|
|||
],
|
||||
"documentation":"<p>Deletes a group. Currently only groups with no members can be deleted.</p> <p>Requires developer credentials.</p>"
|
||||
},
|
||||
"DeleteIdentityProvider":{
|
||||
"name":"DeleteIdentityProvider",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteIdentityProviderRequest"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"UnsupportedIdentityProviderException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"NotAuthorizedException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Deletes an identity provider for a user pool.</p>"
|
||||
},
|
||||
"DeleteUser":{
|
||||
"name":"DeleteUser",
|
||||
"http":{
|
||||
|
|
@ -700,6 +754,39 @@
|
|||
],
|
||||
"documentation":"<p>Allows the developer to delete the user pool client.</p>"
|
||||
},
|
||||
"DeleteUserPoolDomain":{
|
||||
"name":"DeleteUserPoolDomain",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteUserPoolDomainRequest"},
|
||||
"output":{"shape":"DeleteUserPoolDomainResponse"},
|
||||
"errors":[
|
||||
{"shape":"NotAuthorizedException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a domain for a user pool.</p>"
|
||||
},
|
||||
"DescribeIdentityProvider":{
|
||||
"name":"DescribeIdentityProvider",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeIdentityProviderRequest"},
|
||||
"output":{"shape":"DescribeIdentityProviderResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"NotAuthorizedException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Gets information about a specific identity provider.</p>"
|
||||
},
|
||||
"DescribeUserImportJob":{
|
||||
"name":"DescribeUserImportJob",
|
||||
"http":{
|
||||
|
|
@ -752,6 +839,22 @@
|
|||
],
|
||||
"documentation":"<p>Client method for returning the configuration information and metadata of the specified user pool client.</p>"
|
||||
},
|
||||
"DescribeUserPoolDomain":{
|
||||
"name":"DescribeUserPoolDomain",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeUserPoolDomainRequest"},
|
||||
"output":{"shape":"DescribeUserPoolDomainResponse"},
|
||||
"errors":[
|
||||
{"shape":"NotAuthorizedException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Gets information about a domain.</p>"
|
||||
},
|
||||
"ForgetDevice":{
|
||||
"name":"ForgetDevice",
|
||||
"http":{
|
||||
|
|
@ -797,7 +900,7 @@
|
|||
{"shape":"UserNotConfirmedException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves the password for the specified client ID or username.</p>",
|
||||
"documentation":"<p>Calling this API causes a message to be sent to the end user with a confirmation code that is required to change the user's password. For the <code>Username</code> parameter, you can use the username or user alias. If a verified phone number exists for the user, the confirmation code is sent to the phone number. Otherwise, if a verified email exists, the confirmation code is sent to the email. If neither a verified phone number nor a verified email exists, <code>InvalidParameterException</code> is thrown. To use the confirmation code for resetting the password, call <a href=\"API_ConfirmForgotPassword.html\">ConfirmForgotPassword</a>.</p>",
|
||||
"authtype":"none"
|
||||
},
|
||||
"GetCSVHeader":{
|
||||
|
|
@ -855,6 +958,23 @@
|
|||
],
|
||||
"documentation":"<p>Gets a group.</p> <p>Requires developer credentials.</p>"
|
||||
},
|
||||
"GetIdentityProviderByIdentifier":{
|
||||
"name":"GetIdentityProviderByIdentifier",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetIdentityProviderByIdentifierRequest"},
|
||||
"output":{"shape":"GetIdentityProviderByIdentifierResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"NotAuthorizedException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Gets the specified identity provider.</p>"
|
||||
},
|
||||
"GetUser":{
|
||||
"name":"GetUser",
|
||||
"http":{
|
||||
|
|
@ -986,6 +1106,23 @@
|
|||
],
|
||||
"documentation":"<p>Lists the groups associated with a user pool.</p> <p>Requires developer credentials.</p>"
|
||||
},
|
||||
"ListIdentityProviders":{
|
||||
"name":"ListIdentityProviders",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListIdentityProvidersRequest"},
|
||||
"output":{"shape":"ListIdentityProvidersResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"NotAuthorizedException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Lists information about all identity providers for a user pool.</p>"
|
||||
},
|
||||
"ListUserImportJobs":{
|
||||
"name":"ListUserImportJobs",
|
||||
"http":{
|
||||
|
|
@ -1249,6 +1386,24 @@
|
|||
],
|
||||
"documentation":"<p>Updates the specified group with the specified attributes.</p> <p>Requires developer credentials.</p>"
|
||||
},
|
||||
"UpdateIdentityProvider":{
|
||||
"name":"UpdateIdentityProvider",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateIdentityProviderRequest"},
|
||||
"output":{"shape":"UpdateIdentityProviderResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"UnsupportedIdentityProviderException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"NotAuthorizedException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Updates identity provider information for a user pool.</p>"
|
||||
},
|
||||
"UpdateUserAttributes":{
|
||||
"name":"UpdateUserAttributes",
|
||||
"http":{
|
||||
|
|
@ -1316,6 +1471,8 @@
|
|||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"TooManyRequestsException"},
|
||||
{"shape":"NotAuthorizedException"},
|
||||
{"shape":"ScopeDoesNotExistException"},
|
||||
{"shape":"InvalidOAuthFlowException"},
|
||||
{"shape":"InternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Allows the developer to update the specified user pool client and password policy.</p>"
|
||||
|
|
@ -1346,6 +1503,7 @@
|
|||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AWSAccountIdType":{"type":"string"},
|
||||
"AddCustomAttributesRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -1421,11 +1579,11 @@
|
|||
"members":{
|
||||
"AllowAdminCreateUserOnly":{
|
||||
"shape":"BooleanType",
|
||||
"documentation":"<p>Set to True if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.</p>"
|
||||
"documentation":"<p>Set to <code>True</code> if only the administrator is allowed to create user profiles. Set to <code>False</code> if users can sign themselves up via an app.</p>"
|
||||
},
|
||||
"UnusedAccountValidityDays":{
|
||||
"shape":"AdminCreateUserUnusedAccountValidityDaysType",
|
||||
"documentation":"<p>The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter. The default value for this paameter is 7.</p>"
|
||||
"documentation":"<p>The user account expiration limit, in days, after which the account is no longer usable. To reset the account after that time limit, you must call <code>AdminCreateUser</code> again, specifying <code>\"RESEND\"</code> for the <code>MessageAction</code> parameter. The default value for this parameter is 7.</p>"
|
||||
},
|
||||
"InviteMessageTemplate":{
|
||||
"shape":"MessageTemplateType",
|
||||
|
|
@ -1451,7 +1609,7 @@
|
|||
},
|
||||
"UserAttributes":{
|
||||
"shape":"AttributeListType",
|
||||
"documentation":"<p>An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than Username. However, any attributes that you specify as required (in CreateUserPool or in the <b>Attributes</b> tab of the console) must be supplied either by you (in your call to AdminCreateUser) or by the user (when he or she signs up in response to your welcome message).</p> <p>To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the <b>Users</b> tab of the Amazon Cognito console for managing your user pools.</p> <p>In your call to AdminCreateUser, you can set the email_verified attribute to True, and you can set the phone_number_verified attribute to True. (You cannot do this by calling other operations such as AdminUpdateUserAttributes.)</p> <ul> <li> <p> <b>email</b>: The email address of the user to whom the message that contains the code and username will be sent. Required if the email_verified attribute is set to True, or if \"EMAIL\" is specified in the DesiredDeliveryMediums parameter.</p> </li> <li> <p> <b>phone_number</b>: The phone number of the user to whom the message that contains the code and username will be sent. Required if the phone_number_verified attribute is set to True, or if \"SMS\" is specified in the DesiredDeliveryMediums parameter.</p> </li> </ul>"
|
||||
"documentation":"<p>An array of name-value pairs that contain user attributes and attribute values to be set for the user to be created. You can create a user without specifying any attributes other than <code>Username</code>. However, any attributes that you specify as required (in <a href=\"API_CreateUserPool.html\">CreateUserPool</a> or in the <b>Attributes</b> tab of the console) must be supplied either by you (in your call to <code>AdminCreateUser</code>) or by the user (when he or she signs up in response to your welcome message).</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p> <p>To send a message inviting the user to sign up, you must specify the user's email address or phone number. This can be done in your call to AdminCreateUser or in the <b>Users</b> tab of the Amazon Cognito console for managing your user pools.</p> <p>In your call to <code>AdminCreateUser</code>, you can set the <code>email_verified</code> attribute to <code>True</code>, and you can set the <code>phone_number_verified</code> attribute to <code>True</code>. (You can also do this by calling <a href=\"API_AdminUpdateUserAttributes.html\">AdminUpdateUserAttributes</a>.)</p> <ul> <li> <p> <b>email</b>: The email address of the user to whom the message that contains the code and username will be sent. Required if the <code>email_verified</code> attribute is set to <code>True</code>, or if <code>\"EMAIL\"</code> is specified in the <code>DesiredDeliveryMediums</code> parameter.</p> </li> <li> <p> <b>phone_number</b>: The phone number of the user to whom the message that contains the code and username will be sent. Required if the <code>phone_number_verified</code> attribute is set to <code>True</code>, or if <code>\"SMS\"</code> is specified in the <code>DesiredDeliveryMediums</code> parameter.</p> </li> </ul>"
|
||||
},
|
||||
"ValidationData":{
|
||||
"shape":"AttributeListType",
|
||||
|
|
@ -1459,19 +1617,19 @@
|
|||
},
|
||||
"TemporaryPassword":{
|
||||
"shape":"PasswordType",
|
||||
"documentation":"<p>The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.</p> <p>The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.</p> <p>This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.</p> <p>The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call AdminCreateUser again, specifying \"RESEND\" for the MessageAction parameter.</p>"
|
||||
"documentation":"<p>The user's temporary password. This password must conform to the password policy that you specified when you created the user pool.</p> <p>The temporary password is valid only once. To complete the Admin Create User flow, the user must enter the temporary password in the sign-in page along with a new password to be used in all future sign-ins.</p> <p>This parameter is not required. If you do not specify a value, Amazon Cognito generates one for you.</p> <p>The temporary password can only be used until the user account expiration limit that you specified when you created the user pool. To reset the account after that time limit, you must call <code>AdminCreateUser</code> again, specifying <code>\"RESEND\"</code> for the <code>MessageAction</code> parameter.</p>"
|
||||
},
|
||||
"ForceAliasCreation":{
|
||||
"shape":"ForceAliasCreation",
|
||||
"documentation":"<p>This parameter is only used if the phone_number_verified or email_verified attribute is set to True. Otherwise, it is ignored.</p> <p>If this parameter is set to True and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.</p> <p>If this parameter is set to False, the API throws an AliasExistsException error if the alias already exists. The default value is False.</p>"
|
||||
"documentation":"<p>This parameter is only used if the <code>phone_number_verified</code> or <code>email_verified</code> attribute is set to <code>True</code>. Otherwise, it is ignored.</p> <p>If this parameter is set to <code>True</code> and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user. The previous user will no longer be able to log in using that alias.</p> <p>If this parameter is set to <code>False</code>, the API throws an <code>AliasExistsException</code> error if the alias already exists. The default value is <code>False</code>.</p>"
|
||||
},
|
||||
"MessageAction":{
|
||||
"shape":"MessageActionType",
|
||||
"documentation":"<p>Set to \"RESEND\" to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to \"SUPPRESS\" to suppress sending the message. Only one value can be specified.</p>"
|
||||
"documentation":"<p>Set to <code>\"RESEND\"</code> to resend the invitation message to a user that already exists and reset the expiration limit on the user's account. Set to <code>\"SUPPRESS\"</code> to suppress sending the message. Only one value can be specified.</p>"
|
||||
},
|
||||
"DesiredDeliveryMediums":{
|
||||
"shape":"DeliveryMediumListType",
|
||||
"documentation":"<p>Specify \"EMAIL\" if email will be used to send the welcome message. Specify \"SMS\" if the phone number will be used. The default value is \"SMS\". More than one value can be specified.</p>"
|
||||
"documentation":"<p>Specify <code>\"EMAIL\"</code> if email will be used to send the welcome message. Specify <code>\"SMS\"</code> if the phone number will be used. The default value is <code>\"SMS\"</code>. More than one value can be specified.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the request to create a user in the specified user pool.</p>"
|
||||
|
|
@ -1509,7 +1667,7 @@
|
|||
},
|
||||
"UserAttributeNames":{
|
||||
"shape":"AttributeNameListType",
|
||||
"documentation":"<p>An array of strings representing the user attribute names you wish to delete.</p>"
|
||||
"documentation":"<p>An array of strings representing the user attribute names you wish to delete.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the request to delete user attributes as an administrator.</p>"
|
||||
|
|
@ -1575,7 +1733,7 @@
|
|||
},
|
||||
"Username":{
|
||||
"shape":"UsernameType",
|
||||
"documentation":"<p>The user name of the user you wish to ebable.</p>"
|
||||
"documentation":"<p>The user name of the user you wish to enable.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the request that enables the user as an administrator.</p>"
|
||||
|
|
@ -1710,19 +1868,19 @@
|
|||
},
|
||||
"ClientId":{
|
||||
"shape":"ClientIdType",
|
||||
"documentation":"<p>The client app ID.</p>"
|
||||
"documentation":"<p>The app client ID.</p>"
|
||||
},
|
||||
"AuthFlow":{
|
||||
"shape":"AuthFlowType",
|
||||
"documentation":"<p>The authentication flow.</p>"
|
||||
"documentation":"<p>The authentication flow for this call to execute. The API action will depend on this value. For example:</p> <ul> <li> <p> <code>REFRESH_TOKEN_AUTH</code> will take in a valid refresh token and return new tokens.</p> </li> <li> <p> <code>USER_SRP_AUTH</code> will take in <code>USERNAME</code> and <code>SRPA</code> and return the SRP variables to be used for next challenge execution.</p> </li> </ul> <p>Valid values include:</p> <ul> <li> <p> <code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password (SRP) protocol.</p> </li> <li> <p> <code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.</p> </li> <li> <p> <code>CUSTOM_AUTH</code>: Custom authentication flow.</p> </li> <li> <p> <code>ADMIN_NO_SRP_AUTH</code>: Non-SRP authentication flow; you can pass in the USERNAME and PASSWORD directly if the flow is enabled for calling the app client.</p> </li> </ul>"
|
||||
},
|
||||
"AuthParameters":{
|
||||
"shape":"AuthParametersType",
|
||||
"documentation":"<p>The authentication parameters.</p>"
|
||||
"documentation":"<p>The authentication parameters. These are inputs corresponding to the <code>AuthFlow</code> that you are invoking. The required values depend on the value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>: <code>USERNAME</code> (required), <code>SRPA</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code> </p> </li> <li> <p>For <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>REFRESH_TOKEN</code> (required), <code>DEVICE_KEY</code> </p> </li> <li> <p>For <code>ADMIN_NO_SRP_AUTH</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (if app client is configured with client secret), <code>PASSWORD</code> (required), <code>DEVICE_KEY</code> </p> </li> <li> <p>For <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (if app client is configured with client secret), <code>DEVICE_KEY</code> </p> </li> </ul>"
|
||||
},
|
||||
"ClientMetadata":{
|
||||
"shape":"ClientMetadataType",
|
||||
"documentation":"<p>The client app metadata.</p>"
|
||||
"documentation":"<p>This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Initiates the authorization request, as an administrator.</p>"
|
||||
|
|
@ -1732,19 +1890,19 @@
|
|||
"members":{
|
||||
"ChallengeName":{
|
||||
"shape":"ChallengeNameType",
|
||||
"documentation":"<p>The name of the challenge.</p>"
|
||||
"documentation":"<p>The name of the challenge which you are responding to with this call. This is returned to you in the <code>AdminInitiateAuth</code> response if you need to pass another challenge.</p> <ul> <li> <p> <code>SMS_MFA</code>: Next challenge is to supply an <code>SMS_MFA_CODE</code>, delivered via SMS.</p> </li> <li> <p> <code>PASSWORD_VERIFIER</code>: Next challenge is to supply <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after the client-side SRP calculations.</p> </li> <li> <p> <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.</p> </li> <li> <p> <code>DEVICE_SRP_AUTH</code>: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.</p> </li> <li> <p> <code>DEVICE_PASSWORD_VERIFIER</code>: Similar to <code>PASSWORD_VERIFIER</code>, but for devices only.</p> </li> <li> <p> <code>ADMIN_NO_SRP_AUTH</code>: This is returned if you need to authenticate with <code>USERNAME</code> and <code>PASSWORD</code> directly. An app client must be enabled to use this flow.</p> </li> <li> <p> <code>NEW_PASSWORD_REQUIRED</code>: For users which are required to change their passwords after successful first login. This challenge should be passed with <code>NEW_PASSWORD</code> and any other required attributes.</p> </li> </ul>"
|
||||
},
|
||||
"Session":{
|
||||
"shape":"SessionType",
|
||||
"documentation":"<p>The session.</p>"
|
||||
"documentation":"<p>The session which should be passed both ways in challenge-response calls to the service. If <code>AdminInitiateAuth</code> or <code>AdminRespondToAuthChallenge</code> API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>AdminRespondToAuthChallenge</code> API call.</p>"
|
||||
},
|
||||
"ChallengeParameters":{
|
||||
"shape":"ChallengeParametersType",
|
||||
"documentation":"<p>The challenge parameters.</p>"
|
||||
"documentation":"<p>The challenge parameters. These are returned to you in the <code>AdminInitiateAuth</code> response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (<code>AdminRespondToAuthChallenge</code>).</p> <p>All challenges require <code>USERNAME</code> and <code>SECRET_HASH</code> (if applicable).</p> <p>The value of the <code>USER_IF_FOR_SRP</code> attribute will be the user's actual username, not an alias (such as email address or phone number), even if you specified an alias in your call to <code>AdminInitiateAuth</code>. This is because, in the <code>AdminRespondToAuthChallenge</code> API <code>ChallengeResponses</code>, the <code>USERNAME</code> attribute cannot be an alias.</p>"
|
||||
},
|
||||
"AuthenticationResult":{
|
||||
"shape":"AuthenticationResultType",
|
||||
"documentation":"<p>The result of the authentication response.</p>"
|
||||
"documentation":"<p>The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, <code>ChallengeName</code>, <code>ChallengeParameters</code>, and <code>Session</code> are returned.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Initiates the authentication response, as an administrator.</p>"
|
||||
|
|
@ -1887,19 +2045,19 @@
|
|||
},
|
||||
"ClientId":{
|
||||
"shape":"ClientIdType",
|
||||
"documentation":"<p>The client ID.</p>"
|
||||
"documentation":"<p>The app client ID.</p>"
|
||||
},
|
||||
"ChallengeName":{
|
||||
"shape":"ChallengeNameType",
|
||||
"documentation":"<p>The name of the challenge.</p>"
|
||||
"documentation":"<p>The challenge name. For more information, see <a href=\"API_AdminInitiateAuth.html\">AdminInitiateAuth</a>.</p>"
|
||||
},
|
||||
"ChallengeResponses":{
|
||||
"shape":"ChallengeResponsesType",
|
||||
"documentation":"<p>The challenge response.</p>"
|
||||
"documentation":"<p>The challenge responses. These are inputs corresponding to the value of <code>ChallengeName</code>, for example:</p> <ul> <li> <p> <code>SMS_MFA</code>: <code>SMS_MFA_CODE</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p> </li> <li> <p> <code>PASSWORD_VERIFIER</code>: <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, <code>TIMESTAMP</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p> </li> <li> <p> <code>ADMIN_NO_SRP_AUTH</code>: <code>PASSWORD</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). </p> </li> <li> <p> <code>NEW_PASSWORD_REQUIRED</code>: <code>NEW_PASSWORD</code>, any other required attributes, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). </p> </li> </ul> <p>The value of the <code>USERNAME</code> attribute must be the user's actual username, not an alias (such as email address or phone number). To make this easier, the <code>AdminInitiateAuth</code> response includes the actual username value in the <code>USERNAMEUSER_ID_FOR_SRP</code> attribute, even if you specified an alias in your call to <code>AdminInitiateAuth</code>.</p>"
|
||||
},
|
||||
"Session":{
|
||||
"shape":"SessionType",
|
||||
"documentation":"<p>The session.</p>"
|
||||
"documentation":"<p>The session which should be passed both ways in challenge-response calls to the service. If <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to respond to the authentication challenge, as an administrator.</p>"
|
||||
|
|
@ -1909,15 +2067,15 @@
|
|||
"members":{
|
||||
"ChallengeName":{
|
||||
"shape":"ChallengeNameType",
|
||||
"documentation":"<p>The name of the challenge.</p>"
|
||||
"documentation":"<p>The name of the challenge. For more information, see <a href=\"API_AdminInitiateAuth.html\">AdminInitiateAuth</a>.</p>"
|
||||
},
|
||||
"Session":{
|
||||
"shape":"SessionType",
|
||||
"documentation":"<p>The session.</p>"
|
||||
"documentation":"<p>The session which should be passed both ways in challenge-response calls to the service. If the <a href=\"API_InitiateAuth.html\">InitiateAuth</a> or <a href=\"API_RespondToAuthChallenge.html\">RespondToAuthChallenge</a> API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>"
|
||||
},
|
||||
"ChallengeParameters":{
|
||||
"shape":"ChallengeParametersType",
|
||||
"documentation":"<p>The challenge parameters.</p>"
|
||||
"documentation":"<p>The challenge parameters. For more information, see <a href=\"API_AdminInitiateAuth.html\">AdminInitiateAuth</a>.</p>"
|
||||
},
|
||||
"AuthenticationResult":{
|
||||
"shape":"AuthenticationResultType",
|
||||
|
|
@ -1965,7 +2123,7 @@
|
|||
"members":{
|
||||
"UserPoolId":{
|
||||
"shape":"UserPoolIdType",
|
||||
"documentation":"<p>The user pool ID></p>"
|
||||
"documentation":"<p>The user pool ID.</p>"
|
||||
},
|
||||
"Username":{
|
||||
"shape":"UsernameType",
|
||||
|
|
@ -2006,7 +2164,7 @@
|
|||
},
|
||||
"UserAttributes":{
|
||||
"shape":"AttributeListType",
|
||||
"documentation":"<p>An array of name-value pairs representing user attributes.</p>"
|
||||
"documentation":"<p>An array of name-value pairs representing user attributes.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the request to update the user's attributes as an administrator.</p>"
|
||||
|
|
@ -2083,6 +2241,11 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"AttributeType"}
|
||||
},
|
||||
"AttributeMappingType":{
|
||||
"type":"map",
|
||||
"key":{"shape":"CustomAttributeNameType"},
|
||||
"value":{"shape":"StringType"}
|
||||
},
|
||||
"AttributeNameListType":{
|
||||
"type":"list",
|
||||
"member":{"shape":"AttributeNameType"}
|
||||
|
|
@ -2159,6 +2322,12 @@
|
|||
"documentation":"<p>The result type of the authentication result.</p>"
|
||||
},
|
||||
"BooleanType":{"type":"boolean"},
|
||||
"CallbackURLsListType":{
|
||||
"type":"list",
|
||||
"member":{"shape":"RedirectUrlType"},
|
||||
"max":100,
|
||||
"min":0
|
||||
},
|
||||
"ChallengeNameType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -2185,7 +2354,8 @@
|
|||
"type":"structure",
|
||||
"required":[
|
||||
"PreviousPassword",
|
||||
"ProposedPassword"
|
||||
"ProposedPassword",
|
||||
"AccessToken"
|
||||
],
|
||||
"members":{
|
||||
"PreviousPassword":{
|
||||
|
|
@ -2363,11 +2533,11 @@
|
|||
},
|
||||
"ConfirmationCode":{
|
||||
"shape":"ConfirmationCodeType",
|
||||
"documentation":"<p>The confirmation code sent by a user's request to retrieve a forgotten password.</p>"
|
||||
"documentation":"<p>The confirmation code sent by a user's request to retrieve a forgotten password. For more information, see <a href=\"API_ForgotPassword.html\">ForgotPassword</a> </p>"
|
||||
},
|
||||
"Password":{
|
||||
"shape":"PasswordType",
|
||||
"documentation":"<p>The password sent by sent by a user's request to retrieve a forgotten password.</p>"
|
||||
"documentation":"<p>The password sent by a user's request to retrieve a forgotten password.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request representing the confirmation for a password reset.</p>"
|
||||
|
|
@ -2404,7 +2574,7 @@
|
|||
},
|
||||
"ForceAliasCreation":{
|
||||
"shape":"ForceAliasCreation",
|
||||
"documentation":"<p>Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an <b>AliasExistsException</b> error.</p>"
|
||||
"documentation":"<p>Boolean to be specified to force user confirmation irrespective of existing alias. By default set to <code>False</code>. If this parameter is set to <code>True</code> and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to <code>False</code>, the API will throw an <b>AliasExistsException</b> error.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the request to confirm registration of a user.</p>"
|
||||
|
|
@ -2459,6 +2629,51 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"CreateIdentityProviderRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"UserPoolId",
|
||||
"ProviderName",
|
||||
"ProviderType",
|
||||
"ProviderDetails"
|
||||
],
|
||||
"members":{
|
||||
"UserPoolId":{
|
||||
"shape":"UserPoolIdType",
|
||||
"documentation":"<p>The user pool ID.</p>"
|
||||
},
|
||||
"ProviderName":{
|
||||
"shape":"ProviderNameType",
|
||||
"documentation":"<p>The identity provider name.</p>"
|
||||
},
|
||||
"ProviderType":{
|
||||
"shape":"IdentityProviderTypeType",
|
||||
"documentation":"<p>The identity provider type.</p>"
|
||||
},
|
||||
"ProviderDetails":{
|
||||
"shape":"ProviderDetailsType",
|
||||
"documentation":"<p>The identity provider details, such as <code>MetadataURL</code> and <code>MetadataFile</code>.</p>"
|
||||
},
|
||||
"AttributeMapping":{
|
||||
"shape":"AttributeMappingType",
|
||||
"documentation":"<p>A mapping of identity provider attributes to standard and custom user pool attributes.</p>"
|
||||
},
|
||||
"IdpIdentifiers":{
|
||||
"shape":"IdpIdentifiersListType",
|
||||
"documentation":"<p>A list of identity provider identifiers.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateIdentityProviderResponse":{
|
||||
"type":"structure",
|
||||
"required":["IdentityProvider"],
|
||||
"members":{
|
||||
"IdentityProvider":{
|
||||
"shape":"IdentityProviderType",
|
||||
"documentation":"<p>The newly created identity provider object.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateUserImportJobRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -2513,7 +2728,7 @@
|
|||
},
|
||||
"RefreshTokenValidity":{
|
||||
"shape":"RefreshTokenValidityType",
|
||||
"documentation":"<p>The validity of the refresh token, in days.</p>"
|
||||
"documentation":"<p>The time limit, in days, after which the refresh token is no longer valid and cannot be used.</p>"
|
||||
},
|
||||
"ReadAttributes":{
|
||||
"shape":"ClientPermissionListType",
|
||||
|
|
@ -2526,6 +2741,34 @@
|
|||
"ExplicitAuthFlows":{
|
||||
"shape":"ExplicitAuthFlowsListType",
|
||||
"documentation":"<p>The explicit authentication flows.</p>"
|
||||
},
|
||||
"SupportedIdentityProviders":{
|
||||
"shape":"SupportedIdentityProvidersListType",
|
||||
"documentation":"<p>A list of provider names for the identity providers that are supported on this client.</p>"
|
||||
},
|
||||
"CallbackURLs":{
|
||||
"shape":"CallbackURLsListType",
|
||||
"documentation":"<p>A list of allowed callback URLs for the identity providers.</p>"
|
||||
},
|
||||
"LogoutURLs":{
|
||||
"shape":"LogoutURLsListType",
|
||||
"documentation":"<p>A list of allowed logout URLs for the identity providers.</p>"
|
||||
},
|
||||
"DefaultRedirectURI":{
|
||||
"shape":"RedirectUrlType",
|
||||
"documentation":"<p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>"
|
||||
},
|
||||
"AllowedOAuthFlows":{
|
||||
"shape":"OAuthFlowsType",
|
||||
"documentation":"<p>Set to <code>code</code> to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.</p> <p>Set to <code>token</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.</p>"
|
||||
},
|
||||
"AllowedOAuthScopes":{
|
||||
"shape":"ScopeListType",
|
||||
"documentation":"<p>A list of allowed <code>OAuth</code> scopes. Currently supported values are <code>\"phone\"</code>, <code>\"email\"</code>, <code>\"openid\"</code>, and <code>\"Cognito\"</code>.</p>"
|
||||
},
|
||||
"AllowedOAuthFlowsUserPoolClient":{
|
||||
"shape":"BooleanType",
|
||||
"documentation":"<p>Set to <code>True</code> if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the request to create a user pool client.</p>"
|
||||
|
|
@ -2540,6 +2783,28 @@
|
|||
},
|
||||
"documentation":"<p>Represents the response from the server to create a user pool client.</p>"
|
||||
},
|
||||
"CreateUserPoolDomainRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Domain",
|
||||
"UserPoolId"
|
||||
],
|
||||
"members":{
|
||||
"Domain":{
|
||||
"shape":"DomainType",
|
||||
"documentation":"<p>The domain string.</p>"
|
||||
},
|
||||
"UserPoolId":{
|
||||
"shape":"UserPoolIdType",
|
||||
"documentation":"<p>The user pool ID.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateUserPoolDomainResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"CreateUserPoolRequest":{
|
||||
"type":"structure",
|
||||
"required":["PoolName"],
|
||||
|
|
@ -2602,7 +2867,7 @@
|
|||
},
|
||||
"AdminCreateUserConfig":{
|
||||
"shape":"AdminCreateUserConfigType",
|
||||
"documentation":"<p>The configuration for AdminCreateUser requests.</p>"
|
||||
"documentation":"<p>The configuration for <code>AdminCreateUser</code> requests.</p>"
|
||||
},
|
||||
"Schema":{
|
||||
"shape":"SchemaAttributesListType",
|
||||
|
|
@ -2651,13 +2916,33 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"DeleteIdentityProviderRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"UserPoolId",
|
||||
"ProviderName"
|
||||
],
|
||||
"members":{
|
||||
"UserPoolId":{
|
||||
"shape":"UserPoolIdType",
|
||||
"documentation":"<p>The user pool ID.</p>"
|
||||
},
|
||||
"ProviderName":{
|
||||
"shape":"ProviderNameType",
|
||||
"documentation":"<p>The identity provider name.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteUserAttributesRequest":{
|
||||
"type":"structure",
|
||||
"required":["UserAttributeNames"],
|
||||
"required":[
|
||||
"UserAttributeNames",
|
||||
"AccessToken"
|
||||
],
|
||||
"members":{
|
||||
"UserAttributeNames":{
|
||||
"shape":"AttributeNameListType",
|
||||
"documentation":"<p>An array of strings representing the user attribute names you wish to delete.</p>"
|
||||
"documentation":"<p>An array of strings representing the user attribute names you wish to delete.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>"
|
||||
},
|
||||
"AccessToken":{
|
||||
"shape":"TokenModelType",
|
||||
|
|
@ -2690,6 +2975,28 @@
|
|||
},
|
||||
"documentation":"<p>Represents the request to delete a user pool client.</p>"
|
||||
},
|
||||
"DeleteUserPoolDomainRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Domain",
|
||||
"UserPoolId"
|
||||
],
|
||||
"members":{
|
||||
"Domain":{
|
||||
"shape":"DomainType",
|
||||
"documentation":"<p>The domain string.</p>"
|
||||
},
|
||||
"UserPoolId":{
|
||||
"shape":"UserPoolIdType",
|
||||
"documentation":"<p>The user pool ID.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteUserPoolDomainResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteUserPoolRequest":{
|
||||
"type":"structure",
|
||||
"required":["UserPoolId"],
|
||||
|
|
@ -2703,6 +3010,7 @@
|
|||
},
|
||||
"DeleteUserRequest":{
|
||||
"type":"structure",
|
||||
"required":["AccessToken"],
|
||||
"members":{
|
||||
"AccessToken":{
|
||||
"shape":"TokenModelType",
|
||||
|
|
@ -2722,6 +3030,33 @@
|
|||
"EMAIL"
|
||||
]
|
||||
},
|
||||
"DescribeIdentityProviderRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"UserPoolId",
|
||||
"ProviderName"
|
||||
],
|
||||
"members":{
|
||||
"UserPoolId":{
|
||||
"shape":"UserPoolIdType",
|
||||
"documentation":"<p>The user pool ID.</p>"
|
||||
},
|
||||
"ProviderName":{
|
||||
"shape":"ProviderNameType",
|
||||
"documentation":"<p>The identity provider name.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeIdentityProviderResponse":{
|
||||
"type":"structure",
|
||||
"required":["IdentityProvider"],
|
||||
"members":{
|
||||
"IdentityProvider":{
|
||||
"shape":"IdentityProviderType",
|
||||
"documentation":"<p>The identity provider that was deleted.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeUserImportJobRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -2778,6 +3113,25 @@
|
|||
},
|
||||
"documentation":"<p>Represents the response from the server from a request to describe the user pool client.</p>"
|
||||
},
|
||||
"DescribeUserPoolDomainRequest":{
|
||||
"type":"structure",
|
||||
"required":["Domain"],
|
||||
"members":{
|
||||
"Domain":{
|
||||
"shape":"DomainType",
|
||||
"documentation":"<p>The domain string.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeUserPoolDomainResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DomainDescription":{
|
||||
"shape":"DomainDescriptionType",
|
||||
"documentation":"<p>A domain description object containing information about the domain.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeUserPoolRequest":{
|
||||
"type":"structure",
|
||||
"required":["UserPoolId"],
|
||||
|
|
@ -2879,6 +3233,67 @@
|
|||
},
|
||||
"documentation":"<p>The device type.</p>"
|
||||
},
|
||||
"DomainDescriptionType":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"UserPoolId":{
|
||||
"shape":"UserPoolIdType",
|
||||
"documentation":"<p>The user pool ID.</p>"
|
||||
},
|
||||
"AWSAccountId":{
|
||||
"shape":"AWSAccountIdType",
|
||||
"documentation":"<p>The AWS account ID for the user pool owner.</p>"
|
||||
},
|
||||
"Domain":{
|
||||
"shape":"DomainType",
|
||||
"documentation":"<p>The domain string.</p>"
|
||||
},
|
||||
"S3Bucket":{
|
||||
"shape":"S3BucketType",
|
||||
"documentation":"<p>The S3 bucket where the static files for this domain are stored.</p>"
|
||||
},
|
||||
"CloudFrontDistribution":{
|
||||
"shape":"ArnType",
|
||||
"documentation":"<p>The ARN of the CloudFront distribution.</p>"
|
||||
},
|
||||
"Version":{
|
||||
"shape":"DomainVersionType",
|
||||
"documentation":"<p>The app version.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"DomainStatusType",
|
||||
"documentation":"<p>The domain status.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A container for information about a domain.</p>"
|
||||
},
|
||||
"DomainStatusType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"CREATING",
|
||||
"DELETING",
|
||||
"UPDATING",
|
||||
"ACTIVE"
|
||||
]
|
||||
},
|
||||
"DomainType":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
"min":1
|
||||
},
|
||||
"DomainVersionType":{
|
||||
"type":"string",
|
||||
"max":20,
|
||||
"min":1
|
||||
},
|
||||
"DuplicateProviderException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"MessageType"}
|
||||
},
|
||||
"documentation":"<p>This exception is thrown when the provider is already supported by the user pool.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"EmailAddressType":{
|
||||
"type":"string",
|
||||
"pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+@[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+"
|
||||
|
|
@ -2899,7 +3314,7 @@
|
|||
},
|
||||
"EmailVerificationMessageType":{
|
||||
"type":"string",
|
||||
"max":2048,
|
||||
"max":20000,
|
||||
"min":6,
|
||||
"pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*\\{####\\}[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}\\s*]*"
|
||||
},
|
||||
|
|
@ -3057,9 +3472,39 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"GetIdentityProviderByIdentifierRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"UserPoolId",
|
||||
"IdpIdentifier"
|
||||
],
|
||||
"members":{
|
||||
"UserPoolId":{
|
||||
"shape":"UserPoolIdType",
|
||||
"documentation":"<p>The user pool ID.</p>"
|
||||
},
|
||||
"IdpIdentifier":{
|
||||
"shape":"IdpIdentifierType",
|
||||
"documentation":"<p>The identity provider ID.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetIdentityProviderByIdentifierResponse":{
|
||||
"type":"structure",
|
||||
"required":["IdentityProvider"],
|
||||
"members":{
|
||||
"IdentityProvider":{
|
||||
"shape":"IdentityProviderType",
|
||||
"documentation":"<p>The identity provider object.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetUserAttributeVerificationCodeRequest":{
|
||||
"type":"structure",
|
||||
"required":["AttributeName"],
|
||||
"required":[
|
||||
"AccessToken",
|
||||
"AttributeName"
|
||||
],
|
||||
"members":{
|
||||
"AccessToken":{
|
||||
"shape":"TokenModelType",
|
||||
|
|
@ -3084,6 +3529,7 @@
|
|||
},
|
||||
"GetUserRequest":{
|
||||
"type":"structure",
|
||||
"required":["AccessToken"],
|
||||
"members":{
|
||||
"AccessToken":{
|
||||
"shape":"TokenModelType",
|
||||
|
|
@ -3105,7 +3551,7 @@
|
|||
},
|
||||
"UserAttributes":{
|
||||
"shape":"AttributeListType",
|
||||
"documentation":"<p>An array of name-value pairs representing user attributes.</p>"
|
||||
"documentation":"<p>An array of name-value pairs representing user attributes.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>"
|
||||
},
|
||||
"MFAOptions":{
|
||||
"shape":"MFAOptionListType",
|
||||
|
|
@ -3116,6 +3562,7 @@
|
|||
},
|
||||
"GlobalSignOutRequest":{
|
||||
"type":"structure",
|
||||
"required":["AccessToken"],
|
||||
"members":{
|
||||
"AccessToken":{
|
||||
"shape":"TokenModelType",
|
||||
|
|
@ -3182,6 +3629,60 @@
|
|||
},
|
||||
"documentation":"<p>The group type.</p>"
|
||||
},
|
||||
"IdentityProviderType":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"UserPoolId":{
|
||||
"shape":"UserPoolIdType",
|
||||
"documentation":"<p>The user pool ID.</p>"
|
||||
},
|
||||
"ProviderName":{
|
||||
"shape":"ProviderNameType",
|
||||
"documentation":"<p>The identity provider name.</p>"
|
||||
},
|
||||
"ProviderType":{
|
||||
"shape":"IdentityProviderTypeType",
|
||||
"documentation":"<p>The identity provider type.</p>"
|
||||
},
|
||||
"ProviderDetails":{
|
||||
"shape":"ProviderDetailsType",
|
||||
"documentation":"<p>The identity provider details, such as <code>MetadataURL</code> and <code>MetadataFile</code>.</p>"
|
||||
},
|
||||
"AttributeMapping":{
|
||||
"shape":"AttributeMappingType",
|
||||
"documentation":"<p>A mapping of identity provider attributes to standard and custom user pool attributes.</p>"
|
||||
},
|
||||
"IdpIdentifiers":{
|
||||
"shape":"IdpIdentifiersListType",
|
||||
"documentation":"<p>A list of identity provider identifiers.</p>"
|
||||
},
|
||||
"LastModifiedDate":{
|
||||
"shape":"DateType",
|
||||
"documentation":"<p>The date the identity provider was last modified.</p>"
|
||||
},
|
||||
"CreationDate":{
|
||||
"shape":"DateType",
|
||||
"documentation":"<p>The date the identity provider was created.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A container for information about an identity provider.</p>"
|
||||
},
|
||||
"IdentityProviderTypeType":{
|
||||
"type":"string",
|
||||
"enum":["SAML"]
|
||||
},
|
||||
"IdpIdentifierType":{
|
||||
"type":"string",
|
||||
"max":40,
|
||||
"min":1,
|
||||
"pattern":"[\\w\\s+=.@-]+"
|
||||
},
|
||||
"IdpIdentifiersListType":{
|
||||
"type":"list",
|
||||
"member":{"shape":"IdpIdentifierType"},
|
||||
"max":50,
|
||||
"min":0
|
||||
},
|
||||
"InitiateAuthRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -3191,19 +3692,19 @@
|
|||
"members":{
|
||||
"AuthFlow":{
|
||||
"shape":"AuthFlowType",
|
||||
"documentation":"<p>The authentication flow.</p>"
|
||||
"documentation":"<p>The authentication flow for this call to execute. The API action will depend on this value. For example: </p> <ul> <li> <p> <code>REFRESH_TOKEN_AUTH</code> will take in a valid refresh token and return new tokens.</p> </li> <li> <p> <code>USER_SRP_AUTH</code> will take in USERNAME and SRPA and return the SRP variables to be used for next challenge execution.</p> </li> </ul> <p>Valid values include:</p> <ul> <li> <p> <code>USER_SRP_AUTH</code>: Authentication flow for the Secure Remote Password (SRP) protocol.</p> </li> <li> <p> <code>REFRESH_TOKEN_AUTH</code>/<code>REFRESH_TOKEN</code>: Authentication flow for refreshing the access token and ID token by supplying a valid refresh token.</p> </li> <li> <p> <code>CUSTOM_AUTH</code>: Custom authentication flow.</p> </li> </ul> <p> <code>ADMIN_NO_SRP_AUTH</code> is not a valid value.</p>"
|
||||
},
|
||||
"AuthParameters":{
|
||||
"shape":"AuthParametersType",
|
||||
"documentation":"<p>The authentication parameters.</p>"
|
||||
"documentation":"<p>The authentication parameters. These are inputs corresponding to the <code>AuthFlow</code> that you are invoking. The required values depend on the value of <code>AuthFlow</code>:</p> <ul> <li> <p>For <code>USER_SRP_AUTH</code>: <code>USERNAME</code> (required), <code>SRPA</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>DEVICE_KEY</code> </p> </li> <li> <p>For <code>REFRESH_TOKEN_AUTH/REFRESH_TOKEN</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (required if the app client is configured with a client secret), <code>REFRESH_TOKEN</code> (required), <code>DEVICE_KEY</code> </p> </li> <li> <p>For <code>CUSTOM_AUTH</code>: <code>USERNAME</code> (required), <code>SECRET_HASH</code> (if app client is configured with client secret), <code>DEVICE_KEY</code> </p> </li> </ul>"
|
||||
},
|
||||
"ClientMetadata":{
|
||||
"shape":"ClientMetadataType",
|
||||
"documentation":"<p>The client app's metadata.</p>"
|
||||
"documentation":"<p>This is a random key-value pair map which can contain any key and will be passed to your PreAuthentication Lambda trigger as-is. It can be used to implement additional validations around authentication.</p>"
|
||||
},
|
||||
"ClientId":{
|
||||
"shape":"ClientIdType",
|
||||
"documentation":"<p>The client ID.</p>"
|
||||
"documentation":"<p>The app client ID.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Initiates the authentication request.</p>"
|
||||
|
|
@ -3213,19 +3714,19 @@
|
|||
"members":{
|
||||
"ChallengeName":{
|
||||
"shape":"ChallengeNameType",
|
||||
"documentation":"<p>The name of the challenge.</p>"
|
||||
"documentation":"<p>The name of the challenge which you are responding to with this call. This is returned to you in the <code>AdminInitiateAuth</code> response if you need to pass another challenge.</p> <p>Valid values include the following. Note that all of these challenges require <code>USERNAME</code> and <code>SECRET_HASH</code> (if applicable) in the parameters.</p> <ul> <li> <p> <code>SMS_MFA</code>: Next challenge is to supply an <code>SMS_MFA_CODE</code>, delivered via SMS.</p> </li> <li> <p> <code>PASSWORD_VERIFIER</code>: Next challenge is to supply <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, and <code>TIMESTAMP</code> after the client-side SRP calculations.</p> </li> <li> <p> <code>CUSTOM_CHALLENGE</code>: This is returned if your custom authentication flow determines that the user should pass another challenge before tokens are issued.</p> </li> <li> <p> <code>DEVICE_SRP_AUTH</code>: If device tracking was enabled on your user pool and the previous challenges were passed, this challenge is returned so that Amazon Cognito can start tracking this device.</p> </li> <li> <p> <code>DEVICE_PASSWORD_VERIFIER</code>: Similar to <code>PASSWORD_VERIFIER</code>, but for devices only.</p> </li> <li> <p> <code>NEW_PASSWORD_REQUIRED</code>: For users which are required to change their passwords after successful first login. This challenge should be passed with <code>NEW_PASSWORD</code> and any other required attributes.</p> </li> </ul>"
|
||||
},
|
||||
"Session":{
|
||||
"shape":"SessionType",
|
||||
"documentation":"<p>The session.</p>"
|
||||
"documentation":"<p>The session which should be passed both ways in challenge-response calls to the service. If the <a href=\"API_InitiateAuth.html\">InitiateAuth</a> or <a href=\"API_RespondToAuthChallenge.html\">RespondToAuthChallenge</a> API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>"
|
||||
},
|
||||
"ChallengeParameters":{
|
||||
"shape":"ChallengeParametersType",
|
||||
"documentation":"<p>The challenge parameters.</p>"
|
||||
"documentation":"<p>The challenge parameters. These are returned to you in the <code>InitiateAuth</code> response if you need to pass another challenge. The responses in this parameter should be used to compute inputs to the next call (<code>RespondToAuthChallenge</code>). </p> <p>All challenges require <code>USERNAME</code> and <code>SECRET_HASH</code> (if applicable).</p>"
|
||||
},
|
||||
"AuthenticationResult":{
|
||||
"shape":"AuthenticationResultType",
|
||||
"documentation":"<p>The result returned by the server in response to the request to initiate authentication.</p>"
|
||||
"documentation":"<p>The result of the authentication response. This is only returned if the caller does not need to pass another challenge. If the caller does need to pass another challenge before it gets tokens, <code>ChallengeName</code>, <code>ChallengeParameters</code>, and <code>Session</code> are returned.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Initiates the authentication response.</p>"
|
||||
|
|
@ -3265,6 +3766,14 @@
|
|||
"documentation":"<p>This exception is thrown when the Amazon Cognito service encounters an invalid AWS Lambda response.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidOAuthFlowException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"MessageType"}
|
||||
},
|
||||
"documentation":"<p>This exception is thrown when the specified OAuth flow is invalid.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidParameterException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -3433,10 +3942,47 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"ListIdentityProvidersRequest":{
|
||||
"type":"structure",
|
||||
"required":["UserPoolId"],
|
||||
"members":{
|
||||
"UserPoolId":{
|
||||
"shape":"UserPoolIdType",
|
||||
"documentation":"<p>The user pool ID.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"ListProvidersLimitType",
|
||||
"documentation":"<p>The maximum number of identity providers to return.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"PaginationKeyType",
|
||||
"documentation":"<p>A pagination token.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListIdentityProvidersResponse":{
|
||||
"type":"structure",
|
||||
"required":["Providers"],
|
||||
"members":{
|
||||
"Providers":{
|
||||
"shape":"ProvidersListType",
|
||||
"documentation":"<p>A list of identity provider objects.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"PaginationKeyType",
|
||||
"documentation":"<p>A pagination token.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListOfStringTypes":{
|
||||
"type":"list",
|
||||
"member":{"shape":"StringType"}
|
||||
},
|
||||
"ListProvidersLimitType":{
|
||||
"type":"integer",
|
||||
"max":60,
|
||||
"min":1
|
||||
},
|
||||
"ListUserImportJobsRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -3454,7 +4000,7 @@
|
|||
},
|
||||
"PaginationToken":{
|
||||
"shape":"PaginationKeyType",
|
||||
"documentation":"<p>An identifier that was returned from the previous call to ListUserImportJobs, which can be used to return the next set of import jobs in the list.</p>"
|
||||
"documentation":"<p>An identifier that was returned from the previous call to <code>ListUserImportJobs</code>, which can be used to return the next set of import jobs in the list.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the request to list the user import jobs.</p>"
|
||||
|
|
@ -3579,15 +4125,15 @@
|
|||
"members":{
|
||||
"UserPoolId":{
|
||||
"shape":"UserPoolIdType",
|
||||
"documentation":"<p>The user pool ID for which you want to list users.</p>"
|
||||
"documentation":"<p>The user pool ID for the user pool on which the search should be performed.</p>"
|
||||
},
|
||||
"AttributesToGet":{
|
||||
"shape":"SearchedAttributeNamesListType",
|
||||
"documentation":"<p>The attributes to get from the request to list users.</p>"
|
||||
"documentation":"<p>An array of strings, where each string is the name of a user attribute to be returned for each user in the search results. If the array is empty, all attributes are returned.</p>"
|
||||
},
|
||||
"Limit":{
|
||||
"shape":"QueryLimitType",
|
||||
"documentation":"<p>The limit of the request to list users.</p>"
|
||||
"documentation":"<p>Maximum number of users to be returned.</p>"
|
||||
},
|
||||
"PaginationToken":{
|
||||
"shape":"SearchPaginationTokenType",
|
||||
|
|
@ -3595,7 +4141,7 @@
|
|||
},
|
||||
"Filter":{
|
||||
"shape":"UserFilterType",
|
||||
"documentation":"<p>The filter for the list users request.</p>"
|
||||
"documentation":"<p>A filter string of the form \"<i>AttributeName</i> <i>Filter-Type</i> \"<i>AttributeValue</i>\"\". Quotation marks within the filter string must be escaped using the backslash (\\) character. For example, \"<code>family_name</code> = \\\"Reddy\\\"\".</p> <ul> <li> <p> <i>AttributeName</i>: The name of the attribute to search for. You can only search for one attribute at a time.</p> </li> <li> <p> <i>Filter-Type</i>: For an exact match, use =, for example, \"<code>given_name</code> = \\\"Jon\\\"\". For a prefix (\"starts with\") match, use ^=, for example, \"<code>given_name</code> ^= \\\"Jon\\\"\". </p> </li> <li> <p> <i>AttributeValue</i>: The attribute value that must be matched for each user.</p> </li> </ul> <p>If the filter string is empty, <code>ListUsers</code> returns all users in the user pool.</p> <p>You can only search for the following standard attributes:</p> <ul> <li> <p> <code>username</code> (case-sensitive)</p> </li> <li> <p> <code>email</code> </p> </li> <li> <p> <code>phone_number</code> </p> </li> <li> <p> <code>name</code> </p> </li> <li> <p> <code>given_name</code> </p> </li> <li> <p> <code>family_name</code> </p> </li> <li> <p> <code>preferred_username</code> </p> </li> <li> <p> <code>cognito:user_status</code> (called <b>Enabled</b> in the Console) (case-sensitive)</p> </li> <li> <p> <code>status</code> (case-insensitive)</p> </li> </ul> <p>Custom attributes are not searchable.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-using-listusers-api\">Searching for Users Using the ListUsers API</a> and <a href=\"http://docs.aws.amazon.com/cognito/latest/developerguide/how-to-manage-user-accounts.html#cognito-user-pools-searching-for-users-listusers-api-examples\">Examples of Using the ListUsers API</a> in the <i>Amazon Cognito Developer Guide</i>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the request to list users.</p>"
|
||||
|
|
@ -3614,6 +4160,12 @@
|
|||
},
|
||||
"documentation":"<p>The response from the request to list users.</p>"
|
||||
},
|
||||
"LogoutURLsListType":{
|
||||
"type":"list",
|
||||
"member":{"shape":"RedirectUrlType"},
|
||||
"max":100,
|
||||
"min":0
|
||||
},
|
||||
"LongType":{"type":"long"},
|
||||
"MFAMethodNotFoundException":{
|
||||
"type":"structure",
|
||||
|
|
@ -3692,7 +4244,7 @@
|
|||
"documentation":"<p>The message returned when the Amazon Cognito service returns a not authorized exception.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>This exception gets thrown when a user is not authorized.</p>",
|
||||
"documentation":"<p>This exception is thrown when a user is not authorized.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"NumberAttributeConstraintsType":{
|
||||
|
|
@ -3709,6 +4261,20 @@
|
|||
},
|
||||
"documentation":"<p>The minimum and maximum value of an attribute that is of the number data type.</p>"
|
||||
},
|
||||
"OAuthFlowType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"code",
|
||||
"implicit",
|
||||
"client_credentials"
|
||||
]
|
||||
},
|
||||
"OAuthFlowsType":{
|
||||
"type":"list",
|
||||
"member":{"shape":"OAuthFlowType"},
|
||||
"max":3,
|
||||
"min":0
|
||||
},
|
||||
"PaginationKey":{
|
||||
"type":"string",
|
||||
"min":1,
|
||||
|
|
@ -3793,6 +4359,45 @@
|
|||
"documentation":"<p>This exception is thrown when a precondition is not met.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ProviderDescription":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ProviderName":{
|
||||
"shape":"ProviderNameType",
|
||||
"documentation":"<p>The identity provider name.</p>"
|
||||
},
|
||||
"ProviderType":{
|
||||
"shape":"IdentityProviderTypeType",
|
||||
"documentation":"<p>The identity provider type.</p>"
|
||||
},
|
||||
"LastModifiedDate":{
|
||||
"shape":"DateType",
|
||||
"documentation":"<p>The date the provider was last modified.</p>"
|
||||
},
|
||||
"CreationDate":{
|
||||
"shape":"DateType",
|
||||
"documentation":"<p>The date the provider was added to the user pool.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A container for identity provider details.</p>"
|
||||
},
|
||||
"ProviderDetailsType":{
|
||||
"type":"map",
|
||||
"key":{"shape":"StringType"},
|
||||
"value":{"shape":"StringType"}
|
||||
},
|
||||
"ProviderNameType":{
|
||||
"type":"string",
|
||||
"max":32,
|
||||
"min":1,
|
||||
"pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+"
|
||||
},
|
||||
"ProvidersListType":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ProviderDescription"},
|
||||
"max":50,
|
||||
"min":0
|
||||
},
|
||||
"QueryLimit":{
|
||||
"type":"integer",
|
||||
"max":60,
|
||||
|
|
@ -3803,6 +4408,12 @@
|
|||
"max":60,
|
||||
"min":0
|
||||
},
|
||||
"RedirectUrlType":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
"min":1,
|
||||
"pattern":"[\\p{L}\\p{M}\\p{S}\\p{N}\\p{P}]+"
|
||||
},
|
||||
"RefreshTokenValidityType":{
|
||||
"type":"integer",
|
||||
"max":3650,
|
||||
|
|
@ -3860,19 +4471,19 @@
|
|||
"members":{
|
||||
"ClientId":{
|
||||
"shape":"ClientIdType",
|
||||
"documentation":"<p>The client ID.</p>"
|
||||
"documentation":"<p>The app client ID.</p>"
|
||||
},
|
||||
"ChallengeName":{
|
||||
"shape":"ChallengeNameType",
|
||||
"documentation":"<p>The name of the challenge.</p>"
|
||||
"documentation":"<p>The challenge name. For more information, see <a href=\"API_InitiateAuth.html\">InitiateAuth</a>.</p> <p> <code>ADMIN_NO_SRP_AUTH</code> is not a valid value.</p>"
|
||||
},
|
||||
"Session":{
|
||||
"shape":"SessionType",
|
||||
"documentation":"<p>The session.</p>"
|
||||
"documentation":"<p>The session which should be passed both ways in challenge-response calls to the service. If <code>InitiateAuth</code> or <code>RespondToAuthChallenge</code> API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>"
|
||||
},
|
||||
"ChallengeResponses":{
|
||||
"shape":"ChallengeResponsesType",
|
||||
"documentation":"<p>The responses to the authentication challenge.</p>"
|
||||
"documentation":"<p>The challenge responses. These are inputs corresponding to the value of <code>ChallengeName</code>, for example:</p> <ul> <li> <p> <code>SMS_MFA</code>: <code>SMS_MFA_CODE</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p> </li> <li> <p> <code>PASSWORD_VERIFIER</code>: <code>PASSWORD_CLAIM_SIGNATURE</code>, <code>PASSWORD_CLAIM_SECRET_BLOCK</code>, <code>TIMESTAMP</code>, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret).</p> </li> <li> <p> <code>NEW_PASSWORD_REQUIRED</code>: <code>NEW_PASSWORD</code>, any other required attributes, <code>USERNAME</code>, <code>SECRET_HASH</code> (if app client is configured with client secret). </p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The request to respond to an authentication challenge.</p>"
|
||||
|
|
@ -3882,15 +4493,15 @@
|
|||
"members":{
|
||||
"ChallengeName":{
|
||||
"shape":"ChallengeNameType",
|
||||
"documentation":"<p>The challenge name.</p>"
|
||||
"documentation":"<p>The challenge name. For more information, see <a href=\"API_InitiateAuth.html\">InitiateAuth</a>.</p>"
|
||||
},
|
||||
"Session":{
|
||||
"shape":"SessionType",
|
||||
"documentation":"<p>The session.</p>"
|
||||
"documentation":"<p>The session which should be passed both ways in challenge-response calls to the service. If the <a href=\"API_InitiateAuth.html\">InitiateAuth</a> or <a href=\"API_RespondToAuthChallenge.html\">RespondToAuthChallenge</a> API call determines that the caller needs to go through another challenge, they return a session with other challenge parameters. This session should be passed as it is to the next <code>RespondToAuthChallenge</code> API call.</p>"
|
||||
},
|
||||
"ChallengeParameters":{
|
||||
"shape":"ChallengeParametersType",
|
||||
"documentation":"<p>The challenge parameters.</p>"
|
||||
"documentation":"<p>The challenge parameters. For more information, see <a href=\"API_InitiateAuth.html\">InitiateAuth</a>.</p>"
|
||||
},
|
||||
"AuthenticationResult":{
|
||||
"shape":"AuthenticationResultType",
|
||||
|
|
@ -3899,6 +4510,12 @@
|
|||
},
|
||||
"documentation":"<p>The response to respond to the authentication challenge.</p>"
|
||||
},
|
||||
"S3BucketType":{
|
||||
"type":"string",
|
||||
"max":1024,
|
||||
"min":3,
|
||||
"pattern":"^[0-9A-Za-z\\.\\-_]*(?<!\\.)$"
|
||||
},
|
||||
"SchemaAttributeType":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -3942,6 +4559,24 @@
|
|||
"max":50,
|
||||
"min":1
|
||||
},
|
||||
"ScopeDoesNotExistException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"MessageType"}
|
||||
},
|
||||
"documentation":"<p>This exception is thrown when the specified scope does not exist.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ScopeListType":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ScopeType"}
|
||||
},
|
||||
"ScopeType":{
|
||||
"type":"string",
|
||||
"max":256,
|
||||
"min":1,
|
||||
"pattern":"[\\x21\\x23-\\x5B\\x5D-\\x7E]+"
|
||||
},
|
||||
"SearchPaginationTokenType":{
|
||||
"type":"string",
|
||||
"min":1,
|
||||
|
|
@ -4013,7 +4648,7 @@
|
|||
},
|
||||
"UserAttributes":{
|
||||
"shape":"AttributeListType",
|
||||
"documentation":"<p>An array of name-value pairs representing user attributes.</p>"
|
||||
"documentation":"<p>An array of name-value pairs representing user attributes.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>"
|
||||
},
|
||||
"ValidationData":{
|
||||
"shape":"AttributeListType",
|
||||
|
|
@ -4024,6 +4659,10 @@
|
|||
},
|
||||
"SignUpResponse":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"UserConfirmed",
|
||||
"UserSub"
|
||||
],
|
||||
"members":{
|
||||
"UserConfirmed":{
|
||||
"shape":"BooleanType",
|
||||
|
|
@ -4032,6 +4671,10 @@
|
|||
"CodeDeliveryDetails":{
|
||||
"shape":"CodeDeliveryDetailsType",
|
||||
"documentation":"<p>The code delivery details returned by the server response to the user registration request.</p>"
|
||||
},
|
||||
"UserSub":{
|
||||
"shape":"StringType",
|
||||
"documentation":"<p>The UUID of the authenticated user. This is not the same as <code>username</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The response from the server for a registration request.</p>"
|
||||
|
|
@ -4049,7 +4692,7 @@
|
|||
"documentation":"<p>The external ID.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The SMS configuratoin type.</p>"
|
||||
"documentation":"<p>The SMS configuration type.</p>"
|
||||
},
|
||||
"SmsVerificationMessageType":{
|
||||
"type":"string",
|
||||
|
|
@ -4135,6 +4778,10 @@
|
|||
"documentation":"<p>The type of constraints associated with an attribute of the string type.</p>"
|
||||
},
|
||||
"StringType":{"type":"string"},
|
||||
"SupportedIdentityProvidersListType":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ProviderNameType"}
|
||||
},
|
||||
"TokenModelType":{
|
||||
"type":"string",
|
||||
"pattern":"[A-Za-z0-9-_=.]+",
|
||||
|
|
@ -4148,7 +4795,7 @@
|
|||
"documentation":"<p>The message returned when the Amazon Cognito service returns a too many failed attempts exception.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>This exception gets thrown when the user has made too many failed attempts for a given action (e.g., sign in).</p>",
|
||||
"documentation":"<p>This exception is thrown when the user has made too many failed attempts for a given action (e.g., sign in).</p>",
|
||||
"exception":true
|
||||
},
|
||||
"TooManyRequestsException":{
|
||||
|
|
@ -4159,7 +4806,7 @@
|
|||
"documentation":"<p>The message returned when the Amazon Cognito service returns a too many requests exception.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>This exception gets thrown when the user has made too many requests for a given operation.</p>",
|
||||
"documentation":"<p>This exception is thrown when the user has made too many requests for a given operation.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"UnexpectedLambdaException":{
|
||||
|
|
@ -4170,7 +4817,15 @@
|
|||
"documentation":"<p>The message returned when the Amazon Cognito service returns an unexpected AWS Lambda exception.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>This exception gets thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.</p>",
|
||||
"documentation":"<p>This exception is thrown when the Amazon Cognito service encounters an unexpected exception with the AWS Lambda service.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"UnsupportedIdentityProviderException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"MessageType"}
|
||||
},
|
||||
"documentation":"<p>This exception is thrown when the specified identifier is not supported.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"UnsupportedUserStateException":{
|
||||
|
|
@ -4237,7 +4892,7 @@
|
|||
},
|
||||
"Precedence":{
|
||||
"shape":"PrecedenceType",
|
||||
"documentation":"<p>The new precedence value for the group. For more information about this parameter, see <a href=\"API_CreateGroupRequeste.html\">CreateGroupRequest</a>.</p>"
|
||||
"documentation":"<p>The new precedence value for the group. For more information about this parameter, see <a href=\"API_CreateGroup.html\">CreateGroup</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -4250,13 +4905,55 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"UpdateIdentityProviderRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"UserPoolId",
|
||||
"ProviderName"
|
||||
],
|
||||
"members":{
|
||||
"UserPoolId":{
|
||||
"shape":"UserPoolIdType",
|
||||
"documentation":"<p>The user pool ID.</p>"
|
||||
},
|
||||
"ProviderName":{
|
||||
"shape":"ProviderNameType",
|
||||
"documentation":"<p>The identity provider name.</p>"
|
||||
},
|
||||
"ProviderDetails":{
|
||||
"shape":"ProviderDetailsType",
|
||||
"documentation":"<p>The identity provider details to be updated, such as <code>MetadataURL</code> and <code>MetadataFile</code>.</p>"
|
||||
},
|
||||
"AttributeMapping":{
|
||||
"shape":"AttributeMappingType",
|
||||
"documentation":"<p>The identity provider attribute mapping to be changed.</p>"
|
||||
},
|
||||
"IdpIdentifiers":{
|
||||
"shape":"IdpIdentifiersListType",
|
||||
"documentation":"<p>A list of identity provider identifiers.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateIdentityProviderResponse":{
|
||||
"type":"structure",
|
||||
"required":["IdentityProvider"],
|
||||
"members":{
|
||||
"IdentityProvider":{
|
||||
"shape":"IdentityProviderType",
|
||||
"documentation":"<p>The identity provider object.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateUserAttributesRequest":{
|
||||
"type":"structure",
|
||||
"required":["UserAttributes"],
|
||||
"required":[
|
||||
"UserAttributes",
|
||||
"AccessToken"
|
||||
],
|
||||
"members":{
|
||||
"UserAttributes":{
|
||||
"shape":"AttributeListType",
|
||||
"documentation":"<p>An array of name-value pairs representing user attributes.</p>"
|
||||
"documentation":"<p>An array of name-value pairs representing user attributes.</p> <p>For custom attributes, you must prepend the <code>custom:</code> prefix to the attribute name.</p>"
|
||||
},
|
||||
"AccessToken":{
|
||||
"shape":"TokenModelType",
|
||||
|
|
@ -4296,7 +4993,7 @@
|
|||
},
|
||||
"RefreshTokenValidity":{
|
||||
"shape":"RefreshTokenValidityType",
|
||||
"documentation":"<p>The validity of the refresh token, in days.</p>"
|
||||
"documentation":"<p>The time limit, in days, after which the refresh token is no longer valid and cannot be used.</p>"
|
||||
},
|
||||
"ReadAttributes":{
|
||||
"shape":"ClientPermissionListType",
|
||||
|
|
@ -4309,6 +5006,34 @@
|
|||
"ExplicitAuthFlows":{
|
||||
"shape":"ExplicitAuthFlowsListType",
|
||||
"documentation":"<p>Explicit authentication flows.</p>"
|
||||
},
|
||||
"SupportedIdentityProviders":{
|
||||
"shape":"SupportedIdentityProvidersListType",
|
||||
"documentation":"<p>A list of provider names for the identity providers that are supported on this client.</p>"
|
||||
},
|
||||
"CallbackURLs":{
|
||||
"shape":"CallbackURLsListType",
|
||||
"documentation":"<p>A list of allowed callback URLs for the identity providers.</p>"
|
||||
},
|
||||
"LogoutURLs":{
|
||||
"shape":"LogoutURLsListType",
|
||||
"documentation":"<p>A list ofallowed logout URLs for the identity providers.</p>"
|
||||
},
|
||||
"DefaultRedirectURI":{
|
||||
"shape":"RedirectUrlType",
|
||||
"documentation":"<p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>"
|
||||
},
|
||||
"AllowedOAuthFlows":{
|
||||
"shape":"OAuthFlowsType",
|
||||
"documentation":"<p>Set to <code>code</code> to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.</p> <p>Set to <code>token</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.</p>"
|
||||
},
|
||||
"AllowedOAuthScopes":{
|
||||
"shape":"ScopeListType",
|
||||
"documentation":"<p>A list of allowed <code>OAuth</code> scopes. Currently supported values are <code>\"phone\"</code>, <code>\"email\"</code>, <code>\"openid\"</code>, and <code>\"Cognito\"</code>.</p>"
|
||||
},
|
||||
"AllowedOAuthFlowsUserPoolClient":{
|
||||
"shape":"BooleanType",
|
||||
"documentation":"<p>Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the request to update the user pool client.</p>"
|
||||
|
|
@ -4353,7 +5078,7 @@
|
|||
},
|
||||
"EmailVerificationSubject":{
|
||||
"shape":"EmailVerificationSubjectType",
|
||||
"documentation":"<p>The subject of the email verfication message.</p>"
|
||||
"documentation":"<p>The subject of the email verification message.</p>"
|
||||
},
|
||||
"SmsAuthenticationMessage":{
|
||||
"shape":"SmsVerificationMessageType",
|
||||
|
|
@ -4381,7 +5106,7 @@
|
|||
},
|
||||
"AdminCreateUserConfig":{
|
||||
"shape":"AdminCreateUserConfigType",
|
||||
"documentation":"<p>The configuration for AdminCreateUser requests.</p>"
|
||||
"documentation":"<p>The configuration for <code>AdminCreateUser</code> requests.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the request to update the user pool.</p>"
|
||||
|
|
@ -4449,11 +5174,11 @@
|
|||
},
|
||||
"PreSignedUrl":{
|
||||
"shape":"PreSignedUrlType",
|
||||
"documentation":"<p>The pre-signed URL to be used to upload the .csv file.</p>"
|
||||
"documentation":"<p>The pre-signed URL to be used to upload the <code>.csv</code> file.</p>"
|
||||
},
|
||||
"CreationDate":{
|
||||
"shape":"DateType",
|
||||
"documentation":"<p>The date when the user import job was created.</p>"
|
||||
"documentation":"<p>The date the user import job was created.</p>"
|
||||
},
|
||||
"StartDate":{
|
||||
"shape":"DateType",
|
||||
|
|
@ -4461,11 +5186,11 @@
|
|||
},
|
||||
"CompletionDate":{
|
||||
"shape":"DateType",
|
||||
"documentation":"<p>The date when the user imoprt job was completed.</p>"
|
||||
"documentation":"<p>The date when the user import job was completed.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"UserImportJobStatusType",
|
||||
"documentation":"<p>The status of the user import job. One of the following:</p> <ul> <li> <p>Created - The job was created but not started.</p> </li> <li> <p>Pending - A transition state. You have started the job, but it has not begun importing users yet.</p> </li> <li> <p>InProgress - The job has started, and users are being imported.</p> </li> <li> <p>Stopping - You have stopped the job, but the job has not stopped importing users yet.</p> </li> <li> <p>Stopped - You have stopped the job, and the job has stopped importing users.</p> </li> <li> <p>Succeeded - The job has completed successfully.</p> </li> <li> <p>Failed - The job has stopped due to an error.</p> </li> <li> <p>Expired - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job cannot be started.</p> </li> </ul>"
|
||||
"documentation":"<p>The status of the user import job. One of the following:</p> <ul> <li> <p> <code>Created</code> - The job was created but not started.</p> </li> <li> <p> <code>Pending</code> - A transition state. You have started the job, but it has not begun importing users yet.</p> </li> <li> <p> <code>InProgress</code> - The job has started, and users are being imported.</p> </li> <li> <p> <code>Stopping</code> - You have stopped the job, but the job has not stopped importing users yet.</p> </li> <li> <p> <code>Stopped</code> - You have stopped the job, and the job has stopped importing users.</p> </li> <li> <p> <code>Succeeded</code> - The job has completed successfully.</p> </li> <li> <p> <code>Failed</code> - The job has stopped due to an error.</p> </li> <li> <p> <code>Expired</code> - You created a job, but did not start the job within 24-48 hours. All data associated with the job was deleted, and the job cannot be started.</p> </li> </ul>"
|
||||
},
|
||||
"CloudWatchLogsRoleArn":{
|
||||
"shape":"ArnType",
|
||||
|
|
@ -4504,7 +5229,7 @@
|
|||
"documentation":"<p>The message returned when the Amazon Cognito service returns a user validation exception with the AWS Lambda service.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>This exception gets thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.</p>",
|
||||
"documentation":"<p>This exception is thrown when the Amazon Cognito service encounters a user validation exception with the AWS Lambda service.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"UserNotConfirmedException":{
|
||||
|
|
@ -4572,15 +5297,15 @@
|
|||
},
|
||||
"LastModifiedDate":{
|
||||
"shape":"DateType",
|
||||
"documentation":"<p>The last modified date from the user pool request of the client type.</p>"
|
||||
"documentation":"<p>The date the user pool client was last modified.</p>"
|
||||
},
|
||||
"CreationDate":{
|
||||
"shape":"DateType",
|
||||
"documentation":"<p>The creation date from the user pool request of the client type.</p>"
|
||||
"documentation":"<p>The date the user pool client was created.</p>"
|
||||
},
|
||||
"RefreshTokenValidity":{
|
||||
"shape":"RefreshTokenValidityType",
|
||||
"documentation":"<p>The validity of the refresh token, in days.</p>"
|
||||
"documentation":"<p>The time limit, in days, after which the refresh token is no longer valid and cannot be used.</p>"
|
||||
},
|
||||
"ReadAttributes":{
|
||||
"shape":"ClientPermissionListType",
|
||||
|
|
@ -4593,6 +5318,35 @@
|
|||
"ExplicitAuthFlows":{
|
||||
"shape":"ExplicitAuthFlowsListType",
|
||||
"documentation":"<p>The explicit authentication flows.</p>"
|
||||
},
|
||||
"SupportedIdentityProviders":{
|
||||
"shape":"SupportedIdentityProvidersListType",
|
||||
"documentation":"<p>A list of provider names for the identity providers that are supported on this client.</p>"
|
||||
},
|
||||
"CallbackURLs":{
|
||||
"shape":"CallbackURLsListType",
|
||||
"documentation":"<p>A list of allowed callback URLs for the identity providers.</p>"
|
||||
},
|
||||
"LogoutURLs":{
|
||||
"shape":"LogoutURLsListType",
|
||||
"documentation":"<p>A list ofallowed logout URLs for the identity providers.</p>"
|
||||
},
|
||||
"DefaultRedirectURI":{
|
||||
"shape":"RedirectUrlType",
|
||||
"documentation":"<p>The default redirect URI. Must be in the <code>CallbackURLs</code> list.</p>"
|
||||
},
|
||||
"AllowedOAuthFlows":{
|
||||
"shape":"OAuthFlowsType",
|
||||
"documentation":"<p>Set to <code>code</code> to initiate a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the token endpoint.</p> <p>Set to <code>token</code> to specify that the client should get the access token (and, optionally, ID token, based on scopes) directly.</p>"
|
||||
},
|
||||
"AllowedOAuthScopes":{
|
||||
"shape":"ScopeListType",
|
||||
"documentation":"<p>A list of allowed <code>OAuth</code> scopes. Currently supported values are <code>\"phone\"</code>, <code>\"email\"</code>, <code>\"openid\"</code>, and <code>\"Cognito\"</code>.</p>"
|
||||
},
|
||||
"AllowedOAuthFlowsUserPoolClient":{
|
||||
"shape":"BooleanType",
|
||||
"documentation":"<p>Set to TRUE if the client is allowed to follow the OAuth protocol when interacting with Cognito user pools.</p>",
|
||||
"box":true
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A user pool of the client type.</p>"
|
||||
|
|
@ -4618,11 +5372,11 @@
|
|||
},
|
||||
"LastModifiedDate":{
|
||||
"shape":"DateType",
|
||||
"documentation":"<p>The last modified date in a user pool description.</p>"
|
||||
"documentation":"<p>The date the user pool description was last modified.</p>"
|
||||
},
|
||||
"CreationDate":{
|
||||
"shape":"DateType",
|
||||
"documentation":"<p>The creation date in a user pool description.</p>"
|
||||
"documentation":"<p>The date the user pool description was created.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A user pool description.</p>"
|
||||
|
|
@ -4656,7 +5410,7 @@
|
|||
"members":{
|
||||
"PasswordPolicy":{
|
||||
"shape":"PasswordPolicyType",
|
||||
"documentation":"<p>A container with information about the user pool password policy.</p>"
|
||||
"documentation":"<p>A container for information about the user pool password policy.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The type of policy in a user pool.</p>"
|
||||
|
|
@ -4666,7 +5420,7 @@
|
|||
"members":{
|
||||
"message":{"shape":"MessageType"}
|
||||
},
|
||||
"documentation":"<p>This exception gets thrown when a user pool tag cannot be set or updated.</p>",
|
||||
"documentation":"<p>This exception is thrown when a user pool tag cannot be set or updated.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"UserPoolTagsType":{
|
||||
|
|
@ -4687,11 +5441,11 @@
|
|||
},
|
||||
"Policies":{
|
||||
"shape":"UserPoolPolicyType",
|
||||
"documentation":"<p>A container describing the policies associated with a user pool.</p>"
|
||||
"documentation":"<p>A container for the policies associated with a user pool.</p>"
|
||||
},
|
||||
"LambdaConfig":{
|
||||
"shape":"LambdaConfigType",
|
||||
"documentation":"<p>A container describing the AWS Lambda triggers associated with a user pool.</p>"
|
||||
"documentation":"<p>A container for the AWS Lambda triggers associated with a user pool.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"StatusType",
|
||||
|
|
@ -4699,11 +5453,11 @@
|
|||
},
|
||||
"LastModifiedDate":{
|
||||
"shape":"DateType",
|
||||
"documentation":"<p>The last modified date of a user pool.</p>"
|
||||
"documentation":"<p>The date the user pool was last modified.</p>"
|
||||
},
|
||||
"CreationDate":{
|
||||
"shape":"DateType",
|
||||
"documentation":"<p>The creation date of a user pool.</p>"
|
||||
"documentation":"<p>The date the user pool was created.</p>"
|
||||
},
|
||||
"SchemaAttributes":{
|
||||
"shape":"SchemaAttributesListType",
|
||||
|
|
@ -4759,7 +5513,7 @@
|
|||
},
|
||||
"SmsConfigurationFailure":{
|
||||
"shape":"StringType",
|
||||
"documentation":"<p>The reason why the SMS configuration cannot send the message(s) to your users.</p>"
|
||||
"documentation":"<p>The reason why the SMS configuration cannot send the messages to your users.</p>"
|
||||
},
|
||||
"EmailConfigurationFailure":{
|
||||
"shape":"StringType",
|
||||
|
|
@ -4767,10 +5521,10 @@
|
|||
},
|
||||
"AdminCreateUserConfig":{
|
||||
"shape":"AdminCreateUserConfigType",
|
||||
"documentation":"<p>The configuration for AdminCreateUser requests.</p>"
|
||||
"documentation":"<p>The configuration for <code>AdminCreateUser</code> requests.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A container with information about the user pool type.</p>"
|
||||
"documentation":"<p>A container for information about the user pool type.</p>"
|
||||
},
|
||||
"UserStatusType":{
|
||||
"type":"string",
|
||||
|
|
@ -4854,6 +5608,7 @@
|
|||
"VerifyUserAttributeRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"AccessToken",
|
||||
"AttributeName",
|
||||
"Code"
|
||||
],
|
||||
|
|
@ -4880,5 +5635,5 @@
|
|||
"documentation":"<p>A container representing the response from the server from the request to verify user attributes.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Using the Amazon Cognito Your User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.</p> <p>This API reference provides information about user pools in Amazon Cognito Your User Pools.</p> <p>For more information, see the Amazon Cognito Documentation.</p>"
|
||||
"documentation":"<p>Using the Amazon Cognito User Pools API, you can create a user pool to manage directories and users. You can authenticate a user to obtain tokens related to user identity and access policies.</p> <p>This API reference provides information about user pools in Amazon Cognito User Pools.</p> <p>For more information, see the Amazon Cognito Documentation.</p>"
|
||||
}
|
||||
|
|
|
|||
5
botocore/data/config/2014-11-12/examples-1.json
Executable file
5
botocore/data/config/2014-11-12/examples-1.json
Executable file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
|
|
@ -28,7 +28,8 @@
|
|||
"GetResourceConfigHistory": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "configurationItems"
|
||||
"result_key": "configurationItems",
|
||||
"limit_key": "limit"
|
||||
},
|
||||
"ListDiscoveredResources": {
|
||||
"input_token": "nextToken",
|
||||
|
|
|
|||
28
botocore/data/config/2014-11-12/service-2.json
Executable file → Normal file
28
botocore/data/config/2014-11-12/service-2.json
Executable file → Normal file
|
|
@ -287,7 +287,7 @@
|
|||
{"shape":"InsufficientPermissionsException"},
|
||||
{"shape":"NoAvailableConfigurationRecorderException"}
|
||||
],
|
||||
"documentation":"<p>Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.</p> <p>You can use this action for custom Config rules and AWS managed Config rules. A custom Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.</p> <p>If you are adding a new custom Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the <code>PutConfigRule</code> action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the <code>SourceIdentifier</code> key. This key is part of the <code>Source</code> object, which is part of the <code>ConfigRule</code> object. </p> <p>If you are adding a new AWS managed Config rule, specify the rule's identifier for the <code>SourceIdentifier</code> key. To reference AWS managed Config rule identifiers, see <a href=\"http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html\">Using AWS Managed Config Rules</a>.</p> <p>For any new rule that you add, specify the <code>ConfigRuleName</code> in the <code>ConfigRule</code> object. Do not specify the <code>ConfigRuleArn</code> or the <code>ConfigRuleId</code>. These values are generated by AWS Config for new rules.</p> <p>If you are updating a rule that you added previously, you can specify the rule by <code>ConfigRuleName</code>, <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the <code>ConfigRule</code> data type that you use in this request.</p> <p>The maximum number of rules that AWS Config supports is 50.</p> <p>For more information about requesting a rule limit increase, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_config\">AWS Config Limits</a> in the <i>AWS General Reference Guide</i>.</p> <p>For more information about developing and using AWS Config rules, see <a href=\"http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html\">Evaluating AWS Resource Configurations with AWS Config</a> in the <i>AWS Config Developer Guide</i>.</p>"
|
||||
"documentation":"<p>Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.</p> <p>You can use this action for custom Config rules and AWS managed Config rules. A custom Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.</p> <p>If you are adding a new custom Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the <code>PutConfigRule</code> action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the <code>SourceIdentifier</code> key. This key is part of the <code>Source</code> object, which is part of the <code>ConfigRule</code> object. </p> <p>If you are adding an AWS managed Config rule, specify the rule's identifier for the <code>SourceIdentifier</code> key. To reference AWS managed Config rule identifiers, see <a href=\"http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html\">About AWS Managed Config Rules</a>.</p> <p>For any new rule that you add, specify the <code>ConfigRuleName</code> in the <code>ConfigRule</code> object. Do not specify the <code>ConfigRuleArn</code> or the <code>ConfigRuleId</code>. These values are generated by AWS Config for new rules.</p> <p>If you are updating a rule that you added previously, you can specify the rule by <code>ConfigRuleName</code>, <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the <code>ConfigRule</code> data type that you use in this request.</p> <p>The maximum number of rules that AWS Config supports is 50.</p> <p>For more information about requesting a rule limit increase, see <a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_config\">AWS Config Limits</a> in the <i>AWS General Reference Guide</i>.</p> <p>For more information about developing and using AWS Config rules, see <a href=\"http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html\">Evaluating AWS Resource Configurations with AWS Config</a> in the <i>AWS Config Developer Guide</i>.</p>"
|
||||
},
|
||||
"PutConfigurationRecorder":{
|
||||
"name":"PutConfigurationRecorder",
|
||||
|
|
@ -587,7 +587,7 @@
|
|||
},
|
||||
"MaximumExecutionFrequency":{
|
||||
"shape":"MaximumExecutionFrequency",
|
||||
"documentation":"<p>The maximum frequency with which AWS Config runs evaluations for a rule. You can specify a value for <code>MaximumExecutionFrequency</code> when:</p> <ul> <li> <p>You are using an AWS managed rule that is triggered at a periodic frequency.</p> </li> <li> <p>Your custom rule is triggered when AWS Config delivers the configuration snapshot.</p> </li> </ul> <p>For more information, see <a>ConfigSnapshotDeliveryProperties</a>.</p>"
|
||||
"documentation":"<p>The maximum frequency with which AWS Config runs evaluations for a rule. You can specify a value for <code>MaximumExecutionFrequency</code> when:</p> <ul> <li> <p>You are using an AWS managed rule that is triggered at a periodic frequency.</p> </li> <li> <p>Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see <a>ConfigSnapshotDeliveryProperties</a>.</p> </li> </ul> <note> <p>By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the <code>MaximumExecutionFrequency</code> parameter.</p> </note>"
|
||||
},
|
||||
"ConfigRuleState":{
|
||||
"shape":"ConfigRuleState",
|
||||
|
|
@ -955,7 +955,10 @@
|
|||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.</p> <p>If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see <a href=\"http://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html\">Permissions for the Amazon SNS Topic</a> in the AWS Config Developer Guide.</p>"
|
||||
},
|
||||
"configSnapshotDeliveryProperties":{"shape":"ConfigSnapshotDeliveryProperties"}
|
||||
"configSnapshotDeliveryProperties":{
|
||||
"shape":"ConfigSnapshotDeliveryProperties",
|
||||
"documentation":"<p>The options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The channel through which AWS Config delivers notifications and updated configuration states.</p>"
|
||||
},
|
||||
|
|
@ -1548,7 +1551,7 @@
|
|||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The speNexcified token is invalid.</p>",
|
||||
"documentation":"<p>The specified <code>ResultToken</code> is invalid.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidRoleException":{
|
||||
|
|
@ -1747,9 +1750,11 @@
|
|||
"type":"structure",
|
||||
"required":["ConfigRule"],
|
||||
"members":{
|
||||
"ConfigRule":{"shape":"ConfigRule"}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
"ConfigRule":{
|
||||
"shape":"ConfigRule",
|
||||
"documentation":"<p>The rule that you want to add to your account.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"PutConfigurationRecorderRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -1784,6 +1789,10 @@
|
|||
"ResultToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An encrypted token that associates an evaluation with an AWS Config rule. Identifies the rule and the event that triggered the evaluation</p>"
|
||||
},
|
||||
"TestMode":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Use this parameter to specify a test run for <code>PutEvaluations</code>. You can verify whether your AWS Lambda function will deliver evaluation results to AWS Config. No updates occur to your existing evaluations, and evaluation results are not sent to AWS Config.</p> <note> <p>When <code>TestMode</code> is <code>true</code>, <code>PutEvaluations</code> doesn't require a valid value for the <code>ResultToken</code> parameter, but the value cannot be null.</p> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
|
|
@ -1951,7 +1960,8 @@
|
|||
"AWS::Redshift::ClusterParameterGroup",
|
||||
"AWS::Redshift::ClusterSecurityGroup",
|
||||
"AWS::Redshift::ClusterSubnetGroup",
|
||||
"AWS::Redshift::EventSubscription"
|
||||
"AWS::Redshift::EventSubscription",
|
||||
"AWS::CloudWatch::Alarm"
|
||||
]
|
||||
},
|
||||
"ResourceTypeList":{
|
||||
|
|
@ -2026,7 +2036,7 @@
|
|||
},
|
||||
"MaximumExecutionFrequency":{
|
||||
"shape":"MaximumExecutionFrequency",
|
||||
"documentation":"<p>The frequency that you want AWS Config to run evaluations for a rule that is triggered periodically. If you specify a value for <code>MaximumExecutionFrequency</code>, then <code>MessageType</code> must use the <code>ScheduledNotification</code> value.</p>"
|
||||
"documentation":"<p>The frequency that you want AWS Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for <code>MaximumExecutionFrequency</code>, then <code>MessageType</code> must use the <code>ScheduledNotification</code> value.</p> <note> <p>By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the <code>MaximumExecutionFrequency</code> parameter.</p> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Provides the source and the message types that trigger AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for <code>SourceDetail</code> only for custom rules. </p>"
|
||||
|
|
|
|||
5
botocore/data/cur/2017-01-06/examples-1.json
Normal file
5
botocore/data/cur/2017-01-06/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
10
botocore/data/cur/2017-01-06/paginators-1.json
Normal file
10
botocore/data/cur/2017-01-06/paginators-1.json
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
{
|
||||
"pagination": {
|
||||
"DescribeReportDefinitions": {
|
||||
"input_token": "NextToken",
|
||||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"result_key": "ReportDefinitions"
|
||||
}
|
||||
}
|
||||
}
|
||||
3
botocore/data/dax/2017-04-19/paginators-1.json
Normal file
3
botocore/data/dax/2017-04-19/paginators-1.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
1614
botocore/data/dax/2017-04-19/service-2.json
Normal file
1614
botocore/data/dax/2017-04-19/service-2.json
Normal file
|
|
@ -0,0 +1,1614 @@
|
|||
{
|
||||
"version":"2.0",
|
||||
"metadata":{
|
||||
"apiVersion":"2017-04-19",
|
||||
"endpointPrefix":"dax",
|
||||
"jsonVersion":"1.1",
|
||||
"protocol":"json",
|
||||
"serviceAbbreviation":"Amazon DAX",
|
||||
"serviceFullName":"Amazon DynamoDB Accelerator (DAX)",
|
||||
"signatureVersion":"v4",
|
||||
"targetPrefix":"AmazonDAXV3",
|
||||
"uid":"dax-2017-04-19"
|
||||
},
|
||||
"operations":{
|
||||
"CreateCluster":{
|
||||
"name":"CreateCluster",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateClusterRequest"},
|
||||
"output":{"shape":"CreateClusterResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClusterAlreadyExistsFault"},
|
||||
{"shape":"InvalidClusterStateFault"},
|
||||
{"shape":"InsufficientClusterCapacityFault"},
|
||||
{"shape":"SubnetGroupNotFoundFault"},
|
||||
{"shape":"InvalidParameterGroupStateFault"},
|
||||
{"shape":"ParameterGroupNotFoundFault"},
|
||||
{"shape":"ClusterQuotaForCustomerExceededFault"},
|
||||
{"shape":"NodeQuotaForClusterExceededFault"},
|
||||
{"shape":"NodeQuotaForCustomerExceededFault"},
|
||||
{"shape":"InvalidVPCNetworkStateFault"},
|
||||
{"shape":"TagQuotaPerResourceExceeded"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.</p>"
|
||||
},
|
||||
"CreateParameterGroup":{
|
||||
"name":"CreateParameterGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateParameterGroupRequest"},
|
||||
"output":{"shape":"CreateParameterGroupResponse"},
|
||||
"errors":[
|
||||
{"shape":"ParameterGroupQuotaExceededFault"},
|
||||
{"shape":"ParameterGroupAlreadyExistsFault"},
|
||||
{"shape":"InvalidParameterGroupStateFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new parameter group. A parameter group is a collection of parameters that you apply to all of the nodes in a DAX cluster.</p>"
|
||||
},
|
||||
"CreateSubnetGroup":{
|
||||
"name":"CreateSubnetGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateSubnetGroupRequest"},
|
||||
"output":{"shape":"CreateSubnetGroupResponse"},
|
||||
"errors":[
|
||||
{"shape":"SubnetGroupAlreadyExistsFault"},
|
||||
{"shape":"SubnetGroupQuotaExceededFault"},
|
||||
{"shape":"SubnetQuotaExceededFault"},
|
||||
{"shape":"InvalidSubnet"}
|
||||
],
|
||||
"documentation":"<p>Creates a new subnet group.</p>"
|
||||
},
|
||||
"DecreaseReplicationFactor":{
|
||||
"name":"DecreaseReplicationFactor",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DecreaseReplicationFactorRequest"},
|
||||
"output":{"shape":"DecreaseReplicationFactorResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClusterNotFoundFault"},
|
||||
{"shape":"NodeNotFoundFault"},
|
||||
{"shape":"InvalidClusterStateFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Removes one or more nodes from a DAX cluster.</p> <note> <p>You cannot use <code>DecreaseReplicationFactor</code> to remove the last node in a DAX cluster. If you need to do this, use <code>DeleteCluster</code> instead.</p> </note>"
|
||||
},
|
||||
"DeleteCluster":{
|
||||
"name":"DeleteCluster",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteClusterRequest"},
|
||||
"output":{"shape":"DeleteClusterResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClusterNotFoundFault"},
|
||||
{"shape":"InvalidClusterStateFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a previously provisioned DAX cluster. <i>DeleteCluster</i> deletes all associated nodes, node endpoints and the DAX cluster itself. When you receive a successful response from this action, DAX immediately begins deleting the cluster; you cannot cancel or revert this action.</p>"
|
||||
},
|
||||
"DeleteParameterGroup":{
|
||||
"name":"DeleteParameterGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteParameterGroupRequest"},
|
||||
"output":{"shape":"DeleteParameterGroupResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterGroupStateFault"},
|
||||
{"shape":"ParameterGroupNotFoundFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Deletes the specified parameter group. You cannot delete a parameter group if it is associated with any DAX clusters.</p>"
|
||||
},
|
||||
"DeleteSubnetGroup":{
|
||||
"name":"DeleteSubnetGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteSubnetGroupRequest"},
|
||||
"output":{"shape":"DeleteSubnetGroupResponse"},
|
||||
"errors":[
|
||||
{"shape":"SubnetGroupInUseFault"},
|
||||
{"shape":"SubnetGroupNotFoundFault"}
|
||||
],
|
||||
"documentation":"<p>Deletes a subnet group.</p> <note> <p>You cannot delete a subnet group if it is associated with any DAX clusters.</p> </note>"
|
||||
},
|
||||
"DescribeClusters":{
|
||||
"name":"DescribeClusters",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeClustersRequest"},
|
||||
"output":{"shape":"DescribeClustersResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClusterNotFoundFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Returns information about all provisioned DAX clusters if no cluster identifier is specified, or about a specific DAX cluster if a cluster identifier is supplied.</p> <p>If the cluster is in the CREATING state, only cluster level information will be displayed until all of the nodes are successfully provisioned.</p> <p>If the cluster is in the DELETING state, only cluster level information will be displayed.</p> <p>If nodes are currently being added to the DAX cluster, node endpoint information and creation time for the additional nodes will not be displayed until they are completely provisioned. When the DAX cluster state is <i>available</i>, the cluster is ready for use.</p> <p>If nodes are currently being removed from the DAX cluster, no endpoint information for the removed nodes is displayed.</p>"
|
||||
},
|
||||
"DescribeDefaultParameters":{
|
||||
"name":"DescribeDefaultParameters",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeDefaultParametersRequest"},
|
||||
"output":{"shape":"DescribeDefaultParametersResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Returns the default system parameter information for the DAX caching software.</p>"
|
||||
},
|
||||
"DescribeEvents":{
|
||||
"name":"DescribeEvents",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeEventsRequest"},
|
||||
"output":{"shape":"DescribeEventsResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Returns events related to DAX clusters and parameter groups. You can obtain events specific to a particular DAX cluster or parameter group by providing the name as a parameter.</p> <p>By default, only the events occurring within the last hour are returned; however, you can retrieve up to 14 days' worth of events if necessary.</p>"
|
||||
},
|
||||
"DescribeParameterGroups":{
|
||||
"name":"DescribeParameterGroups",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeParameterGroupsRequest"},
|
||||
"output":{"shape":"DescribeParameterGroupsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ParameterGroupNotFoundFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Returns a list of parameter group descriptions. If a parameter group name is specified, the list will contain only the descriptions for that group.</p>"
|
||||
},
|
||||
"DescribeParameters":{
|
||||
"name":"DescribeParameters",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeParametersRequest"},
|
||||
"output":{"shape":"DescribeParametersResponse"},
|
||||
"errors":[
|
||||
{"shape":"ParameterGroupNotFoundFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Returns the detailed parameter list for a particular parameter group.</p>"
|
||||
},
|
||||
"DescribeSubnetGroups":{
|
||||
"name":"DescribeSubnetGroups",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeSubnetGroupsRequest"},
|
||||
"output":{"shape":"DescribeSubnetGroupsResponse"},
|
||||
"errors":[
|
||||
{"shape":"SubnetGroupNotFoundFault"}
|
||||
],
|
||||
"documentation":"<p>Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.</p>"
|
||||
},
|
||||
"IncreaseReplicationFactor":{
|
||||
"name":"IncreaseReplicationFactor",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"IncreaseReplicationFactorRequest"},
|
||||
"output":{"shape":"IncreaseReplicationFactorResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClusterNotFoundFault"},
|
||||
{"shape":"InvalidClusterStateFault"},
|
||||
{"shape":"InsufficientClusterCapacityFault"},
|
||||
{"shape":"InvalidVPCNetworkStateFault"},
|
||||
{"shape":"NodeQuotaForClusterExceededFault"},
|
||||
{"shape":"NodeQuotaForCustomerExceededFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Adds one or more nodes to a DAX cluster.</p>"
|
||||
},
|
||||
"ListTags":{
|
||||
"name":"ListTags",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListTagsRequest"},
|
||||
"output":{"shape":"ListTagsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClusterNotFoundFault"},
|
||||
{"shape":"InvalidARNFault"},
|
||||
{"shape":"InvalidClusterStateFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>List all of the tags for a DAX cluster. You can call <code>ListTags</code> up to 10 times per second, per account.</p>"
|
||||
},
|
||||
"RebootNode":{
|
||||
"name":"RebootNode",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"RebootNodeRequest"},
|
||||
"output":{"shape":"RebootNodeResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClusterNotFoundFault"},
|
||||
{"shape":"NodeNotFoundFault"},
|
||||
{"shape":"InvalidClusterStateFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Reboots a single node of a DAX cluster. The reboot action takes place as soon as possible. During the reboot, the node status is set to REBOOTING.</p>"
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"TagResourceRequest"},
|
||||
"output":{"shape":"TagResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClusterNotFoundFault"},
|
||||
{"shape":"TagQuotaPerResourceExceeded"},
|
||||
{"shape":"InvalidARNFault"},
|
||||
{"shape":"InvalidClusterStateFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Associates a set of tags with a DAX resource. You can call <code>TagResource</code> up to 5 times per second, per account. </p>"
|
||||
},
|
||||
"UntagResource":{
|
||||
"name":"UntagResource",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UntagResourceRequest"},
|
||||
"output":{"shape":"UntagResourceResponse"},
|
||||
"errors":[
|
||||
{"shape":"ClusterNotFoundFault"},
|
||||
{"shape":"InvalidARNFault"},
|
||||
{"shape":"TagNotFoundFault"},
|
||||
{"shape":"InvalidClusterStateFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Removes the association of tags from a DAX resource. You can call <code>UntagResource</code> up to 5 times per second, per account. </p>"
|
||||
},
|
||||
"UpdateCluster":{
|
||||
"name":"UpdateCluster",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateClusterRequest"},
|
||||
"output":{"shape":"UpdateClusterResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidClusterStateFault"},
|
||||
{"shape":"ClusterNotFoundFault"},
|
||||
{"shape":"InvalidParameterGroupStateFault"},
|
||||
{"shape":"ParameterGroupNotFoundFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Modifies the settings for a DAX cluster. You can use this action to change one or more cluster configuration parameters by specifying the parameters and the new values.</p>"
|
||||
},
|
||||
"UpdateParameterGroup":{
|
||||
"name":"UpdateParameterGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateParameterGroupRequest"},
|
||||
"output":{"shape":"UpdateParameterGroupResponse"},
|
||||
"errors":[
|
||||
{"shape":"InvalidParameterGroupStateFault"},
|
||||
{"shape":"ParameterGroupNotFoundFault"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"InvalidParameterCombinationException"}
|
||||
],
|
||||
"documentation":"<p>Modifies the parameters of a parameter group. You can modify up to 20 parameters in a single request by submitting a list parameter name and value pairs.</p>"
|
||||
},
|
||||
"UpdateSubnetGroup":{
|
||||
"name":"UpdateSubnetGroup",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateSubnetGroupRequest"},
|
||||
"output":{"shape":"UpdateSubnetGroupResponse"},
|
||||
"errors":[
|
||||
{"shape":"SubnetGroupNotFoundFault"},
|
||||
{"shape":"SubnetQuotaExceededFault"},
|
||||
{"shape":"SubnetInUse"},
|
||||
{"shape":"InvalidSubnet"}
|
||||
],
|
||||
"documentation":"<p>Modifies an existing subnet group.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"AvailabilityZoneList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"AwsQueryErrorMessage":{"type":"string"},
|
||||
"ChangeType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"IMMEDIATE",
|
||||
"REQUIRES_REBOOT"
|
||||
]
|
||||
},
|
||||
"Cluster":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ClusterName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the DAX cluster.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The description of the cluster.</p>"
|
||||
},
|
||||
"ClusterArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster. </p>"
|
||||
},
|
||||
"TotalNodes":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The total number of nodes in the cluster.</p>"
|
||||
},
|
||||
"ActiveNodes":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The number of nodes in the cluster that are active (i.e., capable of serving requests).</p>"
|
||||
},
|
||||
"NodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The current status of the cluster.</p>"
|
||||
},
|
||||
"ClusterDiscoveryEndpoint":{
|
||||
"shape":"Endpoint",
|
||||
"documentation":"<p>The configuration endpoint for this DAX cluster, consisting of a DNS name and a port number. Client applications can specify this endpoint, rather than an individual node endpoint, and allow the DAX client software to intelligently route requests and responses to nodes in the DAX cluster.</p>"
|
||||
},
|
||||
"NodeIdsToRemove":{
|
||||
"shape":"NodeIdentifierList",
|
||||
"documentation":"<p>A list of nodes to be removed from the cluster.</p>"
|
||||
},
|
||||
"Nodes":{
|
||||
"shape":"NodeList",
|
||||
"documentation":"<p>A list of nodes that are currently in the cluster.</p>"
|
||||
},
|
||||
"PreferredMaintenanceWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A range of time when maintenance of DAX cluster software will be performed. For example: <code>sun:01:00-sun:09:00</code>. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.</p>"
|
||||
},
|
||||
"NotificationConfiguration":{
|
||||
"shape":"NotificationConfiguration",
|
||||
"documentation":"<p>Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).</p>"
|
||||
},
|
||||
"SubnetGroup":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The subnet group where the DAX cluster is running.</p>"
|
||||
},
|
||||
"SecurityGroups":{
|
||||
"shape":"SecurityGroupMembershipList",
|
||||
"documentation":"<p>A list of security groups, and the status of each, for the nodes in the cluster.</p>"
|
||||
},
|
||||
"IamRoleArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.</p>"
|
||||
},
|
||||
"ParameterGroup":{
|
||||
"shape":"ParameterGroupStatus",
|
||||
"documentation":"<p>The parameter group being used by nodes in the cluster.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains all of the attributes of a specific DAX cluster.</p>"
|
||||
},
|
||||
"ClusterAlreadyExistsFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>You already have a DAX cluster with the given identifier.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ClusterList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Cluster"}
|
||||
},
|
||||
"ClusterNameList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"ClusterNotFoundFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The requested cluster ID does not refer to an existing DAX cluster.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ClusterQuotaForCustomerExceededFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>You have attempted to exceed the maximum number of DAX clusters for your AWS account.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"CreateClusterRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ClusterName",
|
||||
"NodeType",
|
||||
"ReplicationFactor",
|
||||
"IamRoleArn"
|
||||
],
|
||||
"members":{
|
||||
"ClusterName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The cluster identifier. This parameter is stored as a lowercase string.</p> <p> <b>Constraints:</b> </p> <ul> <li> <p>A name must contain from 1 to 20 alphanumeric characters or hyphens.</p> </li> <li> <p>The first character must be a letter.</p> </li> <li> <p>A name cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
|
||||
},
|
||||
"NodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The compute and memory capacity of the nodes in the cluster.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A description of the cluster.</p>"
|
||||
},
|
||||
"ReplicationFactor":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The number of nodes in the DAX cluster. A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set <i>ReplicationFactor</i> to 2 or more.</p> <note> <p>AWS recommends that you have at least two read replicas per cluster.</p> </note>"
|
||||
},
|
||||
"AvailabilityZones":{
|
||||
"shape":"AvailabilityZoneList",
|
||||
"documentation":"<p>The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.</p>"
|
||||
},
|
||||
"SubnetGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the subnet group to be used for the replication group.</p> <important> <p>DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.</p> </important>"
|
||||
},
|
||||
"SecurityGroupIds":{
|
||||
"shape":"SecurityGroupIdentifierList",
|
||||
"documentation":"<p>A list of security group IDs to be assigned to each node in the DAX cluster. (Each of the security group ID is system-generated.)</p> <p>If this parameter is not specified, DAX assigns the default VPC security group to each node.</p>"
|
||||
},
|
||||
"PreferredMaintenanceWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Specifies the weekly time range during which maintenance on the DAX cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. Valid values for <code>ddd</code> are:</p> <ul> <li> <p> <code>sun</code> </p> </li> <li> <p> <code>mon</code> </p> </li> <li> <p> <code>tue</code> </p> </li> <li> <p> <code>wed</code> </p> </li> <li> <p> <code>thu</code> </p> </li> <li> <p> <code>fri</code> </p> </li> <li> <p> <code>sat</code> </p> </li> </ul> <p>Example: <code>sun:05:00-sun:09:00</code> </p> <note> <p>If you don't specify a preferred maintenance window when you create or modify a cache cluster, DAX assigns a 60-minute maintenance window on a randomly selected day of the week.</p> </note>"
|
||||
},
|
||||
"NotificationTopicArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.</p> <note> <p>The Amazon SNS topic owner must be same as the DAX cluster owner.</p> </note>"
|
||||
},
|
||||
"IamRoleArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.</p>"
|
||||
},
|
||||
"ParameterGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The parameter group to be associated with the DAX cluster.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>A set of tags to associate with the DAX cluster. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateClusterResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Cluster":{
|
||||
"shape":"Cluster",
|
||||
"documentation":"<p>A description of the DAX cluster that you have created.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateParameterGroupRequest":{
|
||||
"type":"structure",
|
||||
"required":["ParameterGroupName"],
|
||||
"members":{
|
||||
"ParameterGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the parameter group to apply to all of the clusters in this replication group.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A description of the parameter group.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateParameterGroupResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ParameterGroup":{
|
||||
"shape":"ParameterGroup",
|
||||
"documentation":"<p>Represents the output of a <i>CreateParameterGroup</i> action.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateSubnetGroupRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SubnetGroupName",
|
||||
"SubnetIds"
|
||||
],
|
||||
"members":{
|
||||
"SubnetGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A name for the subnet group. This value is stored as a lowercase string. </p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A description for the subnet group</p>"
|
||||
},
|
||||
"SubnetIds":{
|
||||
"shape":"SubnetIdentifierList",
|
||||
"documentation":"<p>A list of VPC subnet IDs for the subnet group.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateSubnetGroupResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SubnetGroup":{
|
||||
"shape":"SubnetGroup",
|
||||
"documentation":"<p>Represents the output of a <i>CreateSubnetGroup</i> operation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DecreaseReplicationFactorRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ClusterName",
|
||||
"NewReplicationFactor"
|
||||
],
|
||||
"members":{
|
||||
"ClusterName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the DAX cluster from which you want to remove nodes.</p>"
|
||||
},
|
||||
"NewReplicationFactor":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The new number of nodes for the DAX cluster.</p>"
|
||||
},
|
||||
"AvailabilityZones":{
|
||||
"shape":"AvailabilityZoneList",
|
||||
"documentation":"<p>The Availability Zone(s) from which to remove nodes.</p>"
|
||||
},
|
||||
"NodeIdsToRemove":{
|
||||
"shape":"NodeIdentifierList",
|
||||
"documentation":"<p>The unique identifiers of the nodes to be removed from the cluster.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DecreaseReplicationFactorResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Cluster":{
|
||||
"shape":"Cluster",
|
||||
"documentation":"<p>A description of the DAX cluster, after you have decreased its replication factor.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteClusterRequest":{
|
||||
"type":"structure",
|
||||
"required":["ClusterName"],
|
||||
"members":{
|
||||
"ClusterName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the cluster to be deleted.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteClusterResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Cluster":{
|
||||
"shape":"Cluster",
|
||||
"documentation":"<p>A description of the DAX cluster that is being deleted.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteParameterGroupRequest":{
|
||||
"type":"structure",
|
||||
"required":["ParameterGroupName"],
|
||||
"members":{
|
||||
"ParameterGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the parameter group to delete.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteParameterGroupResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DeletionMessage":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A user-specified message for this action (i.e., a reason for deleting the parameter group).</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteSubnetGroupRequest":{
|
||||
"type":"structure",
|
||||
"required":["SubnetGroupName"],
|
||||
"members":{
|
||||
"SubnetGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the subnet group to delete.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteSubnetGroupResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"DeletionMessage":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A user-specified message for this action (i.e., a reason for deleting the subnet group).</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeClustersRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ClusterNames":{
|
||||
"shape":"ClusterNameList",
|
||||
"documentation":"<p>The names of the DAX clusters being described.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p> <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by <code>MaxResults</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeClustersResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Provides an identifier to allow retrieval of paginated results.</p>"
|
||||
},
|
||||
"Clusters":{
|
||||
"shape":"ClusterList",
|
||||
"documentation":"<p>The descriptions of your DAX clusters, in response to a <i>DescribeClusters</i> request.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeDefaultParametersRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"MaxResults":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p> <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by <code>MaxResults</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeDefaultParametersResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Provides an identifier to allow retrieval of paginated results.</p>"
|
||||
},
|
||||
"Parameters":{
|
||||
"shape":"ParameterList",
|
||||
"documentation":"<p>A list of parameters. Each element in the list represents one parameter.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeEventsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SourceName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The identifier of the event source for which events will be returned. If not specified, then all sources are included in the response.</p>"
|
||||
},
|
||||
"SourceType":{
|
||||
"shape":"SourceType",
|
||||
"documentation":"<p>The event source to retrieve events for. If no value is specified, all events are returned.</p>"
|
||||
},
|
||||
"StartTime":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The beginning of the time interval to retrieve events for, specified in ISO 8601 format.</p>"
|
||||
},
|
||||
"EndTime":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The end of the time interval for which to retrieve events, specified in ISO 8601 format.</p>"
|
||||
},
|
||||
"Duration":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The number of minutes' worth of events to retrieve.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p> <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by <code>MaxResults</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeEventsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Provides an identifier to allow retrieval of paginated results.</p>"
|
||||
},
|
||||
"Events":{
|
||||
"shape":"EventList",
|
||||
"documentation":"<p>An array of events. Each element in the array represents one event.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeParameterGroupsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ParameterGroupNames":{
|
||||
"shape":"ParameterGroupNameList",
|
||||
"documentation":"<p>The names of the parameter groups.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p> <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by <code>MaxResults</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeParameterGroupsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Provides an identifier to allow retrieval of paginated results.</p>"
|
||||
},
|
||||
"ParameterGroups":{
|
||||
"shape":"ParameterGroupList",
|
||||
"documentation":"<p>An array of parameter groups. Each element in the array represents one parameter group.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeParametersRequest":{
|
||||
"type":"structure",
|
||||
"required":["ParameterGroupName"],
|
||||
"members":{
|
||||
"ParameterGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the parameter group.</p>"
|
||||
},
|
||||
"Source":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>How the parameter is defined. For example, <code>system</code> denotes a system-defined parameter.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p> <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by <code>MaxResults</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeParametersResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Provides an identifier to allow retrieval of paginated results.</p>"
|
||||
},
|
||||
"Parameters":{
|
||||
"shape":"ParameterList",
|
||||
"documentation":"<p>A list of parameters within a parameter group. Each element in the list represents one parameter.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeSubnetGroupsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SubnetGroupNames":{
|
||||
"shape":"SubnetGroupNameList",
|
||||
"documentation":"<p>The name of the subnet group.</p>"
|
||||
},
|
||||
"MaxResults":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The maximum number of results to include in the response. If more results exist than the specified <code>MaxResults</code> value, a token is included in the response so that the remaining results can be retrieved.</p> <p>The value for <code>MaxResults</code> must be between 20 and 100.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by <code>MaxResults</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeSubnetGroupsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Provides an identifier to allow retrieval of paginated results.</p>"
|
||||
},
|
||||
"SubnetGroups":{
|
||||
"shape":"SubnetGroupList",
|
||||
"documentation":"<p>An array of subnet groups. Each element in the array represents a single subnet group.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Endpoint":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Address":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The DNS hostname of the endpoint.</p>"
|
||||
},
|
||||
"Port":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The port number that applications should use to connect to the endpoint.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the information required for client programs to connect to the configuration endpoint for a DAX cluster, or to an individual node within the cluster.</p>"
|
||||
},
|
||||
"Event":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SourceName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The source of the event. For example, if the event occurred at the node level, the source would be the node ID.</p>"
|
||||
},
|
||||
"SourceType":{
|
||||
"shape":"SourceType",
|
||||
"documentation":"<p>Specifies the origin of this event - a cluster, a parameter group, a node ID, etc.</p>"
|
||||
},
|
||||
"Message":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A user-defined message associated with the event.</p>"
|
||||
},
|
||||
"Date":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The date and time when the event occurred.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents a single occurrence of something interesting within the system. Some examples of events are creating a DAX cluster, adding or removing a node, or rebooting a node.</p>"
|
||||
},
|
||||
"EventList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Event"}
|
||||
},
|
||||
"IncreaseReplicationFactorRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ClusterName",
|
||||
"NewReplicationFactor"
|
||||
],
|
||||
"members":{
|
||||
"ClusterName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the DAX cluster that will receive additional nodes.</p>"
|
||||
},
|
||||
"NewReplicationFactor":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The new number of nodes for the DAX cluster.</p>"
|
||||
},
|
||||
"AvailabilityZones":{
|
||||
"shape":"AvailabilityZoneList",
|
||||
"documentation":"<p>The Availability Zones (AZs) in which the cluster nodes will be created. All nodes belonging to the cluster are placed in these Availability Zones. Use this parameter if you want to distribute the nodes across multiple AZs.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"IncreaseReplicationFactorResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Cluster":{
|
||||
"shape":"Cluster",
|
||||
"documentation":"<p>A description of the DAX cluster. with its new replication factor.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"InsufficientClusterCapacityFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>There are not enough system resources to create the cluster you requested (or to resize an already-existing cluster). </p>",
|
||||
"exception":true
|
||||
},
|
||||
"Integer":{"type":"integer"},
|
||||
"IntegerOptional":{"type":"integer"},
|
||||
"InvalidARNFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) supplied in the request is not valid.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidClusterStateFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The requested DAX cluster is not in the <i>available</i> state.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidParameterCombinationException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"AwsQueryErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>Two or more incompatible parameters were specified.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidParameterGroupStateFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>One or more parameters in a parameter group are in an invalid state.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidParameterValueException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{"shape":"AwsQueryErrorMessage"}
|
||||
},
|
||||
"documentation":"<p>The value for a parameter is invalid.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidSubnet":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>An invalid subnet identifier was specified.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"InvalidVPCNetworkStateFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The VPC network is in an invalid state.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"IsModifiable":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"TRUE",
|
||||
"FALSE",
|
||||
"CONDITIONAL"
|
||||
]
|
||||
},
|
||||
"KeyList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"ListTagsRequest":{
|
||||
"type":"structure",
|
||||
"required":["ResourceName"],
|
||||
"members":{
|
||||
"ResourceName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the DAX resource to which the tags belong.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListTagsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>A list of tags currently associated with the DAX cluster.</p>"
|
||||
},
|
||||
"NextToken":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>If this value is present, there are additional results to be displayed. To retrieve them, call <code>ListTags</code> again, with <code>NextToken</code> set to this value.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"Node":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NodeId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A system-generated identifier for the node.</p>"
|
||||
},
|
||||
"Endpoint":{
|
||||
"shape":"Endpoint",
|
||||
"documentation":"<p>The endpoint for the node, consisting of a DNS name and a port number. Client applications can connect directly to a node endpoint, if desired (as an alternative to allowing DAX client software to intelligently route requests and responses to nodes in the DAX cluster.</p>"
|
||||
},
|
||||
"NodeCreateTime":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The date and time (in UNIX epoch format) when the node was launched.</p>"
|
||||
},
|
||||
"AvailabilityZone":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Availability Zone (AZ) in which the node has been deployed.</p>"
|
||||
},
|
||||
"NodeStatus":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The current status of the node. For example: <code>available</code>.</p>"
|
||||
},
|
||||
"ParameterGroupStatus":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The status of the parameter group associated with this node. For example, <code>in-sync</code>.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents an individual node within a DAX cluster.</p>"
|
||||
},
|
||||
"NodeIdentifierList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"NodeList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Node"}
|
||||
},
|
||||
"NodeNotFoundFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>None of the nodes in the cluster have the given node ID.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"NodeQuotaForClusterExceededFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>You have attempted to exceed the maximum number of nodes for a DAX cluster.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"NodeQuotaForCustomerExceededFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>You have attempted to exceed the maximum number of nodes for your AWS account.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"NodeTypeSpecificValue":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"NodeType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A node type to which the parameter value applies.</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The parameter value for this node type.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents a parameter value that is applicable to a particular node type.</p>"
|
||||
},
|
||||
"NodeTypeSpecificValueList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NodeTypeSpecificValue"}
|
||||
},
|
||||
"NotificationConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TopicArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the topic. </p>"
|
||||
},
|
||||
"TopicStatus":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The current state of the topic.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).</p>"
|
||||
},
|
||||
"Parameter":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ParameterName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the parameter.</p>"
|
||||
},
|
||||
"ParameterType":{
|
||||
"shape":"ParameterType",
|
||||
"documentation":"<p>Determines whether the parameter can be applied to any nodes, or only nodes of a particular type.</p>"
|
||||
},
|
||||
"ParameterValue":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The value for the parameter.</p>"
|
||||
},
|
||||
"NodeTypeSpecificValues":{
|
||||
"shape":"NodeTypeSpecificValueList",
|
||||
"documentation":"<p>A list of node types, and specific parameter values for each node.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A description of the parameter</p>"
|
||||
},
|
||||
"Source":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>How the parameter is defined. For example, <code>system</code> denotes a system-defined parameter.</p>"
|
||||
},
|
||||
"DataType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The data type of the parameter. For example, <code>integer</code>:</p>"
|
||||
},
|
||||
"AllowedValues":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A range of values within which the parameter can be set.</p>"
|
||||
},
|
||||
"IsModifiable":{
|
||||
"shape":"IsModifiable",
|
||||
"documentation":"<p>Whether the customer is allowed to modify the parameter.</p>"
|
||||
},
|
||||
"ChangeType":{
|
||||
"shape":"ChangeType",
|
||||
"documentation":"<p>The conditions under which changes to this parameter can be applied. For example, <code>requires-reboot</code> indicates that a new value for this parameter will only take effect if a node is rebooted.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes an individual setting that controls some aspect of DAX behavior.</p>"
|
||||
},
|
||||
"ParameterGroup":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ParameterGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the parameter group.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A description of the parameter group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A named set of parameters that are applied to all of the nodes in a DAX cluster.</p>"
|
||||
},
|
||||
"ParameterGroupAlreadyExistsFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The specified parameter group already exists.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ParameterGroupList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ParameterGroup"}
|
||||
},
|
||||
"ParameterGroupNameList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"ParameterGroupNotFoundFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The specified parameter group does not exist.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ParameterGroupQuotaExceededFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>You have attempted to exceed the maximum number of parameter groups.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"ParameterGroupStatus":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ParameterGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the parameter group.</p>"
|
||||
},
|
||||
"ParameterApplyStatus":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The status of parameter updates. </p>"
|
||||
},
|
||||
"NodeIdsToReboot":{
|
||||
"shape":"NodeIdentifierList",
|
||||
"documentation":"<p>The node IDs of one or more nodes to be rebooted.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The status of a parameter group.</p>"
|
||||
},
|
||||
"ParameterList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Parameter"}
|
||||
},
|
||||
"ParameterNameValue":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ParameterName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the parameter.</p>"
|
||||
},
|
||||
"ParameterValue":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The value of the parameter.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An individual DAX parameter.</p>"
|
||||
},
|
||||
"ParameterNameValueList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ParameterNameValue"}
|
||||
},
|
||||
"ParameterType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"DEFAULT",
|
||||
"NODE_TYPE_SPECIFIC"
|
||||
]
|
||||
},
|
||||
"RebootNodeRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ClusterName",
|
||||
"NodeId"
|
||||
],
|
||||
"members":{
|
||||
"ClusterName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the DAX cluster containing the node to be rebooted.</p>"
|
||||
},
|
||||
"NodeId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The system-assigned ID of the node to be rebooted.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"RebootNodeResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Cluster":{
|
||||
"shape":"Cluster",
|
||||
"documentation":"<p>A description of the DAX cluster after a node has been rebooted.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SecurityGroupIdentifierList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"SecurityGroupMembership":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SecurityGroupIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The unique ID for this security group.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The status of this security group.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An individual VPC security group and its status.</p>"
|
||||
},
|
||||
"SecurityGroupMembershipList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"SecurityGroupMembership"}
|
||||
},
|
||||
"SourceType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"CLUSTER",
|
||||
"PARAMETER_GROUP",
|
||||
"SUBNET_GROUP"
|
||||
]
|
||||
},
|
||||
"String":{"type":"string"},
|
||||
"Subnet":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SubnetIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The system-assigned identifier for the subnet.</p>"
|
||||
},
|
||||
"SubnetAvailabilityZone":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Availability Zone (AZ) for subnet subnet.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the subnet associated with a DAX cluster. This parameter refers to subnets defined in Amazon Virtual Private Cloud (Amazon VPC) and used with DAX.</p>"
|
||||
},
|
||||
"SubnetGroup":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SubnetGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the subnet group.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The description of the subnet group.</p>"
|
||||
},
|
||||
"VpcId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Virtual Private Cloud identifier (VPC ID) of the subnet group.</p>"
|
||||
},
|
||||
"Subnets":{
|
||||
"shape":"SubnetList",
|
||||
"documentation":"<p>A list of subnets associated with the subnet group. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of one of the following actions:</p> <ul> <li> <p> <i>CreateSubnetGroup</i> </p> </li> <li> <p> <i>ModifySubnetGroup</i> </p> </li> </ul>"
|
||||
},
|
||||
"SubnetGroupAlreadyExistsFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The specified subnet group already exists.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"SubnetGroupInUseFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The specified subnet group is currently in use.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"SubnetGroupList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"SubnetGroup"}
|
||||
},
|
||||
"SubnetGroupNameList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"SubnetGroupNotFoundFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The requested subnet group name does not refer to an existing subnet group.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"SubnetGroupQuotaExceededFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"SubnetIdentifierList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
},
|
||||
"SubnetInUse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The requested subnet is being used by another subnet group.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"SubnetList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Subnet"}
|
||||
},
|
||||
"SubnetQuotaExceededFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The request cannot be processed because it would exceed the allowed number of subnets in a subnet group.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"TStamp":{"type":"timestamp"},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Key":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The key for the tag. Tag keys are case sensitive. Every DAX cluster can only have one tag with the same key. If you try to add an existing tag (same key), the existing tag value will be updated to the new value.</p>"
|
||||
},
|
||||
"Value":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The value of the tag. Tag values are case-sensitive and can be null. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A description of a tag. Every tag is a key-value pair. You can add up to 50 tags to a single DAX cluster.</p> <p>AWS-assigned tag names and values are automatically assigned the <code>aws:</code> prefix, which the user cannot assign. AWS-assigned tag names do not count towards the tag limit of 50. User-assigned tag names have the prefix <code>user:</code>.</p> <p>You cannot backdate the application of a tag.</p>"
|
||||
},
|
||||
"TagList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Tag"}
|
||||
},
|
||||
"TagNotFoundFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>The tag does not exist.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"TagQuotaPerResourceExceeded":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
},
|
||||
"documentation":"<p>You have exceeded the maximum number of tags for this DAX cluster.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"TagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceName",
|
||||
"Tags"
|
||||
],
|
||||
"members":{
|
||||
"ResourceName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the DAX resource to which tags should be added.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>The tags to be assigned to the DAX resource. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"TagResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>The list of tags that are associated with the DAX resource.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UntagResourceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ResourceName",
|
||||
"TagKeys"
|
||||
],
|
||||
"members":{
|
||||
"ResourceName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the DAX resource from which the tags should be removed.</p>"
|
||||
},
|
||||
"TagKeys":{
|
||||
"shape":"KeyList",
|
||||
"documentation":"<p>A list of tag keys. If the DAX cluster has any tags with these keys, then the tags are removed from the cluster.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UntagResourceResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>The tag keys that have been removed from the cluster.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateClusterRequest":{
|
||||
"type":"structure",
|
||||
"required":["ClusterName"],
|
||||
"members":{
|
||||
"ClusterName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the DAX cluster to be modified.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A description of the changes being made to the cluster.</p>"
|
||||
},
|
||||
"PreferredMaintenanceWindow":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A range of time when maintenance of DAX cluster software will be performed. For example: <code>sun:01:00-sun:09:00</code>. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.</p>"
|
||||
},
|
||||
"NotificationTopicArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) that identifies the topic.</p>"
|
||||
},
|
||||
"NotificationTopicStatus":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The current state of the topic.</p>"
|
||||
},
|
||||
"ParameterGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of a parameter group for this cluster.</p>"
|
||||
},
|
||||
"SecurityGroupIds":{
|
||||
"shape":"SecurityGroupIdentifierList",
|
||||
"documentation":"<p>A list of user-specified security group IDs to be assigned to each node in the DAX cluster. If this parameter is not specified, DAX assigns the default VPC security group to each node.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateClusterResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Cluster":{
|
||||
"shape":"Cluster",
|
||||
"documentation":"<p>A description of the DAX cluster, after it has been modified.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateParameterGroupRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ParameterGroupName",
|
||||
"ParameterNameValues"
|
||||
],
|
||||
"members":{
|
||||
"ParameterGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the parameter group.</p>"
|
||||
},
|
||||
"ParameterNameValues":{
|
||||
"shape":"ParameterNameValueList",
|
||||
"documentation":"<p>An array of name-value pairs for the parameters in the group. Each element in the array represents a single parameter.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateParameterGroupResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ParameterGroup":{
|
||||
"shape":"ParameterGroup",
|
||||
"documentation":"<p>The parameter group that has been modified.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateSubnetGroupRequest":{
|
||||
"type":"structure",
|
||||
"required":["SubnetGroupName"],
|
||||
"members":{
|
||||
"SubnetGroupName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the subnet group.</p>"
|
||||
},
|
||||
"Description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A description of the subnet group.</p>"
|
||||
},
|
||||
"SubnetIds":{
|
||||
"shape":"SubnetIdentifierList",
|
||||
"documentation":"<p>A list of subnet IDs in the subnet group.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateSubnetGroupResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SubnetGroup":{
|
||||
"shape":"SubnetGroup",
|
||||
"documentation":"<p>The subnet group that has been modified.</p>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<p>DAX is a managed caching service engineered for Amazon DynamoDB. DAX dramatically speeds up database reads by caching frequently-accessed data from DynamoDB, so applications can access that data with sub-millisecond latency. You can create a DAX cluster easily, using the AWS Management Console. With a few simple modifications to your code, your application can begin taking advantage of the DAX cluster and realize significant improvements in read performance.</p>"
|
||||
}
|
||||
1242
botocore/data/devicefarm/2015-06-23/examples-1.json
Normal file
1242
botocore/data/devicefarm/2015-06-23/examples-1.json
Normal file
|
|
@ -0,0 +1,1242 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
"CreateDevicePool": [
|
||||
{
|
||||
"input": {
|
||||
"name": "MyDevicePool",
|
||||
"description": "My Android devices",
|
||||
"projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
|
||||
"rules": [
|
||||
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"devicePool": {
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"name": "A device pool contains related devices, such as devices that run only on Android or that run only on iOS.",
|
||||
"projectArn": "You can get the project ARN by using the list-projects CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example creates a new device pool named MyDevicePool inside an existing project.",
|
||||
"id": "createdevicepool-example-1470862210860",
|
||||
"title": "To create a new device pool"
|
||||
}
|
||||
],
|
||||
"CreateProject": [
|
||||
{
|
||||
"input": {
|
||||
"name": "MyProject"
|
||||
},
|
||||
"output": {
|
||||
"project": {
|
||||
"name": "MyProject",
|
||||
"arn": "arn:aws:devicefarm:us-west-2:183774035805:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE",
|
||||
"created": "1472660939.152"
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"name": "A project in Device Farm is a workspace that contains test runs. A run is a test of a single app against one or more devices."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example creates a new project named MyProject.",
|
||||
"id": "createproject-example-1470862210860",
|
||||
"title": "To create a new project"
|
||||
}
|
||||
],
|
||||
"CreateRemoteAccessSession": [
|
||||
{
|
||||
"input": {
|
||||
"name": "MySession",
|
||||
"configuration": {
|
||||
"billingMethod": "METERED"
|
||||
},
|
||||
"deviceArn": "arn:aws:devicefarm:us-west-2::device:123EXAMPLE",
|
||||
"projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"output": {
|
||||
"remoteAccessSession": {
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"deviceArn": "You can get the device ARN by using the list-devices CLI command.",
|
||||
"projectArn": "You can get the project ARN by using the list-projects CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example creates a remote access session named MySession.",
|
||||
"id": "to-create-a-remote-access-session-1470970668274",
|
||||
"title": "To create a remote access session"
|
||||
}
|
||||
],
|
||||
"CreateUpload": [
|
||||
{
|
||||
"input": {
|
||||
"name": "MyAppiumPythonUpload",
|
||||
"type": "APPIUM_PYTHON_TEST_PACKAGE",
|
||||
"projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"output": {
|
||||
"upload": {
|
||||
"name": "MyAppiumPythonUpload",
|
||||
"type": "APPIUM_PYTHON_TEST_PACKAGE",
|
||||
"arn": "arn:aws:devicefarm:us-west-2:183774035805:upload:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE",
|
||||
"created": "1472661404.186",
|
||||
"status": "INITIALIZED",
|
||||
"url": "https://prod-us-west-2-uploads.s3-us-west-2.amazonaws.com/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A183774035805%3Aproject%3A5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE/uploads/arn%3Aaws%3Adevicefarm%3Aus-west-2%3A183774035805%3Aupload%3A5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/b5340a65-3da7-4da6-a26e-12345EXAMPLE/MyAppiumPythonUpload?AWSAccessKeyId=1234567891011EXAMPLE&Expires=1472747804&Signature=1234567891011EXAMPLE"
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"projectArn": "You can get the project ARN by using the list-projects CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example creates a new Appium Python test package upload inside an existing project.",
|
||||
"id": "createupload-example-1470864711775",
|
||||
"title": "To create a new test package upload"
|
||||
}
|
||||
],
|
||||
"DeleteDevicePool": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the device pool ARN by using the list-device-pools CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example deletes a specific device pool.",
|
||||
"id": "deletedevicepool-example-1470866975494",
|
||||
"title": "To delete a device pool"
|
||||
}
|
||||
],
|
||||
"DeleteProject": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the project ARN by using the list-projects CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example deletes a specific project.",
|
||||
"id": "deleteproject-example-1470867374212",
|
||||
"title": "To delete a project"
|
||||
}
|
||||
],
|
||||
"DeleteRemoteAccessSession": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the remote access session ARN by using the list-remote-access-sessions CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example deletes a specific remote access session.",
|
||||
"id": "to-delete-a-specific-remote-access-session-1470971431677",
|
||||
"title": "To delete a specific remote access session"
|
||||
}
|
||||
],
|
||||
"DeleteRun": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the run ARN by using the list-runs CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example deletes a specific test run.",
|
||||
"id": "deleterun-example-1470867905129",
|
||||
"title": "To delete a run"
|
||||
}
|
||||
],
|
||||
"DeleteUpload": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the upload ARN by using the list-uploads CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example deletes a specific upload.",
|
||||
"id": "deleteupload-example-1470868363942",
|
||||
"title": "To delete a specific upload"
|
||||
}
|
||||
],
|
||||
"GetAccountSettings": [
|
||||
{
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
"accountSettings": {
|
||||
"awsAccountNumber": "123456789101",
|
||||
"unmeteredDevices": {
|
||||
"ANDROID": 1,
|
||||
"IOS": 2
|
||||
}
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about your Device Farm account settings.",
|
||||
"id": "to-get-information-about-account-settings-1472567568189",
|
||||
"title": "To get information about account settings"
|
||||
}
|
||||
],
|
||||
"GetDevice": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2::device:123EXAMPLE"
|
||||
},
|
||||
"output": {
|
||||
"device": {
|
||||
"name": "LG G2 (Sprint)",
|
||||
"arn": "arn:aws:devicefarm:us-west-2::device:A0E6E6E1059E45918208DF75B2B7EF6C",
|
||||
"cpu": {
|
||||
"architecture": "armeabi-v7a",
|
||||
"clock": 2265.6,
|
||||
"frequency": "MHz"
|
||||
},
|
||||
"formFactor": "PHONE",
|
||||
"heapSize": 256000000,
|
||||
"image": "75B2B7EF6C12345EXAMPLE",
|
||||
"manufacturer": "LG",
|
||||
"memory": 16000000000,
|
||||
"model": "G2 (Sprint)",
|
||||
"os": "4.2.2",
|
||||
"platform": "ANDROID",
|
||||
"resolution": {
|
||||
"height": 1920,
|
||||
"width": 1080
|
||||
}
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about a specific device.",
|
||||
"id": "getdevice-example-1470870602173",
|
||||
"title": "To get information about a device"
|
||||
}
|
||||
],
|
||||
"GetDevicePool": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"output": {
|
||||
"devicePool": {
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can obtain the project ARN by using the list-projects CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about a specific device pool, given a project ARN.",
|
||||
"id": "getdevicepool-example-1470870873136",
|
||||
"title": "To get information about a device pool"
|
||||
}
|
||||
],
|
||||
"GetDevicePoolCompatibility": [
|
||||
{
|
||||
"input": {
|
||||
"appArn": "arn:aws:devicefarm:us-west-2::app:123-456-EXAMPLE-GUID",
|
||||
"devicePoolArn": "arn:aws:devicefarm:us-west-2::devicepool:123-456-EXAMPLE-GUID",
|
||||
"testType": "APPIUM_PYTHON"
|
||||
},
|
||||
"output": {
|
||||
"compatibleDevices": [
|
||||
|
||||
],
|
||||
"incompatibleDevices": [
|
||||
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"devicePoolArn": "You can get the device pool ARN by using the list-device-pools CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about the compatibility of a specific device pool, given its ARN.",
|
||||
"id": "getdevicepoolcompatibility-example-1470925003466",
|
||||
"title": "To get information about the compatibility of a device pool"
|
||||
}
|
||||
],
|
||||
"GetJob": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2::job:123-456-EXAMPLE-GUID"
|
||||
},
|
||||
"output": {
|
||||
"job": {
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the job ARN by using the list-jobs CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about a specific job.",
|
||||
"id": "getjob-example-1470928294268",
|
||||
"title": "To get information about a job"
|
||||
}
|
||||
],
|
||||
"GetOfferingStatus": [
|
||||
{
|
||||
"input": {
|
||||
"nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE="
|
||||
},
|
||||
"output": {
|
||||
"current": {
|
||||
"D68B3C05-1BA6-4360-BC69-12345EXAMPLE": {
|
||||
"offering": {
|
||||
"type": "RECURRING",
|
||||
"description": "Android Remote Access Unmetered Device Slot",
|
||||
"id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
|
||||
"platform": "ANDROID"
|
||||
},
|
||||
"quantity": 1
|
||||
}
|
||||
},
|
||||
"nextPeriod": {
|
||||
"D68B3C05-1BA6-4360-BC69-12345EXAMPLE": {
|
||||
"effectiveOn": "1472688000",
|
||||
"offering": {
|
||||
"type": "RECURRING",
|
||||
"description": "Android Remote Access Unmetered Device Slot",
|
||||
"id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
|
||||
"platform": "ANDROID"
|
||||
},
|
||||
"quantity": 1
|
||||
}
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"nextToken": "A dynamically generated value, used for paginating results."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about Device Farm offerings available to your account.",
|
||||
"id": "to-get-status-information-about-device-offerings-1472568124402",
|
||||
"title": "To get status information about device offerings"
|
||||
}
|
||||
],
|
||||
"GetProject": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE"
|
||||
},
|
||||
"output": {
|
||||
"project": {
|
||||
"name": "My Project",
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:5e01a8c7-c861-4c0a-b1d5-12345EXAMPLE",
|
||||
"created": "1472660939.152"
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the project ARN by using the list-projects CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example gets information about a specific project.",
|
||||
"id": "to-get-a-project-1470975038449",
|
||||
"title": "To get information about a project"
|
||||
}
|
||||
],
|
||||
"GetRemoteAccessSession": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"output": {
|
||||
"remoteAccessSession": {
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the remote access session ARN by using the list-remote-access-sessions CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example gets a specific remote access session.",
|
||||
"id": "to-get-a-remote-access-session-1471014119414",
|
||||
"title": "To get a remote access session"
|
||||
}
|
||||
],
|
||||
"GetRun": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE"
|
||||
},
|
||||
"output": {
|
||||
"run": {
|
||||
"name": "My Test Run",
|
||||
"type": "BUILTIN_EXPLORER",
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE",
|
||||
"billingMethod": "METERED",
|
||||
"completedJobs": 0,
|
||||
"counters": {
|
||||
"errored": 0,
|
||||
"failed": 0,
|
||||
"passed": 0,
|
||||
"skipped": 0,
|
||||
"stopped": 0,
|
||||
"total": 0,
|
||||
"warned": 0
|
||||
},
|
||||
"created": "1472667509.852",
|
||||
"deviceMinutes": {
|
||||
"metered": 0.0,
|
||||
"total": 0.0,
|
||||
"unmetered": 0.0
|
||||
},
|
||||
"platform": "ANDROID",
|
||||
"result": "PENDING",
|
||||
"status": "RUNNING",
|
||||
"totalJobs": 3
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the run ARN by using the list-runs CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example gets information about a specific test run.",
|
||||
"id": "to-get-a-test-run-1471015895657",
|
||||
"title": "To get information about a test run"
|
||||
}
|
||||
],
|
||||
"GetSuite": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:suite:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"output": {
|
||||
"suite": {
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the suite ARN by using the list-suites CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example gets information about a specific test suite.",
|
||||
"id": "to-get-information-about-a-test-suite-1471016525008",
|
||||
"title": "To get information about a test suite"
|
||||
}
|
||||
],
|
||||
"GetTest": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"output": {
|
||||
"test": {
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the test ARN by using the list-tests CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example gets information about a specific test.",
|
||||
"id": "to-get-information-about-a-specific-test-1471025744238",
|
||||
"title": "To get information about a specific test"
|
||||
}
|
||||
],
|
||||
"GetUpload": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:upload:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"output": {
|
||||
"upload": {
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the test ARN by using the list-uploads CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example gets information about a specific upload.",
|
||||
"id": "to-get-information-about-a-specific-upload-1471025996221",
|
||||
"title": "To get information about a specific upload"
|
||||
}
|
||||
],
|
||||
"InstallToRemoteAccessSession": [
|
||||
{
|
||||
"input": {
|
||||
"appArn": "arn:aws:devicefarm:us-west-2:123456789101:app:EXAMPLE-GUID-123-456",
|
||||
"remoteAccessSessionArn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"output": {
|
||||
"appUpload": {
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"remoteAccessSessionArn": "You can get the remote access session ARN by using the list-remote-access-sessions CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example installs a specific app to a device in a specific remote access session.",
|
||||
"id": "to-install-to-a-remote-access-session-1471634453818",
|
||||
"title": "To install to a remote access session"
|
||||
}
|
||||
],
|
||||
"ListArtifacts": [
|
||||
{
|
||||
"input": {
|
||||
"type": "SCREENSHOT",
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "Can also be used to list artifacts for a Job, Suite, or Test ARN."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example lists screenshot artifacts for a specific run.",
|
||||
"id": "to-list-artifacts-for-a-resource-1471635409527",
|
||||
"title": "To list artifacts for a resource"
|
||||
}
|
||||
],
|
||||
"ListDevicePools": [
|
||||
{
|
||||
"input": {
|
||||
"type": "PRIVATE",
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"output": {
|
||||
"devicePools": [
|
||||
{
|
||||
"name": "Top Devices",
|
||||
"arn": "arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE",
|
||||
"description": "Top devices",
|
||||
"rules": [
|
||||
{
|
||||
"value": "[\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\"]",
|
||||
"attribute": "ARN",
|
||||
"operator": "IN"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"name": "My Android Device Pool",
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:devicepool:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/bf96e75a-28f6-4e61-b6a7-12345EXAMPLE",
|
||||
"description": "Samsung Galaxy Android devices",
|
||||
"rules": [
|
||||
{
|
||||
"value": "[\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\",\"arn:aws:devicefarm:us-west-2::device:123456789EXAMPLE\"]",
|
||||
"attribute": "ARN",
|
||||
"operator": "IN"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the project ARN by using the list-projects CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about the private device pools in a specific project.",
|
||||
"id": "to-get-information-about-device-pools-1471635745170",
|
||||
"title": "To get information about device pools"
|
||||
}
|
||||
],
|
||||
"ListDevices": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the project ARN by using the list-projects CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about the available devices in a specific project.",
|
||||
"id": "to-get-information-about-devices-1471641699344",
|
||||
"title": "To get information about devices"
|
||||
}
|
||||
],
|
||||
"ListJobs": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the project ARN by using the list-jobs CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about jobs in a specific project.",
|
||||
"id": "to-get-information-about-jobs-1471642228071",
|
||||
"title": "To get information about jobs"
|
||||
}
|
||||
],
|
||||
"ListOfferingTransactions": [
|
||||
{
|
||||
"input": {
|
||||
"nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE="
|
||||
},
|
||||
"output": {
|
||||
"offeringTransactions": [
|
||||
{
|
||||
"cost": {
|
||||
"amount": 0,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"createdOn": "1470021420",
|
||||
"offeringStatus": {
|
||||
"type": "RENEW",
|
||||
"effectiveOn": "1472688000",
|
||||
"offering": {
|
||||
"type": "RECURRING",
|
||||
"description": "Android Remote Access Unmetered Device Slot",
|
||||
"id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
|
||||
"platform": "ANDROID"
|
||||
},
|
||||
"quantity": 0
|
||||
},
|
||||
"transactionId": "03728003-d1ea-4851-abd6-12345EXAMPLE"
|
||||
},
|
||||
{
|
||||
"cost": {
|
||||
"amount": 250,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"createdOn": "1470021420",
|
||||
"offeringStatus": {
|
||||
"type": "PURCHASE",
|
||||
"effectiveOn": "1470021420",
|
||||
"offering": {
|
||||
"type": "RECURRING",
|
||||
"description": "Android Remote Access Unmetered Device Slot",
|
||||
"id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
|
||||
"platform": "ANDROID"
|
||||
},
|
||||
"quantity": 1
|
||||
},
|
||||
"transactionId": "56820b6e-06bd-473a-8ff8-12345EXAMPLE"
|
||||
},
|
||||
{
|
||||
"cost": {
|
||||
"amount": 175,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"createdOn": "1465538520",
|
||||
"offeringStatus": {
|
||||
"type": "PURCHASE",
|
||||
"effectiveOn": "1465538520",
|
||||
"offering": {
|
||||
"type": "RECURRING",
|
||||
"description": "Android Unmetered Device Slot",
|
||||
"id": "8980F81C-00D7-469D-8EC6-12345EXAMPLE",
|
||||
"platform": "ANDROID"
|
||||
},
|
||||
"quantity": 1
|
||||
},
|
||||
"transactionId": "953ae2c6-d760-4a04-9597-12345EXAMPLE"
|
||||
},
|
||||
{
|
||||
"cost": {
|
||||
"amount": 8.07,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"createdOn": "1459344300",
|
||||
"offeringStatus": {
|
||||
"type": "PURCHASE",
|
||||
"effectiveOn": "1459344300",
|
||||
"offering": {
|
||||
"type": "RECURRING",
|
||||
"description": "iOS Unmetered Device Slot",
|
||||
"id": "A53D4D73-A6F6-4B82-A0B0-12345EXAMPLE",
|
||||
"platform": "IOS"
|
||||
},
|
||||
"quantity": 1
|
||||
},
|
||||
"transactionId": "2baf9021-ae3e-47f5-ab52-12345EXAMPLE"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"nextToken": "A dynamically generated value, used for paginating results."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about Device Farm offering transactions.",
|
||||
"id": "to-get-information-about-device-offering-transactions-1472561712315",
|
||||
"title": "To get information about device offering transactions"
|
||||
}
|
||||
],
|
||||
"ListOfferings": [
|
||||
{
|
||||
"input": {
|
||||
"nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE="
|
||||
},
|
||||
"output": {
|
||||
"offerings": [
|
||||
{
|
||||
"type": "RECURRING",
|
||||
"description": "iOS Unmetered Device Slot",
|
||||
"id": "A53D4D73-A6F6-4B82-A0B0-12345EXAMPLE",
|
||||
"platform": "IOS",
|
||||
"recurringCharges": [
|
||||
{
|
||||
"cost": {
|
||||
"amount": 250,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"frequency": "MONTHLY"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "RECURRING",
|
||||
"description": "Android Unmetered Device Slot",
|
||||
"id": "8980F81C-00D7-469D-8EC6-12345EXAMPLE",
|
||||
"platform": "ANDROID",
|
||||
"recurringCharges": [
|
||||
{
|
||||
"cost": {
|
||||
"amount": 250,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"frequency": "MONTHLY"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "RECURRING",
|
||||
"description": "Android Remote Access Unmetered Device Slot",
|
||||
"id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
|
||||
"platform": "ANDROID",
|
||||
"recurringCharges": [
|
||||
{
|
||||
"cost": {
|
||||
"amount": 250,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"frequency": "MONTHLY"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "RECURRING",
|
||||
"description": "iOS Remote Access Unmetered Device Slot",
|
||||
"id": "552B4DAD-A6C9-45C4-94FB-12345EXAMPLE",
|
||||
"platform": "IOS",
|
||||
"recurringCharges": [
|
||||
{
|
||||
"cost": {
|
||||
"amount": 250,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"frequency": "MONTHLY"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"nextToken": "A dynamically generated value, used for paginating results."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about available device offerings.",
|
||||
"id": "to-get-information-about-device-offerings-1472562810999",
|
||||
"title": "To get information about device offerings"
|
||||
}
|
||||
],
|
||||
"ListProjects": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE",
|
||||
"nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
|
||||
},
|
||||
"output": {
|
||||
"projects": [
|
||||
{
|
||||
"name": "My Test Project",
|
||||
"arn": "arn:aws:devicefarm:us-west-2:183774035805:project:7ad300ed-8183-41a7-bf94-12345EXAMPLE",
|
||||
"created": "1453163262.105"
|
||||
},
|
||||
{
|
||||
"name": "Hello World",
|
||||
"arn": "arn:aws:devicefarm:us-west-2:183774035805:project:d6b087d9-56db-4e44-b9ec-12345EXAMPLE",
|
||||
"created": "1470350112.439"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"nextToken": "A dynamically generated value, used for paginating results."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about the specified project in Device Farm.",
|
||||
"id": "to-get-information-about-a-device-farm-project-1472564014388",
|
||||
"title": "To get information about a Device Farm project"
|
||||
}
|
||||
],
|
||||
"ListRemoteAccessSessions": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:session:EXAMPLE-GUID-123-456",
|
||||
"nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE="
|
||||
},
|
||||
"output": {
|
||||
"remoteAccessSessions": [
|
||||
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the Amazon Resource Name (ARN) of the session by using the list-sessions CLI command.",
|
||||
"nextToken": "A dynamically generated value, used for paginating results."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about a specific Device Farm remote access session.",
|
||||
"id": "to-get-information-about-a-remote-access-session-1472581144803",
|
||||
"title": "To get information about a remote access session"
|
||||
}
|
||||
],
|
||||
"ListRuns": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE",
|
||||
"nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
|
||||
},
|
||||
"output": {
|
||||
"runs": [
|
||||
{
|
||||
"name": "My Test Run",
|
||||
"type": "BUILTIN_EXPLORER",
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:run:5e01a8c7-c861-4c0a-b1d5-5ec6e6c6dd23/0fcac17b-6122-44d7-ae5a-12345EXAMPLE",
|
||||
"billingMethod": "METERED",
|
||||
"completedJobs": 0,
|
||||
"counters": {
|
||||
"errored": 0,
|
||||
"failed": 0,
|
||||
"passed": 0,
|
||||
"skipped": 0,
|
||||
"stopped": 0,
|
||||
"total": 0,
|
||||
"warned": 0
|
||||
},
|
||||
"created": "1472667509.852",
|
||||
"deviceMinutes": {
|
||||
"metered": 0.0,
|
||||
"total": 0.0,
|
||||
"unmetered": 0.0
|
||||
},
|
||||
"platform": "ANDROID",
|
||||
"result": "PENDING",
|
||||
"status": "RUNNING",
|
||||
"totalJobs": 3
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the Amazon Resource Name (ARN) of the run by using the list-runs CLI command.",
|
||||
"nextToken": "A dynamically generated value, used for paginating results."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about a specific test run.",
|
||||
"id": "to-get-information-about-test-runs-1472582711069",
|
||||
"title": "To get information about a test run"
|
||||
}
|
||||
],
|
||||
"ListSamples": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
|
||||
"nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
|
||||
},
|
||||
"output": {
|
||||
"samples": [
|
||||
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.",
|
||||
"nextToken": "A dynamically generated value, used for paginating results."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about samples, given a specific Device Farm project.",
|
||||
"id": "to-get-information-about-samples-1472582847534",
|
||||
"title": "To get information about samples"
|
||||
}
|
||||
],
|
||||
"ListSuites": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
|
||||
"nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
|
||||
},
|
||||
"output": {
|
||||
"suites": [
|
||||
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.",
|
||||
"nextToken": "A dynamically generated value, used for paginating results."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about suites, given a specific Device Farm project.",
|
||||
"id": "to-get-information-about-suites-1472583038218",
|
||||
"title": "To get information about suites"
|
||||
}
|
||||
],
|
||||
"ListTests": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
|
||||
"nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
|
||||
},
|
||||
"output": {
|
||||
"tests": [
|
||||
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.",
|
||||
"nextToken": "A dynamically generated value, used for paginating results."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about tests, given a specific Device Farm project.",
|
||||
"id": "to-get-information-about-tests-1472617372212",
|
||||
"title": "To get information about tests"
|
||||
}
|
||||
],
|
||||
"ListUniqueProblems": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
|
||||
"nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
|
||||
},
|
||||
"output": {
|
||||
"uniqueProblems": {
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.",
|
||||
"nextToken": "A dynamically generated value, used for paginating results."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about unique problems, given a specific Device Farm project.",
|
||||
"id": "to-get-information-about-unique-problems-1472617781008",
|
||||
"title": "To get information about unique problems"
|
||||
}
|
||||
],
|
||||
"ListUploads": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
|
||||
"nextToken": "RW5DdDJkMWYwZjM2MzM2VHVpOHJIUXlDUXlhc2QzRGViYnc9SEXAMPLE"
|
||||
},
|
||||
"output": {
|
||||
"uploads": [
|
||||
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.",
|
||||
"nextToken": "A dynamically generated value, used for paginating results."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns information about uploads, given a specific Device Farm project.",
|
||||
"id": "to-get-information-about-uploads-1472617943090",
|
||||
"title": "To get information about uploads"
|
||||
}
|
||||
],
|
||||
"PurchaseOffering": [
|
||||
{
|
||||
"input": {
|
||||
"offeringId": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
|
||||
"quantity": 1
|
||||
},
|
||||
"output": {
|
||||
"offeringTransaction": {
|
||||
"cost": {
|
||||
"amount": 8.07,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"createdOn": "1472648340",
|
||||
"offeringStatus": {
|
||||
"type": "PURCHASE",
|
||||
"effectiveOn": "1472648340",
|
||||
"offering": {
|
||||
"type": "RECURRING",
|
||||
"description": "Android Remote Access Unmetered Device Slot",
|
||||
"id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
|
||||
"platform": "ANDROID"
|
||||
},
|
||||
"quantity": 1
|
||||
},
|
||||
"transactionId": "d30614ed-1b03-404c-9893-12345EXAMPLE"
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"offeringId": "You can get the offering ID by using the list-offerings CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example purchases a specific device slot offering.",
|
||||
"id": "to-purchase-a-device-slot-offering-1472648146343",
|
||||
"title": "To purchase a device slot offering"
|
||||
}
|
||||
],
|
||||
"RenewOffering": [
|
||||
{
|
||||
"input": {
|
||||
"offeringId": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
|
||||
"quantity": 1
|
||||
},
|
||||
"output": {
|
||||
"offeringTransaction": {
|
||||
"cost": {
|
||||
"amount": 250,
|
||||
"currencyCode": "USD"
|
||||
},
|
||||
"createdOn": "1472648880",
|
||||
"offeringStatus": {
|
||||
"type": "RENEW",
|
||||
"effectiveOn": "1472688000",
|
||||
"offering": {
|
||||
"type": "RECURRING",
|
||||
"description": "Android Remote Access Unmetered Device Slot",
|
||||
"id": "D68B3C05-1BA6-4360-BC69-12345EXAMPLE",
|
||||
"platform": "ANDROID"
|
||||
},
|
||||
"quantity": 1
|
||||
},
|
||||
"transactionId": "e90f1405-8c35-4561-be43-12345EXAMPLE"
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"offeringId": "You can get the offering ID by using the list-offerings CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example renews a specific device slot offering.",
|
||||
"id": "to-renew-a-device-slot-offering-1472648899785",
|
||||
"title": "To renew a device slot offering"
|
||||
}
|
||||
],
|
||||
"ScheduleRun": [
|
||||
{
|
||||
"input": {
|
||||
"name": "MyRun",
|
||||
"devicePoolArn": "arn:aws:devicefarm:us-west-2:123456789101:pool:EXAMPLE-GUID-123-456",
|
||||
"projectArn": "arn:aws:devicefarm:us-west-2:123456789101:project:EXAMPLE-GUID-123-456",
|
||||
"test": {
|
||||
"type": "APPIUM_JAVA_JUNIT",
|
||||
"testPackageArn": "arn:aws:devicefarm:us-west-2:123456789101:test:EXAMPLE-GUID-123-456"
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"run": {
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"devicePoolArn": "You can get the Amazon Resource Name (ARN) of the device pool by using the list-pools CLI command.",
|
||||
"projectArn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command.",
|
||||
"testPackageArn": "You can get the Amazon Resource Name (ARN) of the test package by using the list-tests CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example schedules a test run named MyRun.",
|
||||
"id": "to-schedule-a-test-run-1472652429636",
|
||||
"title": "To schedule a test run"
|
||||
}
|
||||
],
|
||||
"StopRun": [
|
||||
{
|
||||
"input": {
|
||||
"arn": "arn:aws:devicefarm:us-west-2:123456789101:run:EXAMPLE-GUID-123-456"
|
||||
},
|
||||
"output": {
|
||||
"run": {
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the Amazon Resource Name (ARN) of the test run by using the list-runs CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example stops a specific test run.",
|
||||
"id": "to-stop-a-test-run-1472653770340",
|
||||
"title": "To stop a test run"
|
||||
}
|
||||
],
|
||||
"UpdateDevicePool": [
|
||||
{
|
||||
"input": {
|
||||
"name": "NewName",
|
||||
"arn": "arn:aws:devicefarm:us-west-2::devicepool:082d10e5-d7d7-48a5-ba5c-12345EXAMPLE",
|
||||
"description": "NewDescription",
|
||||
"rules": [
|
||||
{
|
||||
"value": "True",
|
||||
"attribute": "REMOTE_ACCESS_ENABLED",
|
||||
"operator": "EQUALS"
|
||||
}
|
||||
]
|
||||
},
|
||||
"output": {
|
||||
"devicePool": {
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the Amazon Resource Name (ARN) of the device pool by using the list-pools CLI command."
|
||||
},
|
||||
"output": {
|
||||
"devicePool": "Note: you cannot update curated device pools."
|
||||
}
|
||||
},
|
||||
"description": "The following example updates the specified device pool with a new name and description. It also enables remote access of devices in the device pool.",
|
||||
"id": "to-update-a-device-pool-1472653887677",
|
||||
"title": "To update a device pool"
|
||||
}
|
||||
],
|
||||
"UpdateProject": [
|
||||
{
|
||||
"input": {
|
||||
"name": "NewName",
|
||||
"arn": "arn:aws:devicefarm:us-west-2:183774035805:project:8f75187d-101e-4625-accc-12345EXAMPLE"
|
||||
},
|
||||
"output": {
|
||||
"project": {
|
||||
"name": "NewName",
|
||||
"arn": "arn:aws:devicefarm:us-west-2:183774035805:project:8f75187d-101e-4625-accc-12345EXAMPLE",
|
||||
"created": "1448400709.927"
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
"arn": "You can get the Amazon Resource Name (ARN) of the project by using the list-projects CLI command."
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example updates the specified project with a new name.",
|
||||
"id": "to-update-a-device-pool-1472653887677",
|
||||
"title": "To update a device pool"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -54,6 +54,24 @@
|
|||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "uploads"
|
||||
},
|
||||
"GetOfferingStatus": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"result_key": [
|
||||
"current",
|
||||
"nextPeriod"
|
||||
]
|
||||
},
|
||||
"ListOfferingTransactions": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "offeringTransactions"
|
||||
},
|
||||
"ListOfferings": {
|
||||
"input_token": "nextToken",
|
||||
"output_token": "nextToken",
|
||||
"result_key": "offerings"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -27,6 +27,22 @@
|
|||
],
|
||||
"documentation":"<p>Creates a device pool.</p>"
|
||||
},
|
||||
"CreateNetworkProfile":{
|
||||
"name":"CreateNetworkProfile",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateNetworkProfileRequest"},
|
||||
"output":{"shape":"CreateNetworkProfileResult"},
|
||||
"errors":[
|
||||
{"shape":"ArgumentException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceAccountException"}
|
||||
],
|
||||
"documentation":"<p>Creates a network profile.</p>"
|
||||
},
|
||||
"CreateProject":{
|
||||
"name":"CreateProject",
|
||||
"http":{
|
||||
|
|
@ -91,6 +107,22 @@
|
|||
],
|
||||
"documentation":"<p>Deletes a device pool given the pool ARN. Does not allow deletion of curated pools owned by the system.</p>"
|
||||
},
|
||||
"DeleteNetworkProfile":{
|
||||
"name":"DeleteNetworkProfile",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteNetworkProfileRequest"},
|
||||
"output":{"shape":"DeleteNetworkProfileResult"},
|
||||
"errors":[
|
||||
{"shape":"ArgumentException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceAccountException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a network profile.</p>"
|
||||
},
|
||||
"DeleteProject":{
|
||||
"name":"DeleteProject",
|
||||
"http":{
|
||||
|
|
@ -235,6 +267,22 @@
|
|||
],
|
||||
"documentation":"<p>Gets information about a job.</p>"
|
||||
},
|
||||
"GetNetworkProfile":{
|
||||
"name":"GetNetworkProfile",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"GetNetworkProfileRequest"},
|
||||
"output":{"shape":"GetNetworkProfileResult"},
|
||||
"errors":[
|
||||
{"shape":"ArgumentException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceAccountException"}
|
||||
],
|
||||
"documentation":"<p>Returns information about a network profile.</p>"
|
||||
},
|
||||
"GetOfferingStatus":{
|
||||
"name":"GetOfferingStatus",
|
||||
"http":{
|
||||
|
|
@ -428,6 +476,39 @@
|
|||
],
|
||||
"documentation":"<p>Gets information about jobs.</p>"
|
||||
},
|
||||
"ListNetworkProfiles":{
|
||||
"name":"ListNetworkProfiles",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListNetworkProfilesRequest"},
|
||||
"output":{"shape":"ListNetworkProfilesResult"},
|
||||
"errors":[
|
||||
{"shape":"ArgumentException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceAccountException"}
|
||||
],
|
||||
"documentation":"<p>Returns the list of available network profiles.</p>"
|
||||
},
|
||||
"ListOfferingPromotions":{
|
||||
"name":"ListOfferingPromotions",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ListOfferingPromotionsRequest"},
|
||||
"output":{"shape":"ListOfferingPromotionsResult"},
|
||||
"errors":[
|
||||
{"shape":"ArgumentException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"NotEligibleException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceAccountException"}
|
||||
],
|
||||
"documentation":"<p>Returns a list of offering promotions. Each offering promotion record contains the ID and description of the promotion. The API returns a <code>NotEligible</code> error if the caller is not permitted to invoke the operation. Contact <a href=\"mailto:aws-devicefarm-support@amazon.com\">aws-devicefarm-support@amazon.com</a> if you believe that you should be able to invoke this operation.</p>"
|
||||
},
|
||||
"ListOfferingTransactions":{
|
||||
"name":"ListOfferingTransactions",
|
||||
"http":{
|
||||
|
|
@ -689,6 +770,22 @@
|
|||
],
|
||||
"documentation":"<p>Modifies the name, description, and rules in a device pool given the attributes and the pool ARN. Rule updates are all-or-nothing, meaning they can only be updated as a whole (or not at all).</p>"
|
||||
},
|
||||
"UpdateNetworkProfile":{
|
||||
"name":"UpdateNetworkProfile",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateNetworkProfileRequest"},
|
||||
"output":{"shape":"UpdateNetworkProfileResult"},
|
||||
"errors":[
|
||||
{"shape":"ArgumentException"},
|
||||
{"shape":"NotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"ServiceAccountException"}
|
||||
],
|
||||
"documentation":"<p>Updates the network profile with specific settings.</p>"
|
||||
},
|
||||
"UpdateProject":{
|
||||
"name":"UpdateProject",
|
||||
"http":{
|
||||
|
|
@ -726,10 +823,27 @@
|
|||
"unmeteredRemoteAccessDevices":{
|
||||
"shape":"PurchasedDevicesMap",
|
||||
"documentation":"<p>Returns the unmetered remote access devices you have purchased or want to purchase.</p>"
|
||||
},
|
||||
"maxJobTimeoutMinutes":{
|
||||
"shape":"JobTimeoutMinutes",
|
||||
"documentation":"<p>The maximum number of minutes a test run will execute before it times out.</p>"
|
||||
},
|
||||
"trialMinutes":{
|
||||
"shape":"TrialMinutes",
|
||||
"documentation":"<p>Information about an AWS account's usage of free trial device minutes.</p>"
|
||||
},
|
||||
"maxSlots":{
|
||||
"shape":"MaxSlotMap",
|
||||
"documentation":"<p>The maximum number of device slots that the AWS account can purchase. Each maximum is expressed as an <code>offering-id:number</code> pair, where the <code>offering-id</code> represents one of the IDs returned by the <code>ListOfferings</code> command.</p>"
|
||||
},
|
||||
"defaultJobTimeoutMinutes":{
|
||||
"shape":"JobTimeoutMinutes",
|
||||
"documentation":"<p>The default number of minutes (at the account level) a test run will execute before it times out. Default value is 60 minutes.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A container for account-level settings within AWS Device Farm.</p>"
|
||||
},
|
||||
"AccountsCleanup":{"type":"boolean"},
|
||||
"AmazonResourceName":{
|
||||
"type":"string",
|
||||
"min":32
|
||||
|
|
@ -738,6 +852,7 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"AmazonResourceName"}
|
||||
},
|
||||
"AppPackagesCleanup":{"type":"boolean"},
|
||||
"ArgumentException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -919,6 +1034,72 @@
|
|||
},
|
||||
"documentation":"<p>Represents the result of a create device pool request.</p>"
|
||||
},
|
||||
"CreateNetworkProfileRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"projectArn",
|
||||
"name"
|
||||
],
|
||||
"members":{
|
||||
"projectArn":{
|
||||
"shape":"AmazonResourceName",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the project for which you want to create a network profile.</p>"
|
||||
},
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name you wish to specify for the new network profile.</p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"Message",
|
||||
"documentation":"<p>The description of the network profile.</p>"
|
||||
},
|
||||
"type":{
|
||||
"shape":"NetworkProfileType",
|
||||
"documentation":"<p>The type of network profile you wish to create. Valid values are listed below.</p>"
|
||||
},
|
||||
"uplinkBandwidthBits":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The data throughput rate in bits per second, as an integer from 0 to 104857600.</p>"
|
||||
},
|
||||
"downlinkBandwidthBits":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The data throughput rate in bits per second, as an integer from 0 to 104857600.</p>"
|
||||
},
|
||||
"uplinkDelayMs":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.</p>"
|
||||
},
|
||||
"downlinkDelayMs":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.</p>"
|
||||
},
|
||||
"uplinkJitterMs":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.</p>"
|
||||
},
|
||||
"downlinkJitterMs":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.</p>"
|
||||
},
|
||||
"uplinkLossPercent":{
|
||||
"shape":"PercentInteger",
|
||||
"documentation":"<p>Proportion of transmitted packets that fail to arrive from 0 to 100 percent.</p>"
|
||||
},
|
||||
"downlinkLossPercent":{
|
||||
"shape":"PercentInteger",
|
||||
"documentation":"<p>Proportion of received packets that fail to arrive from 0 to 100 percent.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateNetworkProfileResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"networkProfile":{
|
||||
"shape":"NetworkProfile",
|
||||
"documentation":"<p>The network profile that is returned by the create network profile request.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"CreateProjectRequest":{
|
||||
"type":"structure",
|
||||
"required":["name"],
|
||||
|
|
@ -926,6 +1107,10 @@
|
|||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The project's name.</p>"
|
||||
},
|
||||
"defaultJobTimeoutMinutes":{
|
||||
"shape":"JobTimeoutMinutes",
|
||||
"documentation":"<p>Sets the execution timeout value (in minutes) for a project. All test runs in this project will use the specified execution timeout value unless overridden when scheduling a run.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents a request to the create project operation.</p>"
|
||||
|
|
@ -1045,6 +1230,21 @@
|
|||
},
|
||||
"documentation":"<p>Represents the result of a delete device pool request.</p>"
|
||||
},
|
||||
"DeleteNetworkProfileRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
"members":{
|
||||
"arn":{
|
||||
"shape":"AmazonResourceName",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the network profile you want to delete.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DeleteNetworkProfileResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
}
|
||||
},
|
||||
"DeleteProjectRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
|
|
@ -1148,7 +1348,10 @@
|
|||
"shape":"CPU",
|
||||
"documentation":"<p>Information about the device's CPU.</p>"
|
||||
},
|
||||
"resolution":{"shape":"Resolution"},
|
||||
"resolution":{
|
||||
"shape":"Resolution",
|
||||
"documentation":"<p>The resolution of the device.</p>"
|
||||
},
|
||||
"heapSize":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The device's heap size, expressed in bytes.</p>"
|
||||
|
|
@ -1191,7 +1394,8 @@
|
|||
"PLATFORM",
|
||||
"FORM_FACTOR",
|
||||
"MANUFACTURER",
|
||||
"REMOTE_ACCESS_ENABLED"
|
||||
"REMOTE_ACCESS_ENABLED",
|
||||
"APPIUM_VERSION"
|
||||
]
|
||||
},
|
||||
"DeviceFormFactor":{
|
||||
|
|
@ -1255,7 +1459,10 @@
|
|||
"DevicePoolCompatibilityResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"device":{"shape":"Device"},
|
||||
"device":{
|
||||
"shape":"Device",
|
||||
"documentation":"<p>The device (phone or tablet) that you wish to return information about.</p>"
|
||||
},
|
||||
"compatible":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Whether the result was compatible with the device pool.</p>"
|
||||
|
|
@ -1287,6 +1494,24 @@
|
|||
"member":{"shape":"Device"}
|
||||
},
|
||||
"Double":{"type":"double"},
|
||||
"ExecutionConfiguration":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"jobTimeoutMinutes":{
|
||||
"shape":"JobTimeoutMinutes",
|
||||
"documentation":"<p>The number of minutes a test run will execute before it times out.</p>"
|
||||
},
|
||||
"accountsCleanup":{
|
||||
"shape":"AccountsCleanup",
|
||||
"documentation":"<p>True if account cleanup is enabled at the beginning of the test; otherwise, false.</p>"
|
||||
},
|
||||
"appPackagesCleanup":{
|
||||
"shape":"AppPackagesCleanup",
|
||||
"documentation":"<p>True if app package cleanup is enabled at the beginning of the test; otherwise, false.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents configuration information about a test run, such as the execution timeout (in minutes).</p>"
|
||||
},
|
||||
"ExecutionResult":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
|
|
@ -1327,7 +1552,10 @@
|
|||
"GetAccountSettingsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"accountSettings":{"shape":"AccountSettings"}
|
||||
"accountSettings":{
|
||||
"shape":"AccountSettings",
|
||||
"documentation":"<p>The account settings.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the account settings return values from the <code>GetAccountSettings</code> request.</p>"
|
||||
},
|
||||
|
|
@ -1346,6 +1574,10 @@
|
|||
"testType":{
|
||||
"shape":"TestType",
|
||||
"documentation":"<p>The test type for the specified device pool.</p> <p>Allowed values include the following:</p> <ul> <li> <p>BUILTIN_FUZZ: The built-in fuzz type.</p> </li> <li> <p>BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.</p> </li> <li> <p>APPIUM_JAVA_JUNIT: The Appium Java JUnit type.</p> </li> <li> <p>APPIUM_JAVA_TESTNG: The Appium Java TestNG type.</p> </li> <li> <p>APPIUM_PYTHON: The Appium Python type.</p> </li> <li> <p>APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.</p> </li> <li> <p>APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.</p> </li> <li> <p>APPIUM_WEB_PYTHON: The Appium Python type for Web apps.</p> </li> <li> <p>CALABASH: The Calabash type.</p> </li> <li> <p>INSTRUMENTATION: The Instrumentation type.</p> </li> <li> <p>UIAUTOMATION: The uiautomation type.</p> </li> <li> <p>UIAUTOMATOR: The uiautomator type.</p> </li> <li> <p>XCTEST: The XCode test type.</p> </li> <li> <p>XCTEST_UI: The XCode UI test type.</p> </li> </ul>"
|
||||
},
|
||||
"test":{
|
||||
"shape":"ScheduleRunTest",
|
||||
"documentation":"<p>Information about the uploaded test to be run against the device pool.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents a request to the get device pool compatibility operation.</p>"
|
||||
|
|
@ -1378,7 +1610,10 @@
|
|||
"GetDevicePoolResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"devicePool":{"shape":"DevicePool"}
|
||||
"devicePool":{
|
||||
"shape":"DevicePool",
|
||||
"documentation":"<p>An object containing information about the requested device pool.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the result of a get device pool request.</p>"
|
||||
},
|
||||
|
|
@ -1396,7 +1631,10 @@
|
|||
"GetDeviceResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"device":{"shape":"Device"}
|
||||
"device":{
|
||||
"shape":"Device",
|
||||
"documentation":"<p>An object containing information about the requested device.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the result of a get device request.</p>"
|
||||
},
|
||||
|
|
@ -1414,10 +1652,32 @@
|
|||
"GetJobResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"job":{"shape":"Job"}
|
||||
"job":{
|
||||
"shape":"Job",
|
||||
"documentation":"<p>An object containing information about the requested job.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the result of a get job request.</p>"
|
||||
},
|
||||
"GetNetworkProfileRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
"members":{
|
||||
"arn":{
|
||||
"shape":"AmazonResourceName",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the network profile you want to return information about.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetNetworkProfileResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"networkProfile":{
|
||||
"shape":"NetworkProfile",
|
||||
"documentation":"<p>The network profile.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"GetOfferingStatusRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1460,7 +1720,10 @@
|
|||
"GetProjectResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"project":{"shape":"Project"}
|
||||
"project":{
|
||||
"shape":"Project",
|
||||
"documentation":"<p>The project you wish to get information about.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the result of a get project request.</p>"
|
||||
},
|
||||
|
|
@ -1499,7 +1762,10 @@
|
|||
"GetRunResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"run":{"shape":"Run"}
|
||||
"run":{
|
||||
"shape":"Run",
|
||||
"documentation":"<p>The run you wish to get results from.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the result of a get run request.</p>"
|
||||
},
|
||||
|
|
@ -1517,7 +1783,10 @@
|
|||
"GetSuiteResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"suite":{"shape":"Suite"}
|
||||
"suite":{
|
||||
"shape":"Suite",
|
||||
"documentation":"<p>A collection of one or more tests.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the result of a get suite request.</p>"
|
||||
},
|
||||
|
|
@ -1535,7 +1804,10 @@
|
|||
"GetTestResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"test":{"shape":"Test"}
|
||||
"test":{
|
||||
"shape":"Test",
|
||||
"documentation":"<p>A test condition that is evaluated.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the result of a get test request.</p>"
|
||||
},
|
||||
|
|
@ -1553,7 +1825,10 @@
|
|||
"GetUploadResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"upload":{"shape":"Upload"}
|
||||
"upload":{
|
||||
"shape":"Upload",
|
||||
"documentation":"<p>An app or a set of one or more tests to upload or that have been uploaded.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the result of a get upload request.</p>"
|
||||
},
|
||||
|
|
@ -1577,7 +1852,7 @@
|
|||
},
|
||||
"type":{
|
||||
"shape":"DeviceAttribute",
|
||||
"documentation":"<p>The type of incompatibility.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The ARN.</p> </li> <li> <p>FORM_FACTOR: The form factor (for example, phone or tablet).</p> </li> <li> <p>MANUFACTURER: The manufacturer.</p> </li> <li> <p>PLATFORM: The platform (for example, Android or iOS).</p> </li> </ul>"
|
||||
"documentation":"<p>The type of incompatibility.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The ARN.</p> </li> <li> <p>FORM_FACTOR: The form factor (for example, phone or tablet).</p> </li> <li> <p>MANUFACTURER: The manufacturer.</p> </li> <li> <p>PLATFORM: The platform (for example, Android or iOS).</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.</p> </li> <li> <p>APPIUM_VERSION: The Appium version for the test.</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents information about incompatibility.</p>"
|
||||
|
|
@ -1607,7 +1882,10 @@
|
|||
"InstallToRemoteAccessSessionResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"appUpload":{"shape":"Upload"}
|
||||
"appUpload":{
|
||||
"shape":"Upload",
|
||||
"documentation":"<p>An app to upload or that has been uploaded.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the response from the server after AWS Device Farm makes a request to install to a remote access session.</p>"
|
||||
},
|
||||
|
|
@ -1655,7 +1933,10 @@
|
|||
"shape":"Message",
|
||||
"documentation":"<p>A message about the job's result.</p>"
|
||||
},
|
||||
"device":{"shape":"Device"},
|
||||
"device":{
|
||||
"shape":"Device",
|
||||
"documentation":"<p>The device (phone or tablet).</p>"
|
||||
},
|
||||
"deviceMinutes":{
|
||||
"shape":"DeviceMinutes",
|
||||
"documentation":"<p>Represents the total (metered or unmetered) minutes used by the job.</p>"
|
||||
|
|
@ -1663,6 +1944,7 @@
|
|||
},
|
||||
"documentation":"<p>Represents a device.</p>"
|
||||
},
|
||||
"JobTimeoutMinutes":{"type":"integer"},
|
||||
"Jobs":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Job"}
|
||||
|
|
@ -1804,6 +2086,59 @@
|
|||
},
|
||||
"documentation":"<p>Represents the result of a list jobs request.</p>"
|
||||
},
|
||||
"ListNetworkProfilesRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
"members":{
|
||||
"arn":{
|
||||
"shape":"AmazonResourceName",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the project for which you want to list network profiles.</p>"
|
||||
},
|
||||
"type":{
|
||||
"shape":"NetworkProfileType",
|
||||
"documentation":"<p>The type of network profile you wish to return information about. Valid values are listed below.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListNetworkProfilesResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"networkProfiles":{
|
||||
"shape":"NetworkProfiles",
|
||||
"documentation":"<p>A list of the available network profiles.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListOfferingPromotionsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListOfferingPromotionsResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"offeringPromotions":{
|
||||
"shape":"OfferingPromotions",
|
||||
"documentation":"<p>Information about the offering promotions.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"PaginationToken",
|
||||
"documentation":"<p>An identifier to be used in the next call to this operation, to return the next set of items in the list.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ListOfferingTransactionsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2102,6 +2437,11 @@
|
|||
"documentation":"<p>Represents a latitude and longitude pair, expressed in geographic coordinate system degrees (for example 47.6204, -122.3491).</p> <p>Elevation is currently not supported.</p>"
|
||||
},
|
||||
"Long":{"type":"long"},
|
||||
"MaxSlotMap":{
|
||||
"type":"map",
|
||||
"key":{"shape":"String"},
|
||||
"value":{"shape":"Integer"}
|
||||
},
|
||||
"Message":{
|
||||
"type":"string",
|
||||
"max":16384,
|
||||
|
|
@ -2131,6 +2471,71 @@
|
|||
"max":256,
|
||||
"min":0
|
||||
},
|
||||
"NetworkProfile":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"arn":{
|
||||
"shape":"AmazonResourceName",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the network profile.</p>"
|
||||
},
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name of the network profile.</p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"Message",
|
||||
"documentation":"<p>The description of the network profile.</p>"
|
||||
},
|
||||
"type":{
|
||||
"shape":"NetworkProfileType",
|
||||
"documentation":"<p>The type of network profile. Valid values are listed below.</p>"
|
||||
},
|
||||
"uplinkBandwidthBits":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The data throughput rate in bits per second, as an integer from 0 to 104857600.</p>"
|
||||
},
|
||||
"downlinkBandwidthBits":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The data throughput rate in bits per second, as an integer from 0 to 104857600.</p>"
|
||||
},
|
||||
"uplinkDelayMs":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.</p>"
|
||||
},
|
||||
"downlinkDelayMs":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.</p>"
|
||||
},
|
||||
"uplinkJitterMs":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.</p>"
|
||||
},
|
||||
"downlinkJitterMs":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.</p>"
|
||||
},
|
||||
"uplinkLossPercent":{
|
||||
"shape":"PercentInteger",
|
||||
"documentation":"<p>Proportion of transmitted packets that fail to arrive from 0 to 100 percent.</p>"
|
||||
},
|
||||
"downlinkLossPercent":{
|
||||
"shape":"PercentInteger",
|
||||
"documentation":"<p>Proportion of received packets that fail to arrive from 0 to 100 percent.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An array of settings that describes characteristics of a network profile.</p>"
|
||||
},
|
||||
"NetworkProfileType":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"CURATED",
|
||||
"PRIVATE"
|
||||
]
|
||||
},
|
||||
"NetworkProfiles":{
|
||||
"type":"list",
|
||||
"member":{"shape":"NetworkProfile"}
|
||||
},
|
||||
"NotEligibleException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2183,6 +2588,28 @@
|
|||
"type":"string",
|
||||
"min":32
|
||||
},
|
||||
"OfferingPromotion":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"id":{
|
||||
"shape":"OfferingPromotionIdentifier",
|
||||
"documentation":"<p>The ID of the offering promotion.</p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"Message",
|
||||
"documentation":"<p>A string describing the offering promotion.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents information about an offering promotion.</p>"
|
||||
},
|
||||
"OfferingPromotionIdentifier":{
|
||||
"type":"string",
|
||||
"min":4
|
||||
},
|
||||
"OfferingPromotions":{
|
||||
"type":"list",
|
||||
"member":{"shape":"OfferingPromotion"}
|
||||
},
|
||||
"OfferingStatus":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2221,6 +2648,10 @@
|
|||
"shape":"TransactionIdentifier",
|
||||
"documentation":"<p>The transaction ID of the offering transaction.</p>"
|
||||
},
|
||||
"offeringPromotionId":{
|
||||
"shape":"OfferingPromotionIdentifier",
|
||||
"documentation":"<p>The ID that corresponds to a device offering promotion.</p>"
|
||||
},
|
||||
"createdOn":{
|
||||
"shape":"DateTime",
|
||||
"documentation":"<p>The date on which an offering transaction was created.</p>"
|
||||
|
|
@ -2257,6 +2688,11 @@
|
|||
"max":1024,
|
||||
"min":4
|
||||
},
|
||||
"PercentInteger":{
|
||||
"type":"integer",
|
||||
"max":100,
|
||||
"min":0
|
||||
},
|
||||
"Problem":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2320,6 +2756,10 @@
|
|||
"shape":"Name",
|
||||
"documentation":"<p>The project's name.</p>"
|
||||
},
|
||||
"defaultJobTimeoutMinutes":{
|
||||
"shape":"JobTimeoutMinutes",
|
||||
"documentation":"<p>The default number of minutes (at the project level) a test run will execute before it times out. Default value is 60 minutes.</p>"
|
||||
},
|
||||
"created":{
|
||||
"shape":"DateTime",
|
||||
"documentation":"<p>When the project was created.</p>"
|
||||
|
|
@ -2341,6 +2781,10 @@
|
|||
"quantity":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The number of device slots you wish to purchase in an offering request.</p>"
|
||||
},
|
||||
"offeringPromotionId":{
|
||||
"shape":"OfferingPromotionIdentifier",
|
||||
"documentation":"<p>The ID of the offering promotion to be applied to the purchase.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents a request for a purchase offering.</p>"
|
||||
|
|
@ -2439,12 +2883,18 @@
|
|||
"shape":"DateTime",
|
||||
"documentation":"<p>The date and time the remote access session was stopped.</p>"
|
||||
},
|
||||
"device":{"shape":"Device"},
|
||||
"device":{
|
||||
"shape":"Device",
|
||||
"documentation":"<p>The device (phone or tablet) used in the remote access session.</p>"
|
||||
},
|
||||
"billingMethod":{
|
||||
"shape":"BillingMethod",
|
||||
"documentation":"<p>The billing method of the remote access session. Possible values include <code>METERED</code> or <code>UNMETERED</code>. For more information about metered devices, see <a href=\"http://docs.aws.amazon.com/devicefarm/latest/developerguide/welcome.html#welcome-terminology\">AWS Device Farm terminology</a>.\"</p>"
|
||||
},
|
||||
"deviceMinutes":{"shape":"DeviceMinutes"},
|
||||
"deviceMinutes":{
|
||||
"shape":"DeviceMinutes",
|
||||
"documentation":"<p>The number of minutes a device is used in a remote access sesssion (including setup and teardown minutes).</p>"
|
||||
},
|
||||
"endpoint":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The endpoint for the remote access sesssion.</p>"
|
||||
|
|
@ -2499,11 +2949,11 @@
|
|||
"members":{
|
||||
"attribute":{
|
||||
"shape":"DeviceAttribute",
|
||||
"documentation":"<p>The rule's stringified attribute. For example, specify the value as <code>\"\\\"abc\\\"\"</code>.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The ARN.</p> </li> <li> <p>FORM_FACTOR: The form factor (for example, phone or tablet).</p> </li> <li> <p>MANUFACTURER: The manufacturer.</p> </li> <li> <p>PLATFORM: The platform (for example, Android or iOS).</p> </li> </ul>"
|
||||
"documentation":"<p>The rule's stringified attribute. For example, specify the value as <code>\"\\\"abc\\\"\"</code>.</p> <p>Allowed values include:</p> <ul> <li> <p>ARN: The ARN.</p> </li> <li> <p>FORM_FACTOR: The form factor (for example, phone or tablet).</p> </li> <li> <p>MANUFACTURER: The manufacturer.</p> </li> <li> <p>PLATFORM: The platform (for example, Android or iOS).</p> </li> <li> <p>REMOTE_ACCESS_ENABLED: Whether the device is enabled for remote access.</p> </li> <li> <p>APPIUM_VERSION: The Appium version for the test.</p> </li> </ul>"
|
||||
},
|
||||
"operator":{
|
||||
"shape":"RuleOperator",
|
||||
"documentation":"<p>The rule's operator.</p> <ul> <li> <p>EQUALS: The equals operator.</p> </li> <li> <p>GREATER_THAN: The greater-than operator.</p> </li> <li> <p>IN: The in operator.</p> </li> <li> <p>LESS_THAN: The less-than operator.</p> </li> <li> <p>NOT_IN: The not-in operator.</p> </li> </ul>"
|
||||
"documentation":"<p>The rule's operator.</p> <ul> <li> <p>EQUALS: The equals operator.</p> </li> <li> <p>GREATER_THAN: The greater-than operator.</p> </li> <li> <p>IN: The in operator.</p> </li> <li> <p>LESS_THAN: The less-than operator.</p> </li> <li> <p>NOT_IN: The not-in operator.</p> </li> <li> <p>CONTAINS: The contains operator.</p> </li> </ul>"
|
||||
},
|
||||
"value":{
|
||||
"shape":"String",
|
||||
|
|
@ -2519,7 +2969,8 @@
|
|||
"LESS_THAN",
|
||||
"GREATER_THAN",
|
||||
"IN",
|
||||
"NOT_IN"
|
||||
"NOT_IN",
|
||||
"CONTAINS"
|
||||
]
|
||||
},
|
||||
"Rules":{
|
||||
|
|
@ -2588,6 +3039,10 @@
|
|||
"deviceMinutes":{
|
||||
"shape":"DeviceMinutes",
|
||||
"documentation":"<p>Represents the total (metered or unmetered) minutes used by the test run.</p>"
|
||||
},
|
||||
"networkProfile":{
|
||||
"shape":"NetworkProfile",
|
||||
"documentation":"<p>The network profile being used for a test run.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents an app on a set of devices with a specific test and configuration.</p>"
|
||||
|
|
@ -2705,6 +3160,10 @@
|
|||
"configuration":{
|
||||
"shape":"ScheduleRunConfiguration",
|
||||
"documentation":"<p>Information about the settings for the run to be scheduled.</p>"
|
||||
},
|
||||
"executionConfiguration":{
|
||||
"shape":"ExecutionConfiguration",
|
||||
"documentation":"<p>Specifies configuration information about a test run, such as the execution timeout (in minutes).</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents a request to the schedule run operation.</p>"
|
||||
|
|
@ -2737,7 +3196,7 @@
|
|||
},
|
||||
"parameters":{
|
||||
"shape":"TestParameters",
|
||||
"documentation":"<p>The test's parameters, such as test framework parameters and fixture settings.</p>"
|
||||
"documentation":"<p>The test's parameters, such as the following test framework parameters and fixture settings:</p> <p>For Calabash tests:</p> <ul> <li> <p>profile: A cucumber profile, for example, \"my_profile_name\".</p> </li> <li> <p>tags: You can limit execution to features or scenarios that have (or don't have) certain tags, for example, \"@smoke\" or \"@smoke,~@wip\".</p> </li> </ul> <p>For Appium tests (all types):</p> <ul> <li> <p>appium_version: The Appium version. Currently supported values are \"1.4.16\", \"1.6.3\", \"latest\", and \"default\".</p> <ul> <li> <p>“latest” will run the latest Appium version supported by Device Farm (1.6.3).</p> </li> <li> <p>For “default”, Device Farm will choose a compatible version of Appium for the device. The current behavior is to run 1.4.16 on Android devices and iOS 9 and earlier, 1.6.3 for iOS 10 and later.</p> </li> <li> <p>This behavior is subject to change.</p> </li> </ul> </li> </ul> <p>For Fuzz tests (Android only):</p> <ul> <li> <p>event_count: The number of events, between 1 and 10000, that the UI fuzz test should perform.</p> </li> <li> <p>throttle: The time, in ms, between 0 and 1000, that the UI fuzz test should wait between events.</p> </li> <li> <p>seed: A seed to use for randomizing the UI fuzz test. Using the same seed value between tests ensures identical event sequences.</p> </li> </ul> <p>For Explorer tests:</p> <ul> <li> <p>username: A username to use if the Explorer encounters a login form. If not supplied, no username will be inserted.</p> </li> <li> <p>password: A password to use if the Explorer encounters a login form. If not supplied, no password will be inserted.</p> </li> </ul> <p>For Instrumentation:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test case: \"com.android.abc.Test1\"</p> </li> <li> <p>Running a single test: \"com.android.abc.Test1#smoke\"</p> </li> <li> <p>Running multiple tests: \"com.android.abc.Test1,com.android.abc.Test2\"</p> </li> </ul> </li> </ul> <p>For XCTest and XCTestUI:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test class: \"LoginTests\"</p> </li> <li> <p>Running a multiple test classes: \"LoginTests,SmokeTests\"</p> </li> <li> <p>Running a single test: \"LoginTests/testValid\"</p> </li> <li> <p>Running multiple tests: \"LoginTests/testValid,LoginTests/testInvalid\"</p> </li> </ul> </li> </ul> <p>For UIAutomator:</p> <ul> <li> <p>filter: A test filter string. Examples:</p> <ul> <li> <p>Running a single test case: \"com.android.abc.Test1\"</p> </li> <li> <p>Running a single test: \"com.android.abc.Test1#smoke\"</p> </li> <li> <p>Running multiple tests: \"com.android.abc.Test1,com.android.abc.Test2\"</p> </li> </ul> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents additional test settings.</p>"
|
||||
|
|
@ -2788,7 +3247,10 @@
|
|||
"StopRunResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"run":{"shape":"Run"}
|
||||
"run":{
|
||||
"shape":"Run",
|
||||
"documentation":"<p>The run that was stopped.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the results of your stop run attempt.</p>"
|
||||
},
|
||||
|
|
@ -2929,6 +3391,20 @@
|
|||
"type":"string",
|
||||
"min":32
|
||||
},
|
||||
"TrialMinutes":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"total":{
|
||||
"shape":"Double",
|
||||
"documentation":"<p>The total number of free trial minutes that the account started with.</p>"
|
||||
},
|
||||
"remaining":{
|
||||
"shape":"Double",
|
||||
"documentation":"<p>The number of free trial minutes remaining in the account.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents information about free trial device minutes for an AWS account.</p>"
|
||||
},
|
||||
"URL":{
|
||||
"type":"string",
|
||||
"max":2048,
|
||||
|
|
@ -2983,10 +3459,76 @@
|
|||
"UpdateDevicePoolResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"devicePool":{"shape":"DevicePool"}
|
||||
"devicePool":{
|
||||
"shape":"DevicePool",
|
||||
"documentation":"<p>The device pool you just updated.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the result of an update device pool request.</p>"
|
||||
},
|
||||
"UpdateNetworkProfileRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
"members":{
|
||||
"arn":{
|
||||
"shape":"AmazonResourceName",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the project that you wish to update network profile settings.</p>"
|
||||
},
|
||||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>The name of the network profile about which you are returning information.</p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"Message",
|
||||
"documentation":"<p>The descriptoin of the network profile about which you are returning information.</p>"
|
||||
},
|
||||
"type":{
|
||||
"shape":"NetworkProfileType",
|
||||
"documentation":"<p>The type of network profile you wish to return information about. Valid values are listed below.</p>"
|
||||
},
|
||||
"uplinkBandwidthBits":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The data throughput rate in bits per second, as an integer from 0 to 104857600.</p>"
|
||||
},
|
||||
"downlinkBandwidthBits":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The data throughput rate in bits per second, as an integer from 0 to 104857600.</p>"
|
||||
},
|
||||
"uplinkDelayMs":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.</p>"
|
||||
},
|
||||
"downlinkDelayMs":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Delay time for all packets to destination in milliseconds as an integer from 0 to 2000.</p>"
|
||||
},
|
||||
"uplinkJitterMs":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.</p>"
|
||||
},
|
||||
"downlinkJitterMs":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Time variation in the delay of received packets in milliseconds as an integer from 0 to 2000.</p>"
|
||||
},
|
||||
"uplinkLossPercent":{
|
||||
"shape":"PercentInteger",
|
||||
"documentation":"<p>Proportion of transmitted packets that fail to arrive from 0 to 100 percent.</p>"
|
||||
},
|
||||
"downlinkLossPercent":{
|
||||
"shape":"PercentInteger",
|
||||
"documentation":"<p>Proportion of received packets that fail to arrive from 0 to 100 percent.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateNetworkProfileResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"networkProfile":{
|
||||
"shape":"NetworkProfile",
|
||||
"documentation":"<p>A list of the available network profiles.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"UpdateProjectRequest":{
|
||||
"type":"structure",
|
||||
"required":["arn"],
|
||||
|
|
@ -2998,6 +3540,10 @@
|
|||
"name":{
|
||||
"shape":"Name",
|
||||
"documentation":"<p>A string representing the new name of the project that you are updating.</p>"
|
||||
},
|
||||
"defaultJobTimeoutMinutes":{
|
||||
"shape":"JobTimeoutMinutes",
|
||||
"documentation":"<p>The number of minutes a test run in the project will execute before it times out.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents a request to the update project operation.</p>"
|
||||
|
|
@ -3005,7 +3551,10 @@
|
|||
"UpdateProjectResult":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"project":{"shape":"Project"}
|
||||
"project":{
|
||||
"shape":"Project",
|
||||
"documentation":"<p>The project you wish to update.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the result of an update project request.</p>"
|
||||
},
|
||||
|
|
|
|||
5
botocore/data/directconnect/2012-10-25/examples-1.json
Normal file
5
botocore/data/directconnect/2012-10-25/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
3
botocore/data/directconnect/2012-10-25/paginators-1.json
Normal file
3
botocore/data/directconnect/2012-10-25/paginators-1.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
|
|
@ -23,7 +23,22 @@
|
|||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Creates a hosted connection on an interconnect.</p> <p>Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>"
|
||||
"documentation":"<p>Deprecated in favor of <a>AllocateHostedConnection</a>.</p> <p>Creates a hosted connection on an interconnect.</p> <p>Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>",
|
||||
"deprecated":true
|
||||
},
|
||||
"AllocateHostedConnection":{
|
||||
"name":"AllocateHostedConnection",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"AllocateHostedConnectionRequest"},
|
||||
"output":{"shape":"Connection"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Creates a hosted connection on an interconnect or a link aggregation group (LAG).</p> <p>Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the given interconnect or LAG.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>"
|
||||
},
|
||||
"AllocatePrivateVirtualInterface":{
|
||||
"name":"AllocatePrivateVirtualInterface",
|
||||
|
|
@ -37,7 +52,7 @@
|
|||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Provisions a private virtual interface to be owned by a different customer.</p> <p>The owner of a connection calls this function to provision a private virtual interface which will be owned by another AWS customer.</p> <p>Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPrivateVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.</p>"
|
||||
"documentation":"<p>Provisions a private virtual interface to be owned by another AWS customer.</p> <p>Virtual interfaces created using this action must be confirmed by the virtual interface owner by using the <a>ConfirmPrivateVirtualInterface</a> action. Until then, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.</p>"
|
||||
},
|
||||
"AllocatePublicVirtualInterface":{
|
||||
"name":"AllocatePublicVirtualInterface",
|
||||
|
|
@ -53,6 +68,48 @@
|
|||
],
|
||||
"documentation":"<p>Provisions a public virtual interface to be owned by a different customer.</p> <p>The owner of a connection calls this function to provision a public virtual interface which will be owned by another AWS customer.</p> <p>Virtual interfaces created using this function must be confirmed by the virtual interface owner by calling ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface will be in 'Confirming' state, and will not be available for handling traffic.</p> <p>When creating an IPv6 public virtual interface (addressFamily is 'ipv6'), the customer and amazon address fields should be left blank to use auto-assigned IPv6 space. Custom IPv6 Addresses are currently not supported.</p>"
|
||||
},
|
||||
"AssociateConnectionWithLag":{
|
||||
"name":"AssociateConnectionWithLag",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"AssociateConnectionWithLagRequest"},
|
||||
"output":{"shape":"Connection"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to AWS will be interrupted). The connection must be hosted on the same AWS Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can reassociate a connection that's currently associated with a different LAG; however, if removing the connection will cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.</p> <p>Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.</p> <p>For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.</p>"
|
||||
},
|
||||
"AssociateHostedConnection":{
|
||||
"name":"AssociateHostedConnection",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"AssociateHostedConnectionRequest"},
|
||||
"output":{"shape":"Connection"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection's connectivity to AWS as it is being migrated.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>"
|
||||
},
|
||||
"AssociateVirtualInterface":{
|
||||
"name":"AssociateVirtualInterface",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"AssociateVirtualInterfaceRequest"},
|
||||
"output":{"shape":"VirtualInterface"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to AWS is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails. </p> <p>Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using <a>AssociateHostedConnection</a>.</p> <p>Hosted virtual interfaces (an interface for which the owner of the connection is not the owner of physical connection) can only be reassociated by the owner of the physical connection.</p>"
|
||||
},
|
||||
"ConfirmConnection":{
|
||||
"name":"ConfirmConnection",
|
||||
"http":{
|
||||
|
|
@ -121,7 +178,7 @@
|
|||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new connection between the customer network and a specific AWS Direct Connect location.</p> <p>A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.</p>"
|
||||
"documentation":"<p>Creates a new connection between the customer network and a specific AWS Direct Connect location.</p> <p>A connection links your internal network to an AWS Direct Connect location over a standard 1 gigabit or 10 gigabit Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an AWS Direct Connect router. An AWS Direct Connect location provides access to Amazon Web Services in the region it is associated with. You can establish connections with AWS Direct Connect locations in multiple regions, but a connection in one region does not provide connectivity to other regions.</p> <p>You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection will be created.</p>"
|
||||
},
|
||||
"CreateInterconnect":{
|
||||
"name":"CreateInterconnect",
|
||||
|
|
@ -135,7 +192,21 @@
|
|||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.</p> <p>An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.</p> <p>For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>"
|
||||
"documentation":"<p>Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.</p> <p>An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.</p> <p>You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect will be created.</p> <p>For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>"
|
||||
},
|
||||
"CreateLag":{
|
||||
"name":"CreateLag",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateLagRequest"},
|
||||
"output":{"shape":"Lag"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Creates a new link aggregation group (LAG) with the specified number of bundled physical connections between the customer network and a specific AWS Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple 1 gigabit or 10 gigabit interfaces, allowing you to treat them as a single interface.</p> <p>All connections in a LAG must use the same bandwidth (for example, 10 Gbps), and must terminate at the same AWS Direct Connect endpoint.</p> <p>You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created.</p> <p>You can specify an existing physical connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical connection or hosted connections, and re-establishes them as a member of the LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the connection terminates. Any virtual interfaces associated with the connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.</p> <p>If the AWS account used to create a LAG is a registered AWS Direct Connect partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.</p>"
|
||||
},
|
||||
"CreatePrivateVirtualInterface":{
|
||||
"name":"CreatePrivateVirtualInterface",
|
||||
|
|
@ -207,6 +278,20 @@
|
|||
],
|
||||
"documentation":"<p>Deletes the specified interconnect.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>"
|
||||
},
|
||||
"DeleteLag":{
|
||||
"name":"DeleteLag",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteLagRequest"},
|
||||
"output":{"shape":"Lag"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Deletes a link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.</p>"
|
||||
},
|
||||
"DeleteVirtualInterface":{
|
||||
"name":"DeleteVirtualInterface",
|
||||
"http":{
|
||||
|
|
@ -233,7 +318,8 @@
|
|||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Returns the LOA-CFA for a Connection.</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the AWS Direct Connect user guide.</p>"
|
||||
"documentation":"<p>Deprecated in favor of <a>DescribeLoa</a>.</p> <p>Returns the LOA-CFA for a Connection.</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the AWS Direct Connect user guide.</p>",
|
||||
"deprecated":true
|
||||
},
|
||||
"DescribeConnections":{
|
||||
"name":"DescribeConnections",
|
||||
|
|
@ -261,7 +347,22 @@
|
|||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Return a list of connections that have been provisioned on the given interconnect.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>"
|
||||
"documentation":"<p>Deprecated in favor of <a>DescribeHostedConnections</a>.</p> <p>Returns a list of connections that have been provisioned on the given interconnect.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>",
|
||||
"deprecated":true
|
||||
},
|
||||
"DescribeHostedConnections":{
|
||||
"name":"DescribeHostedConnections",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeHostedConnectionsRequest"},
|
||||
"output":{"shape":"Connections"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Returns a list of hosted connections that have been provisioned on the given interconnect or link aggregation group (LAG).</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>"
|
||||
},
|
||||
"DescribeInterconnectLoa":{
|
||||
"name":"DescribeInterconnectLoa",
|
||||
|
|
@ -275,7 +376,8 @@
|
|||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Returns the LOA-CFA for an Interconnect.</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the AWS Direct Connect user guide.</p>"
|
||||
"documentation":"<p>Deprecated in favor of <a>DescribeLoa</a>.</p> <p>Returns the LOA-CFA for an Interconnect.</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the AWS Direct Connect user guide.</p>",
|
||||
"deprecated":true
|
||||
},
|
||||
"DescribeInterconnects":{
|
||||
"name":"DescribeInterconnects",
|
||||
|
|
@ -291,6 +393,34 @@
|
|||
],
|
||||
"documentation":"<p>Returns a list of interconnects owned by the AWS account.</p> <p>If an interconnect ID is provided, it will only return this particular interconnect.</p>"
|
||||
},
|
||||
"DescribeLags":{
|
||||
"name":"DescribeLags",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeLagsRequest"},
|
||||
"output":{"shape":"Lags"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Describes the link aggregation groups (LAGs) in your account. </p> <p>If a LAG ID is provided, only information about the specified LAG is returned.</p>"
|
||||
},
|
||||
"DescribeLoa":{
|
||||
"name":"DescribeLoa",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeLoaRequest"},
|
||||
"output":{"shape":"Loa"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Returns the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).</p> <p>The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to AWS at the colocation facility. For more information, see <a href=\"http://docs.aws.amazon.com/directconnect/latest/UserGuide/Colocation.html\">Requesting Cross Connects at AWS Direct Connect Locations</a> in the AWS Direct Connect user guide.</p>"
|
||||
},
|
||||
"DescribeLocations":{
|
||||
"name":"DescribeLocations",
|
||||
"http":{
|
||||
|
|
@ -343,7 +473,21 @@
|
|||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before DescribeVirtualInterfaces is called are also returned. If a connection ID is included then only virtual interfaces associated with this connection will be returned. If a virtual interface ID is included then only a single virtual interface will be returned.</p> <p>A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.</p> <p>If a connection ID is provided, only virtual interfaces provisioned on the specified connection will be returned. If a virtual interface ID is provided, only this particular virtual interface will be returned.</p>"
|
||||
"documentation":"<p>Displays all virtual interfaces for an AWS account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.</p> <p>A virtual interface (VLAN) transmits the traffic between the AWS Direct Connect location and the customer.</p>"
|
||||
},
|
||||
"DisassociateConnectionFromLag":{
|
||||
"name":"DisassociateConnectionFromLag",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DisassociateConnectionFromLagRequest"},
|
||||
"output":{"shape":"Connection"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the <a>DeleteConnection</a> request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an AWS Direct Connect partner is automatically converted to an interconnect.</p> <p>If disassociating the connection will cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it's the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections. </p>"
|
||||
},
|
||||
"TagResource":{
|
||||
"name":"TagResource",
|
||||
|
|
@ -374,12 +518,26 @@
|
|||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Removes one or more tags from the specified Direct Connect resource.</p>"
|
||||
},
|
||||
"UpdateLag":{
|
||||
"name":"UpdateLag",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateLagRequest"},
|
||||
"output":{"shape":"Lag"},
|
||||
"errors":[
|
||||
{"shape":"DirectConnectServerException"},
|
||||
{"shape":"DirectConnectClientException"}
|
||||
],
|
||||
"documentation":"<p>Updates the attributes of a link aggregation group (LAG). </p> <p>You can update the following attributes: </p> <ul> <li> <p>The name of the LAG.</p> </li> <li> <p>The value for the minimum number of connections that must be operational for the LAG itself to be operational. </p> </li> </ul> <p>When you create a LAG, the default value for the minimum number of operational connections is zero (0). If you update this value, and the number of operational connections falls below the specified value, the LAG will automatically go down to avoid overutilization of the remaining connections. Adjusting this value should be done with care as it could force the LAG down if the value is set higher than the current number of operational connections.</p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
"ASN":{
|
||||
"type":"integer",
|
||||
"documentation":"<p>Autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.</p> <p>Example: 65000</p>"
|
||||
"documentation":"<p>The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.</p> <p>Example: 65000</p>"
|
||||
},
|
||||
"AddressFamily":{
|
||||
"type":"string",
|
||||
|
|
@ -401,7 +559,7 @@
|
|||
"members":{
|
||||
"bandwidth":{
|
||||
"shape":"Bandwidth",
|
||||
"documentation":"<p>Bandwidth of the connection.</p> <p>Example: \"<i>500Mbps</i>\"</p> <p>Default: None</p> <p>Values: 50M, 100M, 200M, 300M, 400M, or 500M</p>"
|
||||
"documentation":"<p>Bandwidth of the connection.</p> <p>Example: \"<i>500Mbps</i>\"</p> <p>Default: None</p> <p>Values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps</p>"
|
||||
},
|
||||
"connectionName":{
|
||||
"shape":"ConnectionName",
|
||||
|
|
@ -422,6 +580,39 @@
|
|||
},
|
||||
"documentation":"<p>Container for the parameters to the AllocateConnectionOnInterconnect operation.</p>"
|
||||
},
|
||||
"AllocateHostedConnectionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"connectionId",
|
||||
"ownerAccount",
|
||||
"bandwidth",
|
||||
"connectionName",
|
||||
"vlan"
|
||||
],
|
||||
"members":{
|
||||
"connectionId":{
|
||||
"shape":"ConnectionId",
|
||||
"documentation":"<p>The ID of the interconnect or LAG on which the connection will be provisioned.</p> <p>Example: dxcon-456abc78 or dxlag-abc123</p> <p>Default: None</p>"
|
||||
},
|
||||
"ownerAccount":{
|
||||
"shape":"OwnerAccount",
|
||||
"documentation":"<p>The numeric account ID of the customer for whom the connection will be provisioned.</p> <p>Example: 123443215678</p> <p>Default: None</p>"
|
||||
},
|
||||
"bandwidth":{
|
||||
"shape":"Bandwidth",
|
||||
"documentation":"<p>The bandwidth of the connection.</p> <p>Example: <code>500Mbps</code> </p> <p>Default: None</p> <p>Values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps</p>"
|
||||
},
|
||||
"connectionName":{
|
||||
"shape":"ConnectionName",
|
||||
"documentation":"<p>The name of the provisioned connection.</p> <p>Example: \"<code>500M Connection to AWS</code>\"</p> <p>Default: None</p>"
|
||||
},
|
||||
"vlan":{
|
||||
"shape":"VLAN",
|
||||
"documentation":"<p>The dedicated VLAN provisioned to the hosted connection.</p> <p>Example: 101</p> <p>Default: None</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Container for the parameters to theHostedConnection operation.</p>"
|
||||
},
|
||||
"AllocatePrivateVirtualInterfaceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -472,9 +663,67 @@
|
|||
"type":"string",
|
||||
"documentation":"<p>IP address assigned to the Amazon interface.</p> <p>Example: 192.168.1.1/30 or 2001:db8::1/125</p>"
|
||||
},
|
||||
"AssociateConnectionWithLagRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"connectionId",
|
||||
"lagId"
|
||||
],
|
||||
"members":{
|
||||
"connectionId":{
|
||||
"shape":"ConnectionId",
|
||||
"documentation":"<p>The ID of the connection.</p> <p>Example: dxcon-abc123</p> <p>Default: None</p>"
|
||||
},
|
||||
"lagId":{
|
||||
"shape":"LagId",
|
||||
"documentation":"<p>The ID of the LAG with which to associate the connection.</p> <p>Example: dxlag-abc123</p> <p>Default: None</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Container for the parameters to the AssociateConnectionWithLag operation.</p>"
|
||||
},
|
||||
"AssociateHostedConnectionRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"connectionId",
|
||||
"parentConnectionId"
|
||||
],
|
||||
"members":{
|
||||
"connectionId":{
|
||||
"shape":"ConnectionId",
|
||||
"documentation":"<p>The ID of the hosted connection.</p> <p>Example: dxcon-abc123</p> <p>Default: None</p>"
|
||||
},
|
||||
"parentConnectionId":{
|
||||
"shape":"ConnectionId",
|
||||
"documentation":"<p>The ID of the interconnect or the LAG.</p> <p>Example: dxcon-abc123 or dxlag-abc123</p> <p>Default: None</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Container for the parameters to the AssociateHostedConnection operation.</p>"
|
||||
},
|
||||
"AssociateVirtualInterfaceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"virtualInterfaceId",
|
||||
"connectionId"
|
||||
],
|
||||
"members":{
|
||||
"virtualInterfaceId":{
|
||||
"shape":"VirtualInterfaceId",
|
||||
"documentation":"<p>The ID of the virtual interface.</p> <p>Example: dxvif-123dfg56</p> <p>Default: None</p>"
|
||||
},
|
||||
"connectionId":{
|
||||
"shape":"ConnectionId",
|
||||
"documentation":"<p>The ID of the LAG or connection with which to associate the virtual interface.</p> <p>Example: dxlag-abc123 or dxcon-abc123</p> <p>Default: None</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Container for the parameters to the AssociateVirtualInterface operation.</p>"
|
||||
},
|
||||
"AwsDevice":{
|
||||
"type":"string",
|
||||
"documentation":"<p>An abstract ID for the physical Direct Connect endpoint.</p> <p>Example: EQC50-abcdef123456</p>"
|
||||
},
|
||||
"BGPAuthKey":{
|
||||
"type":"string",
|
||||
"documentation":"<p>Authentication key for BGP configuration.</p> <p>Example: asdf34example</p>"
|
||||
"documentation":"<p>The authentication key for BGP configuration.</p> <p>Example: asdf34example</p>"
|
||||
},
|
||||
"BGPPeer":{
|
||||
"type":"structure",
|
||||
|
|
@ -517,6 +766,7 @@
|
|||
"type":"string",
|
||||
"documentation":"<p>Bandwidth of the connection.</p> <p>Example: 1Gbps</p> <p>Default: None</p>"
|
||||
},
|
||||
"BooleanFlag":{"type":"boolean"},
|
||||
"CIDR":{"type":"string"},
|
||||
"ConfirmConnectionRequest":{
|
||||
"type":"structure",
|
||||
|
|
@ -593,14 +843,19 @@
|
|||
},
|
||||
"loaIssueTime":{
|
||||
"shape":"LoaIssueTime",
|
||||
"documentation":"<p>The time of the most recent call to DescribeConnectionLoa for this Connection.</p>"
|
||||
"documentation":"<p>The time of the most recent call to <a>DescribeLoa</a> for this connection.</p>"
|
||||
},
|
||||
"lagId":{"shape":"LagId"},
|
||||
"awsDevice":{
|
||||
"shape":"AwsDevice",
|
||||
"documentation":"<p>The Direct Connection endpoint which the physical connection terminates on.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A connection represents the physical network connection between the AWS Direct Connect location and the customer.</p>"
|
||||
},
|
||||
"ConnectionId":{
|
||||
"type":"string",
|
||||
"documentation":"<p>ID of the connection.</p> <p>Example: dxcon-fg5678gh</p> <p>Default: None</p>"
|
||||
"documentation":"<p>The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).</p> <p>Example: dxcon-fg5678gh</p> <p>Default: None</p>"
|
||||
},
|
||||
"ConnectionList":{
|
||||
"type":"list",
|
||||
|
|
@ -635,6 +890,7 @@
|
|||
},
|
||||
"documentation":"<p>A structure containing a list of connections.</p>"
|
||||
},
|
||||
"Count":{"type":"integer"},
|
||||
"CreateBGPPeerRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -666,7 +922,8 @@
|
|||
"members":{
|
||||
"location":{"shape":"LocationCode"},
|
||||
"bandwidth":{"shape":"Bandwidth"},
|
||||
"connectionName":{"shape":"ConnectionName"}
|
||||
"connectionName":{"shape":"ConnectionName"},
|
||||
"lagId":{"shape":"LagId"}
|
||||
},
|
||||
"documentation":"<p>Container for the parameters to the CreateConnection operation.</p>"
|
||||
},
|
||||
|
|
@ -689,10 +946,43 @@
|
|||
"location":{
|
||||
"shape":"LocationCode",
|
||||
"documentation":"<p>Where the interconnect is located</p> <p>Example: EqSV5</p> <p>Default: None</p>"
|
||||
}
|
||||
},
|
||||
"lagId":{"shape":"LagId"}
|
||||
},
|
||||
"documentation":"<p>Container for the parameters to the CreateInterconnect operation.</p>"
|
||||
},
|
||||
"CreateLagRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"numberOfConnections",
|
||||
"location",
|
||||
"connectionsBandwidth",
|
||||
"lagName"
|
||||
],
|
||||
"members":{
|
||||
"numberOfConnections":{
|
||||
"shape":"Count",
|
||||
"documentation":"<p>The number of physical connections initially provisioned and bundled by the LAG.</p> <p>Default: None</p>"
|
||||
},
|
||||
"location":{
|
||||
"shape":"LocationCode",
|
||||
"documentation":"<p>The AWS Direct Connect location in which the LAG should be allocated.</p> <p>Example: EqSV5</p> <p>Default: None</p>"
|
||||
},
|
||||
"connectionsBandwidth":{
|
||||
"shape":"Bandwidth",
|
||||
"documentation":"<p>The bandwidth of the individual physical connections bundled by the LAG.</p> <p>Default: None</p> <p>Available values: 1Gbps, 10Gbps</p>"
|
||||
},
|
||||
"lagName":{
|
||||
"shape":"LagName",
|
||||
"documentation":"<p>The name of the LAG.</p> <p>Example: \"<code>3x10G LAG to AWS</code>\"</p> <p>Default: None</p>"
|
||||
},
|
||||
"connectionId":{
|
||||
"shape":"ConnectionId",
|
||||
"documentation":"<p>The ID of an existing connection to migrate to the LAG.</p> <p>Default: None</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Container for the parameters to the CreateLag operation.</p>"
|
||||
},
|
||||
"CreatePrivateVirtualInterfaceRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -769,6 +1059,17 @@
|
|||
},
|
||||
"documentation":"<p>The response received when DeleteInterconnect is called.</p>"
|
||||
},
|
||||
"DeleteLagRequest":{
|
||||
"type":"structure",
|
||||
"required":["lagId"],
|
||||
"members":{
|
||||
"lagId":{
|
||||
"shape":"LagId",
|
||||
"documentation":"<p>The ID of the LAG to delete.</p> <p>Example: dxlag-abc123</p> <p>Default: None</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Container for the parameters to the DeleteLag operation.</p>"
|
||||
},
|
||||
"DeleteVirtualInterfaceRequest":{
|
||||
"type":"structure",
|
||||
"required":["virtualInterfaceId"],
|
||||
|
|
@ -822,6 +1123,17 @@
|
|||
},
|
||||
"documentation":"<p>Container for the parameters to the DescribeConnections operation.</p>"
|
||||
},
|
||||
"DescribeHostedConnectionsRequest":{
|
||||
"type":"structure",
|
||||
"required":["connectionId"],
|
||||
"members":{
|
||||
"connectionId":{
|
||||
"shape":"ConnectionId",
|
||||
"documentation":"<p>The ID of the interconnect or LAG on which the hosted connections are provisioned.</p> <p>Example: dxcon-abc123 or dxlag-abc123</p> <p>Default: None</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Container for the parameters to the DescribeHostedConnections operation.</p>"
|
||||
},
|
||||
"DescribeInterconnectLoaRequest":{
|
||||
"type":"structure",
|
||||
"required":["interconnectId"],
|
||||
|
|
@ -849,6 +1161,35 @@
|
|||
},
|
||||
"documentation":"<p>Container for the parameters to the DescribeInterconnects operation.</p>"
|
||||
},
|
||||
"DescribeLagsRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"lagId":{
|
||||
"shape":"LagId",
|
||||
"documentation":"<p>The ID of the LAG.</p> <p>Example: dxlag-abc123</p> <p>Default: None</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Container for the parameters to the DescribeLags operation.</p>"
|
||||
},
|
||||
"DescribeLoaRequest":{
|
||||
"type":"structure",
|
||||
"required":["connectionId"],
|
||||
"members":{
|
||||
"connectionId":{
|
||||
"shape":"ConnectionId",
|
||||
"documentation":"<p>The ID of a connection, LAG, or interconnect for which to get the LOA-CFA information.</p> <p>Example: dxcon-abc123 or dxlag-abc123</p> <p>Default: None</p>"
|
||||
},
|
||||
"providerName":{
|
||||
"shape":"ProviderName",
|
||||
"documentation":"<p>The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.</p> <p>Default: None</p>"
|
||||
},
|
||||
"loaContentType":{
|
||||
"shape":"LoaContentType",
|
||||
"documentation":"<p>A standard media type indicating the content type of the LOA-CFA document. Currently, the only supported value is \"application/pdf\".</p> <p>Default: application/pdf</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Container for the parameters to the DescribeLoa operation.</p>"
|
||||
},
|
||||
"DescribeTagsRequest":{
|
||||
"type":"structure",
|
||||
"required":["resourceArns"],
|
||||
|
|
@ -900,6 +1241,24 @@
|
|||
"documentation":"<p>A server-side error occurred during the API call. The error message will contain additional details about the cause.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"DisassociateConnectionFromLagRequest":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"connectionId",
|
||||
"lagId"
|
||||
],
|
||||
"members":{
|
||||
"connectionId":{
|
||||
"shape":"ConnectionId",
|
||||
"documentation":"<p>The ID of the connection to disassociate from the LAG.</p> <p>Example: dxcon-abc123</p> <p>Default: None</p>"
|
||||
},
|
||||
"lagId":{
|
||||
"shape":"LagId",
|
||||
"documentation":"<p>The ID of the LAG.</p> <p>Example: dxlag-abc123</p> <p>Default: None</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Container for the parameters to the DisassociateConnectionFromLag operation.</p>"
|
||||
},
|
||||
"DuplicateTagKeysException":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -920,6 +1279,11 @@
|
|||
"loaIssueTime":{
|
||||
"shape":"LoaIssueTime",
|
||||
"documentation":"<p>The time of the most recent call to DescribeInterconnectLoa for this Interconnect.</p>"
|
||||
},
|
||||
"lagId":{"shape":"LagId"},
|
||||
"awsDevice":{
|
||||
"shape":"AwsDevice",
|
||||
"documentation":"<p>The Direct Connection endpoint which the physical connection terminates on.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>An interconnect is a connection that can host other connections.</p> <p>Like a standard AWS Direct Connect connection, an interconnect represents the physical connection between an AWS Direct Connect partner's network and a specific Direct Connect location. An AWS Direct Connect partner who owns an interconnect can provision hosted connections on the interconnect for their end customers, thereby providing the end customers with connectivity to AWS services.</p> <p>The resources of the interconnect, including bandwidth and VLAN numbers, are shared by all of the hosted connections on the interconnect, and the owner of the interconnect determines how these resources are assigned.</p>"
|
||||
|
|
@ -939,7 +1303,7 @@
|
|||
},
|
||||
"InterconnectState":{
|
||||
"type":"string",
|
||||
"documentation":"<p>State of the interconnect.</p> <ul> <li> <p> <b>Requested</b>: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</p> </li> <li> <p> <b>Pending</b>>: The interconnect has been approved, and is being initialized.</p> </li> <li> <p> <b>Available</b>: The network link is up, and the interconnect is ready for use.</p> </li> <li> <p> <b>Down</b>: The network link is down.</p> </li> <li> <p> <b>Deleting</b>: The interconnect is in the process of being deleted.</p> </li> <li> <p> <b>Deleted</b>: The interconnect has been deleted.</p> </li> </ul>",
|
||||
"documentation":"<p>State of the interconnect.</p> <ul> <li> <p> <b>Requested</b>: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</p> </li> <li> <p> <b>Pending</b>: The interconnect has been approved, and is being initialized.</p> </li> <li> <p> <b>Available</b>: The network link is up, and the interconnect is ready for use.</p> </li> <li> <p> <b>Down</b>: The network link is down.</p> </li> <li> <p> <b>Deleting</b>: The interconnect is in the process of being deleted.</p> </li> <li> <p> <b>Deleted</b>: The interconnect has been deleted.</p> </li> </ul>",
|
||||
"enum":[
|
||||
"requested",
|
||||
"pending",
|
||||
|
|
@ -959,6 +1323,80 @@
|
|||
},
|
||||
"documentation":"<p>A structure containing a list of interconnects.</p>"
|
||||
},
|
||||
"Lag":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"connectionsBandwidth":{
|
||||
"shape":"Bandwidth",
|
||||
"documentation":"<p>The individual bandwidth of the physical connections bundled by the LAG.</p> <p>Available values: 1Gbps, 10Gbps</p>"
|
||||
},
|
||||
"numberOfConnections":{
|
||||
"shape":"Count",
|
||||
"documentation":"<p>The number of physical connections bundled by the LAG, up to a maximum of 10.</p>"
|
||||
},
|
||||
"lagId":{"shape":"LagId"},
|
||||
"ownerAccount":{
|
||||
"shape":"OwnerAccount",
|
||||
"documentation":"<p>The owner of the LAG.</p>"
|
||||
},
|
||||
"lagName":{
|
||||
"shape":"LagName",
|
||||
"documentation":"<p>The name of the LAG.</p>"
|
||||
},
|
||||
"lagState":{"shape":"LagState"},
|
||||
"location":{"shape":"LocationCode"},
|
||||
"region":{"shape":"Region"},
|
||||
"minimumLinks":{
|
||||
"shape":"Count",
|
||||
"documentation":"<p>The minimum number of physical connections that must be operational for the LAG itself to be operational. If the number of operational connections drops below this setting, the LAG state changes to <code>down</code>. This value can help to ensure that a LAG is not overutilized if a significant number of its bundled connections go down.</p>"
|
||||
},
|
||||
"awsDevice":{
|
||||
"shape":"AwsDevice",
|
||||
"documentation":"<p>The AWS Direct Connection endpoint that hosts the LAG.</p>"
|
||||
},
|
||||
"connections":{
|
||||
"shape":"ConnectionList",
|
||||
"documentation":"<p>A list of connections bundled by this LAG.</p>"
|
||||
},
|
||||
"allowsHostedConnections":{
|
||||
"shape":"BooleanFlag",
|
||||
"documentation":"<p>Indicates whether the LAG can host other connections.</p> <note> <p>This is intended for use by AWS Direct Connect partners only.</p> </note>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Describes a link aggregation group (LAG). A LAG is a connection that uses the Link Aggregation Control Protocol (LACP) to logically aggregate a bundle of physical connections. Like an interconnect, it can host other connections. All connections in a LAG must terminate on the same physical AWS Direct Connect endpoint, and must be the same bandwidth.</p>"
|
||||
},
|
||||
"LagId":{
|
||||
"type":"string",
|
||||
"documentation":"<p>The ID of the LAG.</p> <p>Example: dxlag-fg5678gh</p>"
|
||||
},
|
||||
"LagList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"Lag"},
|
||||
"documentation":"<p>A list of LAGs.</p>"
|
||||
},
|
||||
"LagName":{"type":"string"},
|
||||
"LagState":{
|
||||
"type":"string",
|
||||
"documentation":"<p>The state of the LAG.</p> <ul> <li> <p> <b>Requested</b>: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.</p> </li> <li> <p> <b>Pending</b>: The LAG has been approved, and is being initialized.</p> </li> <li> <p> <b>Available</b>: The network link is established, and the LAG is ready for use.</p> </li> <li> <p> <b>Down</b>: The network link is down.</p> </li> <li> <p> <b>Deleting</b>: The LAG is in the process of being deleted.</p> </li> <li> <p> <b>Deleted</b>: The LAG has been deleted.</p> </li> </ul>",
|
||||
"enum":[
|
||||
"requested",
|
||||
"pending",
|
||||
"available",
|
||||
"down",
|
||||
"deleting",
|
||||
"deleted"
|
||||
]
|
||||
},
|
||||
"Lags":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"lags":{
|
||||
"shape":"LagList",
|
||||
"documentation":"<p>A list of LAGs.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A structure containing a list of LAGs.</p>"
|
||||
},
|
||||
"Loa":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1234,6 +1672,25 @@
|
|||
},
|
||||
"documentation":"<p>The response received when UntagResource is called.</p>"
|
||||
},
|
||||
"UpdateLagRequest":{
|
||||
"type":"structure",
|
||||
"required":["lagId"],
|
||||
"members":{
|
||||
"lagId":{
|
||||
"shape":"LagId",
|
||||
"documentation":"<p>The ID of the LAG to update.</p> <p>Example: dxlag-abc123</p> <p>Default: None</p>"
|
||||
},
|
||||
"lagName":{
|
||||
"shape":"LagName",
|
||||
"documentation":"<p>The name for the LAG.</p> <p>Example: \"<code>3x10G LAG to AWS</code>\"</p> <p>Default: None</p>"
|
||||
},
|
||||
"minimumLinks":{
|
||||
"shape":"Count",
|
||||
"documentation":"<p>The minimum number of physical connections that must be operational for the LAG itself to be operational.</p> <p>Default: None</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Container for the parameters to the UpdateLag operation.</p>"
|
||||
},
|
||||
"VLAN":{
|
||||
"type":"integer",
|
||||
"documentation":"<p>The VLAN ID.</p> <p>Example: 101</p>"
|
||||
|
|
@ -1300,7 +1757,7 @@
|
|||
},
|
||||
"VirtualInterfaceId":{
|
||||
"type":"string",
|
||||
"documentation":"<p>ID of the virtual interface.</p> <p>Example: dxvif-123dfg56</p> <p>Default: None</p>"
|
||||
"documentation":"<p>The ID of the virtual interface.</p> <p>Example: dxvif-123dfg56</p> <p>Default: None</p>"
|
||||
},
|
||||
"VirtualInterfaceList":{
|
||||
"type":"list",
|
||||
|
|
@ -1313,7 +1770,7 @@
|
|||
},
|
||||
"VirtualInterfaceState":{
|
||||
"type":"string",
|
||||
"documentation":"<p>State of the virtual interface.</p> <ul> <li> <p> <b>Confirming</b>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</p> </li> <li> <p> <b>Verifying</b>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</p> </li> <li> <p> <b>Pending</b>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</p> </li> <li> <p> <b>Available</b>: A virtual interface that is able to forward traffic.</p> </li> <li> <p> <b>Down</b>: A virtual interface that is BGP down.</p> </li> <li> <p> <b>Deleting</b>: A virtual interface is in this state immediately after calling <i>DeleteVirtualInterface</i> until it can no longer forward traffic.</p> </li> <li> <p> <b>Deleted</b>: A virtual interface that cannot forward traffic.</p> </li> <li> <p> <b>Rejected</b>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.</p> </li> </ul>",
|
||||
"documentation":"<p>State of the virtual interface.</p> <ul> <li> <p> <b>Confirming</b>: The creation of the virtual interface is pending confirmation from the virtual interface owner. If the owner of the virtual interface is different from the owner of the connection on which it is provisioned, then the virtual interface will remain in this state until it is confirmed by the virtual interface owner.</p> </li> <li> <p> <b>Verifying</b>: This state only applies to public virtual interfaces. Each public virtual interface needs validation before the virtual interface can be created.</p> </li> <li> <p> <b>Pending</b>: A virtual interface is in this state from the time that it is created until the virtual interface is ready to forward traffic.</p> </li> <li> <p> <b>Available</b>: A virtual interface that is able to forward traffic.</p> </li> <li> <p> <b>Down</b>: A virtual interface that is BGP down.</p> </li> <li> <p> <b>Deleting</b>: A virtual interface is in this state immediately after calling <a>DeleteVirtualInterface</a> until it can no longer forward traffic.</p> </li> <li> <p> <b>Deleted</b>: A virtual interface that cannot forward traffic.</p> </li> <li> <p> <b>Rejected</b>: The virtual interface owner has declined creation of the virtual interface. If a virtual interface in the 'Confirming' state is deleted by the virtual interface owner, the virtual interface will enter the 'Rejected' state.</p> </li> </ul>",
|
||||
"enum":[
|
||||
"confirming",
|
||||
"verifying",
|
||||
|
|
|
|||
5
botocore/data/discovery/2015-11-01/examples-1.json
Normal file
5
botocore/data/discovery/2015-11-01/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
3
botocore/data/discovery/2015-11-01/paginators-1.json
Normal file
3
botocore/data/discovery/2015-11-01/paginators-1.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
|
|
@ -123,7 +123,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ServerInternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves attributes for a list of configuration item IDs. All of the supplied IDs must be for the same asset type (server, application, process, or connection). Output fields are specific to the asset type selected. For example, the output for a <i>server</i> configuration item includes a list of attributes about the server, such as host name, operating system, and number of network cards.</p> <p>For a complete list of outputs for each asset type, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/querying-configuration-items.html#DescribeConfigurations\">Querying Discovered Configuration Items</a>.</p>"
|
||||
"documentation":"<p>Retrieves attributes for a list of configuration item IDs. All of the supplied IDs must be for the same asset type (server, application, process, or connection). Output fields are specific to the asset type selected. For example, the output for a <i>server</i> configuration item includes a list of attributes about the server, such as host name, operating system, and number of network cards.</p> <p>For a complete list of outputs for each asset type, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/discovery-api-queries.html#DescribeConfigurations\">Using the DescribeConfigurations Action</a>.</p>"
|
||||
},
|
||||
"DescribeExportConfigurations":{
|
||||
"name":"DescribeExportConfigurations",
|
||||
|
|
@ -140,7 +140,24 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ServerInternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.</p>"
|
||||
"documentation":"<p>Deprecated. Use <code>DescribeExportTasks</code> instead.</p> <p>Retrieves the status of a given export process. You can retrieve status from a maximum of 100 processes.</p>",
|
||||
"deprecated":true
|
||||
},
|
||||
"DescribeExportTasks":{
|
||||
"name":"DescribeExportTasks",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeExportTasksRequest"},
|
||||
"output":{"shape":"DescribeExportTasksResponse"},
|
||||
"errors":[
|
||||
{"shape":"AuthorizationErrorException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ServerInternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Retrieve status of one or more export tasks. You can retrieve the status of up to 100 export tasks.</p>"
|
||||
},
|
||||
"DescribeTags":{
|
||||
"name":"DescribeTags",
|
||||
|
|
@ -189,7 +206,8 @@
|
|||
{"shape":"ServerInternalErrorException"},
|
||||
{"shape":"OperationNotPermittedException"}
|
||||
],
|
||||
"documentation":"<p>Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID which you can query using the <i>DescribeExportConfigurations</i> API. The system imposes a limit of two configuration exports in six hours.</p>"
|
||||
"documentation":"<p>Deprecated. Use <code>StartExportTask</code> instead.</p> <p>Exports all discovered configuration data to an Amazon S3 bucket or an application that enables you to view and evaluate the data. Data includes tags and tag associations, processes, connections, servers, and system performance. This API returns an export ID that you can query using the <i>DescribeExportConfigurations</i> API. The system imposes a limit of two configuration exports in six hours.</p>",
|
||||
"deprecated":true
|
||||
},
|
||||
"GetDiscoverySummary":{
|
||||
"name":"GetDiscoverySummary",
|
||||
|
|
@ -222,7 +240,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ServerInternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves a list of configuration items according to criteria you specify in a filter. The filter criteria identify relationship requirements.</p>"
|
||||
"documentation":"<p>Retrieves a list of configuration items according to criteria that you specify in a filter. The filter criteria identifies the relationship requirements.</p>"
|
||||
},
|
||||
"ListServerNeighbors":{
|
||||
"name":"ListServerNeighbors",
|
||||
|
|
@ -238,7 +256,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ServerInternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Retrieves a list of servers which are one network hop away from a specified server.</p>"
|
||||
"documentation":"<p>Retrieves a list of servers that are one network hop away from a specified server.</p>"
|
||||
},
|
||||
"StartDataCollectionByAgentIds":{
|
||||
"name":"StartDataCollectionByAgentIds",
|
||||
|
|
@ -254,7 +272,24 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ServerInternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Instructs the specified agents or Connectors to start collecting data.</p>"
|
||||
"documentation":"<p>Instructs the specified agents or connectors to start collecting data.</p>"
|
||||
},
|
||||
"StartExportTask":{
|
||||
"name":"StartExportTask",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"StartExportTaskRequest"},
|
||||
"output":{"shape":"StartExportTaskResponse"},
|
||||
"errors":[
|
||||
{"shape":"AuthorizationErrorException"},
|
||||
{"shape":"InvalidParameterException"},
|
||||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ServerInternalErrorException"},
|
||||
{"shape":"OperationNotPermittedException"}
|
||||
],
|
||||
"documentation":"<p>Export the configuration data about discovered configuration items and relationships to an S3 bucket in a specified format.</p>"
|
||||
},
|
||||
"StopDataCollectionByAgentIds":{
|
||||
"name":"StopDataCollectionByAgentIds",
|
||||
|
|
@ -270,7 +305,7 @@
|
|||
{"shape":"InvalidParameterValueException"},
|
||||
{"shape":"ServerInternalErrorException"}
|
||||
],
|
||||
"documentation":"<p>Instructs the specified agents or Connectors to stop collecting data.</p>"
|
||||
"documentation":"<p>Instructs the specified agents or connectors to stop collecting data.</p>"
|
||||
},
|
||||
"UpdateApplication":{
|
||||
"name":"UpdateApplication",
|
||||
|
|
@ -295,18 +330,18 @@
|
|||
"members":{
|
||||
"agentId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The agent/Connector ID.</p>"
|
||||
"documentation":"<p>The agent/connector ID.</p>"
|
||||
},
|
||||
"operationSucceeded":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Information about the status of the <code>StartDataCollection</code> and <code>StopDataCollection</code> operations. The system has recorded the data collection operation. The agent/Connector receives this command the next time it polls for a new command. </p>"
|
||||
"documentation":"<p>Information about the status of the <code>StartDataCollection</code> and <code>StopDataCollection</code> operations. The system has recorded the data collection operation. The agent/connector receives this command the next time it polls for a new command. </p>"
|
||||
},
|
||||
"description":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A description of the operation performed.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about agents or Connectors that were instructed to start collecting data. Information includes the agent/Connector ID, a description of the operation, and whether or not the agent/Connector configuration was updated.</p>"
|
||||
"documentation":"<p>Information about agents or connectors that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation, and whether the agent/connector configuration was updated.</p>"
|
||||
},
|
||||
"AgentConfigurationStatusList":{
|
||||
"type":"list",
|
||||
|
|
@ -358,7 +393,7 @@
|
|||
},
|
||||
"registeredTime":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Agent's first registration time stamp in UTC.</p>"
|
||||
"documentation":"<p>Agent's first registration timestamp in UTC.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information about agents or connectors associated with the user’s AWS account. Information includes agent or connector IDs, IP addresses, media access control (MAC) addresses, agent or connector health, hostname where the agent or connector resides, and agent version for each agent.</p>"
|
||||
|
|
@ -368,14 +403,14 @@
|
|||
"members":{
|
||||
"ipAddress":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The IP address for the host where the agent/Connector resides.</p>"
|
||||
"documentation":"<p>The IP address for the host where the agent/connector resides.</p>"
|
||||
},
|
||||
"macAddress":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The MAC address for the host where the agent/Connector resides.</p>"
|
||||
"documentation":"<p>The MAC address for the host where the agent/connector resides.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Network details about the host where the agent/Connector resides.</p>"
|
||||
"documentation":"<p>Network details about the host where the agent/connector resides.</p>"
|
||||
},
|
||||
"AgentNetworkInfoList":{
|
||||
"type":"list",
|
||||
|
|
@ -461,19 +496,19 @@
|
|||
"members":{
|
||||
"configurationType":{
|
||||
"shape":"ConfigurationItemType",
|
||||
"documentation":"<p>A type of IT asset that you want to tag.</p>"
|
||||
"documentation":"<p>A type of IT asset to tag.</p>"
|
||||
},
|
||||
"configurationId":{
|
||||
"shape":"ConfigurationId",
|
||||
"documentation":"<p>The configuration ID for the item you want to tag. You can specify a list of keys and values.</p>"
|
||||
"documentation":"<p>The configuration ID for the item to tag. You can specify a list of keys and values.</p>"
|
||||
},
|
||||
"key":{
|
||||
"shape":"TagKey",
|
||||
"documentation":"<p>A type of tag to filter on. For example, <i>serverType</i>.</p>"
|
||||
"documentation":"<p>A type of tag on which to filter. For example, <i>serverType</i>.</p>"
|
||||
},
|
||||
"value":{
|
||||
"shape":"TagValue",
|
||||
"documentation":"<p>A value to filter on. For example <i>key = serverType</i> and <i>value = web server</i>.</p>"
|
||||
"documentation":"<p>A value on which to filter. For example <i>key = serverType</i> and <i>value = web server</i>.</p>"
|
||||
},
|
||||
"timeOfCreation":{
|
||||
"shape":"TimeStamp",
|
||||
|
|
@ -669,7 +704,7 @@
|
|||
},
|
||||
"filters":{
|
||||
"shape":"Filters",
|
||||
"documentation":"<p>You can filter the request using various logical operators and a <i>key</i>-<i>value</i> format. For example: </p> <p> <code>{\"key\": \"collectionStatus\", \"value\": \"STARTED\"}</code> </p> <p>For a complete list of filter options and guidance about using them with this action, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/managing-agent.html\">Managing AWS Application Discovery Service Agents and the AWS Application Discovery Connector </a>.</p>"
|
||||
"documentation":"<p>You can filter the request using various logical operators and a <i>key</i>-<i>value</i> format. For example: </p> <p> <code>{\"key\": \"collectionStatus\", \"value\": \"STARTED\"}</code> </p>"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"Integer",
|
||||
|
|
@ -735,7 +770,7 @@
|
|||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>A token to get the next set of results. For example, if you specified 100 IDs for <code>DescribeExportConfigurationsRequest$exportIds</code> but set <code>DescribeExportConfigurationsRequest$maxResults</code> to 10, you will get results in a set of 10. Use the token in the query to get the next set of 10.</p>"
|
||||
"documentation":"<p>A token to get the next set of results. For example, if you specify 100 IDs for <code>DescribeExportConfigurationsRequest$exportIds</code> but set <code>DescribeExportConfigurationsRequest$maxResults</code> to 10, you get results in a set of 10. Use the token in the query to get the next set of 10.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -748,7 +783,37 @@
|
|||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>A token to get the next set of results. For example, if you specified 100 IDs for <code>DescribeExportConfigurationsRequest$exportIds</code> but set <code>DescribeExportConfigurationsRequest$maxResults</code> to 10, you will get results in a set of 10. Use the token in the query to get the next set of 10.</p>"
|
||||
"documentation":"<p>A token to get the next set of results. For example, if you specify 100 IDs for <code>DescribeExportConfigurationsRequest$exportIds</code> but set <code>DescribeExportConfigurationsRequest$maxResults</code> to 10, you get results in a set of 10. Use the token in the query to get the next set of 10.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeExportTasksRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"exportIds":{
|
||||
"shape":"ExportIds",
|
||||
"documentation":"<p>One or more unique identifiers used to query the status of an export request.</p>"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"Integer",
|
||||
"documentation":"<p>The maximum number of volume results returned by <code>DescribeExportTasks</code> in paginated output. When this parameter is used, <code>DescribeExportTasks</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The <code>nextToken</code> value returned from a previous paginated <code>DescribeExportTasks</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. This value is null when there are no more results to return.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeExportTasksResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"exportsInfo":{
|
||||
"shape":"ExportsInfo",
|
||||
"documentation":"<p>Contains one or more sets of export request details. When the status of a request is <code>SUCCEEDED</code>, the response includes a URL for an Amazon S3 bucket where you can view the data in a CSV file.</p>"
|
||||
},
|
||||
"nextToken":{
|
||||
"shape":"NextToken",
|
||||
"documentation":"<p>The <code>nextToken</code> value to include in a future <code>DescribeExportTasks</code> request. When the results of a <code>DescribeExportTasks</code> request exceed <code>maxResults</code>, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -757,7 +822,7 @@
|
|||
"members":{
|
||||
"filters":{
|
||||
"shape":"TagFilters",
|
||||
"documentation":"<p>You can filter the list using a <i>key</i>-<i>value</i> format. You can separate these items by using logical operators. Allowed filters include <code>tagKey</code>, <code>tagValue</code>, and <code>configurationId</code>. </p> <p>For a complete list of filter options and guidance about using them with this action, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/managing-agents.html\">Managing AWS Application Discovery Service Agents and the AWS Application Discovery Connector </a>.</p>"
|
||||
"documentation":"<p>You can filter the list using a <i>key</i>-<i>value</i> format. You can separate these items by using logical operators. Allowed filters include <code>tagKey</code>, <code>tagValue</code>, and <code>configurationId</code>. </p>"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"Integer",
|
||||
|
|
@ -791,11 +856,11 @@
|
|||
"members":{
|
||||
"applicationConfigurationId":{
|
||||
"shape":"ApplicationId",
|
||||
"documentation":"<p>Configuration ID of an application from which each item will be disassociated.</p>"
|
||||
"documentation":"<p>Configuration ID of an application from which each item is disassociated.</p>"
|
||||
},
|
||||
"configurationIds":{
|
||||
"shape":"ConfigurationIdList",
|
||||
"documentation":"<p>Configuration ID of each item be be disassociated from an application.</p>"
|
||||
"documentation":"<p>Configuration ID of each item to be disassociated from an application.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -813,6 +878,17 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"ExportDataFormat":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"CSV",
|
||||
"GRAPHML"
|
||||
]
|
||||
},
|
||||
"ExportDataFormats":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ExportDataFormat"}
|
||||
},
|
||||
"ExportIds":{
|
||||
"type":"list",
|
||||
"member":{"shape":"ConfigurationsExportId"}
|
||||
|
|
@ -844,7 +920,7 @@
|
|||
},
|
||||
"exportRequestTime":{
|
||||
"shape":"ExportRequestTime",
|
||||
"documentation":"<p>The time the configuration data export was initiated.</p>"
|
||||
"documentation":"<p>The time that the configuration data export was initiated.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Information regarding the export status of the discovered data. The value is an array of objects.</p>"
|
||||
|
|
@ -877,14 +953,14 @@
|
|||
},
|
||||
"values":{
|
||||
"shape":"FilterValues",
|
||||
"documentation":"<p>A string value that you want to filter on. For example, if you choose the <code>destinationServer.osVersion</code> filter name, you could specify <code>Ubuntu</code> for the value.</p>"
|
||||
"documentation":"<p>A string value on which to filter. For example, if you choose the <code>destinationServer.osVersion</code> filter name, you could specify <code>Ubuntu</code> for the value.</p>"
|
||||
},
|
||||
"condition":{
|
||||
"shape":"Condition",
|
||||
"documentation":"<p>A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all filters as though concatenated by <i>AND</i>. If you specify multiple values for a particular filter, the system differentiates the values using <i>OR</i>. Calling either <i>DescribeConfigurations</i> or <i>ListConfigurations</i> returns attributes of matching configuration items.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A filter that can use conditional operators.</p> <p>for a complete list of filters and guidance for using them with the Application Discovery Service, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/querying-configuration-items.html\">Querying Discovered Configuration Items</a>.</p>"
|
||||
"documentation":"<p>A filter that can use conditional operators.</p> <p>For more information about filters, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/discovery-api-queries.html\">Querying Discovered Configuration Items</a>. </p>"
|
||||
},
|
||||
"FilterName":{"type":"string"},
|
||||
"FilterValue":{"type":"string"},
|
||||
|
|
@ -909,19 +985,19 @@
|
|||
"members":{
|
||||
"servers":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Number of servers discovered.</p>"
|
||||
"documentation":"<p>The number of servers discovered.</p>"
|
||||
},
|
||||
"applications":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Number of applications discovered.</p>"
|
||||
"documentation":"<p>The number of applications discovered.</p>"
|
||||
},
|
||||
"serversMappedToApplications":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Number of servers mapped to applications.</p>"
|
||||
"documentation":"<p>The number of servers mapped to applications.</p>"
|
||||
},
|
||||
"serversMappedtoTags":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Number of servers mapped to tags.</p>"
|
||||
"documentation":"<p>The number of servers mapped to tags.</p>"
|
||||
},
|
||||
"agentSummary":{
|
||||
"shape":"CustomerAgentInfo",
|
||||
|
|
@ -956,11 +1032,11 @@
|
|||
"members":{
|
||||
"configurationType":{
|
||||
"shape":"ConfigurationItemType",
|
||||
"documentation":"<p>A valid configuration identified by the Discovery Service. </p>"
|
||||
"documentation":"<p>A valid configuration identified by Application Discovery Service. </p>"
|
||||
},
|
||||
"filters":{
|
||||
"shape":"Filters",
|
||||
"documentation":"<p>You can filter the request using various logical operators and a <i>key</i>-<i>value</i> format. For example: </p> <p> <code>{\"key\": \"serverType\", \"value\": \"webServer\"}</code> </p> <p>For a complete list of filter options and guidance about using them with this action, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/querying-configuration-items.html#ListConfigurations\">Querying Discovered Configuration Items</a>. </p>"
|
||||
"documentation":"<p>You can filter the request using various logical operators and a <i>key</i>-<i>value</i> format. For example: </p> <p> <code>{\"key\": \"serverType\", \"value\": \"webServer\"}</code> </p> <p>For a complete list of filter options and guidance about using them with this action, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/discovery-api-queries.html#ListConfigurations\">Querying Discovered Configuration Items</a>. </p>"
|
||||
},
|
||||
"maxResults":{
|
||||
"shape":"Integer",
|
||||
|
|
@ -972,7 +1048,7 @@
|
|||
},
|
||||
"orderBy":{
|
||||
"shape":"OrderByList",
|
||||
"documentation":"<p>Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/querying-configuration-items.html#ListConfigurations\">Querying Discovered Configuration Items</a>.</p>"
|
||||
"documentation":"<p>Certain filter criteria return output that can be sorted in ascending or descending order. For a list of output characteristics for each filter, see <a href=\"http://docs.aws.amazon.com/application-discovery/latest/APIReference/discovery-api-queries.html#ListConfigurations\">Using the ListConfigurations Action</a>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1045,23 +1121,23 @@
|
|||
"members":{
|
||||
"sourceServerId":{
|
||||
"shape":"ConfigurationId",
|
||||
"documentation":"<p>ID of server that opened the network connection.</p>"
|
||||
"documentation":"<p>The ID of the server that opened the network connection.</p>"
|
||||
},
|
||||
"destinationServerId":{
|
||||
"shape":"ConfigurationId",
|
||||
"documentation":"<p>ID of the server that accepted the networker connection.</p>"
|
||||
"documentation":"<p>The ID of the server that accepted the network connection.</p>"
|
||||
},
|
||||
"destinationPort":{
|
||||
"shape":"BoxedInteger",
|
||||
"documentation":"<p>Destination network port for the connection.</p>"
|
||||
"documentation":"<p>The destination network port for the connection.</p>"
|
||||
},
|
||||
"transportProtocol":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Network protocol used for the connection.</p>"
|
||||
"documentation":"<p>The network protocol used for the connection.</p>"
|
||||
},
|
||||
"connectionsCount":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>Number of open network connections with the neighboring server.</p>"
|
||||
"documentation":"<p>The number of open network connections with the neighboring server.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Details about neighboring servers.</p>"
|
||||
|
|
@ -1085,14 +1161,14 @@
|
|||
"members":{
|
||||
"fieldName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>Field to order on.</p>"
|
||||
"documentation":"<p>The field on which to order.</p>"
|
||||
},
|
||||
"sortOrder":{
|
||||
"shape":"orderString",
|
||||
"documentation":"<p>Ordering direction.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Field and direction for ordered output.</p>"
|
||||
"documentation":"<p>A field and direction for ordered output.</p>"
|
||||
},
|
||||
"OrderByList":{
|
||||
"type":"list",
|
||||
|
|
@ -1121,7 +1197,7 @@
|
|||
"members":{
|
||||
"agentIds":{
|
||||
"shape":"AgentIds",
|
||||
"documentation":"<p>The IDs of the agents or Connectors that you want to start collecting data. If you send a request to an agent/Connector ID that you do not have permission to contact, according to your AWS account, the service does not throw an exception. Instead, it returns the error in the <i>Description</i> field. If you send a request to multiple agents/Connectors and you do not have permission to contact some of those agents/Connectors, the system does not throw an exception. Instead, the system shows <code>Failed</code> in the <i>Description</i> field.</p>"
|
||||
"documentation":"<p>The IDs of the agents or connectors from which to start collecting data. If you send a request to an agent/connector ID that you do not have permission to contact, according to your AWS account, the service does not throw an exception. Instead, it returns the error in the <i>Description</i> field. If you send a request to multiple agents/connectors and you do not have permission to contact some of those agents/connectors, the system does not throw an exception. Instead, the system shows <code>Failed</code> in the <i>Description</i> field.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1130,7 +1206,25 @@
|
|||
"members":{
|
||||
"agentsConfigurationStatus":{
|
||||
"shape":"AgentConfigurationStatusList",
|
||||
"documentation":"<p>Information about agents or the Connector that were instructed to start collecting data. Information includes the agent/Connector ID, a description of the operation performed, and whether or not the agent/Connector configuration was updated.</p>"
|
||||
"documentation":"<p>Information about agents or the connector that were instructed to start collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartExportTaskRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"exportDataFormat":{
|
||||
"shape":"ExportDataFormats",
|
||||
"documentation":"<p>The file format for the returned export data. Default value is <code>CSV</code>.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"StartExportTaskResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"exportId":{
|
||||
"shape":"ConfigurationsExportId",
|
||||
"documentation":"<p> A unique identifier used to query the status of an export request.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1140,7 +1234,7 @@
|
|||
"members":{
|
||||
"agentIds":{
|
||||
"shape":"AgentIds",
|
||||
"documentation":"<p>The IDs of the agents or Connectors that you want to stop collecting data.</p>"
|
||||
"documentation":"<p>The IDs of the agents or connectors from which to stop collecting data.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1149,7 +1243,7 @@
|
|||
"members":{
|
||||
"agentsConfigurationStatus":{
|
||||
"shape":"AgentConfigurationStatusList",
|
||||
"documentation":"<p>Information about agents or the Connector that were instructed to stop collecting data. Information includes the agent/Connector ID, a description of the operation performed, and whether or not the agent/Connector configuration was updated.</p>"
|
||||
"documentation":"<p>Information about the agents or connector that were instructed to stop collecting data. Information includes the agent/connector ID, a description of the operation performed, and whether the agent/connector configuration was updated.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1163,11 +1257,11 @@
|
|||
"members":{
|
||||
"key":{
|
||||
"shape":"TagKey",
|
||||
"documentation":"<p>A type of tag to filter on.</p>"
|
||||
"documentation":"<p>The type of tag on which to filter.</p>"
|
||||
},
|
||||
"value":{
|
||||
"shape":"TagValue",
|
||||
"documentation":"<p>A value for a tag key to filter on.</p>"
|
||||
"documentation":"<p>A value for a tag key on which to filter.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Metadata that help you categorize IT assets.</p>"
|
||||
|
|
@ -1181,14 +1275,14 @@
|
|||
"members":{
|
||||
"name":{
|
||||
"shape":"FilterName",
|
||||
"documentation":"<p>A name of a tag filter.</p>"
|
||||
"documentation":"<p>A name of the tag filter.</p>"
|
||||
},
|
||||
"values":{
|
||||
"shape":"FilterValues",
|
||||
"documentation":"<p>Values of a tag filter.</p>"
|
||||
"documentation":"<p>Values for the tag filter.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The name of a tag filter. Valid names are: <code>tagKey</code>, <code>tagValue</code>, <code>configurationId</code>.</p>"
|
||||
"documentation":"<p>The tag filter. Valid names are: <code>tagKey</code>, <code>tagValue</code>, <code>configurationId</code>.</p>"
|
||||
},
|
||||
"TagFilters":{
|
||||
"type":"list",
|
||||
|
|
@ -1235,5 +1329,5 @@
|
|||
]
|
||||
}
|
||||
},
|
||||
"documentation":"<fullname>AWS Application Discovery Service</fullname> <p>AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an Amazon-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see the Application Discovery Service <a href=\"http://aws.amazon.com/application-discovery/faqs/\">FAQ</a>.</p> <p>Application Discovery Service offers two modes of operation.</p> <ul> <li> <p> <b>Agentless discovery</b> mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment. Agentless discovery doesn't collect information about software and software dependencies. It also doesn't work in non-VMware environments. We recommend that you use agent-based discovery for non-VMware environments and if you want to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts to gather information about software and software dependencies.</p> </li> <li> <p> <b>Agent-based discovery</b> mode collects a richer set of data than agentless discovery by using Amazon software, the AWS Application Discovery Agent, which you install on one or more hosts in your data center. The agent captures infrastructure and application information, including an inventory of installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud. </p> </li> </ul> <p>Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query the Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution.</p> <important> <p>Application Discovery Service doesn't gather sensitive information. All data is handled according to the <a href=\"http://aws.amazon.com/privacy/\">AWS Privacy Policy</a>. You can operate Application Discovery Service using offline mode to inspect collected data before it is shared with the service.</p> </important> <p>Your AWS account must be granted access to Application Discovery Service, a process called <i>whitelisting</i>. This is true for AWS partners and customers alike. To request access, sign up for the AWS Application Discovery Service <a href=\"http://aws.amazon.com/application-discovery/preview/\">here</a>. We will send you information about how to get started.</p> <p>This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for the Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> <p>This guide is intended for use with the <a href=\"http://docs.aws.amazon.com/application-discovery/latest/userguide/\"> <i>AWS Application Discovery Service User Guide</i> </a>.</p>"
|
||||
"documentation":"<fullname>AWS Application Discovery Service</fullname> <p>AWS Application Discovery Service helps you plan application migration projects by automatically identifying servers, virtual machines (VMs), software, and software dependencies running in your on-premises data centers. Application Discovery Service also collects application performance data, which can help you assess the outcome of your migration. The data collected by Application Discovery Service is securely retained in an Amazon-hosted and managed database in the cloud. You can export the data as a CSV or XML file into your preferred visualization tool or cloud-migration solution to plan your migration. For more information, see the Application Discovery Service <a href=\"http://aws.amazon.com/application-discovery/faqs/\">FAQ</a>.</p> <p>Application Discovery Service offers two modes of operation.</p> <ul> <li> <p> <b>Agentless discovery</b> mode is recommended for environments that use VMware vCenter Server. This mode doesn't require you to install an agent on each host. Agentless discovery gathers server information regardless of the operating systems, which minimizes the time required for initial on-premises infrastructure assessment. Agentless discovery doesn't collect information about software and software dependencies. It also doesn't work in non-VMware environments. We recommend that you use agent-based discovery for non-VMware environments and if you want to collect information about software and software dependencies. You can also run agent-based and agentless discovery simultaneously. Use agentless discovery to quickly complete the initial infrastructure assessment and then install agents on select hosts to gather information about software and software dependencies.</p> </li> <li> <p> <b>Agent-based discovery</b> mode collects a richer set of data than agentless discovery by using Amazon software, the AWS Application Discovery Agent, which you install on one or more hosts in your data center. The agent captures infrastructure and application information, including an inventory of installed software applications, system and process performance, resource utilization, and network dependencies between workloads. The information collected by agents is secured at rest and in transit to the Application Discovery Service database in the cloud. </p> </li> </ul> <p>Application Discovery Service integrates with application discovery solutions from AWS Partner Network (APN) partners. Third-party application discovery tools can query Application Discovery Service and write to the Application Discovery Service database using a public API. You can then import the data into either a visualization tool or cloud-migration solution.</p> <important> <p>Application Discovery Service doesn't gather sensitive information. All data is handled according to the <a href=\"http://aws.amazon.com/privacy/\">AWS Privacy Policy</a>. You can operate Application Discovery Service using offline mode to inspect collected data before it is shared with the service.</p> </important> <p>Your AWS account must be granted access to Application Discovery Service, a process called <i>whitelisting</i>. This is true for AWS partners and customers alike. To request access, sign up for AWS Application Discovery Service <a href=\"http://aws.amazon.com/application-discovery/preview/\">here</a>. We send you information about how to get started.</p> <p>This API reference provides descriptions, syntax, and usage examples for each of the actions and data types for Application Discovery Service. The topic for each action shows the API request parameters and the response. Alternatively, you can use one of the AWS SDKs to access an API that is tailored to the programming language or platform that you're using. For more information, see <a href=\"http://aws.amazon.com/tools/#SDKs\">AWS SDKs</a>.</p> <p>This guide is intended for use with the <a href=\"http://docs.aws.amazon.com/application-discovery/latest/userguide/\"> <i>AWS Application Discovery Service User Guide</i> </a>.</p>"
|
||||
}
|
||||
|
|
|
|||
5
botocore/data/dms/2016-01-01/examples-1.json
Normal file
5
botocore/data/dms/2016-01-01/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
3
botocore/data/dms/2016-01-01/paginators-1.json
Normal file
3
botocore/data/dms/2016-01-01/paginators-1.json
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
|
|
@ -42,6 +42,23 @@
|
|||
],
|
||||
"documentation":"<p>Creates an endpoint using the provided settings.</p>"
|
||||
},
|
||||
"CreateEventSubscription":{
|
||||
"name":"CreateEventSubscription",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"CreateEventSubscriptionMessage"},
|
||||
"output":{"shape":"CreateEventSubscriptionResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceQuotaExceededFault"},
|
||||
{"shape":"ResourceAlreadyExistsFault"},
|
||||
{"shape":"SNSInvalidTopicFault"},
|
||||
{"shape":"SNSNoAuthorizationFault"},
|
||||
{"shape":"ResourceNotFoundFault"}
|
||||
],
|
||||
"documentation":"<p> Creates an AWS DMS event notification subscription. </p> <p>You can specify the type of source (<code>SourceType</code>) you want to be notified of, provide a list of AWS DMS source IDs (<code>SourceIds</code>) that triggers the events, and provide a list of event categories (<code>EventCategories</code>) for events you want to be notified of. If you specify both the <code>SourceType</code> and <code>SourceIds</code>, such as <code>SourceType = replication-instance</code> and <code>SourceIdentifier = my-replinstance</code>, you will be notified of all the replication instance events for the specified source. If you specify a <code>SourceType</code> but don't specify a <code>SourceIdentifier</code>, you receive notice of the events for that source type for all your AWS DMS sources. If you don't specify either <code>SourceType</code> nor <code>SourceIdentifier</code>, you will be notified of events generated from all AWS DMS sources belonging to your customer account.</p> <p>For more information about AWS DMS events, see <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html\"> Working with Events and Notifications </a> in the AWS Database MIgration Service User Guide.</p>"
|
||||
},
|
||||
"CreateReplicationInstance":{
|
||||
"name":"CreateReplicationInstance",
|
||||
"http":{
|
||||
|
|
@ -91,6 +108,7 @@
|
|||
"input":{"shape":"CreateReplicationTaskMessage"},
|
||||
"output":{"shape":"CreateReplicationTaskResponse"},
|
||||
"errors":[
|
||||
{"shape":"AccessDeniedFault"},
|
||||
{"shape":"InvalidResourceStateFault"},
|
||||
{"shape":"ResourceAlreadyExistsFault"},
|
||||
{"shape":"ResourceNotFoundFault"},
|
||||
|
|
@ -127,6 +145,20 @@
|
|||
],
|
||||
"documentation":"<p>Deletes the specified endpoint.</p> <note> <p>All tasks associated with the endpoint must be deleted before you can delete the endpoint.</p> </note> <p/>"
|
||||
},
|
||||
"DeleteEventSubscription":{
|
||||
"name":"DeleteEventSubscription",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DeleteEventSubscriptionMessage"},
|
||||
"output":{"shape":"DeleteEventSubscriptionResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundFault"},
|
||||
{"shape":"InvalidResourceStateFault"}
|
||||
],
|
||||
"documentation":"<p> Deletes an AWS DMS event subscription. </p>"
|
||||
},
|
||||
"DeleteReplicationInstance":{
|
||||
"name":"DeleteReplicationInstance",
|
||||
"http":{
|
||||
|
|
@ -228,6 +260,39 @@
|
|||
],
|
||||
"documentation":"<p>Returns information about the endpoints for your account in the current region.</p>"
|
||||
},
|
||||
"DescribeEventCategories":{
|
||||
"name":"DescribeEventCategories",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeEventCategoriesMessage"},
|
||||
"output":{"shape":"DescribeEventCategoriesResponse"},
|
||||
"documentation":"<p>Lists categories for all event source types, or, if specified, for a specified source type. You can see a list of the event categories and source types in <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html\"> Working with Events and Notifications </a> in the AWS Database Migration Service User Guide. </p>"
|
||||
},
|
||||
"DescribeEventSubscriptions":{
|
||||
"name":"DescribeEventSubscriptions",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeEventSubscriptionsMessage"},
|
||||
"output":{"shape":"DescribeEventSubscriptionsResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundFault"}
|
||||
],
|
||||
"documentation":"<p>Lists all the event subscriptions for a customer account. The description of a subscription includes <code>SubscriptionName</code>, <code>SNSTopicARN</code>, <code>CustomerID</code>, <code>SourceType</code>, <code>SourceID</code>, <code>CreationTime</code>, and <code>Status</code>. </p> <p>If you specify <code>SubscriptionName</code>, this action lists the description for that subscription.</p>"
|
||||
},
|
||||
"DescribeEvents":{
|
||||
"name":"DescribeEvents",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeEventsMessage"},
|
||||
"output":{"shape":"DescribeEventsResponse"},
|
||||
"documentation":"<p> Lists events for a given source identifier and source type. You can also specify a start and end time. For more information on AWS DMS events, see <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html\"> Working with Events and Notifications </a>. </p>"
|
||||
},
|
||||
"DescribeOrderableReplicationInstances":{
|
||||
"name":"DescribeOrderableReplicationInstances",
|
||||
"http":{
|
||||
|
|
@ -358,10 +423,27 @@
|
|||
{"shape":"InvalidResourceStateFault"},
|
||||
{"shape":"ResourceNotFoundFault"},
|
||||
{"shape":"ResourceAlreadyExistsFault"},
|
||||
{"shape":"KMSKeyNotAccessibleFault"}
|
||||
{"shape":"KMSKeyNotAccessibleFault"},
|
||||
{"shape":"AccessDeniedFault"}
|
||||
],
|
||||
"documentation":"<p>Modifies the specified endpoint.</p>"
|
||||
},
|
||||
"ModifyEventSubscription":{
|
||||
"name":"ModifyEventSubscription",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ModifyEventSubscriptionMessage"},
|
||||
"output":{"shape":"ModifyEventSubscriptionResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceQuotaExceededFault"},
|
||||
{"shape":"ResourceNotFoundFault"},
|
||||
{"shape":"SNSInvalidTopicFault"},
|
||||
{"shape":"SNSNoAuthorizationFault"}
|
||||
],
|
||||
"documentation":"<p>Modifies an existing AWS DMS event notification subscription. </p>"
|
||||
},
|
||||
"ModifyReplicationInstance":{
|
||||
"name":"ModifyReplicationInstance",
|
||||
"http":{
|
||||
|
|
@ -412,7 +494,7 @@
|
|||
{"shape":"ResourceAlreadyExistsFault"},
|
||||
{"shape":"KMSKeyNotAccessibleFault"}
|
||||
],
|
||||
"documentation":"<p>Modifies the specified replication task.</p> <p>You can't modify the task endpoints. The task must be stopped before you can modify it. </p>"
|
||||
"documentation":"<p>Modifies the specified replication task.</p> <p>You can't modify the task endpoints. The task must be stopped before you can modify it. </p> <p>For more information about AWS DMS tasks, see the AWS DMS user guide at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html\"> Working with Migration Tasks </a> </p>"
|
||||
},
|
||||
"RefreshSchemas":{
|
||||
"name":"RefreshSchemas",
|
||||
|
|
@ -430,6 +512,20 @@
|
|||
],
|
||||
"documentation":"<p>Populates the schema for the specified endpoint. This is an asynchronous operation and can take several minutes. You can check the status of this operation by calling the DescribeRefreshSchemasStatus operation.</p>"
|
||||
},
|
||||
"ReloadTables":{
|
||||
"name":"ReloadTables",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"ReloadTablesMessage"},
|
||||
"output":{"shape":"ReloadTablesResponse"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundFault"},
|
||||
{"shape":"InvalidResourceStateFault"}
|
||||
],
|
||||
"documentation":"<p>Reloads the target database table with the source data. </p>"
|
||||
},
|
||||
"RemoveTagsFromResource":{
|
||||
"name":"RemoveTagsFromResource",
|
||||
"http":{
|
||||
|
|
@ -455,7 +551,7 @@
|
|||
{"shape":"ResourceNotFoundFault"},
|
||||
{"shape":"InvalidResourceStateFault"}
|
||||
],
|
||||
"documentation":"<p>Starts the replication task.</p>"
|
||||
"documentation":"<p>Starts the replication task.</p> <p>For more information about AWS DMS tasks, see the AWS DMS user guide at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Tasks.html\"> Working with Migration Tasks </a> </p>"
|
||||
},
|
||||
"StopReplicationTask":{
|
||||
"name":"StopReplicationTask",
|
||||
|
|
@ -549,6 +645,21 @@
|
|||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"AuthMechanismValue":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"default",
|
||||
"mongodb_cr",
|
||||
"scram_sha_1"
|
||||
]
|
||||
},
|
||||
"AuthTypeValue":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"no",
|
||||
"password"
|
||||
]
|
||||
},
|
||||
"AvailabilityZone":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -615,6 +726,13 @@
|
|||
}
|
||||
},
|
||||
"CertificateWallet":{"type":"blob"},
|
||||
"CompressionTypeValue":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"none",
|
||||
"gzip"
|
||||
]
|
||||
},
|
||||
"Connection":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -670,7 +788,7 @@
|
|||
},
|
||||
"EngineName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The type of engine for the endpoint. Valid values include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, SYBASE, and SQLSERVER.</p>"
|
||||
"documentation":"<p>The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.</p>"
|
||||
},
|
||||
"Username":{
|
||||
"shape":"String",
|
||||
|
|
@ -711,6 +829,18 @@
|
|||
"SslMode":{
|
||||
"shape":"DmsSslModeValue",
|
||||
"documentation":"<p>The SSL mode to use for the SSL connection.</p> <p>SSL mode can be one of four values: none, require, verify-ca, verify-full. </p> <p>The default value is none.</p>"
|
||||
},
|
||||
"DynamoDbSettings":{
|
||||
"shape":"DynamoDbSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the <b>Using Object Mapping to Migrate Data to DynamoDB</b> section at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html\"> Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service</a>. </p>"
|
||||
},
|
||||
"S3Settings":{
|
||||
"shape":"S3Settings",
|
||||
"documentation":"<p>Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the <b>Extra Connection Attributes</b> section at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html\"> Using Amazon S3 as a Target for AWS Database Migration Service</a>. </p>"
|
||||
},
|
||||
"MongoDbSettings":{
|
||||
"shape":"MongoDbSettings",
|
||||
"documentation":"<p>Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the <b>Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service</b> section at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html\"> Using Amazon S3 as a Target for AWS Database Migration Service</a>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
|
|
@ -725,6 +855,54 @@
|
|||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"CreateEventSubscriptionMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"SubscriptionName",
|
||||
"SnsTopicArn"
|
||||
],
|
||||
"members":{
|
||||
"SubscriptionName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the DMS event notification subscription. </p> <p>Constraints: The name must be less than 255 characters. </p>"
|
||||
},
|
||||
"SnsTopicArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it. </p>"
|
||||
},
|
||||
"SourceType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to <code>replication-instance</code>. If this value is not specified, all events are returned. </p> <p>Valid values: replication-instance | migration-task</p>"
|
||||
},
|
||||
"EventCategories":{
|
||||
"shape":"EventCategoriesList",
|
||||
"documentation":"<p> A list of event categories for a source type that you want to subscribe to. You can see a list of the categories for a given source type by calling the <b>DescribeEventCategories</b> action or in the topic <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Events.html\"> Working with Events and Notifications</a> in the AWS Database Migration Service User Guide. </p>"
|
||||
},
|
||||
"SourceIds":{
|
||||
"shape":"SourceIdsList",
|
||||
"documentation":"<p> The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. </p>"
|
||||
},
|
||||
"Enabled":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p> A Boolean value; set to <b>true</b> to activate the subscription, or set to <b>false</b> to create the subscription but not activate it. </p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>A tag to be attached to the event subscription.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"CreateEventSubscriptionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"EventSubscription":{
|
||||
"shape":"EventSubscription",
|
||||
"documentation":"<p>The event subscription that was created.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"CreateReplicationInstanceMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -847,7 +1025,7 @@
|
|||
"members":{
|
||||
"ReplicationTaskIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The replication task identifier.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
|
||||
"documentation":"<p>The replication task identifier.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 255 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
|
||||
},
|
||||
"SourceEndpointArn":{
|
||||
"shape":"String",
|
||||
|
|
@ -867,7 +1045,7 @@
|
|||
},
|
||||
"TableMappings":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The path of the JSON file that contains the table mappings. Preceed the path with \"file://\".</p> <p>For example, --table-mappings file://mappingfile.json</p>"
|
||||
"documentation":"<p>When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with \"file://\". When working with the DMS API, provide the JSON as the parameter value.</p> <p>For example, --table-mappings file://mappingfile.json</p>"
|
||||
},
|
||||
"ReplicationTaskSettings":{
|
||||
"shape":"String",
|
||||
|
|
@ -934,6 +1112,27 @@
|
|||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DeleteEventSubscriptionMessage":{
|
||||
"type":"structure",
|
||||
"required":["SubscriptionName"],
|
||||
"members":{
|
||||
"SubscriptionName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the DMS event notification subscription to be deleted.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DeleteEventSubscriptionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"EventSubscription":{
|
||||
"shape":"EventSubscription",
|
||||
"documentation":"<p>The event subscription that was deleted.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DeleteReplicationInstanceMessage":{
|
||||
"type":"structure",
|
||||
"required":["ReplicationInstanceArn"],
|
||||
|
|
@ -1135,6 +1334,122 @@
|
|||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DescribeEventCategoriesMessage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SourceType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The type of AWS DMS resource that generates events. </p> <p>Valid values: replication-instance | migration-task</p>"
|
||||
},
|
||||
"Filters":{
|
||||
"shape":"FilterList",
|
||||
"documentation":"<p>Filters applied to the action.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DescribeEventCategoriesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"EventCategoryGroupList":{
|
||||
"shape":"EventCategoryGroupList",
|
||||
"documentation":"<p>A list of event categories.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DescribeEventSubscriptionsMessage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SubscriptionName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the AWS DMS event subscription to be described.</p>"
|
||||
},
|
||||
"Filters":{
|
||||
"shape":"FilterList",
|
||||
"documentation":"<p>Filters applied to the action.</p>"
|
||||
},
|
||||
"MaxRecords":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
|
||||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DescribeEventSubscriptionsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
|
||||
},
|
||||
"EventSubscriptionsList":{
|
||||
"shape":"EventSubscriptionsList",
|
||||
"documentation":"<p>A list of event subscriptions.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DescribeEventsMessage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SourceIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens. It cannot end with a hyphen or contain two consecutive hyphens. </p>"
|
||||
},
|
||||
"SourceType":{
|
||||
"shape":"SourceType",
|
||||
"documentation":"<p>The type of AWS DMS resource that generates events.</p> <p>Valid values: replication-instance | migration-task</p>"
|
||||
},
|
||||
"StartTime":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The start time for the events to be listed.</p>"
|
||||
},
|
||||
"EndTime":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The end time for the events to be listed.</p>"
|
||||
},
|
||||
"Duration":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p>The duration of the events to be listed.</p>"
|
||||
},
|
||||
"EventCategories":{
|
||||
"shape":"EventCategoriesList",
|
||||
"documentation":"<p>A list of event categories for a source type that you want to subscribe to.</p>"
|
||||
},
|
||||
"Filters":{
|
||||
"shape":"FilterList",
|
||||
"documentation":"<p>Filters applied to the action.</p>"
|
||||
},
|
||||
"MaxRecords":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p> The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that the remaining results can be retrieved. </p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"
|
||||
},
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DescribeEventsResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Marker":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>. </p>"
|
||||
},
|
||||
"Events":{
|
||||
"shape":"EventList",
|
||||
"documentation":"<p>The events described.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"DescribeOrderableReplicationInstancesMessage":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1359,6 +1674,17 @@
|
|||
"verify-full"
|
||||
]
|
||||
},
|
||||
"DynamoDbSettings":{
|
||||
"type":"structure",
|
||||
"required":["ServiceAccessRoleArn"],
|
||||
"members":{
|
||||
"ServiceAccessRoleArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) used by the service access IAM role. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"Endpoint":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1372,7 +1698,7 @@
|
|||
},
|
||||
"EngineName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The database engine name. Valid values include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, SYBASE, and SQLSERVER.</p>"
|
||||
"documentation":"<p>The database engine name. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.</p>"
|
||||
},
|
||||
"Username":{
|
||||
"shape":"String",
|
||||
|
|
@ -1413,6 +1739,22 @@
|
|||
"SslMode":{
|
||||
"shape":"DmsSslModeValue",
|
||||
"documentation":"<p>The SSL mode used to connect to the endpoint.</p> <p>SSL mode can be one of four values: none, require, verify-ca, verify-full. </p> <p>The default value is none.</p>"
|
||||
},
|
||||
"ExternalId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> Value returned by a call to CreateEndpoint that can be used for cross-account validation. Use it on a subsequent call to CreateEndpoint to create the endpoint with a cross-account. </p>"
|
||||
},
|
||||
"DynamoDbSettings":{
|
||||
"shape":"DynamoDbSettings",
|
||||
"documentation":"<p>The settings for the target DynamoDB database. For more information, see the <code>DynamoDBSettings</code> structure.</p>"
|
||||
},
|
||||
"S3Settings":{
|
||||
"shape":"S3Settings",
|
||||
"documentation":"<p>The settings for the S3 target endpoint. For more information, see the <code>S3Settings</code> structure.</p>"
|
||||
},
|
||||
"MongoDbSettings":{
|
||||
"shape":"MongoDbSettings",
|
||||
"documentation":"<p>The settings for the MongoDB source endpoint. For more information, see the <code>MongoDbSettings</code> structure.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
|
|
@ -1424,6 +1766,116 @@
|
|||
"locationName":"Endpoint"
|
||||
}
|
||||
},
|
||||
"Event":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SourceIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The identifier of the event source. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens. </p> <p>Constraints:replication instance, endpoint, migration task</p>"
|
||||
},
|
||||
"SourceType":{
|
||||
"shape":"SourceType",
|
||||
"documentation":"<p> The type of AWS DMS resource that generates events. </p> <p>Valid values: replication-instance | endpoint | migration-task</p>"
|
||||
},
|
||||
"Message":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The event message.</p>"
|
||||
},
|
||||
"EventCategories":{
|
||||
"shape":"EventCategoriesList",
|
||||
"documentation":"<p>The event categories available for the specified source type.</p>"
|
||||
},
|
||||
"Date":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The date of the event.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"EventCategoriesList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"String",
|
||||
"locationName":"EventCategory"
|
||||
}
|
||||
},
|
||||
"EventCategoryGroup":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SourceType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The type of AWS DMS resource that generates events. </p> <p>Valid values: replication-instance | replication-server | security-group | migration-task</p>"
|
||||
},
|
||||
"EventCategories":{
|
||||
"shape":"EventCategoriesList",
|
||||
"documentation":"<p> A list of event categories for a <code>SourceType</code> that you want to subscribe to. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"EventCategoryGroupList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"EventCategoryGroup",
|
||||
"locationName":"EventCategoryGroup"
|
||||
}
|
||||
},
|
||||
"EventList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"Event",
|
||||
"locationName":"Event"
|
||||
}
|
||||
},
|
||||
"EventSubscription":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"CustomerAwsId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS customer account associated with the AWS DMS event notification subscription.</p>"
|
||||
},
|
||||
"CustSubscriptionId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS DMS event notification subscription Id.</p>"
|
||||
},
|
||||
"SnsTopicArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The topic ARN of the AWS DMS event notification subscription.</p>"
|
||||
},
|
||||
"Status":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The status of the AWS DMS event notification subscription.</p> <p>Constraints:</p> <p>Can be one of the following: creating | modifying | deleting | active | no-permission | topic-not-exist</p> <p>The status \"no-permission\" indicates that AWS DMS no longer has permission to post to the SNS topic. The status \"topic-not-exist\" indicates that the topic was deleted after the subscription was created.</p>"
|
||||
},
|
||||
"SubscriptionCreationTime":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The time the RDS event notification subscription was created.</p>"
|
||||
},
|
||||
"SourceType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The type of AWS DMS resource that generates events. </p> <p>Valid values: replication-instance | replication-server | security-group | migration-task</p>"
|
||||
},
|
||||
"SourceIdsList":{
|
||||
"shape":"SourceIdsList",
|
||||
"documentation":"<p>A list of source Ids for the event subscription.</p>"
|
||||
},
|
||||
"EventCategoriesList":{
|
||||
"shape":"EventCategoriesList",
|
||||
"documentation":"<p>A lists of event categories.</p>"
|
||||
},
|
||||
"Enabled":{
|
||||
"shape":"Boolean",
|
||||
"documentation":"<p>Boolean value that indicates if the event subscription is enabled.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"EventSubscriptionsList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"EventSubscription",
|
||||
"locationName":"EventSubscription"
|
||||
}
|
||||
},
|
||||
"ExceptionMessage":{"type":"string"},
|
||||
"Filter":{
|
||||
"type":"structure",
|
||||
|
|
@ -1472,6 +1924,10 @@
|
|||
"CertificateWallet":{
|
||||
"shape":"CertificateWallet",
|
||||
"documentation":"<p>The location of the imported Oracle Wallet certificate for use with SSL.</p>"
|
||||
},
|
||||
"Tags":{
|
||||
"shape":"TagList",
|
||||
"documentation":"<p>The tags associated with the certificate.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
|
|
@ -1590,7 +2046,7 @@
|
|||
},
|
||||
"EngineName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The type of engine for the endpoint. Valid values include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, SYBASE, and SQLSERVER.</p>"
|
||||
"documentation":"<p>The type of engine for the endpoint. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, DYNAMODB, MONGODB, SYBASE, and SQLSERVER.</p>"
|
||||
},
|
||||
"Username":{
|
||||
"shape":"String",
|
||||
|
|
@ -1623,6 +2079,18 @@
|
|||
"SslMode":{
|
||||
"shape":"DmsSslModeValue",
|
||||
"documentation":"<p>The SSL mode to be used.</p> <p>SSL mode can be one of four values: none, require, verify-ca, verify-full. </p> <p>The default value is none.</p>"
|
||||
},
|
||||
"DynamoDbSettings":{
|
||||
"shape":"DynamoDbSettings",
|
||||
"documentation":"<p>Settings in JSON format for the target Amazon DynamoDB endpoint. For more information about the available settings, see the <b>Using Object Mapping to Migrate Data to DynamoDB</b> section at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.DynamoDB.html\"> Using an Amazon DynamoDB Database as a Target for AWS Database Migration Service</a>. </p>"
|
||||
},
|
||||
"S3Settings":{
|
||||
"shape":"S3Settings",
|
||||
"documentation":"<p>Settings in JSON format for the target S3 endpoint. For more information about the available settings, see the <b>Extra Connection Attributes</b> section at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Target.S3.html\"> Using Amazon S3 as a Target for AWS Database Migration Service</a>. </p>"
|
||||
},
|
||||
"MongoDbSettings":{
|
||||
"shape":"MongoDbSettings",
|
||||
"documentation":"<p>Settings in JSON format for the source MongoDB endpoint. For more information about the available settings, see the <b>Configuration Properties When Using MongoDB as a Source for AWS Database Migration Service</b> section at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.MongoDB.html\"> Using Amazon S3 as a Target for AWS Database Migration Service</a>. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
|
|
@ -1637,6 +2105,43 @@
|
|||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"ModifyEventSubscriptionMessage":{
|
||||
"type":"structure",
|
||||
"required":["SubscriptionName"],
|
||||
"members":{
|
||||
"SubscriptionName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The name of the AWS DMS event notification subscription to be modified.</p>"
|
||||
},
|
||||
"SnsTopicArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.</p>"
|
||||
},
|
||||
"SourceType":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The type of AWS DMS resource that generates the events you want to subscribe to. </p> <p>Valid values: replication-instance | migration-task</p>"
|
||||
},
|
||||
"EventCategories":{
|
||||
"shape":"EventCategoriesList",
|
||||
"documentation":"<p> A list of event categories for a source type that you want to subscribe to. Use the <code>DescribeEventCategories</code> action to see a list of event categories. </p>"
|
||||
},
|
||||
"Enabled":{
|
||||
"shape":"BooleanOptional",
|
||||
"documentation":"<p> A Boolean value; set to <b>true</b> to activate the subscription. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"ModifyEventSubscriptionResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"EventSubscription":{
|
||||
"shape":"EventSubscription",
|
||||
"documentation":"<p>The modified event subscription.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"ModifyReplicationInstanceMessage":{
|
||||
"type":"structure",
|
||||
"required":["ReplicationInstanceArn"],
|
||||
|
|
@ -1740,7 +2245,7 @@
|
|||
},
|
||||
"ReplicationTaskIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The replication task identifier.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
|
||||
"documentation":"<p>The replication task identifier.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 255 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
|
||||
},
|
||||
"MigrationType":{
|
||||
"shape":"MigrationTypeValue",
|
||||
|
|
@ -1748,7 +2253,7 @@
|
|||
},
|
||||
"TableMappings":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The path of the JSON file that contains the table mappings. Preceed the path with \"file://\".</p> <p>For example, --table-mappings file://mappingfile.json</p>"
|
||||
"documentation":"<p>When using the AWS CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with \"file://\". When working with the DMS API, provide the JSON as the parameter value.</p> <p>For example, --table-mappings file://mappingfile.json</p>"
|
||||
},
|
||||
"ReplicationTaskSettings":{
|
||||
"shape":"String",
|
||||
|
|
@ -1771,6 +2276,63 @@
|
|||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"MongoDbSettings":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"Username":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The user name you use to access the MongoDB source endpoint. </p>"
|
||||
},
|
||||
"Password":{
|
||||
"shape":"SecretString",
|
||||
"documentation":"<p> The password for the user account you use to access the MongoDB source endpoint. </p>"
|
||||
},
|
||||
"ServerName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The name of the server on the MongoDB source endpoint. </p>"
|
||||
},
|
||||
"Port":{
|
||||
"shape":"IntegerOptional",
|
||||
"documentation":"<p> The port value for the MongoDB source endpoint. </p>"
|
||||
},
|
||||
"DatabaseName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The database name on the MongoDB source endpoint. </p>"
|
||||
},
|
||||
"AuthType":{
|
||||
"shape":"AuthTypeValue",
|
||||
"documentation":"<p> The authentication type you use to access the MongoDB source endpoint.</p> <p>Valid values: NO, PASSWORD </p> <p>When NO is selected, user name and password parameters are not used and can be empty. </p>"
|
||||
},
|
||||
"AuthMechanism":{
|
||||
"shape":"AuthMechanismValue",
|
||||
"documentation":"<p> The authentication mechanism you use to access the MongoDB source endpoint.</p> <p>Valid values: DEFAULT, MONGODB_CR, SCRAM_SHA_1 </p> <p>DEFAULT – For MongoDB version 2.x, use MONGODB_CR. For MongoDB version 3.x, use SCRAM_SHA_1. This attribute is not used when authType=No.</p>"
|
||||
},
|
||||
"NestingLevel":{
|
||||
"shape":"NestingLevelValue",
|
||||
"documentation":"<p> Specifies either document or table mode. </p> <p>Valid values: NONE, ONE</p> <p>Default value is NONE. Specify NONE to use document mode. Specify ONE to use table mode.</p>"
|
||||
},
|
||||
"ExtractDocId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> Specifies the document ID. Use this attribute when <code>NestingLevel</code> is set to NONE. </p> <p>Default value is false. </p>"
|
||||
},
|
||||
"DocsToInvestigate":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> Indicates the number of documents to preview to determine the document organization. Use this attribute when <code>NestingLevel</code> is set to ONE. </p> <p>Must be a positive value greater than 0. Default value is 1000.</p>"
|
||||
},
|
||||
"AuthSource":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The MongoDB database name. This attribute is not used when <code>authType=NO</code>. </p> <p>The default is admin.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"NestingLevelValue":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"none",
|
||||
"one"
|
||||
]
|
||||
},
|
||||
"OrderableReplicationInstance":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -1874,6 +2436,32 @@
|
|||
"refreshing"
|
||||
]
|
||||
},
|
||||
"ReloadTablesMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"ReplicationTaskArn",
|
||||
"TablesToReload"
|
||||
],
|
||||
"members":{
|
||||
"ReplicationTaskArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the replication instance. </p>"
|
||||
},
|
||||
"TablesToReload":{
|
||||
"shape":"TableListToReload",
|
||||
"documentation":"<p>The name and schema of the table to be reloaded. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ReloadTablesResponse":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ReplicationTaskArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The Amazon Resource Name (ARN) of the replication task. </p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"RemoveTagsFromResourceMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -2083,7 +2671,7 @@
|
|||
"members":{
|
||||
"ReplicationTaskIdentifier":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The replication task identifier.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 63 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
|
||||
"documentation":"<p>The replication task identifier.</p> <p>Constraints:</p> <ul> <li> <p>Must contain from 1 to 255 alphanumeric characters or hyphens.</p> </li> <li> <p>First character must be a letter.</p> </li> <li> <p>Cannot end with a hyphen or contain two consecutive hyphens.</p> </li> </ul>"
|
||||
},
|
||||
"SourceEndpointArn":{
|
||||
"shape":"String",
|
||||
|
|
@ -2210,6 +2798,62 @@
|
|||
"documentation":"<p>The quota for this resource quota has been exceeded.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"S3Settings":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"ServiceAccessRoleArn":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The Amazon Resource Name (ARN) used by the service access IAM role. </p>"
|
||||
},
|
||||
"ExternalTableDefinition":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> </p>"
|
||||
},
|
||||
"CsvRowDelimiter":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The delimiter used to separate rows in the source files. The default is a carriage return (\\n). </p>"
|
||||
},
|
||||
"CsvDelimiter":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The delimiter used to separate columns in the source files. The default is a comma. </p>"
|
||||
},
|
||||
"BucketFolder":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> An optional parameter to set a folder name in the S3 bucket. If provided, tables are created in the path <bucketFolder>/<schema_name>/<table_name>/. If this parameter is not specified, then the path used is <schema_name>/<table_name>/. </p>"
|
||||
},
|
||||
"BucketName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p> The name of the S3 bucket. </p>"
|
||||
},
|
||||
"CompressionType":{
|
||||
"shape":"CompressionTypeValue",
|
||||
"documentation":"<p> An optional parameter to use GZIP to compress the target files. Set to GZIP to compress the target files. Set to NONE (the default) or do not use to leave the files uncompressed. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"SNSInvalidTopicFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{
|
||||
"shape":"ExceptionMessage",
|
||||
"documentation":"<p/>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The SNS topic is invalid.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"SNSNoAuthorizationFault":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"message":{
|
||||
"shape":"ExceptionMessage",
|
||||
"documentation":"<p/>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>You are not authorized for the SNS subscription.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"SchemaList":{
|
||||
"type":"list",
|
||||
"member":{"shape":"String"}
|
||||
|
|
@ -2218,6 +2862,17 @@
|
|||
"type":"string",
|
||||
"sensitive":true
|
||||
},
|
||||
"SourceIdsList":{
|
||||
"type":"list",
|
||||
"member":{
|
||||
"shape":"String",
|
||||
"locationName":"SourceId"
|
||||
}
|
||||
},
|
||||
"SourceType":{
|
||||
"type":"string",
|
||||
"enum":["replication-instance"]
|
||||
},
|
||||
"StartReplicationTaskMessage":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -2339,7 +2994,7 @@
|
|||
"members":{
|
||||
"EngineName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The database engine name. Valid values include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, SYBASE, and SQLSERVER.</p>"
|
||||
"documentation":"<p>The database engine name. Valid values, depending on the EndPointType, include MYSQL, ORACLE, POSTGRES, MARIADB, AURORA, REDSHIFT, S3, SYBASE, DYNAMODB, MONGODB, and SQLSERVER.</p>"
|
||||
},
|
||||
"SupportsCDC":{
|
||||
"shape":"Boolean",
|
||||
|
|
@ -2360,6 +3015,10 @@
|
|||
}
|
||||
},
|
||||
"TStamp":{"type":"timestamp"},
|
||||
"TableListToReload":{
|
||||
"type":"list",
|
||||
"member":{"shape":"TableToReload"}
|
||||
},
|
||||
"TableStatistics":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2391,6 +3050,14 @@
|
|||
"shape":"Long",
|
||||
"documentation":"<p>The number of rows added during the Full Load operation.</p>"
|
||||
},
|
||||
"FullLoadCondtnlChkFailedRows":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The number of rows that failed conditional checks during the Full Load operation (valid only for DynamoDB as a target migrations).</p>"
|
||||
},
|
||||
"FullLoadErrorRows":{
|
||||
"shape":"Long",
|
||||
"documentation":"<p>The number of rows that failed to load during the Full Load operation (valid only for DynamoDB as a target migrations).</p>"
|
||||
},
|
||||
"LastUpdateTime":{
|
||||
"shape":"TStamp",
|
||||
"documentation":"<p>The last time the table was updated.</p>"
|
||||
|
|
@ -2406,6 +3073,20 @@
|
|||
"type":"list",
|
||||
"member":{"shape":"TableStatistics"}
|
||||
},
|
||||
"TableToReload":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"SchemaName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The schema name of the table to be reloaded.</p>"
|
||||
},
|
||||
"TableName":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The table name of the table to be reloaded.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p/>"
|
||||
},
|
||||
"Tag":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
@ -2495,5 +3176,5 @@
|
|||
}
|
||||
}
|
||||
},
|
||||
"documentation":"<fullname>AWS Database Migration Service</fullname> <p>AWS Database Migration Service (AWS DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.</p>"
|
||||
"documentation":"<fullname>AWS Database Migration Service</fullname> <p>AWS Database Migration Service (AWS DMS) can migrate your data to and from the most widely used commercial and open-source databases such as Oracle, PostgreSQL, Microsoft SQL Server, Amazon Redshift, MariaDB, Amazon Aurora, MySQL, and SAP Adaptive Server Enterprise (ASE). The service supports homogeneous migrations such as Oracle to Oracle, as well as heterogeneous migrations between different database platforms, such as Oracle to MySQL or SQL Server to PostgreSQL.</p> <p>For more information about AWS DMS, see the AWS DMS user guide at <a href=\"http://docs.aws.amazon.com/dms/latest/userguide/Welcome.html\"> What Is AWS Database Migration Service? </a> </p>"
|
||||
}
|
||||
|
|
|
|||
5
botocore/data/ds/2015-04-16/examples-1.json
Normal file
5
botocore/data/ds/2015-04-16/examples-1.json
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
}
|
||||
}
|
||||
628
botocore/data/dynamodb/2012-08-10/examples-1.json
Normal file
628
botocore/data/dynamodb/2012-08-10/examples-1.json
Normal file
|
|
@ -0,0 +1,628 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
"BatchGetItem": [
|
||||
{
|
||||
"input": {
|
||||
"RequestItems": {
|
||||
"Music": {
|
||||
"Keys": [
|
||||
{
|
||||
"Artist": {
|
||||
"S": "No One You Know"
|
||||
},
|
||||
"SongTitle": {
|
||||
"S": "Call Me Today"
|
||||
}
|
||||
},
|
||||
{
|
||||
"Artist": {
|
||||
"S": "Acme Band"
|
||||
},
|
||||
"SongTitle": {
|
||||
"S": "Happy Day"
|
||||
}
|
||||
},
|
||||
{
|
||||
"Artist": {
|
||||
"S": "No One You Know"
|
||||
},
|
||||
"SongTitle": {
|
||||
"S": "Scared of My Shadow"
|
||||
}
|
||||
}
|
||||
],
|
||||
"ProjectionExpression": "AlbumTitle"
|
||||
}
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
"Responses": {
|
||||
"Music": [
|
||||
{
|
||||
"AlbumTitle": {
|
||||
"S": "Somewhat Famous"
|
||||
}
|
||||
},
|
||||
{
|
||||
"AlbumTitle": {
|
||||
"S": "Blue Sky Blues"
|
||||
}
|
||||
},
|
||||
{
|
||||
"AlbumTitle": {
|
||||
"S": "Louder Than Ever"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example reads multiple items from the Music table using a batch of three GetItem requests. Only the AlbumTitle attribute is returned.",
|
||||
"id": "to-retrieve-multiple-items-from-a-table-1476118438992",
|
||||
"title": "To retrieve multiple items from a table"
|
||||
}
|
||||
],
|
||||
"BatchWriteItem": [
|
||||
{
|
||||
"input": {
|
||||
"RequestItems": {
|
||||
"Music": [
|
||||
{
|
||||
"PutRequest": {
|
||||
"Item": {
|
||||
"AlbumTitle": {
|
||||
"S": "Somewhat Famous"
|
||||
},
|
||||
"Artist": {
|
||||
"S": "No One You Know"
|
||||
},
|
||||
"SongTitle": {
|
||||
"S": "Call Me Today"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"PutRequest": {
|
||||
"Item": {
|
||||
"AlbumTitle": {
|
||||
"S": "Songs About Life"
|
||||
},
|
||||
"Artist": {
|
||||
"S": "Acme Band"
|
||||
},
|
||||
"SongTitle": {
|
||||
"S": "Happy Day"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
"PutRequest": {
|
||||
"Item": {
|
||||
"AlbumTitle": {
|
||||
"S": "Blue Sky Blues"
|
||||
},
|
||||
"Artist": {
|
||||
"S": "No One You Know"
|
||||
},
|
||||
"SongTitle": {
|
||||
"S": "Scared of My Shadow"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"output": {
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example adds three new items to the Music table using a batch of three PutItem requests.",
|
||||
"id": "to-add-multiple-items-to-a-table-1476118519747",
|
||||
"title": "To add multiple items to a table"
|
||||
}
|
||||
],
|
||||
"CreateTable": [
|
||||
{
|
||||
"input": {
|
||||
"AttributeDefinitions": [
|
||||
{
|
||||
"AttributeName": "Artist",
|
||||
"AttributeType": "S"
|
||||
},
|
||||
{
|
||||
"AttributeName": "SongTitle",
|
||||
"AttributeType": "S"
|
||||
}
|
||||
],
|
||||
"KeySchema": [
|
||||
{
|
||||
"AttributeName": "Artist",
|
||||
"KeyType": "HASH"
|
||||
},
|
||||
{
|
||||
"AttributeName": "SongTitle",
|
||||
"KeyType": "RANGE"
|
||||
}
|
||||
],
|
||||
"ProvisionedThroughput": {
|
||||
"ReadCapacityUnits": 5,
|
||||
"WriteCapacityUnits": 5
|
||||
},
|
||||
"TableName": "Music"
|
||||
},
|
||||
"output": {
|
||||
"TableDescription": {
|
||||
"AttributeDefinitions": [
|
||||
{
|
||||
"AttributeName": "Artist",
|
||||
"AttributeType": "S"
|
||||
},
|
||||
{
|
||||
"AttributeName": "SongTitle",
|
||||
"AttributeType": "S"
|
||||
}
|
||||
],
|
||||
"CreationDateTime": "1421866952.062",
|
||||
"ItemCount": 0,
|
||||
"KeySchema": [
|
||||
{
|
||||
"AttributeName": "Artist",
|
||||
"KeyType": "HASH"
|
||||
},
|
||||
{
|
||||
"AttributeName": "SongTitle",
|
||||
"KeyType": "RANGE"
|
||||
}
|
||||
],
|
||||
"ProvisionedThroughput": {
|
||||
"ReadCapacityUnits": 5,
|
||||
"WriteCapacityUnits": 5
|
||||
},
|
||||
"TableName": "Music",
|
||||
"TableSizeBytes": 0,
|
||||
"TableStatus": "CREATING"
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example creates a table named Music.",
|
||||
"id": "to-create-a-table-1476116291743",
|
||||
"title": "To create a table"
|
||||
}
|
||||
],
|
||||
"DeleteItem": [
|
||||
{
|
||||
"input": {
|
||||
"Key": {
|
||||
"Artist": {
|
||||
"S": "No One You Know"
|
||||
},
|
||||
"SongTitle": {
|
||||
"S": "Scared of My Shadow"
|
||||
}
|
||||
},
|
||||
"TableName": "Music"
|
||||
},
|
||||
"output": {
|
||||
"ConsumedCapacity": {
|
||||
"CapacityUnits": 1,
|
||||
"TableName": "Music"
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes an item from the Music table.",
|
||||
"id": "to-delete-an-item-1475884573758",
|
||||
"title": "To delete an item"
|
||||
}
|
||||
],
|
||||
"DeleteTable": [
|
||||
{
|
||||
"input": {
|
||||
"TableName": "Music"
|
||||
},
|
||||
"output": {
|
||||
"TableDescription": {
|
||||
"ItemCount": 0,
|
||||
"ProvisionedThroughput": {
|
||||
"NumberOfDecreasesToday": 1,
|
||||
"ReadCapacityUnits": 5,
|
||||
"WriteCapacityUnits": 5
|
||||
},
|
||||
"TableName": "Music",
|
||||
"TableSizeBytes": 0,
|
||||
"TableStatus": "DELETING"
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example deletes the Music table.",
|
||||
"id": "to-delete-a-table-1475884368755",
|
||||
"title": "To delete a table"
|
||||
}
|
||||
],
|
||||
"DescribeLimits": [
|
||||
{
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
"AccountMaxReadCapacityUnits": 20000,
|
||||
"AccountMaxWriteCapacityUnits": 20000,
|
||||
"TableMaxReadCapacityUnits": 10000,
|
||||
"TableMaxWriteCapacityUnits": 10000
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns the maximum read and write capacity units per table, and for the AWS account, in the current AWS region.",
|
||||
"id": "to-determine-capacity-limits-per-table-and-account-in-the-current-aws-region-1475884162064",
|
||||
"title": "To determine capacity limits per table and account, in the current AWS region"
|
||||
}
|
||||
],
|
||||
"DescribeTable": [
|
||||
{
|
||||
"input": {
|
||||
"TableName": "Music"
|
||||
},
|
||||
"output": {
|
||||
"Table": {
|
||||
"AttributeDefinitions": [
|
||||
{
|
||||
"AttributeName": "Artist",
|
||||
"AttributeType": "S"
|
||||
},
|
||||
{
|
||||
"AttributeName": "SongTitle",
|
||||
"AttributeType": "S"
|
||||
}
|
||||
],
|
||||
"CreationDateTime": "1421866952.062",
|
||||
"ItemCount": 0,
|
||||
"KeySchema": [
|
||||
{
|
||||
"AttributeName": "Artist",
|
||||
"KeyType": "HASH"
|
||||
},
|
||||
{
|
||||
"AttributeName": "SongTitle",
|
||||
"KeyType": "RANGE"
|
||||
}
|
||||
],
|
||||
"ProvisionedThroughput": {
|
||||
"NumberOfDecreasesToday": 1,
|
||||
"ReadCapacityUnits": 5,
|
||||
"WriteCapacityUnits": 5
|
||||
},
|
||||
"TableName": "Music",
|
||||
"TableSizeBytes": 0,
|
||||
"TableStatus": "ACTIVE"
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example describes the Music table.",
|
||||
"id": "to-describe-a-table-1475884440502",
|
||||
"title": "To describe a table"
|
||||
}
|
||||
],
|
||||
"GetItem": [
|
||||
{
|
||||
"input": {
|
||||
"Key": {
|
||||
"Artist": {
|
||||
"S": "Acme Band"
|
||||
},
|
||||
"SongTitle": {
|
||||
"S": "Happy Day"
|
||||
}
|
||||
},
|
||||
"TableName": "Music"
|
||||
},
|
||||
"output": {
|
||||
"Item": {
|
||||
"AlbumTitle": {
|
||||
"S": "Songs About Life"
|
||||
},
|
||||
"Artist": {
|
||||
"S": "Acme Band"
|
||||
},
|
||||
"SongTitle": {
|
||||
"S": "Happy Day"
|
||||
}
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example retrieves an item from the Music table. The table has a partition key and a sort key (Artist and SongTitle), so you must specify both of these attributes.",
|
||||
"id": "to-read-an-item-from-a-table-1475884258350",
|
||||
"title": "To read an item from a table"
|
||||
}
|
||||
],
|
||||
"ListTables": [
|
||||
{
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
"TableNames": [
|
||||
"Forum",
|
||||
"ProductCatalog",
|
||||
"Reply",
|
||||
"Thread"
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example lists all of the tables associated with the current AWS account and endpoint.",
|
||||
"id": "to-list-tables-1475884741238",
|
||||
"title": "To list tables"
|
||||
}
|
||||
],
|
||||
"PutItem": [
|
||||
{
|
||||
"input": {
|
||||
"Item": {
|
||||
"AlbumTitle": {
|
||||
"S": "Somewhat Famous"
|
||||
},
|
||||
"Artist": {
|
||||
"S": "No One You Know"
|
||||
},
|
||||
"SongTitle": {
|
||||
"S": "Call Me Today"
|
||||
}
|
||||
},
|
||||
"ReturnConsumedCapacity": "TOTAL",
|
||||
"TableName": "Music"
|
||||
},
|
||||
"output": {
|
||||
"ConsumedCapacity": {
|
||||
"CapacityUnits": 1,
|
||||
"TableName": "Music"
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example adds a new item to the Music table.",
|
||||
"id": "to-add-an-item-to-a-table-1476116191110",
|
||||
"title": "To add an item to a table"
|
||||
}
|
||||
],
|
||||
"Query": [
|
||||
{
|
||||
"input": {
|
||||
"ExpressionAttributeValues": {
|
||||
":v1": {
|
||||
"S": "No One You Know"
|
||||
}
|
||||
},
|
||||
"KeyConditionExpression": "Artist = :v1",
|
||||
"ProjectionExpression": "SongTitle",
|
||||
"TableName": "Music"
|
||||
},
|
||||
"output": {
|
||||
"ConsumedCapacity": {
|
||||
},
|
||||
"Count": 2,
|
||||
"Items": [
|
||||
{
|
||||
"SongTitle": {
|
||||
"S": "Call Me Today"
|
||||
}
|
||||
}
|
||||
],
|
||||
"ScannedCount": 2
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example queries items in the Music table. The table has a partition key and sort key (Artist and SongTitle), but this query only specifies the partition key value. It returns song titles by the artist named \"No One You Know\".",
|
||||
"id": "to-query-an-item-1475883874631",
|
||||
"title": "To query an item"
|
||||
}
|
||||
],
|
||||
"Scan": [
|
||||
{
|
||||
"input": {
|
||||
"ExpressionAttributeNames": {
|
||||
"AT": "AlbumTitle",
|
||||
"ST": "SongTitle"
|
||||
},
|
||||
"ExpressionAttributeValues": {
|
||||
":a": {
|
||||
"S": "No One You Know"
|
||||
}
|
||||
},
|
||||
"FilterExpression": "Artist = :a",
|
||||
"ProjectionExpression": "#ST, #AT",
|
||||
"TableName": "Music"
|
||||
},
|
||||
"output": {
|
||||
"ConsumedCapacity": {
|
||||
},
|
||||
"Count": 2,
|
||||
"Items": [
|
||||
{
|
||||
"AlbumTitle": {
|
||||
"S": "Somewhat Famous"
|
||||
},
|
||||
"SongTitle": {
|
||||
"S": "Call Me Today"
|
||||
}
|
||||
},
|
||||
{
|
||||
"AlbumTitle": {
|
||||
"S": "Blue Sky Blues"
|
||||
},
|
||||
"SongTitle": {
|
||||
"S": "Scared of My Shadow"
|
||||
}
|
||||
}
|
||||
],
|
||||
"ScannedCount": 3
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example scans the entire Music table, and then narrows the results to songs by the artist \"No One You Know\". For each item, only the album title and song title are returned.",
|
||||
"id": "to-scan-a-table-1475883652470",
|
||||
"title": "To scan a table"
|
||||
}
|
||||
],
|
||||
"UpdateItem": [
|
||||
{
|
||||
"input": {
|
||||
"ExpressionAttributeNames": {
|
||||
"#AT": "AlbumTitle",
|
||||
"#Y": "Year"
|
||||
},
|
||||
"ExpressionAttributeValues": {
|
||||
":t": {
|
||||
"S": "Louder Than Ever"
|
||||
},
|
||||
":y": {
|
||||
"N": "2015"
|
||||
}
|
||||
},
|
||||
"Key": {
|
||||
"Artist": {
|
||||
"S": "Acme Band"
|
||||
},
|
||||
"SongTitle": {
|
||||
"S": "Happy Day"
|
||||
}
|
||||
},
|
||||
"ReturnValues": "ALL_NEW",
|
||||
"TableName": "Music",
|
||||
"UpdateExpression": "SET #Y = :y, #AT = :t"
|
||||
},
|
||||
"output": {
|
||||
"Attributes": {
|
||||
"AlbumTitle": {
|
||||
"S": "Songs About Life"
|
||||
},
|
||||
"Artist": {
|
||||
"S": "Acme Band"
|
||||
},
|
||||
"SongTitle": {
|
||||
"S": "Happy Day"
|
||||
}
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example updates an item in the Music table. It adds a new attribute (Year) and modifies the AlbumTitle attribute. All of the attributes in the item, as they appear after the update, are returned in the response.",
|
||||
"id": "to-update-an-item-in-a-table-1476118250055",
|
||||
"title": "To update an item in a table"
|
||||
}
|
||||
],
|
||||
"UpdateTable": [
|
||||
{
|
||||
"input": {
|
||||
"ProvisionedThroughput": {
|
||||
"ReadCapacityUnits": 10,
|
||||
"WriteCapacityUnits": 10
|
||||
},
|
||||
"TableName": "MusicCollection"
|
||||
},
|
||||
"output": {
|
||||
"TableDescription": {
|
||||
"AttributeDefinitions": [
|
||||
{
|
||||
"AttributeName": "Artist",
|
||||
"AttributeType": "S"
|
||||
},
|
||||
{
|
||||
"AttributeName": "SongTitle",
|
||||
"AttributeType": "S"
|
||||
}
|
||||
],
|
||||
"CreationDateTime": "1421866952.062",
|
||||
"ItemCount": 0,
|
||||
"KeySchema": [
|
||||
{
|
||||
"AttributeName": "Artist",
|
||||
"KeyType": "HASH"
|
||||
},
|
||||
{
|
||||
"AttributeName": "SongTitle",
|
||||
"KeyType": "RANGE"
|
||||
}
|
||||
],
|
||||
"ProvisionedThroughput": {
|
||||
"LastIncreaseDateTime": "1421874759.194",
|
||||
"NumberOfDecreasesToday": 1,
|
||||
"ReadCapacityUnits": 1,
|
||||
"WriteCapacityUnits": 1
|
||||
},
|
||||
"TableName": "MusicCollection",
|
||||
"TableSizeBytes": 0,
|
||||
"TableStatus": "UPDATING"
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "This example increases the provisioned read and write capacity on the Music table.",
|
||||
"id": "to-modify-a-tables-provisioned-throughput-1476118076147",
|
||||
"title": "To modify a table's provisioned throughput"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
131
botocore/data/dynamodb/2012-08-10/service-2.json
Normal file → Executable file
131
botocore/data/dynamodb/2012-08-10/service-2.json
Normal file → Executable file
|
|
@ -118,6 +118,20 @@
|
|||
],
|
||||
"documentation":"<p>Returns information about the table, including the current status of the table, when it was created, the primary key schema, and any indexes on the table.</p> <note> <p>If you issue a <code>DescribeTable</code> request immediately after a <code>CreateTable</code> request, DynamoDB might return a <code>ResourceNotFoundException</code>. This is because <code>DescribeTable</code> uses an eventually consistent query, and the metadata for your table might not be available at that moment. Wait for a few seconds, and then try the <code>DescribeTable</code> request again.</p> </note>"
|
||||
},
|
||||
"DescribeTimeToLive":{
|
||||
"name":"DescribeTimeToLive",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"DescribeTimeToLiveInput"},
|
||||
"output":{"shape":"DescribeTimeToLiveOutput"},
|
||||
"errors":[
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InternalServerError"}
|
||||
],
|
||||
"documentation":"<p>Gives a description of the Time to Live (TTL) status on the specified table. </p>"
|
||||
},
|
||||
"GetItem":{
|
||||
"name":"GetItem",
|
||||
"http":{
|
||||
|
|
@ -269,6 +283,22 @@
|
|||
{"shape":"InternalServerError"}
|
||||
],
|
||||
"documentation":"<p>Modifies the provisioned throughput settings, global secondary indexes, or DynamoDB Streams settings for a given table.</p> <p>You can only perform one of the following operations at once:</p> <ul> <li> <p>Modify the provisioned throughput settings of the table.</p> </li> <li> <p>Enable or disable Streams on the table.</p> </li> <li> <p>Remove a global secondary index from the table.</p> </li> <li> <p>Create a new global secondary index on the table. Once the index begins backfilling, you can use <code>UpdateTable</code> to perform other operations.</p> </li> </ul> <p> <code>UpdateTable</code> is an asynchronous operation; while it is executing, the table status changes from <code>ACTIVE</code> to <code>UPDATING</code>. While it is <code>UPDATING</code>, you cannot issue another <code>UpdateTable</code> request. When the table returns to the <code>ACTIVE</code> state, the <code>UpdateTable</code> operation is complete.</p>"
|
||||
},
|
||||
"UpdateTimeToLive":{
|
||||
"name":"UpdateTimeToLive",
|
||||
"http":{
|
||||
"method":"POST",
|
||||
"requestUri":"/"
|
||||
},
|
||||
"input":{"shape":"UpdateTimeToLiveInput"},
|
||||
"output":{"shape":"UpdateTimeToLiveOutput"},
|
||||
"errors":[
|
||||
{"shape":"ResourceInUseException"},
|
||||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"LimitExceededException"},
|
||||
{"shape":"InternalServerError"}
|
||||
],
|
||||
"documentation":"<p>Specify the lifetime of individual table items. The database automatically removes the item at the expiration of the item. The UpdateTimeToLive method will enable or disable TTL for the specified table. A successful <code>UpdateTimeToLive</code> call returns the current <code>TimeToLiveSpecification</code>; it may take up to one hour for the change to fully process. </p> <p>TTL compares the current time in epoch time format to the time stored in the TTL attribute of an item. If the epoch time value stored in the attribute is less than the current time, the item is marked as expired and subsequently deleted.</p> <note> <p> The epoch time format is the number of seconds elapsed since 12:00:00 AM January 1st, 1970 UTC. </p> </note> <p>DynamoDB deletes expired items on a best-effort basis to ensure availability of throughput for other data operations. </p> <important> <p>DynamoDB typically deletes expired items within two days of expiration. The exact duration within which an item gets deleted after expiration is specific to the nature of the workload. Items that have expired and not been deleted will still show up in reads, queries, and scans.</p> </important> <p>As items are deleted, they are removed from any Local Secondary Index and Global Secondary Index immediately in the same eventually consistent way as a standard delete operation.</p> <p>For more information, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html\">Time To Live</a> in the Amazon DynamoDB Developer Guide. </p>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -694,7 +724,7 @@
|
|||
},
|
||||
"ConditionExpression":{
|
||||
"shape":"ConditionExpression",
|
||||
"documentation":"<p>A condition that must be satisfied in order for a conditional <code>DeleteItem</code> to succeed.</p> <p>An expression can contain any of the following:</p> <ul> <li> <p>Functions: <code>attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size</code> </p> <p>These function names are case-sensitive.</p> </li> <li> <p>Comparison operators: <code> = | <> | < | > | <= | >= | BETWEEN | IN</code> </p> </li> <li> <p> Logical operators: <code>AND | OR | NOT</code> </p> </li> </ul> <p>For more information on condition expressions, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html\">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"
|
||||
"documentation":"<p>A condition that must be satisfied in order for a conditional <code>DeleteItem</code> to succeed.</p> <p>An expression can contain any of the following:</p> <ul> <li> <p>Functions: <code>attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size</code> </p> <p>These function names are case-sensitive.</p> </li> <li> <p>Comparison operators: <code>= | <> | < | > | <= | >= | BETWEEN | IN </code> </p> </li> <li> <p> Logical operators: <code>AND | OR | NOT</code> </p> </li> </ul> <p>For more information on condition expressions, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html\">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"
|
||||
},
|
||||
"ExpressionAttributeNames":{
|
||||
"shape":"ExpressionAttributeNameMap",
|
||||
|
|
@ -806,6 +836,25 @@
|
|||
},
|
||||
"documentation":"<p>Represents the output of a <code>DescribeTable</code> operation.</p>"
|
||||
},
|
||||
"DescribeTimeToLiveInput":{
|
||||
"type":"structure",
|
||||
"required":["TableName"],
|
||||
"members":{
|
||||
"TableName":{
|
||||
"shape":"TableName",
|
||||
"documentation":"<p>The name of the table to be described.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"DescribeTimeToLiveOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TimeToLiveDescription":{
|
||||
"shape":"TimeToLiveDescription",
|
||||
"documentation":"<p/>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"ErrorMessage":{"type":"string"},
|
||||
"ExpectedAttributeMap":{
|
||||
"type":"map",
|
||||
|
|
@ -1436,7 +1485,7 @@
|
|||
},
|
||||
"ConditionExpression":{
|
||||
"shape":"ConditionExpression",
|
||||
"documentation":"<p>A condition that must be satisfied in order for a conditional <code>PutItem</code> operation to succeed.</p> <p>An expression can contain any of the following:</p> <ul> <li> <p>Functions: <code>attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size</code> </p> <p>These function names are case-sensitive.</p> </li> <li> <p>Comparison operators: <code> = | <> | < | > | <= | >= | BETWEEN | IN</code> </p> </li> <li> <p> Logical operators: <code>AND | OR | NOT</code> </p> </li> </ul> <p>For more information on condition expressions, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html\">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"
|
||||
"documentation":"<p>A condition that must be satisfied in order for a conditional <code>PutItem</code> operation to succeed.</p> <p>An expression can contain any of the following:</p> <ul> <li> <p>Functions: <code>attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size</code> </p> <p>These function names are case-sensitive.</p> </li> <li> <p>Comparison operators: <code>= | <> | < | > | <= | >= | BETWEEN | IN </code> </p> </li> <li> <p> Logical operators: <code>AND | OR | NOT</code> </p> </li> </ul> <p>For more information on condition expressions, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html\">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"
|
||||
},
|
||||
"ExpressionAttributeNames":{
|
||||
"shape":"ExpressionAttributeNameMap",
|
||||
|
|
@ -1929,6 +1978,53 @@
|
|||
"max":256,
|
||||
"min":0
|
||||
},
|
||||
"TimeToLiveAttributeName":{
|
||||
"type":"string",
|
||||
"max":255,
|
||||
"min":1
|
||||
},
|
||||
"TimeToLiveDescription":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TimeToLiveStatus":{
|
||||
"shape":"TimeToLiveStatus",
|
||||
"documentation":"<p> The Time to Live status for the table.</p>"
|
||||
},
|
||||
"AttributeName":{
|
||||
"shape":"TimeToLiveAttributeName",
|
||||
"documentation":"<p> The name of the Time to Live attribute for items in the table.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The description of the Time to Live (TTL) status on the specified table. </p>"
|
||||
},
|
||||
"TimeToLiveEnabled":{"type":"boolean"},
|
||||
"TimeToLiveSpecification":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"Enabled",
|
||||
"AttributeName"
|
||||
],
|
||||
"members":{
|
||||
"Enabled":{
|
||||
"shape":"TimeToLiveEnabled",
|
||||
"documentation":"<p>Indicates whether Time To Live is to be enabled (true) or disabled (false) on the table.</p>"
|
||||
},
|
||||
"AttributeName":{
|
||||
"shape":"TimeToLiveAttributeName",
|
||||
"documentation":"<p>The name of the Time to Live attribute used to store the expiration time for items in the table.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the settings used to enable or disable Time to Live for the specified table.</p>"
|
||||
},
|
||||
"TimeToLiveStatus":{
|
||||
"type":"string",
|
||||
"enum":[
|
||||
"ENABLING",
|
||||
"DISABLING",
|
||||
"ENABLED",
|
||||
"DISABLED"
|
||||
]
|
||||
},
|
||||
"UntagResourceInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
|
|
@ -1994,7 +2090,7 @@
|
|||
},
|
||||
"ReturnValues":{
|
||||
"shape":"ReturnValue",
|
||||
"documentation":"<p>Use <code>ReturnValues</code> if you want to get the item attributes as they appeared either before or after they were updated. For <code>UpdateItem</code>, the valid values are:</p> <ul> <li> <p> <code>NONE</code> - If <code>ReturnValues</code> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <code>ReturnValues</code>.)</p> </li> <li> <p> <code>ALL_OLD</code> - If <code>UpdateItem</code> overwrote an attribute name-value pair, then the content of the old item is returned.</p> </li> <li> <p> <code>UPDATED_OLD</code> - The old versions of only the updated attributes are returned.</p> </li> <li> <p> <code>ALL_NEW</code> - All of the attributes of the new version of the item are returned.</p> </li> <li> <p> <code>UPDATED_NEW</code> - The new versions of only the updated attributes are returned.</p> </li> </ul> <p>There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.</p> <p>Values returned are strongly consistent</p>"
|
||||
"documentation":"<p>Use <code>ReturnValues</code> if you want to get the item attributes as they appeared either before or after they were updated. For <code>UpdateItem</code>, the valid values are:</p> <ul> <li> <p> <code>NONE</code> - If <code>ReturnValues</code> is not specified, or if its value is <code>NONE</code>, then nothing is returned. (This setting is the default for <code>ReturnValues</code>.)</p> </li> <li> <p> <code>ALL_OLD</code> - Returns all of the attributes of the item, as they appeared before the UpdateItem operation.</p> </li> <li> <p> <code>UPDATED_OLD</code> - Returns only the updated attributes, as they appeared before the UpdateItem operation.</p> </li> <li> <p> <code>ALL_NEW</code> - Returns all of the attributes of the item, as they appear after the UpdateItem operation.</p> </li> <li> <p> <code>UPDATED_NEW</code> - Returns only the updated attributes, as they appear after the UpdateItem operation.</p> </li> </ul> <p>There is no additional cost associated with requesting a return value aside from the small network and processing overhead of receiving a larger response. No Read Capacity Units are consumed.</p> <p>Values returned are strongly consistent</p>"
|
||||
},
|
||||
"ReturnConsumedCapacity":{"shape":"ReturnConsumedCapacity"},
|
||||
"ReturnItemCollectionMetrics":{
|
||||
|
|
@ -2007,7 +2103,7 @@
|
|||
},
|
||||
"ConditionExpression":{
|
||||
"shape":"ConditionExpression",
|
||||
"documentation":"<p>A condition that must be satisfied in order for a conditional update to succeed.</p> <p>An expression can contain any of the following:</p> <ul> <li> <p>Functions: <code>attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size</code> </p> <p>These function names are case-sensitive.</p> </li> <li> <p>Comparison operators: <code> = | <> | < | > | <= | >= | BETWEEN | IN</code> </p> </li> <li> <p> Logical operators: <code>AND | OR | NOT</code> </p> </li> </ul> <p>For more information on condition expressions, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html\">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"
|
||||
"documentation":"<p>A condition that must be satisfied in order for a conditional update to succeed.</p> <p>An expression can contain any of the following:</p> <ul> <li> <p>Functions: <code>attribute_exists | attribute_not_exists | attribute_type | contains | begins_with | size</code> </p> <p>These function names are case-sensitive.</p> </li> <li> <p>Comparison operators: <code>= | <> | < | > | <= | >= | BETWEEN | IN </code> </p> </li> <li> <p> Logical operators: <code>AND | OR | NOT</code> </p> </li> </ul> <p>For more information on condition expressions, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.SpecifyingConditions.html\">Specifying Conditions</a> in the <i>Amazon DynamoDB Developer Guide</i>.</p>"
|
||||
},
|
||||
"ExpressionAttributeNames":{
|
||||
"shape":"ExpressionAttributeNameMap",
|
||||
|
|
@ -2075,6 +2171,33 @@
|
|||
},
|
||||
"documentation":"<p>Represents the output of an <code>UpdateTable</code> operation.</p>"
|
||||
},
|
||||
"UpdateTimeToLiveInput":{
|
||||
"type":"structure",
|
||||
"required":[
|
||||
"TableName",
|
||||
"TimeToLiveSpecification"
|
||||
],
|
||||
"members":{
|
||||
"TableName":{
|
||||
"shape":"TableName",
|
||||
"documentation":"<p>The name of the table to be configured.</p>"
|
||||
},
|
||||
"TimeToLiveSpecification":{
|
||||
"shape":"TimeToLiveSpecification",
|
||||
"documentation":"<p>Represents the settings used to enable or disable Time to Live for the specified table.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of an <code>UpdateTimeToLive</code> operation.</p>"
|
||||
},
|
||||
"UpdateTimeToLiveOutput":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"TimeToLiveSpecification":{
|
||||
"shape":"TimeToLiveSpecification",
|
||||
"documentation":"<p>Represents the output of an <code>UpdateTimeToLive</code> operation.</p>"
|
||||
}
|
||||
}
|
||||
},
|
||||
"WriteRequest":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
|
|
|
|||
212
botocore/data/dynamodbstreams/2012-08-10/examples-1.json
Normal file
212
botocore/data/dynamodbstreams/2012-08-10/examples-1.json
Normal file
|
|
@ -0,0 +1,212 @@
|
|||
{
|
||||
"version": "1.0",
|
||||
"examples": {
|
||||
"DescribeStream": [
|
||||
{
|
||||
"input": {
|
||||
"StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252"
|
||||
},
|
||||
"output": {
|
||||
"StreamDescription": {
|
||||
"CreationRequestDateTime": "Wed May 20 13:51:10 PDT 2015",
|
||||
"KeySchema": [
|
||||
{
|
||||
"AttributeName": "ForumName",
|
||||
"KeyType": "HASH"
|
||||
},
|
||||
{
|
||||
"AttributeName": "Subject",
|
||||
"KeyType": "RANGE"
|
||||
}
|
||||
],
|
||||
"Shards": [
|
||||
{
|
||||
"SequenceNumberRange": {
|
||||
"EndingSequenceNumber": "20500000000000000910398",
|
||||
"StartingSequenceNumber": "20500000000000000910398"
|
||||
},
|
||||
"ShardId": "shardId-00000001414562045508-2bac9cd2"
|
||||
},
|
||||
{
|
||||
"ParentShardId": "shardId-00000001414562045508-2bac9cd2",
|
||||
"SequenceNumberRange": {
|
||||
"EndingSequenceNumber": "820400000000000001192334",
|
||||
"StartingSequenceNumber": "820400000000000001192334"
|
||||
},
|
||||
"ShardId": "shardId-00000001414576573621-f55eea83"
|
||||
},
|
||||
{
|
||||
"ParentShardId": "shardId-00000001414576573621-f55eea83",
|
||||
"SequenceNumberRange": {
|
||||
"EndingSequenceNumber": "1683700000000000001135967",
|
||||
"StartingSequenceNumber": "1683700000000000001135967"
|
||||
},
|
||||
"ShardId": "shardId-00000001414592258131-674fd923"
|
||||
},
|
||||
{
|
||||
"ParentShardId": "shardId-00000001414592258131-674fd923",
|
||||
"SequenceNumberRange": {
|
||||
"StartingSequenceNumber": "2574600000000000000935255"
|
||||
},
|
||||
"ShardId": "shardId-00000001414608446368-3a1afbaf"
|
||||
}
|
||||
],
|
||||
"StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252",
|
||||
"StreamLabel": "2015-05-20T20:51:10.252",
|
||||
"StreamStatus": "ENABLED",
|
||||
"StreamViewType": "NEW_AND_OLD_IMAGES",
|
||||
"TableName": "Forum"
|
||||
}
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example describes a stream with a given stream ARN.",
|
||||
"id": "to-describe-a-stream-with-a-given-stream-arn-1473457835200",
|
||||
"title": "To describe a stream with a given stream ARN"
|
||||
}
|
||||
],
|
||||
"GetRecords": [
|
||||
{
|
||||
"input": {
|
||||
"ShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ... <remaining characters omitted> ..."
|
||||
},
|
||||
"output": {
|
||||
"NextShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAGQBYshYDEe ... <remaining characters omitted> ...",
|
||||
"Records": [
|
||||
{
|
||||
"awsRegion": "us-west-2",
|
||||
"dynamodb": {
|
||||
"ApproximateCreationDateTime": "1.46480646E9",
|
||||
"Keys": {
|
||||
"ForumName": {
|
||||
"S": "DynamoDB"
|
||||
},
|
||||
"Subject": {
|
||||
"S": "DynamoDB Thread 3"
|
||||
}
|
||||
},
|
||||
"SequenceNumber": "300000000000000499659",
|
||||
"SizeBytes": 41,
|
||||
"StreamViewType": "KEYS_ONLY"
|
||||
},
|
||||
"eventID": "e2fd9c34eff2d779b297b26f5fef4206",
|
||||
"eventName": "INSERT",
|
||||
"eventSource": "aws:dynamodb",
|
||||
"eventVersion": "1.0"
|
||||
},
|
||||
{
|
||||
"awsRegion": "us-west-2",
|
||||
"dynamodb": {
|
||||
"ApproximateCreationDateTime": "1.46480527E9",
|
||||
"Keys": {
|
||||
"ForumName": {
|
||||
"S": "DynamoDB"
|
||||
},
|
||||
"Subject": {
|
||||
"S": "DynamoDB Thread 1"
|
||||
}
|
||||
},
|
||||
"SequenceNumber": "400000000000000499660",
|
||||
"SizeBytes": 41,
|
||||
"StreamViewType": "KEYS_ONLY"
|
||||
},
|
||||
"eventID": "4b25bd0da9a181a155114127e4837252",
|
||||
"eventName": "MODIFY",
|
||||
"eventSource": "aws:dynamodb",
|
||||
"eventVersion": "1.0"
|
||||
},
|
||||
{
|
||||
"awsRegion": "us-west-2",
|
||||
"dynamodb": {
|
||||
"ApproximateCreationDateTime": "1.46480646E9",
|
||||
"Keys": {
|
||||
"ForumName": {
|
||||
"S": "DynamoDB"
|
||||
},
|
||||
"Subject": {
|
||||
"S": "DynamoDB Thread 2"
|
||||
}
|
||||
},
|
||||
"SequenceNumber": "500000000000000499661",
|
||||
"SizeBytes": 41,
|
||||
"StreamViewType": "KEYS_ONLY"
|
||||
},
|
||||
"eventID": "740280c73a3df7842edab3548a1b08ad",
|
||||
"eventName": "REMOVE",
|
||||
"eventSource": "aws:dynamodb",
|
||||
"eventVersion": "1.0"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example retrieves all the stream records from a shard.",
|
||||
"id": "to-retrieve-all-the-stream-records-from-a-shard-1473707781419",
|
||||
"title": "To retrieve all the stream records from a shard"
|
||||
}
|
||||
],
|
||||
"GetShardIterator": [
|
||||
{
|
||||
"input": {
|
||||
"ShardId": "00000001414576573621-f55eea83",
|
||||
"ShardIteratorType": "TRIM_HORIZON",
|
||||
"StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252"
|
||||
},
|
||||
"output": {
|
||||
"ShardIterator": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252|1|AAAAAAAAAAEvJp6D+zaQ... <remaining characters omitted> ..."
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example returns a shard iterator for the provided stream ARN and shard ID.",
|
||||
"id": "to-obtain-a-shard-iterator-for-the-provided-stream-arn-and-shard-id-1473459941476",
|
||||
"title": "To obtain a shard iterator for the provided stream ARN and shard ID"
|
||||
}
|
||||
],
|
||||
"ListStreams": [
|
||||
{
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
"Streams": [
|
||||
{
|
||||
"StreamArn": "arn:aws:dynamodb:us-wesst-2:111122223333:table/Forum/stream/2015-05-20T20:51:10.252",
|
||||
"StreamLabel": "2015-05-20T20:51:10.252",
|
||||
"TableName": "Forum"
|
||||
},
|
||||
{
|
||||
"StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-20T20:50:02.714",
|
||||
"StreamLabel": "2015-05-20T20:50:02.714",
|
||||
"TableName": "Forum"
|
||||
},
|
||||
{
|
||||
"StreamArn": "arn:aws:dynamodb:us-west-2:111122223333:table/Forum/stream/2015-05-19T23:03:50.641",
|
||||
"StreamLabel": "2015-05-19T23:03:50.641",
|
||||
"TableName": "Forum"
|
||||
}
|
||||
]
|
||||
},
|
||||
"comments": {
|
||||
"input": {
|
||||
},
|
||||
"output": {
|
||||
}
|
||||
},
|
||||
"description": "The following example lists all of the stream ARNs.",
|
||||
"id": "to-list-all-of-the-stream-arns--1473459534285",
|
||||
"title": "To list all of the stream ARNs "
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
{
|
||||
"pagination": {}
|
||||
}
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InternalServerError"}
|
||||
],
|
||||
"documentation":"<p>Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.</p> <note> <p>You can call <i>DescribeStream</i> at a maximum rate of 10 times per second.</p> </note> <p>Each shard in the stream has a <code>SequenceNumberRange</code> associated with it. If the <code>SequenceNumberRange</code> has a <code>StartingSequenceNumber</code> but no <code>EndingSequenceNumber</code>, then the shard is still open (able to receive more stream records). If both <code>StartingSequenceNumber</code> and <code>EndingSequenceNumber</code> are present, then that shard is closed and can no longer receive more data.</p>"
|
||||
"documentation":"<p>Returns information about a stream, including the current status of the stream, its Amazon Resource Name (ARN), the composition of its shards, and its corresponding DynamoDB table.</p> <note> <p>You can call <code>DescribeStream</code> at a maximum rate of 10 times per second.</p> </note> <p>Each shard in the stream has a <code>SequenceNumberRange</code> associated with it. If the <code>SequenceNumberRange</code> has a <code>StartingSequenceNumber</code> but no <code>EndingSequenceNumber</code>, then the shard is still open (able to receive more stream records). If both <code>StartingSequenceNumber</code> and <code>EndingSequenceNumber</code> are present, then that shard is closed and can no longer receive more data.</p>"
|
||||
},
|
||||
"GetRecords":{
|
||||
"name":"GetRecords",
|
||||
|
|
@ -70,7 +70,7 @@
|
|||
{"shape":"ResourceNotFoundException"},
|
||||
{"shape":"InternalServerError"}
|
||||
],
|
||||
"documentation":"<p>Returns an array of stream ARNs associated with the current account and endpoint. If the <code>TableName</code> parameter is present, then <i>ListStreams</i> will return only the streams ARNs for that table.</p> <note> <p>You can call <i>ListStreams</i> at a maximum rate of 5 times per second.</p> </note>"
|
||||
"documentation":"<p>Returns an array of stream ARNs associated with the current account and endpoint. If the <code>TableName</code> parameter is present, then <code>ListStreams</code> will return only the streams ARNs for that table.</p> <note> <p>You can call <code>ListStreams</code> at a maximum rate of 5 times per second.</p> </note>"
|
||||
}
|
||||
},
|
||||
"shapes":{
|
||||
|
|
@ -153,7 +153,7 @@
|
|||
"documentation":"<p>The shard ID of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedShardId</code> in the previous operation. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>DescribeStream</i> operation.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>DescribeStream</code> operation.</p>"
|
||||
},
|
||||
"DescribeStreamOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -163,7 +163,7 @@
|
|||
"documentation":"<p>A complete description of the stream, including its creation date and time, the DynamoDB table associated with the stream, the shard IDs within the stream, and the beginning and ending sequence numbers of stream records within the shards.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>DescribeStream</i> operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>DescribeStream</code> operation.</p>"
|
||||
},
|
||||
"ErrorMessage":{"type":"string"},
|
||||
"ExpiredIteratorException":{
|
||||
|
|
@ -174,7 +174,7 @@
|
|||
"documentation":"<p>The provided iterator exceeds the maximum age allowed.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the <i>GetShardIterator</i> action.</p>",
|
||||
"documentation":"<p>The shard iterator has expired and can no longer be used to retrieve stream records. A shard iterator expires 15 minutes after it is retrieved using the <code>GetShardIterator</code> action.</p>",
|
||||
"exception":true
|
||||
},
|
||||
"GetRecordsInput":{
|
||||
|
|
@ -190,7 +190,7 @@
|
|||
"documentation":"<p>The maximum number of records to return from the shard. The upper limit is 1000.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>GetRecords</i> operation.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>GetRecords</code> operation.</p>"
|
||||
},
|
||||
"GetRecordsOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -204,7 +204,7 @@
|
|||
"documentation":"<p>The next position in the shard from which to start sequentially reading stream records. If set to <code>null</code>, the shard has been closed and the requested iterator will not return any more data.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>GetRecords</i> operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>GetRecords</code> operation.</p>"
|
||||
},
|
||||
"GetShardIteratorInput":{
|
||||
"type":"structure",
|
||||
|
|
@ -231,7 +231,7 @@
|
|||
"documentation":"<p>The sequence number of a stream record in the shard from which to start reading.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>GetShardIterator</i> operation.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>GetShardIterator</code> operation.</p>"
|
||||
},
|
||||
"GetShardIteratorOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -241,7 +241,21 @@
|
|||
"documentation":"<p>The position in the shard from which to start reading stream records sequentially. A shard iterator specifies this position using the sequence number of a stream record in a shard.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>GetShardIterator</i> operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>GetShardIterator</code> operation.</p>"
|
||||
},
|
||||
"Identity":{
|
||||
"type":"structure",
|
||||
"members":{
|
||||
"PrincipalId":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A unique identifier for the entity that made the call. For Time To Live, the principalId is \"dynamodb.amazonaws.com\".</p>"
|
||||
},
|
||||
"Type":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The type of the identity. For Time To Live, the type is \"Service\".</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Contains details about the type of identity that made the request.</p>"
|
||||
},
|
||||
"InternalServerError":{
|
||||
"type":"structure",
|
||||
|
|
@ -282,7 +296,7 @@
|
|||
"documentation":"<p>The attribute data, consisting of the data type and the attribute value itself.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.</p> <p>A <i>KeySchemaElement</i> represents exactly one attribute of the primary key. For example, a simple primary key (partition key) would be represented by one <i>KeySchemaElement</i>. A composite primary key (partition key and sort key) would require one <i>KeySchemaElement</i> for the partition key, and another <i>KeySchemaElement</i> for the sort key.</p> <note> <p>The partition key of an item is also known as its <i>hash attribute</i>. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.</p> <p>The sort key of an item is also known as its <i>range attribute</i>. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.</p> </note>"
|
||||
"documentation":"<p>Represents <i>a single element</i> of a key schema. A key schema specifies the attributes that make up the primary key of a table, or the key attributes of an index.</p> <p>A <code>KeySchemaElement</code> represents exactly one attribute of the primary key. For example, a simple primary key (partition key) would be represented by one <code>KeySchemaElement</code>. A composite primary key (partition key and sort key) would require one <code>KeySchemaElement</code> for the partition key, and another <code>KeySchemaElement</code> for the sort key.</p> <note> <p>The partition key of an item is also known as its <i>hash attribute</i>. The term \"hash attribute\" derives from DynamoDB's usage of an internal hash function to evenly distribute data items across partitions, based on their partition key values.</p> <p>The sort key of an item is also known as its <i>range attribute</i>. The term \"range attribute\" derives from the way DynamoDB stores items with the same partition key physically close together, in sorted order by the sort key value.</p> </note>"
|
||||
},
|
||||
"KeyType":{
|
||||
"type":"string",
|
||||
|
|
@ -322,7 +336,7 @@
|
|||
"documentation":"<p>The ARN (Amazon Resource Name) of the first item that this operation will evaluate. Use the value that was returned for <code>LastEvaluatedStreamArn</code> in the previous operation. </p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the input of a <i>ListStreams</i> operation.</p>"
|
||||
"documentation":"<p>Represents the input of a <code>ListStreams</code> operation.</p>"
|
||||
},
|
||||
"ListStreamsOutput":{
|
||||
"type":"structure",
|
||||
|
|
@ -336,7 +350,7 @@
|
|||
"documentation":"<p>The stream ARN of the item where the operation stopped, inclusive of the previous result set. Use this value to start a new operation, excluding this value in the new request.</p> <p>If <code>LastEvaluatedStreamArn</code> is empty, then the \"last page\" of results has been processed and there is no more data to be retrieved.</p> <p>If <code>LastEvaluatedStreamArn</code> is not empty, it does not necessarily mean that there is more data in the result set. The only way to know when you have reached the end of the result set is when <code>LastEvaluatedStreamArn</code> is empty.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents the output of a <i>ListStreams</i> operation.</p>"
|
||||
"documentation":"<p>Represents the output of a <code>ListStreams</code> operation.</p>"
|
||||
},
|
||||
"MapAttributeValue":{
|
||||
"type":"map",
|
||||
|
|
@ -378,19 +392,23 @@
|
|||
},
|
||||
"eventVersion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The version number of the stream record format. This number is updated whenever the structure of <i>Record</i> is modified.</p> <p>Client applications must not assume that <i>eventVersion</i> will remain at a particular value, as this number is subject to change at any time. In general, <i>eventVersion</i> will only increase as the low-level DynamoDB Streams API evolves.</p>"
|
||||
"documentation":"<p>The version number of the stream record format. This number is updated whenever the structure of <code>Record</code> is modified.</p> <p>Client applications must not assume that <code>eventVersion</code> will remain at a particular value, as this number is subject to change at any time. In general, <code>eventVersion</code> will only increase as the low-level DynamoDB Streams API evolves.</p>"
|
||||
},
|
||||
"eventSource":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The AWS service from which the stream record originated. For DynamoDB Streams, this is <i>aws:dynamodb</i>.</p>"
|
||||
"documentation":"<p>The AWS service from which the stream record originated. For DynamoDB Streams, this is <code>aws:dynamodb</code>.</p>"
|
||||
},
|
||||
"awsRegion":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>The region in which the <i>GetRecords</i> request was received.</p>"
|
||||
"documentation":"<p>The region in which the <code>GetRecords</code> request was received.</p>"
|
||||
},
|
||||
"dynamodb":{
|
||||
"shape":"StreamRecord",
|
||||
"documentation":"<p>The main body of the stream record, containing all of the DynamoDB-specific fields.</p>"
|
||||
},
|
||||
"userIdentity":{
|
||||
"shape":"Identity",
|
||||
"documentation":"<p>Items that are deleted by the Time to Live process after expiration have the following fields: </p> <ul> <li> <p>Records[].userIdentity.type</p> <p>\"Service\"</p> </li> <li> <p>Records[].userIdentity.principalId</p> <p>\"dynamodb.amazonaws.com\"</p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>A description of a unique event within a stream.</p>"
|
||||
|
|
@ -483,7 +501,7 @@
|
|||
},
|
||||
"StreamLabel":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A timestamp, in ISO 8601 format, for this stream.</p> <p>Note that <i>LatestStreamLabel</i> is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:</p> <ul> <li> <p>the AWS customer ID.</p> </li> <li> <p>the table name</p> </li> <li> <p>the <i>StreamLabel</i> </p> </li> </ul>"
|
||||
"documentation":"<p>A timestamp, in ISO 8601 format, for this stream.</p> <p>Note that <code>LatestStreamLabel</code> is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:</p> <ul> <li> <p>the AWS customer ID.</p> </li> <li> <p>the table name</p> </li> <li> <p>the <code>StreamLabel</code> </p> </li> </ul>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>Represents all of the data describing a particular stream.</p>"
|
||||
|
|
@ -502,7 +520,7 @@
|
|||
},
|
||||
"StreamLabel":{
|
||||
"shape":"String",
|
||||
"documentation":"<p>A timestamp, in ISO 8601 format, for this stream.</p> <p>Note that <i>LatestStreamLabel</i> is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:</p> <ul> <li> <p>the AWS customer ID.</p> </li> <li> <p>the table name</p> </li> <li> <p>the <i>StreamLabel</i> </p> </li> </ul>"
|
||||
"documentation":"<p>A timestamp, in ISO 8601 format, for this stream.</p> <p>Note that <code>LatestStreamLabel</code> is not a unique identifier for the stream, because it is possible that a stream from another table might have the same timestamp. However, the combination of the following three elements is guaranteed to be unique:</p> <ul> <li> <p>the AWS customer ID.</p> </li> <li> <p>the table name</p> </li> <li> <p>the <code>StreamLabel</code> </p> </li> </ul>"
|
||||
},
|
||||
"StreamStatus":{
|
||||
"shape":"StreamStatus",
|
||||
|
|
@ -611,9 +629,9 @@
|
|||
"documentation":"<p>\"The data you are trying to access has been trimmed.</p>"
|
||||
}
|
||||
},
|
||||
"documentation":"<p>The operation attempted to read past the oldest stream record in a shard.</p> <p>In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:</p> <ul> <li><p>You request a shard iterator with a sequence number older than the trim point (24 hours).</p> </li> <li><p>You obtain a shard iterator, but before you use the iterator in a <i>GetRecords</i> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</p> </li> </ul>",
|
||||
"documentation":"<p>The operation attempted to read past the oldest stream record in a shard.</p> <p>In DynamoDB Streams, there is a 24 hour limit on data retention. Stream records whose age exceeds this limit are subject to removal (trimming) from the stream. You might receive a TrimmedDataAccessException if:</p> <ul> <li><p>You request a shard iterator with a sequence number older than the trim point (24 hours).</p> </li> <li><p>You obtain a shard iterator, but before you use the iterator in a <code>GetRecords</code> request, a stream record in the shard exceeds the 24 hour period and is trimmed. This causes the iterator to access a record that no longer exists.</p> </li> </ul>",
|
||||
"exception":true
|
||||
}
|
||||
},
|
||||
"documentation":"<fullname>Amazon DynamoDB</fullname> <p>Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html\">Capturing Table Activity with DynamoDB Streams</a> in the Amazon DynamoDB Developer Guide.</p> <p>The following are short descriptions of each low-level DynamoDB Streams action:</p> <ul> <li> <p> <i>DescribeStream</i> - Returns detailed information about a particular stream.</p> </li> <li> <p> <i>GetRecords</i> - Retrieves the stream records from within a shard.</p> </li> <li> <p> <i>GetShardIterator</i> - Returns information on how to retrieve the streams record from a shard with a given shard ID.</p> </li> <li> <p> <i>ListStreams</i> - Returns a list of all the streams associated with the current AWS account and endpoint.</p> </li> </ul>"
|
||||
"documentation":"<fullname>Amazon DynamoDB</fullname> <p>Amazon DynamoDB Streams provides API actions for accessing streams and processing stream records. To learn more about application development with Streams, see <a href=\"http://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Streams.html\">Capturing Table Activity with DynamoDB Streams</a> in the Amazon DynamoDB Developer Guide.</p>"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -281,6 +281,24 @@
|
|||
}
|
||||
]
|
||||
},
|
||||
"KeyPairExists": {
|
||||
"operation": "DescribeKeyPairs",
|
||||
"delay": 5,
|
||||
"maxAttempts": 6,
|
||||
"acceptors": [
|
||||
{
|
||||
"expected": true,
|
||||
"matcher": "path",
|
||||
"state": "success",
|
||||
"argument": "length(KeyPairs[].KeyName) > `0`"
|
||||
},
|
||||
{
|
||||
"expected": "InvalidKeyPair.NotFound",
|
||||
"matcher": "error",
|
||||
"state": "retry"
|
||||
}
|
||||
]
|
||||
},
|
||||
"NatGatewayAvailable": {
|
||||
"operation": "DescribeNatGateways",
|
||||
"delay": 15,
|
||||
|
|
|
|||
|
|
@ -58,6 +58,12 @@
|
|||
"output_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"result_key": "Volumes"
|
||||
},
|
||||
"DescribeNatGateways": {
|
||||
"input_token": "NextToken",
|
||||
"limit_key": "MaxResults",
|
||||
"output_token": "NextToken",
|
||||
"result_key": "NatGateways"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
9073
botocore/data/ec2/2016-11-15/service-2.json
Executable file → Normal file
9073
botocore/data/ec2/2016-11-15/service-2.json
Executable file → Normal file
File diff suppressed because one or more lines are too long
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue